tools: add lint rule for aborted AbortController#63541
Open
trivikr wants to merge 1 commit into
Open
Conversation
Collaborator
|
Review requested:
|
nodejs-github-bot
added
needs-ci
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #63541 +/- ##
==========================================
+ Coverage 90.26% 90.33% +0.06%
==========================================
Files 730 730
Lines 234004 234161 +157
Branches 43829 43909 +80
==========================================
+ Hits 211223 211519 +296
+ Misses 14502 14385 -117
+ Partials 8279 8257 -22 🚀 New features to boost your workflow:
|
Refs: nodejs#63489 Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com> Assisted-by: openai:gpt-5.5
trivikr
force-pushed
the
eslint-abort-signal-abort
branch
from
55470dd to
2cd59c6
Compare
metcoder95
approved these changes
May 25, 2026
aduh95
reviewed
May 25, 2026
Comment on lines
+164
to
+165
| const signal = AbortSignal.abort('reason'); | ||
| assert.strictEqual(signal.reason, 'reason'); |
Contributor
There was a problem hiding this comment.
This is testing AbortController (see the file name), not AbortSignal; it should be reverted and excluded via a // eslint-disable-next-line comment
Comment on lines
+18
to
+23
| ` | ||
| const controller = new AbortController(); | ||
| controller.abort(); | ||
| controller.abort(); | ||
| fn(controller.signal); | ||
| `, |
Contributor
There was a problem hiding this comment.
For readability sake, let's indent
Suggested change
| ` | |
| const controller = new AbortController(); | |
| controller.abort(); | |
| controller.abort(); | |
| fn(controller.signal); | |
| `, | |
| ` | |
| const controller = new AbortController(); | |
| controller.abort(); | |
| controller.abort(); | |
| fn(controller.signal); | |
| `, |
Comment on lines
+25
to
+27
| const controller = new AbortController(); | ||
| controller.abort(); | ||
| fn(controller.signal, controller.signal); |
Contributor
There was a problem hiding this comment.
ditto, and why is this a valid case?
Comment on lines
+121
to
+122
| if (references.length !== 2 || | ||
| signalReferences.length !== 1 || |
Contributor
There was a problem hiding this comment.
Suggested change
| if (references.length !== 2 || | |
| signalReferences.length !== 1 || | |
| if (references.length !== (1 + signalReferences.length) || |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds an ESLint rule to prefer
AbortSignal.abort()when a test creates anAbortController, immediately aborts it, and only uses the resultingcontroller.signal.The rule is intentionally conservative and only fixes the simple already-aborted
signal pattern from #63489.
The rule uses ESLint scope analysis rather than text matching. After finding a
candidate declaration, it gets the declared variable with
sourceCode.scopeManager.getDeclaredVariables()and checks all references tothat variable.
It only reports when the variable has exactly two non-declaration references:
controller.abort()callcontroller.signalreadIf the controller is logged, passed somewhere else, aborted later, read more than
once, or otherwise referenced, the rule does not report or autofix it.
Assisted-by: openai:gpt-5.5