stream: settle pending stream iter reads on return#63521
Open
trivikr wants to merge 1 commit into
Open
Conversation
Resolve pending next() calls when stream/iter push and broadcast consumers are returned, so the promises do not remain pending after iterator cleanup. Fixes: nodejs#63519 Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com> Assisted-by: openai:gpt-5.5
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 #63521 +/- ##
=======================================
Coverage 90.13% 90.13%
=======================================
Files 718 718
Lines 228399 228408 +9
Branches 42931 42939 +8
=======================================
+ Hits 205860 205872 +12
+ Misses 14283 14278 -5
- Partials 8256 8258 +2
🚀 New features to boost your workflow:
|
jasnell
reviewed
May 23, 2026
| #resolvePendingReadsDone() { | ||
| while (this.#pendingReads.length > 0) { | ||
| this.#pendingReads.shift().resolve( | ||
| { __proto__: null, value: undefined, done: true }); |
Member
There was a problem hiding this comment.
Suggested change
| { __proto__: null, value: undefined, done: true }); | |
| { __proto__: null, done: true, value: undefined }); |
Super minor nit... just keeping the shape the same.
Member
Author
There was a problem hiding this comment.
The value comes before done in rest of push.js.
And done comes before value in rest of broadcast.js.
I'll make the change in a separate PR after this one is merged. It can happen in parallel.
Member
Author
There was a problem hiding this comment.
Do you have a specific preference for the order?
In lib/**/*.js source files, excluding tests, docs, and deps:
donebeforevalue: 30valuebeforedone: 20
In Iteration protocols for MDN, done appears before value.
Member
Author
There was a problem hiding this comment.
I submitted a PR to enforce done before value in iterator result object in #63526
jasnell
approved these changes
May 23, 2026
github-actions
Bot
removed
the
request-ci
Collaborator
trivikr
added
author ready
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
3 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 updates
stream/itercleanup so pendingnext()calls are settled whena consumer calls
return().Previously,
push()andbroadcast()could leave a pendingnext()promiseunresolved if
return()was called before any chunk was written. The cleanuppaths now resolve those pending reads with
{ done: true, value: undefined }.Regression coverage was added for both
push()andbroadcast().Fixes: #63519
Assisted-by: openai:gpt-5.5