FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

stream: support AbortSignal in constructor by benjamingr · Pull Request #36431 · nodejs/node · GitHub

/ node Public

stream: support AbortSignal in constructor - #36431

Closed
benjamingr wants to merge 3 commits into
nodejs:masterfrom
benjamingr:abort-signal-stream-constructor
ConversationCommits (3)ChecksFiles changed
Closed

stream: support AbortSignal in constructor#36431
benjamingr wants to merge 3 commits into
nodejs:masterfrom
benjamingr:abort-signal-stream-constructor

Conversation

benjamingr commented Dec 7, 2020

Copy link
Copy Markdown
Member

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

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

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

ronag reviewed Dec 7, 2020
View reviewed changes
Comment thread lib/internal/streams/writable.js Outdated

benjamingr commented Dec 7, 2020

Copy link
Copy Markdown
Member Author

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 commented Dec 7, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

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 commented Dec 7, 2020

Copy link
Copy Markdown
Member Author

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 commented Dec 7, 2020

Copy link
Copy Markdown
Member

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 commented Dec 7, 2020

Copy link
Copy Markdown
Member Author

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 commented Dec 7, 2020

Copy link
Copy Markdown
Member Author

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 commented Dec 7, 2020

Copy link
Copy Markdown
Member

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

benjamingr commented Dec 7, 2020 •
edited
Loading

Copy link
Copy Markdown
Member Author

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

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
Comment thread lib/internal/streams/add-abort-signal.js Outdated
jasnell reviewed Dec 9, 2020
View reviewed changes
Comment thread test/parallel/test-stream-duplex-destroy.js
});
let count = 0;
duplex.on('error', common.mustCall((e) => {
assert.strictEqual(count++, 0); // Ensure not called twice

jasnell Dec 9, 2020

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

The mustCall already handles this doesn't it?

benjamingr Dec 9, 2020

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

mcollina approved these changes Dec 10, 2020
View reviewed changes

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

lgtm

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

nodejs-github-bot commented Dec 10, 2020

Copy link
Copy Markdown
Collaborator

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

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

nodejs-github-bot commented Dec 10, 2020

Copy link
Copy Markdown
Collaborator

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

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 commented Dec 10, 2020

Copy link
Copy Markdown
Member Author

Landed with NCU in 040a27a 🎉

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
Merged
targos added a commit that referenced this pull request Dec 22, 2020
2020-12-22, Version 15.5.0 (Current)
eb84150 
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
targos added a commit that referenced this pull request Dec 22, 2020
2020-12-22, Version 15.5.0 (Current)
f978628 
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
targos added a commit that referenced this pull request Dec 22, 2020
2020-12-22, Version 15.5.0 (Current)
80d2fbe 
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
Linkgoron mentioned this pull request Mar 12, 2021
Merged
mscdex mentioned this pull request Jul 10, 2021
Closed
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
Merged
nodejs-github-bot pushed a commit that referenced this pull request Mar 18, 2023
doc: clarify that fs.create{Read,Write}Stream support AbortSignal
f7e9a12 
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>
RafaelGSS pushed a commit that referenced this pull request Apr 5, 2023
doc: clarify that fs.create{Read,Write}Stream support AbortSignal
5938a52 
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>
RafaelGSS pushed a commit that referenced this pull request Apr 7, 2023
doc: clarify that fs.create{Read,Write}Stream support AbortSignal
c45a697 
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>
danielleadams pushed a commit that referenced this pull request Jul 6, 2023
doc: clarify that fs.create{Read,Write}Stream support AbortSignal
5fc2bb7 
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>
baby636 mentioned this pull request Nov 28, 2023
Open
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell left review comments
mcollina mcollina approved these changes
ronag ronag approved these changes

Assignees

No one assigned

Labels

semver-minor PRs that contain new features and should be released in the next minor version. stream Issues and PRs related to the stream subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Back | FazBrowse Home | New Git URL