Skip to content

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions packages/eslint-plugin/src/rules/await-thenable.ts
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,
Expand All @@ -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>({
Expand All @@ -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 iterator of non-Promise (non-"Thenable") values passed to promise aggregator.',
removeAwait: 'Remove unnecessary `await`.',
},
schema: [],
Expand Down Expand Up @@ -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)) {
Expand Down Expand Up @@ -176,3 +209,31 @@ export default createRule<[], MessageId>({
};
},
});

function isInvalidPromiseAggregatorInput(
checker: ts.TypeChecker,
node: ts.Node,
type: ts.Type,
): boolean {
for (const part of tsutils.unionConstituents(type)) {
if (
tsutils.isTypeReference(part) &&
tsutils.getWellKnownSymbolPropertyOfType(part, 'iterator', checker)
) {
for (const typeArgument of checker.getTypeArguments(part)) {
if (
tsutils.unionConstituents(typeArgument).some(typeArgumentPart => {
return (
needsToBeAwaited(checker, node, typeArgumentPart) ===
Awaitable.Never
);
})
) {
return true;
}
}
}
}

return false;
}
41 changes: 41 additions & 0 deletions packages/eslint-plugin/src/util/isPromiseAggregatorMethod.ts
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),
);
}
Loading
Loading