Skip to content

Conversation

@ronami
Copy link
Member

@ronami ronami commented Jun 1, 2025

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, and Promise.any):

declare const x: number[];

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

@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 on https://opencollective.com/typescript-eslint.

@netlify
Copy link

netlify bot commented Jun 1, 2025

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 81aead1
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/68c066c6a0956f0007c0531e
😎 Deploy Preview https://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 your Netlify project configuration.

@nx-cloud
Copy link

nx-cloud bot commented Jun 1, 2025

View your CI Pipeline Execution ↗ for commit 81aead1

Command Status Duration Result
nx run-many -t lint ✅ Succeeded 3m 24s View ↗
nx run types:build ✅ Succeeded 5s View ↗

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

@ronami 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
@codecov
Copy link

codecov bot commented Jun 1, 2025

Codecov Report

❌ Patch coverage is 97.65625% with 3 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 lines Patch % Lines
packages/eslint-plugin/src/rules/await-thenable.ts 97.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              
Flag Coverage Δ
unittest 90.92% <97.65%> (+0.01%) ⬆️

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

Files with missing lines Coverage Δ
...slint-plugin/src/util/isPromiseAggregatorMethod.ts 100.00% <100.00%> (ø)
packages/eslint-plugin/src/rules/await-thenable.ts 98.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 for Promise.all(x) where x is Array<Array<Promise<T>> could be added, as this the bug that we recently had in #11257.

@ronami ronami marked this pull request as ready for review June 24, 2025 21:04
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg 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"

@JoshuaKGoldberg 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
if (tsutils.isTypeReference(part)) {
const typeArguments = checker.getTypeArguments(part);

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

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.

interface MyArray<Unused, T> extends Array<T> {};

declare const arrayOfNull: MyArray<Promise<void>, null>;
declare const arrayOfPromises: MyArray<null, Promise<void>>;

Promise.all(arrayOfNull); // no report; should report
Promise.all(arrayOfPromises); // does report; shouldn't report

Note that if you switch interface to type, this works correctly 🧐

Copy link
Member Author

@ronami ronami Jul 21, 2025

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 with checker.isArrayLikeType() (which seems to check if the value is assignable to Array<any>).

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

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

    interface MyIterable<Unused, T> extends Iterable<T> { }
    declare const x: MyIterable<Promise<void>, null>;
    
    // should report but doesn't
    Promise.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 correctly
      declare const x: Array<object>;
      `${x}`;
      
      // should report but doesn't
      interface MyArray<Unused, T> extends Array<T> { };
      declare const arrayOfObjects: MyArray<null, object>;
      
      `${arrayOfObjects}`;
    • no-floating-promises (link to playground):

      // normally reports correctly
      declare const x: Array<Promise<void>>;
      x;
      
      // should report but doesn't
      interface MyArray<Unused, T> extends Array<T> { };
      declare const arrayOfPromises: MyArray<null, Promise<void>>;
      
      arrayOfPromises;
    • prefer-reduce-type-parameter (link to playground):

      // normally reports correctly
      declare const x: Array<string>
      
      x.reduce(
        (accum, name) => ({
          ...accum,
          [name]: true,
        }),
        {} as Record<string, boolean>,
      );
      
      // should report but doesn't
      interface MyArray<Unused, T> extends Array<T> { };
      
      declare const arrayOfStrings: MyArray<null, string>;
      
      arrayOfStrings.reduce(
        (accum, name) => ({
          ...accum,
          [name]: true,
        }),
        {} as Record<string, boolean>,
      );
  • I updated the PR with the changes described above, would love to hear your thoughts.

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

Copy link
Member

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 🙂

Copy link
Member

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 with checker.isArrayLikeType() (which seems to check if the value is assignable to Array<any>).
    Getting the type of the element(s) of the array seems to be a bit trickier, and may be possible through TypeScript's internal getIterationTypesOfIterable or similar.
    Unless additional APIs are exposed, the best I've managed to come up with is using checker.isArrayLikeType() and getting the value of the array via arrayType.getNumberIndexType(). This seems to work OK, though a similar case that extends Iterable still has this issue (playground link):

    interface MyIterable<Unused, T> extends Iterable<T> { }
    declare const x: MyIterable<Promise<void>, null>;
    
    // should report but doesn't
    Promise.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 correctly
      declare const x: Array<object>;
      `${x}`;
      
      // should report but doesn't
      interface MyArray<Unused, T> extends Array<T> { };
      declare const arrayOfObjects: 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 correctly
    declare const x: Array<Promise<void>>;
    x;
    
    // should report but doesn't
    interface MyArray<Unused, T> extends Array<T> { };
    declare const arrayOfPromises: MyArray<null, Promise<void>>;
    
    arrayOfPromises;
  • prefer-reduce-type-parameter (link to playground):
    // normally reports correctly
    declare const x: Array<string>
    
    x.reduce(
      (accum, name) => ({
        ...accum,
        [name]: true,
      }),
      {} as Record<string, boolean>,
    );
    
    // should report but doesn't
    interface MyArray<Unused, T> extends Array<T> { };
    
    declare const arrayOfStrings: MyArray<null, string>;
    
    arrayOfStrings.reduce(
      (accum, name) => ({
        ...accum,
        [name]: true,
      }),
      {} as Record<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 the getIterationTypesOfIterable 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 the main branch has failing tests which cause this PR to be red too.

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

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

@kirkwaiblinger kirkwaiblinger 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.

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

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

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 with checker.isArrayLikeType() (which seems to check if the value is assignable to Array<any>).
    Getting the type of the element(s) of the array seems to be a bit trickier, and may be possible through TypeScript's internal getIterationTypesOfIterable or similar.
    Unless additional APIs are exposed, the best I've managed to come up with is using checker.isArrayLikeType() and getting the value of the array via arrayType.getNumberIndexType(). This seems to work OK, though a similar case that extends Iterable still has this issue (playground link):

    interface MyIterable<Unused, T> extends Iterable<T> { }
    declare const x: MyIterable<Promise<void>, null>;
    
    // should report but doesn't
    Promise.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 correctly
      declare const x: Array<object>;
      `${x}`;
      
      // should report but doesn't
      interface MyArray<Unused, T> extends Array<T> { };
      declare const arrayOfObjects: 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 correctly
    declare const x: Array<Promise<void>>;
    x;
    
    // should report but doesn't
    interface MyArray<Unused, T> extends Array<T> { };
    declare const arrayOfPromises: MyArray<null, Promise<void>>;
    
    arrayOfPromises;
  • prefer-reduce-type-parameter (link to playground):
    // normally reports correctly
    declare const x: Array<string>
    
    x.reduce(
      (accum, name) => ({
        ...accum,
        [name]: true,
      }),
      {} as Record<string, boolean>,
    );
    
    // should report but doesn't
    interface MyArray<Unused, T> extends Array<T> { };
    
    declare const arrayOfStrings: MyArray<null, string>;
    
    arrayOfStrings.reduce(
      (accum, name) => ({
        ...accum,
        [name]: true,
      }),
      {} as Record<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 the getIterationTypesOfIterable 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 the main branch has failing tests which cause this PR to be red too.

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

@kirkwaiblinger kirkwaiblinger added the awaiting response Issues waiting for a reply from the OP or another party label Aug 3, 2025
@ronami
Copy link
Member Author

ronami commented Sep 8, 2025

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

@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Sep 8, 2025
Copy link
Member

@kirkwaiblinger kirkwaiblinger 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 🥳 ❤️

kirkwaiblinger
kirkwaiblinger previously approved these changes Sep 9, 2025
Copy link
Member

@kirkwaiblinger kirkwaiblinger 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 👍

return checker.getTypeArguments(type).slice(0, 1);
}

return null;
Copy link
Member

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 so return null; seems correct as-is here rather than a nullThrows() 👍

Copy link
Member Author

@ronami ronami Sep 9, 2025

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 throwing like is done here instead of nullThrows()).

@Zamiell
Copy link
Contributor

Zamiell commented Sep 12, 2025

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

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

@JoshuaKGoldberg JoshuaKGoldberg 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!

🔥

@JoshuaKGoldberg JoshuaKGoldberg merged commit 85d8dea into typescript-eslint:main Sep 15, 2025
166 of 171 checks passed
@ronami ronami deleted the promise-all-race-settled branch September 15, 2025 12:22
ArnaudBarre added a commit to ArnaudBarre/tsl that referenced this pull request Sep 16, 2025
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Sep 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 Amiel

You can read about our [versioning strategy](https://typescript-eslint.io/users/versioning) and [releases](https://typescript-eslint.io/users/releases) on our website.
renovate bot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request Sep 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 Amiel

You 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 free to join this conversation on GitHub. Already have an account? Sign in to comment

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

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