This PR tackles#1804 and adjusts the rule to report on invalid (non-promise) input passed to promise aggregator methods (Promise.all,Promise.race,Promise.allSettled, andPromise.any):

declareconstx:number[];// Unexpected iterator of non-Promise (non-"Thenable") values passed to promise aggregator.Promise.all(x);

ronami added2 commits

June 2, 2025 00:37

initial implementation

4bd647c

add promise.any

20ff75d

Copy link

Contributor

typescript-eslintbot commentedJun 1, 2025

Thanks for the PR,@ronami!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

Copy link

netlifybot commentedJun 1, 2025•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

Name	Link
🔨 Latest commit	`bcf18dc`
🔍 Latest deploy log	https://app.netlify.com/projects/typescript-eslint/deploys/685b0ff511bafa0008cbc821
😎 Deploy Preview	https://deploy-preview-11267--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 93 (🔴 down 2 from production) Accessibility: 100 (no change from production) Best Practices: 100 (no change from production) SEO: 100 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to yourNetlify project configuration.

Copy link

nx-cloudbot commentedJun 1, 2025•
edited
Loading

View yourCI Pipeline Execution ↗ for commitbcf18dc.

Command	Status	Duration	Result
`nx test eslint-plugin --coverage=false`	✅ Succeeded	5m	View ↗
`nx run-many -t typecheck`	✅ Succeeded	2m 9s	View ↗
`nx run-many -t lint`	✅ Succeeded	11s	View ↗
`nx run generate-configs`	✅ Succeeded	8s	View ↗
`nx run types:build`	✅ Succeeded	1s	View ↗
`nx test typescript-estree --coverage=false`	✅ Succeeded	<1s	View ↗
`nx test eslint-plugin-internal --coverage=false`	✅ Succeeded	<1s	View ↗
`nx run integration-tests:test`	✅ Succeeded	<1s	View ↗
`Additional runs (27)`	✅ Succeeded	...	View ↗

☁️Nx Cloud last updated this comment at2025-06-24 21:03:07 UTC

ronami changed the title~~feat(await-thenable): report invalid (non-promise) values passed to promise aggregator methods~~feat(eslint-plugin): [await-thenable] report invalid (non-promise) values passed to promise aggregator methods

Jun 1, 2025

Copy link

codecovbot commentedJun 1, 2025•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.85%. Comparing base(d19c9f3) to head(bcf18dc).
Report is 22 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@##             main   #11267      +/-   ##==========================================+ Coverage   90.84%   90.85%   +0.01%==========================================  Files         501      502       +1       Lines       50919    51013      +94       Branches     8386     8405      +19     ==========================================+ Hits        46256    46350      +94  Misses       4648     4648                Partials       15       15

Flag	Coverage Δ
unittest	`90.85% <100.00%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown.Click here to find out more.

Files with missing lines	Coverage Δ
packages/eslint-plugin/src/rules/await-thenable.ts	`100.00% <100.00%> (ø)`
...slint-plugin/src/util/isPromiseAggregatorMethod.ts	`100.00% <100.00%> (ø)`

🚀 New features to boost your workflow:

❄️Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

libre-man commentedJun 6, 2025

It would be great if a test case for forPromise.all(x) wherex isArray<Array<Promise<T>> could be added, as this the bug that we recently had in#11257.

ronami added6 commits

June 24, 2025 23:16

add missing test

921942e

wip

e5bffbf

Merge remote-tracking branch 'origin/main' into promise-all-race-settled

62a6eed

refactor, fix edge cases

d46056a

add nested array test-case

ad08eb1

missing coverage

bcf18dc

ronami marked this pull request as ready for review

June 24, 2025 21:04

JoshuaKGoldberg approved these changes

Jun 30, 2025

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

JoshuaKGoldberg added the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label

Jun 30, 2025

kirkwaiblinger reviewed

Jul 3, 2025

View reviewed changes

packages/eslint-plugin/src/rules/await-thenable.ts

		@@ -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.',

Copy link

Member

kirkwaiblingerJul 3, 2025

Choose a reason for hiding this comment

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

Technically, I think the wording should be like so?

Suggested change

	'Unexpectediterator of non-Promise (non-"Thenable") values passed to promise aggregator.',
	'Unexpectediterable of non-Promise (non-"Thenable") values passed to promise aggregator.',

packages/eslint-plugin/src/rules/await-thenable.ts

		if (tsutils.isTypeReference(part)) {
		const typeArguments = checker.getTypeArguments(part);

		// only check the first type argument of `Iterator<...>` or `Array<...>`

Copy link

Member

kirkwaiblingerJul 3, 2025

Choose a reason for hiding this comment

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

The heuristics here seem to have minor edge case bugs.

interfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfNull:MyArray<Promise<void>,null>;declareconstarrayOfPromises:MyArray<null,Promise<void>>;Promise.all(arrayOfNull);// no report; should reportPromise.all(arrayOfPromises);// does report; shouldn't report

Note that if you switchinterface totype, this works correctly 🧐

packages/eslint-plugin/src/rules/await-thenable.ts

		@@ -1,10 +1,12 @@
		import type { TSESLint, TSESTree } from '@typescript-eslint/utils';

Copy link

Member

kirkwaiblingerJul 3, 2025

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 ofadding an option for.some() vs.every() semantics for whether to report things likePromise.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.