Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Bug: [no-floating-promises] False negative calling .then with second argument undefined #6850

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.

Sign up for GitHub

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

Jump to bottom
Closed
4 tasks done
kirk-waiblinger-trimble opened this issue Apr 5, 2023 · 8 comments · Fixed by #6881
Closed
4 tasks done

Bug: [no-floating-promises] False negative calling .then with second argument undefined #6850

kirk-waiblinger-trimble opened this issue Apr 5, 2023 · 8 comments · Fixed by #6881
Labels
accepting prs Go ahead, send a pull request that resolves this issue bug Something isn't working package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin

Comments

@kirk-waiblinger-trimble
Copy link

Before You File a Bug Report Please Confirm You Have Done The Following...

  • I have tried restarting my IDE and the issue persists.
  • I have updated to the latest version of the packages.
  • I have searched for related issues and found none that matched my issue.
  • I have read the FAQ and my problem is not listed.

Playground Link

https://typescript-eslint.io/play#ts=5.0.2&sourceType=module&code=PTAEGEHsCdoUwMYBcA2BPUAzFBDA5nnACYCwAUAArSQC2AlgM5wB08AVokgBQCUzSACzgA7Lr1ABeAHygA3qAC+PciFAAVAY1BbBcUAxw09gusLzbhoAFIBlZqACSSfUjooU2hqByWArsIEfIhRiUHZOOkhhZnIqWkYWcORefiFRcWk5RQAaUH8iOExTYh4gA&eslintrc=N4KABGBEBOCuA2BTAzpAXGUEKQAIBcBPABxQGNoBLY-AWhXkoDt8B6Jge1oDN4OBDfMwDmtYtA4BbSshTooiaBOiRwYAL4h1QA&tsconfig=N4KABGBEDGD2C2AHAlgGwKYCcDyiAuysAdgM6QBcYoEEkJemy0eAcgK6qoDCAFutAGsylBm3TgwAXxCSgA

Repro Code

Promise.reject().then(() => { }, undefined)

ESLint Config

module.exports = {
  parser: "@typescript-eslint/parser",
  rules: {
    "@typescript-eslint/no-floating-promises": ["error"],
  },
};

tsconfig

No response

Expected Result

I expect that .then(f, undefined) should be flagged as an error the same as .then(f)

Actual Result

No error

Additional Info

No response
@kirk-waiblinger-trimble kirk-waiblinger-trimble added bug Something isn't working package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin triage Waiting for team members to take a look labels Apr 5, 2023
@JoshuaKGoldberg
Copy link
Member

Nice spot - agreed. If the second argument to .then is a potentially null or undefined, we'd still want the rule to file a complaint.

I think we'd want to special-case this error though. How about this?

Rejection handler is (potentially?) (null|undefined). This Promise may become 'floating' if a nullable value is provided as a rejection handler.

Seeking bike-shedding on that error text. I'm not super satisfied with how that one repeats itself...

@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for team members to take a look labels Apr 8, 2023
@kirk-waiblinger-trimble
Copy link
Author

I have no strong opinion on this. Just a thought, though, it might be worth explaining why it would become floating in that case. What about including in the message something like the phrase The Promise constructor treats a nullish rejection handler the same as an omitted one.?

I would imagine though anyone reading it will make the connection with or without the hint, though.

@kirk-waiblinger-trimble
Copy link
Author

would you mind if I try my hand at a PR for this (pending consensus on error message)?

@Josh-Cena
Copy link
Member

Not just nullish handlers; but anything non-callable.

@JoshuaKGoldberg
Copy link
Member

Go ahead @kirk-waiblinger-trimble! 🚀

@kirk-waiblinger-trimble
Copy link
Author

Not just nullish handlers; but anything non-callable.

Good point... I hadn't thought to check since the TS declarations only allow null | undefined | () => PromiseLike<T>. Is the convention in the Typescrpt-Eslint codebase to acknowledge all JS possibilities even if they're a TS error?

Maybe "If the rejection handler is not a function, it will be ignored." or "If the rejection handler is not a function, it will be treated the same as if it were omitted." would be more general?

@JoshuaKGoldberg
Copy link
Member

acknowledge all JS possibilities even if they're a TS error?

I don't think we need to - TS giving an error is enough for users. No need for us to add an addition scream-in-your-face on top of it. It is nifty to know that JS natively ignores non-callable things though.

@Josh-Cena
Copy link
Member

I think "If the rejection handler is not a function, it will be ignored." is much better than "if it is nullish". The latter is technically not wrong (because it's a sufficient condition), but it doesn't give the full information. The former is also not too complex.

@kirkwaiblinger kirkwaiblinger mentioned this issue Apr 11, 2023
Merged
3 tasks
JoshuaKGoldberg pushed a commit that referenced this issue Jul 15, 2023
@kirkwaiblinger
fix(eslint-plugin): [no-floating-promises] false negative calling .th…
606a52c 
…en with second argument undefined (#6881)

* fix(eslint-plugin): [no-floating-promises] False negative calling .then with second argument undefined (Issue #6850)

* use getTypeAtLocation correctly

* clean up duplicate

* correct mistake in IIFE abbreviation

* purge the word invocated from the codebase
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepting prs Go ahead, send a pull request that resolves this issue bug Something isn't working package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix(eslint-plugin): [no-floating-promises] false negative calling .then with second argument undefined
3 participants
@JoshuaKGoldberg @Josh-Cena @kirk-waiblinger-trimble