Content-Length: 494582 | pFad | https://github.com/typescript-eslint/typescript-eslint/pull/11267

9D feat(eslint-plugin): [await-thenable] report invalid (non-promise) values passed to promise aggregator methods by ronami · Pull Request #11267 · typescript-eslint/typescript-eslint · GitHub
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

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.

Copy link

netlify bot commented Jun 1, 2025

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 99343da
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/687e93f34bf72200088ed99f
😎 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: 99 (🟢 up 1 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.

Copy link

nx-cloud bot commented Jun 1, 2025

View your CI Pipeline Execution ↗ for commit 99343da

Command Status Duration Result
nx run ast-spec:test -- --coverage ❌ Failed 11s View ↗
nx test ast-spec ❌ Failed 11s View ↗
nx test eslint-plugin --coverage=false ✅ Succeeded 5m 9s View ↗
nx run-many -t lint ✅ Succeeded 3m 26s View ↗
nx run-many -t typecheck ✅ Succeeded 2m 13s View ↗
nx test eslint-plugin-internal --coverage=false ✅ Succeeded 4s View ↗
nx run integration-tests:test ✅ Succeeded 6s View ↗
nx test typescript-estree --coverage=false ✅ Succeeded 2s View ↗
Additional runs (12) ✅ Succeeded ... View ↗

☁️ Nx Cloud last updated this comment at 2025-07-21 19:32:30 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
Copy link

codecov bot commented Jun 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.85%. Comparing base (6d8fae9) to head (bcf18dc).
Report is 1 commits behind head on main.

Current head bcf18dc differs from pull request most recent head 99343da

Please upload reports for the commit 99343da to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11267      +/-   ##
==========================================
- Coverage   90.86%   90.85%   -0.01%     
==========================================
  Files         503      502       -1     
  Lines       51046    51013      -33     
  Branches     8418     8405      -13     
==========================================
- Hits        46384    46350      -34     
  Misses       4648     4648              
- Partials       14       15       +1     
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%> (ø)

... and 14 files with indirect coverage changes

🚀 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 🙂

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

@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>
@ronami ronami requested a review from kirkwaiblinger July 21, 2025 19:32
@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Jul 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
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)
4 participants








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: https://github.com/typescript-eslint/typescript-eslint/pull/11267

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy