Skip to content

stream: fix async iterator return when destroyed earlier - #31508

Closed
mcollina wants to merge 2 commits into
nodejs:masterfrom
mcollina:fix-no-return-destroyed
Closed

stream: fix async iterator return when destroyed earlier#31508
mcollina wants to merge 2 commits into
nodejs:masterfrom
mcollina:fix-no-return-destroyed

Conversation

@mcollina

@mcollinamcollina commented Jan 25, 2020

Copy link
Copy Markdown
Member

Unfortunately, #31314 introduced a regression that made the loop not terminate:

'use strict'const{ Readable }=require('stream')constr=newReadable({read(){}})r.destroy()asyncfunctionrun(){forawait(letchunkofr){}}r.on('close',()=>{console.log('close emitted')run().then(()=>console.log('finished'))})

I see that as more critical as an error not being forwarded. See #31314 (comment) for more details.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • commit message follows commit guidelines

@mcollinamcollina changed the title Fix no return destroyedstream: fix async iterator return when destroyed earlierJan 25, 2020
@mcollina

mcollina commented Jan 25, 2020

Copy link
Copy Markdown
MemberAuthor

(I've discovered this because one of my modules broke because of this change)

@nodejs-github-bot

nodejs-github-bot commented Jan 25, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/28638/

@mcollina
stream: add regression test for async iteration completion
638ba66
A test was missing for an async iterator created after the stream
had emitted 'close'. This was regressed by nodejs#31314.
See: nodejs#31314
@mcollina
mcollinaforce-pushed the fix-no-return-destroyed branch from 34515ff to 638ba66CompareJanuary 25, 2020 11:20
@nodejs-github-bot

nodejs-github-bot commented Jan 25, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/28639/

ronag
ronag approved these changes Jan 25, 2020
View reviewed changes

@ronagronag left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

An alternative is to add a closeEmitted property and sort out ‘finished’. But that’s a bigger change and maybe semver-major.

@mcollina
mcollina requested a review from jasnellJanuary 25, 2020 12:46
@nodejs-github-bot

nodejs-github-bot commented Jan 25, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/28641/

@nodejs-github-bot

nodejs-github-bot commented Jan 25, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/28652/

@ronagronag mentioned this pull request Jan 25, 2020
Closed
4 tasks
@ronag

ronag commented Jan 26, 2020

Copy link
Copy Markdown
Member

Note, this might only be needed for 13.x if #31509 lands on master.

@Trott

Trott commented Jan 27, 2020

Copy link
Copy Markdown
Member

(I've discovered this because one of my modules broke because of this change)

Perhaps we should add it to CITGM?

@TrottTrott added stream Issues and PRs related to the stream subsystem. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Jan 27, 2020
@nodejs-github-bot

This comment has been minimized.

Sign in to view
@mcollina

mcollina commented Jan 27, 2020

Copy link
Copy Markdown
MemberAuthor

Perhaps we should add it to CITGM?

I don't think it adds much right now. I had it using the node core stream module because readable-stream had async iterators still experimental. As for the fix, I just switched to use readable-stream instead.

@nodejs-github-bot

This comment has been minimized.

Sign in to view
@nodejs-github-bot

This comment has been minimized.

Sign in to view
@nodejs-github-bot

This comment has been minimized.

Sign in to view
@briancbrianc mentioned this pull request Jan 28, 2020
Closed
@nodejs-github-bot

nodejs-github-bot commented Jan 29, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/28749/

@Trott

Trott commented Jan 29, 2020

Copy link
Copy Markdown
Member

Landed in 64161f2...24e81d7

@TrottTrott closed this Jan 29, 2020
Trott pushed a commit that referenced this pull request Jan 29, 2020
@mcollina@Trott
Revert "stream: fix async iterator destroyed error propagation"
2cd9892
This reverts commit d15b8ea.
PR-URL: #31508
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Trott pushed a commit that referenced this pull request Jan 29, 2020
@mcollina@Trott
stream: add regression test for async iteration completion
24e81d7
A test was missing for an async iterator created after the stream
had emitted 'close'. This was regressed by #31314.
See: #31314
PR-URL: #31508
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
ronag added a commit that referenced this pull request Feb 8, 2020
@ronag
stream: finished callback for closed streams
d016b9d
Previously finished(stream, cb) would not invoke the callback
for streams that have already finished, ended or errored
before being passed to finished(stream, cb).
PR-URL: #31509
Refs: #31508
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
codebytere pushed a commit that referenced this pull request Feb 17, 2020
@mcollina@codebytere
Revert "stream: fix async iterator destroyed error propagation"
538582b
This reverts commit d15b8ea.
PR-URL: #31508
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
codebytere pushed a commit that referenced this pull request Feb 17, 2020
@mcollina@codebytere
stream: add regression test for async iteration completion
80e75ab
A test was missing for an async iterator created after the stream
had emitted 'close'. This was regressed by #31314.
See: #31314
PR-URL: #31508
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@codebyterecodebytere mentioned this pull request Feb 17, 2020
Merged
targos pushed a commit that referenced this pull request Apr 18, 2020
@mcollina@targos
stream: add regression test for async iteration completion
d07dd31
A test was missing for an async iterator created after the stream
had emitted 'close'. This was regressed by #31314.
See: #31314
PR-URL: #31508
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@targostargos mentioned this pull request Apr 22, 2020
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@TrottTrottTrott approved these changes
@benjamingrbenjamingrbenjamingr approved these changes
@cjihrigcjihrigcjihrig approved these changes
@ronagronagronag approved these changes
+1 more reviewer
@apapirovskiapapirovskiapapirovski approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.streamIssues and PRs related to the stream subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@mcollina@nodejs-github-bot@ronag@Trott@apapirovski@jasnell@benjamingr@cjihrig@targos