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

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
103 changes: 103 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';
Copy link
Member

Choose a reason for hiding this comment

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

Noting that there was talk on the issue of adding an option for .some() vs .every() semantics for whether to report things like Promise.all([2, Promise.resolve(3)]).

I think the .some() semantics used here are good and if someone wants the .every() semantics option after it's released we can entertain that as a followup, but no need for this version.

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 iterable 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,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) {
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 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
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy