-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
feat(eslint-plugin): [await-thenable] report invalid (non-promise) values passed to promise aggregator methods #11267
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
Open
ronami
wants to merge
11
commits into
typescript-eslint:main
Choose a base branch
from
ronami:promise-all-race-settled
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+538
−0
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
4bd647c
initial implementation
ronami 20ff75d
add promise.any
ronami 921942e
add missing test
ronami e5bffbf
wip
ronami 62a6eed
Merge remote-tracking branch 'origin/main' into promise-all-race-settled
ronami d46056a
refactor, fix edge cases
ronami ad08eb1
add nested array test-case
ronami bcf18dc
missing coverage
ronami a409343
Update packages/eslint-plugin/src/rules/await-thenable.ts
ronami d7fb0b1
Merge branch 'main' into promise-all-race-settled
ronami 99343da
use checker.isArrayLikeType for checking types that extend an array
ronami File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 |
---|---|---|
@@ -1,10 +1,12 @@ | ||
import type { TSESLint, TSESTree } from '@typescript-eslint/utils'; | ||
import type * as ts from 'typescript'; | ||
|
||
import * as tsutils from 'ts-api-utils'; | ||
|
||
import { | ||
Awaitable, | ||
createRule, | ||
getConstrainedTypeAtLocation, | ||
getFixOrSuggest, | ||
getParserServices, | ||
isAwaitKeyword, | ||
|
@@ -14,12 +16,14 @@ import { | |
NullThrowsReasons, | ||
} from '../util'; | ||
import { getForStatementHeadLoc } from '../util/getForStatementHeadLoc'; | ||
import { isPromiseAggregatorMethod } from '../util/isPromiseAggregatorMethod'; | ||
|
||
export type MessageId = | ||
| 'await' | ||
| 'awaitUsingOfNonAsyncDisposable' | ||
| 'convertToOrdinaryFor' | ||
| 'forAwaitOfNonAsyncIterable' | ||
| 'invalidPromiseAggregatorInput' | ||
| 'removeAwait'; | ||
|
||
export default createRule<[], MessageId>({ | ||
|
@@ -39,6 +43,8 @@ export default createRule<[], MessageId>({ | |
convertToOrdinaryFor: 'Convert to an ordinary `for...of` loop.', | ||
forAwaitOfNonAsyncIterable: | ||
'Unexpected `for await...of` of a value that is not async iterable.', | ||
invalidPromiseAggregatorInput: | ||
'Unexpected iterable of non-Promise (non-"Thenable") values passed to promise aggregator.', | ||
removeAwait: 'Remove unnecessary `await`.', | ||
}, | ||
schema: [], | ||
|
@@ -84,6 +90,33 @@ export default createRule<[], MessageId>({ | |
} | ||
}, | ||
|
||
CallExpression(node: TSESTree.CallExpression): void { | ||
if (!isPromiseAggregatorMethod(context, services, node)) { | ||
return; | ||
} | ||
|
||
const argument = node.arguments.at(0); | ||
|
||
if (argument == null) { | ||
return; | ||
} | ||
|
||
const type = getConstrainedTypeAtLocation(services, argument); | ||
|
||
if ( | ||
isInvalidPromiseAggregatorInput( | ||
checker, | ||
services.esTreeNodeToTSNodeMap.get(argument), | ||
type, | ||
) | ||
) { | ||
context.report({ | ||
node: argument, | ||
messageId: 'invalidPromiseAggregatorInput', | ||
}); | ||
} | ||
}, | ||
|
||
'ForOfStatement[await=true]'(node: TSESTree.ForOfStatement): void { | ||
const type = services.getTypeAtLocation(node.right); | ||
if (isTypeAnyType(type)) { | ||
|
@@ -176,3 +209,73 @@ export default createRule<[], MessageId>({ | |
}; | ||
}, | ||
}); | ||
|
||
function isInvalidPromiseAggregatorInput( | ||
checker: ts.TypeChecker, | ||
node: ts.Node, | ||
type: ts.Type, | ||
): boolean { | ||
// non array/tuple/iterable types already show up as a type error | ||
if (!isIterable(type, checker)) { | ||
return false; | ||
} | ||
|
||
for (const part of tsutils.unionConstituents(type)) { | ||
const valueTypes = getValueTypesOfArrayLike(part, checker); | ||
|
||
if (valueTypes != null) { | ||
for (const typeArgument of valueTypes) { | ||
if (containsNonAwaitableType(typeArgument, node, checker)) { | ||
return true; | ||
} | ||
} | ||
} | ||
} | ||
|
||
return false; | ||
} | ||
|
||
function getValueTypesOfArrayLike(type: ts.Type, checker: ts.TypeChecker) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. IMO this would benefit from a return type |
||
if (checker.isTupleType(type)) { | ||
return checker.getTypeArguments(type); | ||
} | ||
|
||
if (checker.isArrayLikeType(type)) { | ||
const indexType = type.getNumberIndexType(); | ||
|
||
if (indexType != null) { | ||
return [indexType]; | ||
} | ||
|
||
return null; | ||
} | ||
|
||
// `Iterable<...>` | ||
if (tsutils.isTypeReference(type)) { | ||
return checker.getTypeArguments(type).slice(0, 1); | ||
} | ||
|
||
return null; | ||
} | ||
|
||
function containsNonAwaitableType( | ||
type: ts.Type, | ||
node: ts.Node, | ||
checker: ts.TypeChecker, | ||
): boolean { | ||
return tsutils | ||
.unionConstituents(type) | ||
.some( | ||
typeArgumentPart => | ||
needsToBeAwaited(checker, node, typeArgumentPart) === Awaitable.Never, | ||
); | ||
} | ||
|
||
function isIterable(type: ts.Type, checker: ts.TypeChecker): boolean { | ||
return tsutils | ||
.unionConstituents(type) | ||
.every( | ||
part => | ||
!!tsutils.getWellKnownSymbolPropertyOfType(part, 'iterator', checker), | ||
); | ||
} |
41 changes: 41 additions & 0 deletions
41
packages/eslint-plugin/src/util/isPromiseAggregatorMethod.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,41 @@ | ||
import type { | ||
ParserServicesWithTypeInformation, | ||
TSESTree, | ||
} from '@typescript-eslint/utils'; | ||
import type { RuleContext } from '@typescript-eslint/utils/ts-eslint'; | ||
|
||
import { | ||
getConstrainedTypeAtLocation, | ||
isPromiseConstructorLike, | ||
} from '@typescript-eslint/type-utils'; | ||
import { AST_NODE_TYPES } from '@typescript-eslint/utils'; | ||
|
||
import { getStaticMemberAccessValue } from './misc'; | ||
|
||
const PROMISE_CONSTRUCTOR_ARRAY_METHODS = new Set<unknown>([ | ||
'all', | ||
'allSettled', | ||
'race', | ||
'any', | ||
]); | ||
|
||
export function isPromiseAggregatorMethod( | ||
context: RuleContext<string, unknown[]>, | ||
services: ParserServicesWithTypeInformation, | ||
node: TSESTree.CallExpression, | ||
): boolean { | ||
if (node.callee.type !== AST_NODE_TYPES.MemberExpression) { | ||
return false; | ||
} | ||
|
||
const staticAccessValue = getStaticMemberAccessValue(node.callee, context); | ||
|
||
if (!PROMISE_CONSTRUCTOR_ARRAY_METHODS.has(staticAccessValue)) { | ||
return false; | ||
} | ||
|
||
return isPromiseConstructorLike( | ||
services.program, | ||
getConstrainedTypeAtLocation(services, node.callee.object), | ||
); | ||
} |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.