stream: support AbortSignal in constructor #36431

benjamingr · 2020-12-07T16:44:17Z

As requested by @ronag (I agree it's useful especially when subclassing streams) - an API to pass AbortSignal directly to the readable/writeable constructor + tests.

It uses addAbortSignal internally to make maintenance easier.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

ronag

Won't it be added twice in case of duplex?

lib/internal/streams/writable.js

benjamingr · 2020-12-07T16:56:16Z

Won't it be added twice in case of duplex?

Maybe? Probably not because destroy already checks that stream is destroyed and does not call _destroy.

I'm happy to add a test for that if you think we should have one.
I'm also happy to make that flow and anything else you don't like in the PR more explicit if you think that improves code quality.

ronag · 2020-12-07T17:01:01Z

Maybe? Probably not because destroy already checks that stream is destroyed and does not call _destroy.

I'm not sure I follow. How is destroy related? This happens in the constructor which is invoked for both Readable and Writable.

benjamingr · 2020-12-07T17:03:25Z

I'm not sure I follow. How is destroy related? This happens in the constructor which is invoked for both Readable and Writable.

destroy would be called twice on the stream (since the signal has two listeners - one for the readable and one for the writeable).

ronag · 2020-12-07T17:15:26Z

destroy would be called twice on the stream (since the signal has two listeners - one for the readable and one for the writeable).

I was more thinking about addAbortSignal being called twice through constructor.

benjamingr · 2020-12-07T17:16:04Z

I was more thinking about addAbortSignal being called twice through constructor.

Yes, that's probably fine, the signal is added twice, destroys the stream twice and the second destroy is ignored.

benjamingr · 2020-12-07T17:18:27Z

I added a test for duplex that makes sure error is called exactly once and close is called to illustrate that point e71ae8f#diff-9772e10e4bd234c2a0d41c8043e02338add0b46578d4782ffc02bcb27cfbb85cR242-R256

ronag · 2020-12-07T17:19:51Z

Can't we just make use of isDuplex and add it once?

benjamingr · 2020-12-07T17:53:31Z

Can't we just make use of isDuplex and add it once?

We can, would you prefer that?

Edit: I think I prefer that too. Pushed a fix + the "ignore bad signal" logic for the construct version

lib/internal/streams/add-abort-signal.js

jasnell · 2020-12-09T22:08:34Z

test/parallel/test-stream-duplex-destroy.js

+  });
+  let count = 0;
+  duplex.on('error', common.mustCall((e) => {
+    assert.strictEqual(count++, 0); // Ensure not called twice


The mustCall already handles this doesn't it?

@jasnell I want to make sure error is called, but not called twice - I'd need a comon.mustCallOnce or something.

mcollina

lgtm

nodejs-github-bot · 2020-12-10T11:31:56Z

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

nodejs-github-bot · 2020-12-10T18:54:33Z

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

PR-URL: #36431 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

benjamingr · 2020-12-10T21:42:03Z

Landed with NCU in 040a27a 🎉

PR-URL: #36431 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

Notable changes: child_process: * (SEMVER-MINOR) add signal support to spawn (Benjamin Gruenbaum) #36432 doc: * add PoojaDurgad to collaborators (Pooja D P) #36511 lib: * (SEMVER-MINOR) support BigInt in querystring.stringify (raisinten) #36499 src: * (SEMVER-MINOR) add way to get IsolateData and allocator from Environment (Anna Henningsen) #36441 * (SEMVER-MINOR) allow preventing SetPrepareStackTraceCallback (Shelley Vohr) #36447 stream: * (SEMVER-MINOR) support abortsignal in constructor (Benjamin Gruenbaum) #36431 PR-URL: #36597

Refs: nodejs#36431

Refs: #36431 PR-URL: #47122 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Debadree Chatterjee <debadree333@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

benjamingr requested a review from ronag December 7, 2020 16:44

benjamingr added the stream Issues and PRs related to the stream subsystem. label Dec 7, 2020

benjamingr requested a review from mcollina December 7, 2020 16:44

ronag reviewed Dec 7, 2020

View reviewed changes

lib/internal/streams/writable.js Show resolved Hide resolved

stream: support abortsignal in constructor

03ff368

benjamingr force-pushed the abort-signal-stream-constructor branch from 4579e20 to 03ff368 Compare December 7, 2020 18:29

ronag reviewed Dec 7, 2020

View reviewed changes

lib/internal/streams/add-abort-signal.js Show resolved Hide resolved

fixup! default behaviour

1b3e4d1

ronag reviewed Dec 7, 2020

View reviewed changes

lib/internal/streams/add-abort-signal.js Outdated Show resolved Hide resolved

fixup! code review

47bd0e7

jasnell reviewed Dec 9, 2020

View reviewed changes

ronag approved these changes Dec 9, 2020

View reviewed changes

mcollina approved these changes Dec 10, 2020

View reviewed changes

benjamingr added the request-ci Add this label to start a Jenkins CI on a PR. label Dec 10, 2020

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Dec 10, 2020

benjamingr added the semver-minor PRs that contain new features and should be released in the next minor version. label Dec 10, 2020

benjamingr added a commit that referenced this pull request Dec 10, 2020

stream: support abortsignal in constructor

040a27a

PR-URL: #36431 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

benjamingr closed this Dec 10, 2020

benjamingr deleted the abort-signal-stream-constructor branch December 10, 2020 21:42

targos pushed a commit that referenced this pull request Dec 21, 2020

stream: support abortsignal in constructor

6ecbc1d

PR-URL: #36431 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

targos mentioned this pull request Dec 22, 2020

v15.5.0 release proposal #36597

Merged

Linkgoron mentioned this pull request Mar 12, 2021

http: fix double AbortSignal registration #37730

Merged

mscdex mentioned this pull request Jul 10, 2021

stream: validate abort signal #39346

Closed

targos added dont-land-on-v12.x labels Aug 8, 2021

aduh95 added a commit to aduh95/node that referenced this pull request Mar 16, 2023

doc: clarify that fs.create{Read,Write}Stream support AbortSignal

29961f1

Refs: nodejs#36431

aduh95 mentioned this pull request Mar 16, 2023

doc: clarify that fs.create{Read,Write}Stream support AbortSignal #47122

Merged

baby636 mentioned this pull request Nov 28, 2023

[Snyk] Fix for 37 vulnerabilities baby636/node#110

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

stream: support AbortSignal in constructor #36431

stream: support AbortSignal in constructor #36431

benjamingr commented Dec 7, 2020

ronag left a comment

benjamingr commented Dec 7, 2020

ronag commented Dec 7, 2020 •

edited

Loading

benjamingr commented Dec 7, 2020

ronag commented Dec 7, 2020

benjamingr commented Dec 7, 2020

benjamingr commented Dec 7, 2020

ronag commented Dec 7, 2020

benjamingr commented Dec 7, 2020 •

edited

Loading

jasnell Dec 9, 2020

benjamingr Dec 9, 2020

mcollina left a comment

nodejs-github-bot commented Dec 10, 2020

nodejs-github-bot commented Dec 10, 2020

benjamingr commented Dec 10, 2020

stream: support AbortSignal in constructor #36431

stream: support AbortSignal in constructor #36431

Conversation

benjamingr commented Dec 7, 2020

Checklist

ronag left a comment

Choose a reason for hiding this comment

benjamingr commented Dec 7, 2020

ronag commented Dec 7, 2020 • edited Loading

benjamingr commented Dec 7, 2020

ronag commented Dec 7, 2020

benjamingr commented Dec 7, 2020

benjamingr commented Dec 7, 2020

ronag commented Dec 7, 2020

benjamingr commented Dec 7, 2020 • edited Loading

jasnell Dec 9, 2020

Choose a reason for hiding this comment

benjamingr Dec 9, 2020

Choose a reason for hiding this comment

mcollina left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented Dec 10, 2020

nodejs-github-bot commented Dec 10, 2020

benjamingr commented Dec 10, 2020

ronag commented Dec 7, 2020 •

edited

Loading

benjamingr commented Dec 7, 2020 •

edited

Loading