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

stream: add auto-destroy mode by mafintosh · Pull Request #22795 · nodejs/node · GitHub

/ node Public

stream: add auto-destroy mode - #22795

Closed
mafintosh wants to merge 7 commits into
nodejs:masterfrom
mafintosh:auto-destroy-stream
ConversationCommits (7)ChecksFiles changed
Closed

stream: add auto-destroy mode#22795
mafintosh wants to merge 7 commits into
nodejs:masterfrom
mafintosh:auto-destroy-stream

Conversation

mafintosh commented Sep 10, 2018

Copy link
Copy Markdown
Member
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

This adds a new options to the stream constructor called autoDestroy that is default false.
When autoDestroy is enabled .destroy() will automatically be called when the stream has ended and/or finished depending on whether it's a readable/writable/duplex.

This simplifies error handling / resource management for users as you can then always do your teardown logic in the destroy method.

nodejs-github-bot commented Sep 10, 2018

Copy link
Copy Markdown
Collaborator

@mafintosh build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/852/pipeline

nodejs-github-bot added dont-land-on-v6.x http2 Issues or PRs related to the http2 subsystem. stream Issues and PRs related to the stream subsystem. labels Sep 10, 2018
mcollina added semver-minor PRs that contain new features and should be released in the next minor version. dont-land-on-v8.x labels Sep 10, 2018

mcollina commented Sep 10, 2018

Copy link
Copy Markdown
Member

@mafintosh I think it needs to call .destroy(err) whenever there is a emit('error'), at least in the streams classes and the option is enabled.

I think this is the first step to implement #20096, right?

vsemozhetbyt reviewed Sep 10, 2018
View reviewed changes
Comment thread doc/api/stream.md Outdated

vsemozhetbyt Sep 10, 2018

Copy link
Copy Markdown
Contributor

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

.destroy() -> `.destroy()`?

addaleax Sep 11, 2018

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

Can you provide the default value explicitly here?

vsemozhetbyt reviewed Sep 10, 2018
View reviewed changes
Comment thread doc/api/stream.md Outdated

vsemozhetbyt Sep 10, 2018

Copy link
Copy Markdown
Contributor

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

Ditto.

mscdex reviewed Sep 10, 2018
View reviewed changes
Comment thread lib/_stream_readable.js Outdated

mscdex Sep 10, 2018

Copy link
Copy Markdown
Contributor

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

Can't this just be inlined?

targos commented Sep 10, 2018 •
edited
Loading

Copy link
Copy Markdown
Member

It looks like the code in _stream_readable.js should be in _stream_writable.js and vice versa.

addaleax reviewed Sep 11, 2018
View reviewed changes
Comment thread doc/api/stream.md Outdated

addaleax Sep 11, 2018

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

Can you provide the default value explicitly here?

Comment thread test/parallel/test-stream-auto-destroy.js Outdated

addaleax Sep 11, 2018

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

Can we maybe check the order of the events/destroy callback as well?

addaleax commented Sep 14, 2018

Copy link
Copy Markdown
Member

Gentle ping @mafintosh :)

@targos I think it’s this way around in order to support shutting down Duplex streams?

mafintosh commented Sep 17, 2018

Copy link
Copy Markdown
Member Author

@addaleax i'll fix up the nits+comments

Fishrock123 commented Sep 17, 2018

Copy link
Copy Markdown
Contributor

Seems like a good addition to me, minus others' comments.

tniessen commented Sep 19, 2018

Copy link
Copy Markdown
Member

semver-minor commits should contain metadata in the YAML changes section of the affected API.

addaleax reviewed Sep 22, 2018
View reviewed changes
Comment thread lib/internal/http2/compat.js Outdated

addaleax Sep 22, 2018

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

Just to make sure I’m not missing anything – how does this change relate to the others?

mcollina mentioned this pull request Oct 5, 2018
Closed
mafintosh force-pushed the auto-destroy-stream branch 2 times, most recently from bb2cb3c to 387516c Compare October 26, 2018 14:08
mafintosh force-pushed the auto-destroy-stream branch from 387516c to ccc94a9 Compare October 26, 2018 14:13
mcollina approved these changes Oct 26, 2018
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

mafintosh commented Oct 29, 2018

Copy link
Copy Markdown
Member Author

Fixed all the nits @addaleax @targos @vsemozhetbyt @Fishrock123

mafintosh commented Oct 29, 2018

Copy link
Copy Markdown
Member Author

CI: https://ci.nodejs.org/view/Node.js/job/node-test-pull-request/18202/

mcollina approved these changes Oct 29, 2018
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 but I would like to see a CITGM run.

Comment thread doc/api/stream.md Outdated
pr-url: https://github.com/nodejs/node/pull/18438
description: >
Add `emitClose` option to specify if `'close'` is emitted on destroy
- version: TBD

mcollina Oct 29, 2018

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

is the value we put here TBD? I never remember.

addaleax Oct 29, 2018

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

REPLACEME :)

mafintosh Oct 29, 2018

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

Ah right! Thanks, will fix

mafintosh commented Oct 29, 2018

Copy link
Copy Markdown
Member Author

CITGM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/1604/
CITGM master: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/1603/

mcollina mentioned this pull request Oct 30, 2018
Closed

mafintosh commented Oct 30, 2018

Copy link
Copy Markdown
Member Author

One more CITGM with readable-stream enabled

master: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/1606/
pr: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/1607/

mafintosh commented Oct 30, 2018

Copy link
Copy Markdown
Member Author

The CITGM runs seem to report similar errors on master + this PR, landing ...

Trott pushed a commit to Trott/io.js that referenced this pull request Oct 30, 2018
stream: add auto-destroy mode
f24b070 
PR-URL: nodejs#22795
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>

mafintosh commented Oct 30, 2018

Copy link
Copy Markdown
Member Author

Landed in f24b070

mafintosh closed this Oct 30, 2018
mafintosh deleted the auto-destroy-stream branch October 30, 2018 14:19
targos pushed a commit that referenced this pull request Nov 2, 2018
stream: add auto-destroy mode
d6bcf8b 
PR-URL: #22795
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
watilde mentioned this pull request Nov 6, 2018
Closed
3 tasks
BridgeAR mentioned this pull request Nov 14, 2018
Merged
This was referenced Nov 15, 2018
Closed
Closed
Closed
Closed
Closed
Closed
BethGriggs pushed a commit that referenced this pull request Apr 8, 2019
stream: add auto-destroy mode
a1b253a 
PR-URL: #22795
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
BethGriggs mentioned this pull request May 1, 2019
Merged
This was referenced May 29, 2019
Closed
Closed
Closed
Closed
Closed
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

mcollina mcollina approved these changes
jasnell jasnell approved these changes
addaleax addaleax approved these changes
+3 more reviewers
mscdex mscdex left review comments
vsemozhetbyt vsemozhetbyt left review comments
Fishrock123 Fishrock123 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

http2 Issues or PRs related to the http2 subsystem. 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.

10 participants

Back | FazBrowse Home | New Git URL