Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(eslint-plugin): [no-floating-promises] add checkThenables option #9263

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Adds a new checkThenables boolean option to the rule that enables checking all shapes for matching the .then() interface. It essentially gates the existing "does this have a .then() with two parameters?" logic behind the option.

checkThenables is true by default in this PR so as to not cause a breaking change. If this PR goes in roughly as-is, I'd like to file a followup issue for v8 to turn it to false by default.

#8433 also mentioned adding in an option for adding additional types to what's flagged by default. I haven't heard anybody mention this as a strong need, so for now I'm holding off on adding that.

💖

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

Copy link

netlify bot commented Jun 4, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit dac381c
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/668996765b425e00089b41b5
😎 Deploy Preview https://deploy-preview-9263--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 96 (🟢 up 2 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@Josh-Cena
Copy link
Member

I don't get the motivation for this, TBH. How can something "happen to be thenable" without noticing? Does then have any other meaning other than interoperating with promises? JavaScript itself resolves thenables, so if your thenable is not supposed to quack like a promise you will shoot yourself in the foot everywhere, like returning it from an async function, etc.

@JoshuaKGoldberg JoshuaKGoldberg changed the title feat(eslint-plugin): [no-floating-promises] add checkAllThenables option feat(eslint-plugin): [no-floating-promises] add checkThenables option Jun 4, 2024
kirkwaiblinger
kirkwaiblinger previously approved these changes Jun 4, 2024
Copy link
Member

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rocket

packages/eslint-plugin/docs/rules/no-floating-promises.mdx Outdated Show resolved Hide resolved
@JoshuaKGoldberg
Copy link
Member Author

How can something "happen to be thenable" without noticing?

https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e40cab53d9971a3e0b34e8fb18ece74240d9425d/types/bluebird/index.d.ts#L59: older projects that have polyfills which generally intentionally match something like Promises/A+.

@Josh-Cena
Copy link
Member

Why would one expect a polyfill to not be checked like a real promise?

@JoshuaKGoldberg
Copy link
Member Author

One example I've believe I've been told is that if a framework implements its own classes that happen to have a similar API to Promises, it's inconvenient to have the rule fire on them by default.

cc @mcollina as I think this was from you and Fastify, but I might be mistaken / mistinterpreting.

@Josh-Cena
Copy link
Member

The issue mentions node:test, but doesn't test() return a real promise?

@JoshuaKGoldberg
Copy link
Member Author

@Josh-Cena the Node issue does, but our #8433 -> this PR isn't around that I don't think.

@Josh-Cena
Copy link
Member

Josh-Cena commented Jun 5, 2024

That issue doesn't mention a valid use case where you want a thenable to not be checked like a promise though. It just mentions polyfills but those are why we check thenables.

@JoshuaKGoldberg
Copy link
Member Author

Great points. Putting into draft per #8433 (comment). Thanks!

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as draft June 5, 2024 13:26
@JoshuaKGoldberg
Copy link
Member Author

#8433 was confirmed as good to go, so un-drafting. 👍

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review June 29, 2024 19:53
@JoshuaKGoldberg JoshuaKGoldberg requested review from kirkwaiblinger, Josh-Cena and a team June 29, 2024 19:53
Copy link
Member

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code makes sense to me! only blocker is some test coverage

Copy link

codecov bot commented Jul 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.24%. Comparing base (dfae228) to head (6078b07).
Report is 111 commits behind head on main.

Current head 6078b07 differs from pull request most recent head dac381c

Please upload reports for the commit dac381c to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9263      +/-   ##
==========================================
+ Coverage   87.42%   88.24%   +0.81%     
==========================================
  Files         261      416     +155     
  Lines       12724    14380    +1656     
  Branches     3975     4195     +220     
==========================================
+ Hits        11124    12689    +1565     
- Misses       1319     1372      +53     
- Partials      281      319      +38     
Flag Coverage Δ
unittest 88.24% <100.00%> (+0.81%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...es/eslint-plugin/src/rules/no-floating-promises.ts 100.00% <100.00%> (ø)

... and 187 files with indirect coverage changes

kirkwaiblinger
kirkwaiblinger previously approved these changes Jul 3, 2024
Copy link
Member

@kirkwaiblinger kirkwaiblinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yay

@kirkwaiblinger kirkwaiblinger added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jul 3, 2024
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
@JoshuaKGoldberg
Copy link
Member Author

Confirmed with @Josh-Cena that we're good to merge with those docs suggestions. 🚀!

@JoshuaKGoldberg JoshuaKGoldberg merged commit 63d17dd into typescript-eslint:main Jul 6, 2024
52 of 58 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the no-floating-promises-check-all-thenables branch July 6, 2024 19:18
kirkwaiblinger pushed a commit that referenced this pull request Jul 8, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: [no-floating-promises] Don't check coincidentally Promise-like (Thenable) type values by default
3 participants