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

fix(eslint-plugin): [no-floating-promises] check top-level type assertions (and more) #9043

Merged

Conversation

kirkwaiblinger
Copy link
Member

PR Checklist

Overview

Changes implementation from an unhandled promise syntax allowlist to a syntax denylist.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @kirkwaiblinger!

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 May 4, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 53e7d0e
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6674c8356fe43200088b7440
😎 Deploy Preview https://deploy-preview-9043--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: 99 (🟢 up 1 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.

async function test() {
declare const promiseValue: Promise<number>;
Copy link
Member Author

@kirkwaiblinger kirkwaiblinger May 4, 2024

Choose a reason for hiding this comment

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

These changes are just because declare is not syntactically allowed in that position (it's required to be at top level). Just some hygiene, not relevant to the changes.

Copy link

nx-cloud bot commented May 4, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 53e7d0e. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

code: `
declare let x: any;
declare const promiseArray: Array<Promise<unknown>>;
x = promiseArray;
Copy link
Member Author

@kirkwaiblinger kirkwaiblinger May 4, 2024

Choose a reason for hiding this comment

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

surprisingly, assignments without a declaration were not tested for

@kirkwaiblinger kirkwaiblinger marked this pull request as ready for review May 4, 2024 00:24
@kirkwaiblinger kirkwaiblinger added the bug Something isn't working label May 4, 2024
},
{
code: `
3 as Promise<number>;
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not a community maintainer, but I'm very much against these tests.
Even, after checking off all the options in the type-checking section, typescript is still giving error on this statement.

Playground link

Either these tests be removed or should be replaced with valid ts code.

Copy link
Member

Choose a reason for hiding this comment

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

Relevant: #8298

+1 that if we can get away with no type error, it'd be better to.

const value = {};

value as Promise<number>;

Copy link
Member Author

Choose a reason for hiding this comment

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

Makes sense. Also, very clever with suggesting the castable {} 👍

Copy link
Member

Choose a reason for hiding this comment

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

The empty object type has been on my mind a lot lately... 😂

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Syntax looks great to me! ✨ 🧹

Just waiting on the test discussion.

@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Jun 16, 2024
@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Jun 21, 2024
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Amusingly crude animation of a photo of a cat on a PB&J sandwich, floating up and down above the cosmos

@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 Jun 22, 2024
Comment on lines +332 to +333
// Anything else is unhandled.
return { isUnhandled: true };
Copy link
Member

Choose a reason for hiding this comment

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

In your summary you wrote

Changes implementation from an unhandled promise syntax allowlist to a syntax denylist.

But I don't understand what we gain from that switch

This seems... dangerous - switching to default assuming it's unhandled is probably going to lead to false positives at scale.

Copy link
Member Author

@kirkwaiblinger kirkwaiblinger Jun 23, 2024

Choose a reason for hiding this comment

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

TL;DR Concern is valid but I tentatively think this is the right move. Would welcome a second opinion


I don't understand what we gain from that switch

implementation simplicity and future proofing 🤷 It seems more straightforward, and more correct (IMO), to opt out of flagging behaviors indicated by the docs than it does to opt in to the ones we do want to flag...

Nodes that are handled

  • await expression
  • assignment expression (x = y)

Nodes that require special handling to determine whether they're handled or unhandled (and therefore need to be specified individually no matter what)

  • CallExpression
  • LogicalExpression
  • SequenceExpression
  • ConditionalExpression
  • void expression
  • optional chaining expression
  • iifes

Nodes that are always unhandled (if they result in a promise)

  • NewExpression
  • Identifier
  • MemberExpression
  • TaggedTemplateExpression (previously forgotten, recently fixed in fix(eslint-plugin): [no-floating-promises] handle TaggedTemplateExpression #8758)
  • TSAsExpression (previously forgotten, the point of this PR)
  • TSTypeAssertion (previously forgotten, the point of this PR)
  • TSNonNullExpression (previously forgotten, basically equivalent to previous two)
  • ... probably more - this feels like the appropriate default behavior for anything that doesn't fall into one of the other two buckets

This seems... dangerous - switching to default assuming it's unhandled is probably going to lead to false positives at scale.

To be sure, I gave this some thought before making this change, and I just couldn't think of any scenarios where this would really be problematic... Every case I thought of seemed to be beneficial. Just to be sure we're on the same page, that code is only reached if the expression results in a promise/thenable.

That does mean that this code will start flagging now

({
  then(resolve: Function, reject: Function) {
    return this;
  }
});

and I think that makes sense, given

const unhandled = {
  then(resolve: Function, reject: Function) {
    return this;
  }
};
unhandled;

already flags (of course, this touches upon #8433). But it's not like we're suddenly going to flag every object literal; just thenable ones.

I think the yield cases added to the tests make sense to flag as well....

Note that we dogfood no-floating-promises in this repo and this change didn't result in any new reports.

My conclusion - false positives are a very valid concern to explore, but for now I do think that this change is safe/beneficial. Would definitely be open to being proven wrong, though, especially if a good counterexample comes to mind! 🙂

@JoshuaKGoldberg JoshuaKGoldberg removed the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jul 6, 2024
@JoshuaKGoldberg JoshuaKGoldberg dismissed their stale review July 6, 2024 16:52

Brad and Kirk have inputs

@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 14, 2024
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

🚀 yay!

@JoshuaKGoldberg JoshuaKGoldberg merged commit 2d81d1a into typescript-eslint:main Jul 16, 2024
70 checks passed
@kirkwaiblinger kirkwaiblinger deleted the flag-on-type-assertions branch July 16, 2024 20:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 24, 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 bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: [no-floating-promises] support TsAsExpression
4 participants