Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
feat(eslint-plugin): add new rule no-floating-promises#495
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
bradzacher merged 11 commits intotypescript-eslint:masterfromprincjef:no-floating-promisesJun 10, 2019
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
11 commits Select commitHold shift + click to select a range
6bb84bd feat(eslint-plugin): add new rule no-floating-promises
princjef534809c Merge branch 'master' into no-floating-promises
bradzacher9b2c4e6 chore: merge master
princjef66c847e chore: updates to fix build/test
princjeffbdbff3 chore: fix typecheck
princjeff7601d5 chore: fix lint error
princjefdef11d3 chore: fix docs mismatch
princjef37e870d Merge branch 'master' into no-floating-promises
princjefefd991b Merge branch 'master' into no-floating-promises
princjef6708e7f Merge branch 'master' into no-floating-promises
bradzacherf0626c8 Merge branch 'master' into no-floating-promises
bradzacherFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
1 change: 1 addition & 0 deletionspackages/eslint-plugin/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
5 changes: 3 additions & 2 deletionspackages/eslint-plugin/ROADMAP.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletionspackages/eslint-plugin/docs/rules/no-floating-promises.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Requires Promise-like values to be handled appropriately (no-floating-promises) | ||
| This rule forbids usage of Promise-like values in statements without handling | ||
| their errors appropriately. Unhandled promises can cause several issues, such | ||
| as improperly sequenced operations, ignored Promise rejections and more. Valid | ||
| ways of handling a Promise-valued statement include `await`ing, returning, and | ||
| either calling `.then()` with two arguments or `.catch()` with one argument. | ||
| ## Rule Details | ||
| Examples of **incorrect** code for this rule: | ||
| ```ts | ||
| const promise = new Promise((resolve, reject) => resolve('value')); | ||
| promise; | ||
| async function returnsPromise() { | ||
| return 'value'; | ||
| } | ||
| returnsPromise().then(() => {}); | ||
| Promise.reject('value').catch(); | ||
| ``` | ||
| Examples of **correct** code for this rule: | ||
| ```ts | ||
| const promise = new Promise((resolve, reject) => resolve('value')); | ||
| await promise; | ||
| async function returnsPromise() { | ||
| return 'value'; | ||
| } | ||
| returnsPromise().then(() => {}, () => {}); | ||
| Promise.reject('value').catch(() => {}); | ||
| ``` | ||
| ## When Not To Use It | ||
| If you do not use Promise-like values in your codebase or want to allow them to | ||
| remain unhandled. | ||
| ## Related to | ||
| - Tslint: ['no-floating-promises'](https://palantir.github.io/tslint/rules/no-floating-promises/) |
2 changes: 2 additions & 0 deletionspackages/eslint-plugin/src/rules/index.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
171 changes: 171 additions & 0 deletionspackages/eslint-plugin/src/rules/no-floating-promises.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| import * as tsutils from 'tsutils'; | ||
| import * as ts from 'typescript'; | ||
| import * as util from '../util'; | ||
| export default util.createRule({ | ||
| name: 'no-floating-promises', | ||
| meta: { | ||
| docs: { | ||
| description: 'Requires Promise-like values to be handled appropriately.', | ||
| category: 'Best Practices', | ||
| recommended: false, | ||
| }, | ||
| messages: { | ||
| floating: 'Promises must be handled appropriately', | ||
| }, | ||
| schema: [], | ||
| type: 'problem', | ||
| }, | ||
| defaultOptions: [], | ||
| create(context) { | ||
| const parserServices = util.getParserServices(context); | ||
| const checker = parserServices.program.getTypeChecker(); | ||
| return { | ||
| ExpressionStatement(node) { | ||
| const { expression } = parserServices.esTreeNodeToTSNodeMap.get( | ||
| node, | ||
| ) as ts.ExpressionStatement; | ||
| if (isUnhandledPromise(checker, expression)) { | ||
| context.report({ | ||
| messageId: 'floating', | ||
| node, | ||
| }); | ||
| } | ||
| }, | ||
| }; | ||
| }, | ||
| }); | ||
| function isUnhandledPromise(checker: ts.TypeChecker, node: ts.Node): boolean { | ||
| // First, check expressions whose resulting types may not be promise-like | ||
| if ( | ||
| ts.isBinaryExpression(node) && | ||
| node.operatorToken.kind === ts.SyntaxKind.CommaToken | ||
| ) { | ||
| // Any child in a comma expression could return a potentially unhandled | ||
| // promise, so we check them all regardless of whether the final returned | ||
| // value is promise-like. | ||
| return ( | ||
| isUnhandledPromise(checker, node.left) || | ||
| isUnhandledPromise(checker, node.right) | ||
| ); | ||
| } else if (ts.isVoidExpression(node)) { | ||
| // Similarly, a `void` expression always returns undefined, so we need to | ||
| // see what's inside it without checking the type of the overall expression. | ||
| return isUnhandledPromise(checker, node.expression); | ||
| } | ||
| // Check the type. At this point it can't be unhandled if it isn't a promise | ||
| if (!isPromiseLike(checker, node)) { | ||
| return false; | ||
| } | ||
| if (ts.isCallExpression(node)) { | ||
| // If the outer expression is a call, it must be either a `.then()` or | ||
| // `.catch()` that handles the promise. | ||
| return ( | ||
| !isPromiseCatchCallWithHandler(node) && | ||
| !isPromiseThenCallWithRejectionHandler(node) | ||
| ); | ||
| } else if (ts.isConditionalExpression(node)) { | ||
| // We must be getting the promise-like value from one of the branches of the | ||
| // ternary. Check them directly. | ||
| return ( | ||
| isUnhandledPromise(checker, node.whenFalse) || | ||
| isUnhandledPromise(checker, node.whenTrue) | ||
| ); | ||
| } else if ( | ||
| ts.isPropertyAccessExpression(node) || | ||
| ts.isIdentifier(node) || | ||
| ts.isNewExpression(node) | ||
| ) { | ||
| // If it is just a property access chain or a `new` call (e.g. `foo.bar` or | ||
| // `new Promise()`), the promise is not handled because it doesn't have the | ||
| // necessary then/catch call at the end of the chain. | ||
| return true; | ||
| } | ||
| // We conservatively return false for all other types of expressions because | ||
| // we don't want to accidentally fail if the promise is handled internally but | ||
| // we just can't tell. | ||
| return false; | ||
| } | ||
| // Modified from tsutils.isThenable() to only consider thenables which can be | ||
| // rejected/caught via a second parameter. Original source (MIT licensed): | ||
| // | ||
| // https://github.com/ajafff/tsutils/blob/49d0d31050b44b81e918eae4fbaf1dfe7b7286af/util/type.ts#L95-L125 | ||
| function isPromiseLike(checker: ts.TypeChecker, node: ts.Node): boolean { | ||
| const type = checker.getTypeAtLocation(node); | ||
| for (const ty of tsutils.unionTypeParts(checker.getApparentType(type))) { | ||
| const then = ty.getProperty('then'); | ||
| if (then === undefined) { | ||
| continue; | ||
| } | ||
| const thenType = checker.getTypeOfSymbolAtLocation(then, node); | ||
| if ( | ||
| hasMatchingSignature( | ||
| thenType, | ||
| signature => | ||
| signature.parameters.length >= 2 && | ||
| isFunctionParam(checker, signature.parameters[0], node) && | ||
| isFunctionParam(checker, signature.parameters[1], node), | ||
| ) | ||
| ) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
| function hasMatchingSignature( | ||
| type: ts.Type, | ||
| matcher: (signature: ts.Signature) => boolean, | ||
| ): boolean { | ||
| for (const t of tsutils.unionTypeParts(type)) { | ||
| if (t.getCallSignatures().some(matcher)) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
| function isFunctionParam( | ||
| checker: ts.TypeChecker, | ||
| param: ts.Symbol, | ||
| node: ts.Node, | ||
| ): boolean { | ||
| const type: ts.Type | undefined = checker.getApparentType( | ||
| checker.getTypeOfSymbolAtLocation(param, node), | ||
| ); | ||
| for (const t of tsutils.unionTypeParts(type)) { | ||
| if (t.getCallSignatures().length !== 0) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
| function isPromiseCatchCallWithHandler(expression: ts.CallExpression): boolean { | ||
| return ( | ||
| tsutils.isPropertyAccessExpression(expression.expression) && | ||
| expression.expression.name.text === 'catch' && | ||
| expression.arguments.length >= 1 | ||
| ); | ||
| } | ||
| function isPromiseThenCallWithRejectionHandler( | ||
| expression: ts.CallExpression, | ||
| ): boolean { | ||
| return ( | ||
| tsutils.isPropertyAccessExpression(expression.expression) && | ||
| expression.expression.name.text === 'then' && | ||
| expression.arguments.length >= 2 | ||
| ); | ||
| } |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.