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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

feat(eslint-plugin): [await-thenable] report invalid (non-promise) values passed to promise aggregator methods #11267

wants to merge 2 commits into from
+397 −0

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 Netlify
Copy link

netlify bot commented Jun 1, 2025 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 20ff75d
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/683cc9925440b20008258e5f
😎 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 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 98 (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 Nx Cloud
Copy link

nx-cloud bot commented Jun 1, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 20ff75d.

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

☁️ Nx Cloud last updated this comment at 2025-06-01 21:53:22 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 Codecov
Copy link

codecov bot commented Jun 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.92%. Comparing base (e493317) to head (20ff75d).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #11267      +/-   ##
==========================================
+ Coverage   90.91%   90.92%   +0.01%     
==========================================
  Files         501      502       +1     
  Lines       50869    50945      +76     
  Branches     8382     8399      +17     
==========================================
+ Hits        46248    46324      +76     
  Misses       4606     4606              
  Partials       15       15
Flag Coverage Δ
unittest 90.92% <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.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
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)
2 participants
@ronami @libre-man
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