Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

ronami
Copy link
Member

PR Checklist

Overview

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);

ulrichstark reacted with thumbs up emoji
@typescript-eslint
Copy link
Contributor

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 onhttps://opencollective.com/typescript-eslint.

@netlifyNetlify
Copy link

netlifybot commentedJun 1, 2025
edited
Loading

Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commit81aead1
🔍 Latest deploy loghttps://app.netlify.com/projects/typescript-eslint/deploys/68c066c6a0956f0007c0531e
😎 Deploy Previewhttps://deploy-preview-11267--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 98 (🟢 up 12 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (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.

@nx-cloudNx Cloud
Copy link

nx-cloudbot commentedJun 1, 2025
edited
Loading

View yourCI Pipeline Execution ↗ for commit81aead1

CommandStatusDurationResult
nx run-many -t lint✅ Succeeded3m 24sView ↗
nx run types:build✅ Succeeded5sView ↗

☁️Nx Cloud last updated this comment at2025-09-09 18:02:20 UTC

@ronamironami changed the titlefeat(await-thenable): report invalid (non-promise) values passed to promise aggregator methodsfeat(eslint-plugin): [await-thenable] report invalid (non-promise) values passed to promise aggregator methodsJun 1, 2025
@codecovCodecov
Copy link

codecovbot commentedJun 1, 2025
edited
Loading

Codecov Report

❌ Patch coverage is97.65625% with3 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.92%. Comparing base (ef9173c) to head (81aead1).
⚠️ Report is 5 commits behind head on main.

Files with missing linesPatch %Lines
packages/eslint-plugin/src/rules/await-thenable.ts97.05%3 Missing⚠️
Additional details and impacted files
@@            Coverage Diff             @@##             main   #11267      +/-   ##==========================================+ Coverage   90.90%   90.92%   +0.01%==========================================  Files         505      506       +1       Lines       51208    51336     +128       Branches     8441     8469      +28     ==========================================+ Hits        46551    46676     +125- Misses       4644     4647       +3  Partials       13       13
FlagCoverage Δ
unittest90.92% <97.65%> (+0.01%)⬆️

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

Files with missing linesCoverage Δ
...slint-plugin/src/util/isPromiseAggregatorMethod.ts100.00% <100.00%> (ø)
packages/eslint-plugin/src/rules/await-thenable.ts98.76% <97.05%> (-1.24%)⬇️
🚀 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.

@libre-man
Copy link

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.

kirkwaiblinger and JoshuaKGoldberg reacted with thumbs up emojironami reacted with heart emoji

@ronamironami marked this pull request as ready for reviewJune 24, 2025 21:04
JoshuaKGoldberg
JoshuaKGoldberg previously approved these changesJun 30, 2025
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Liu Kang from Mortal Kombat clenching his fist as fire erupts from it. Caption: "FLAWLESS VICTORY"

ronami reacted with heart emoji
@JoshuaKGoldbergJoshuaKGoldberg added the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labelJun 30, 2025
if(tsutils.isTypeReference(part)){
consttypeArguments=checker.getTypeArguments(part);

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

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 🧐

ronami reacted with eyes emoji
Copy link
MemberAuthor

@ronamironamiJul 21, 2025
edited
Loading

Choose a reason for hiding this comment

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

Interesting! I didn't consider this edge case!

I took some time trying to figure this out, here are my thoughts:

  • checker.isArrayType() doesn't flag this type as array, and I've only managed to compare this kind of value is withchecker.isArrayLikeType() (which seems to check if the value is assignable toArray<any>).

    Getting the type of the element(s) of the array seems to be a bit trickier, and may be possible through TypeScript's internalgetIterationTypesOfIterable or similar.

    Unless additional APIs are exposed, the best I've managed to come up with is usingchecker.isArrayLikeType() and getting the value of the array viaarrayType.getNumberIndexType(). This seems to work OK, though a similar case that extendsIterable still has this issue (playground link):

    interfaceMyIterable<Unused,T>extendsIterable<T>{}declareconstx:MyIterable<Promise<void>,null>;// should report but doesn'tPromise.all(x);
  • This issue seems to affect additional rules, I was able to create these reproducible ones (should I open issues for them? I'm not sure how often this case gets used in the wild):

    • no-base-to-string (link to playground):

      // normally reports correctlydeclareconstx:Array<object>;`${x}`;// should report but doesn'tinterfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfObjects:MyArray<null,object>;`${arrayOfObjects}`;
    • no-floating-promises (link to playground):

      // normally reports correctlydeclareconstx:Array<Promise<void>>;x;// should report but doesn'tinterfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfPromises:MyArray<null,Promise<void>>;arrayOfPromises;
    • prefer-reduce-type-parameter (link to playground):

      // normally reports correctlydeclareconstx:Array<string>x.reduce((accum,name)=>({    ...accum,[name]:true,}),{}asRecord<string,boolean>,);// should report but doesn'tinterfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfStrings:MyArray<null,string>;arrayOfStrings.reduce((accum,name)=>({    ...accum,[name]:true,}),{}asRecord<string,boolean>,);
  • I updated the PR with the changes described above, would love to hear your thoughts.

Edit: I think themain branch has failing tests which cause this PR to be red too.

kirkwaiblinger reacted with eyes emoji

Choose a reason for hiding this comment

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

Hey! I'm going to be away from a computer until beginning of August. I can look at it then, or feel free to move this along in the meantime 🙂

ronami reacted with thumbs up emoji

Choose a reason for hiding this comment

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

I always appreciate how deeply you investigate things like this, and how clear the examples you come up with are 🙏

Interesting! I didn't consider this edge case!

I took some time trying to figure this out, here are my thoughts:

  • checker.isArrayType() doesn't flag this type as array, and I've only managed to compare this kind of value is withchecker.isArrayLikeType() (which seems to check if the value is assignable toArray<any>).
    Getting the type of the element(s) of the array seems to be a bit trickier, and may be possible through TypeScript's internalgetIterationTypesOfIterable or similar.
    Unless additional APIs are exposed, the best I've managed to come up with is usingchecker.isArrayLikeType() and getting the value of the array viaarrayType.getNumberIndexType(). This seems to work OK, though a similar case that extendsIterable still has this issue (playground link):

    interfaceMyIterable<Unused,T>extendsIterable<T>{}declareconstx:MyIterable<Promise<void>,null>;// should report but doesn'tPromise.all(x);
  • This issue seems to affect additional rules, I was able to create these reproducible ones (should I open issues for them? I'm not sure how often this case gets used in the wild):

    • no-base-to-string (link to playground):
      // normally reports correctlydeclareconstx:Array<object>;`${x}`;// should report but doesn'tinterfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfObjects:MyArray<null,object>;`${arrayOfObjects}`;

I actually think this behavior is arguably correct here. It's only with a true built-in array that the.toString() behavior is known to subsequently call its elements'.toString()s, whereas other "array"s/arraylikes may have different stringification. So in this case, we're reasoning based on implementation details of built-in arrays.

  • no-floating-promises (link to playground):
    // normally reports correctlydeclareconstx:Array<Promise<void>>;x;// should report but doesn'tinterfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfPromises:MyArray<null,Promise<void>>;arrayOfPromises;
  • prefer-reduce-type-parameter (link to playground):
    // normally reports correctlydeclareconstx:Array<string>x.reduce((accum,name)=>({    ...accum,[name]:true,}),{}asRecord<string,boolean>,);// should report but doesn'tinterfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfStrings:MyArray<null,string>;arrayOfStrings.reduce((accum,name)=>({    ...accum,[name]:true,}),{}asRecord<string,boolean>,);

With these two... It's debatable IMO, and I could be convinced either way what the "correct" behavior is. We're linting for how these arraylikes quack, rather than the exact implementation details. Though (maybe?) an argument maybe could be made that the signature of.reduce() is an implementation detail rather than a general feature of arraylikes.

In any case I don't think there's a clear cut wrong behavior in any of these that warrants proactively filing issues (versus reacting to user feedback if anyone encounters these edge cases in the wild).

  • I updated the PR with the changes described above, would love to hear your thoughts.

I think this current state looks great! I'd say this is a very good "best effort" approach at replicating thegetIterationTypesOfIterable TS API (which really would be nice to have!), and we'll find out from user feedback if the remaining edge cases really are necessary to solve. Thanks for digging so deep into this.

Edit: I think themain branch has failing tests which cause this PR to be red too.

Yep, should be fixed now! (after merging from main)

ronami reacted with heart emoji
@kirkwaiblingerkirkwaiblinger added the awaiting responseIssues waiting for a reply from the OP or another party labelJul 6, 2025
@JoshuaKGoldbergJoshuaKGoldberg removed the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labelJul 7, 2025
Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>
Copy link
Member

@kirkwaiblingerkirkwaiblinger left a comment

Choose a reason for hiding this comment

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

Couple of small things, mostly around testing, but this otherwise looks great! Oh and one larger question around special-casing array literals.

ronami reacted with heart emoji
if(tsutils.isTypeReference(part)){
consttypeArguments=checker.getTypeArguments(part);

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

Choose a reason for hiding this comment

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

I always appreciate how deeply you investigate things like this, and how clear the examples you come up with are 🙏

Interesting! I didn't consider this edge case!

I took some time trying to figure this out, here are my thoughts:

  • checker.isArrayType() doesn't flag this type as array, and I've only managed to compare this kind of value is withchecker.isArrayLikeType() (which seems to check if the value is assignable toArray<any>).
    Getting the type of the element(s) of the array seems to be a bit trickier, and may be possible through TypeScript's internalgetIterationTypesOfIterable or similar.
    Unless additional APIs are exposed, the best I've managed to come up with is usingchecker.isArrayLikeType() and getting the value of the array viaarrayType.getNumberIndexType(). This seems to work OK, though a similar case that extendsIterable still has this issue (playground link):

    interfaceMyIterable<Unused,T>extendsIterable<T>{}declareconstx:MyIterable<Promise<void>,null>;// should report but doesn'tPromise.all(x);
  • This issue seems to affect additional rules, I was able to create these reproducible ones (should I open issues for them? I'm not sure how often this case gets used in the wild):

    • no-base-to-string (link to playground):
      // normally reports correctlydeclareconstx:Array<object>;`${x}`;// should report but doesn'tinterfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfObjects:MyArray<null,object>;`${arrayOfObjects}`;

I actually think this behavior is arguably correct here. It's only with a true built-in array that the.toString() behavior is known to subsequently call its elements'.toString()s, whereas other "array"s/arraylikes may have different stringification. So in this case, we're reasoning based on implementation details of built-in arrays.

  • no-floating-promises (link to playground):
    // normally reports correctlydeclareconstx:Array<Promise<void>>;x;// should report but doesn'tinterfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfPromises:MyArray<null,Promise<void>>;arrayOfPromises;
  • prefer-reduce-type-parameter (link to playground):
    // normally reports correctlydeclareconstx:Array<string>x.reduce((accum,name)=>({    ...accum,[name]:true,}),{}asRecord<string,boolean>,);// should report but doesn'tinterfaceMyArray<Unused,T>extendsArray<T>{};declareconstarrayOfStrings:MyArray<null,string>;arrayOfStrings.reduce((accum,name)=>({    ...accum,[name]:true,}),{}asRecord<string,boolean>,);

With these two... It's debatable IMO, and I could be convinced either way what the "correct" behavior is. We're linting for how these arraylikes quack, rather than the exact implementation details. Though (maybe?) an argument maybe could be made that the signature of.reduce() is an implementation detail rather than a general feature of arraylikes.

In any case I don't think there's a clear cut wrong behavior in any of these that warrants proactively filing issues (versus reacting to user feedback if anyone encounters these edge cases in the wild).

  • I updated the PR with the changes described above, would love to hear your thoughts.

I think this current state looks great! I'd say this is a very good "best effort" approach at replicating thegetIterationTypesOfIterable TS API (which really would be nice to have!), and we'll find out from user feedback if the remaining edge cases really are necessary to solve. Thanks for digging so deep into this.

Edit: I think themain branch has failing tests which cause this PR to be red too.

Yep, should be fixed now! (after merging from main)

ronami reacted with heart emoji
@kirkwaiblingerkirkwaiblinger added the awaiting responseIssues waiting for a reply from the OP or another party labelAug 3, 2025
@ronami
Copy link
MemberAuthor

Thanks@kirkwaiblinger! I'm really sorry for how long it took me to get back to this.

kirkwaiblinger reacted with heart emoji

@github-actionsgithub-actionsbot removed the awaiting responseIssues waiting for a reply from the OP or another party labelSep 8, 2025
Copy link
Member

@kirkwaiblingerkirkwaiblinger left a comment

Choose a reason for hiding this comment

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

Another Ronen banger 🥳 ❤️

ronami reacted with heart emoji
kirkwaiblinger
kirkwaiblinger previously approved these changesSep 9, 2025
Copy link
Member

@kirkwaiblingerkirkwaiblinger left a comment

Choose a reason for hiding this comment

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

I had a look and a few of the missing cov lines are reachable for tests, but this is good with or without those tweaks 👍

ronami reacted with rocket emoji
returnchecker.getTypeArguments(type).slice(0,1);
}

returnnull;

Choose a reason for hiding this comment

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

(cov nit) this might also be unreachable? 🤷 But if soreturn null; seems correct as-is here rather than anullThrows() 👍

ronami reacted with eyes emoji
Copy link
MemberAuthor

@ronamironamiSep 9, 2025
edited
Loading

Choose a reason for hiding this comment

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

Oh, I completely missed codcov, thanks! I've updated the PR with your suggestions. I'm not sure about this one though, it's hard to tell if it's truly unreachable or if there's a case I've missed.

I think this is OK either way (though I think this would require throwinglike is done here instead ofnullThrows()).

@Zamiell
Copy link
Contributor

Hey ronami! I've been wanting this bug to be fixed for many years now, so thanks for all your hard work on this!

ronami and JoshuaKGoldberg reacted with heart emoji

@kirkwaiblingerkirkwaiblinger added the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labelSep 12, 2025
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Absolutely lovely. The implementation is very readable and clear, but also handles a lot of edge cases well. Very nicely done.

One less 2020 issue to worry about!

🔥

ronami reacted with heart emoji
@JoshuaKGoldbergJoshuaKGoldberg merged commit85d8dea intotypescript-eslint:mainSep 15, 2025
166 of 171 checks passed
@ronamironami deleted the promise-all-race-settled branchSeptember 15, 2025 12:22
ArnaudBarre added a commit to ArnaudBarre/tsl that referenced this pull requestSep 16, 2025
renovatebot added a commit to andrei-picus-tink/auto-renovate that referenced this pull requestSep 17, 2025
| datasource | package                          | from   | to     || ---------- | -------------------------------- | ------ | ------ || npm        | @typescript-eslint/eslint-plugin | 8.43.0 | 8.44.0 || npm        | @typescript-eslint/parser        | 8.43.0 | 8.44.0 |## [v8.44.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8440-2025-09-15)##### 🚀 Features- **eslint-plugin:** \[await-thenable] report invalid (non-promise) values passed to promise aggregator methods ([#11267](typescript-eslint/typescript-eslint#11267))##### 🩹 Fixes- **eslint-plugin:** \[no-unnecessary-type-conversion] ignore enum members ([#11490](typescript-eslint/typescript-eslint#11490))##### ❤️ Thank You- Moses Odutusin [@thebolarin](https://github.com/thebolarin)- Ronen AmielYou can read about our [versioning strategy](https://typescript-eslint.io/users/versioning) and [releases](https://typescript-eslint.io/users/releases) on our website.
renovatebot added a commit to andrei-picus-tink/auto-renovate that referenced this pull requestSep 17, 2025
| datasource | package                          | from   | to     || ---------- | -------------------------------- | ------ | ------ || npm        | @typescript-eslint/eslint-plugin | 8.43.0 | 8.44.0 || npm        | @typescript-eslint/parser        | 8.43.0 | 8.44.0 |## [v8.44.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8440-2025-09-15)##### 🚀 Features- **eslint-plugin:** \[await-thenable] report invalid (non-promise) values passed to promise aggregator methods ([#11267](typescript-eslint/typescript-eslint#11267))##### 🩹 Fixes- **eslint-plugin:** \[no-unnecessary-type-conversion] ignore enum members ([#11490](typescript-eslint/typescript-eslint#11490))##### ❤️ Thank You- Moses Odutusin [@thebolarin](https://github.com/thebolarin)- Ronen AmielYou can read about our [versioning strategy](https://typescript-eslint.io/users/versioning) and [releases](https://typescript-eslint.io/users/releases) on our website.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@JoshuaKGoldbergJoshuaKGoldbergJoshuaKGoldberg approved these changes

@kirkwaiblingerkirkwaiblingerkirkwaiblinger approved these changes

Assignees
No one assigned
Labels
1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[await-thenable] warn against passing non-promise values to promise aggregators (Promise.all,Promise.allSettled,Promise.race)
5 participants
@ronami@libre-man@Zamiell@JoshuaKGoldberg@kirkwaiblinger

[8]ページ先頭

©2009-2025 Movatter.jp