Skip to content

stream: add auto-destroy mode #22795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mafintosh wants to merge 7 commits into from
Closed

stream: add auto-destroy mode #22795

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ccc94a9
stream: add auto-destroy mode
mafintosh Aug 21, 2018
38077e6
inline duplex autodestroy logic
mafintosh Oct 26, 2018
294e10c
move errorOrDestroy to destroyImpl
mafintosh Oct 26, 2018
a6eb82e
test ordering of events
mafintosh Oct 26, 2018
c40028a
fix docs
mafintosh Oct 29, 2018
7eb4e64
add to changes: section
mafintosh Oct 29, 2018
713a808
TDB -> REPLACEME
mafintosh Oct 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
move errorOrDestroy to destroyImpl
  • Loading branch information
@mafintosh
mafintosh committed Oct 26, 2018
commit 294e10c0a6594423d11bcd5efb7b30286644607d
19 changes: 2 additions & 17 deletions lib/_stream_readable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ let createReadableStreamAsyncIterator;

util.inherits(Readable, Stream);

const { errorOrDestroy } = destroyImpl;
const kProxyEvents = ['error', 'close', 'destroy', 'pause', 'resume'];

function prependListener(emitter, event, fn) {
Expand Down Expand Up @@ -1087,22 +1088,6 @@ function endReadable(stream) {
}
}

function errorOrDestroy(stream, err) {
// We have tests that rely on errors being emitted
// in the same tick, so changing this is semver major.
// For now when you opt-in to autoDestroy we allow
// the error to be emitted nextTick. In a future
// semver major update we should change the default to this.

const rState = stream._readableState;
const wState = stream._writableState;

if ((rState && rState.autoDestroy) || (wState && wState.autoDestroy))
stream.destroy(err);
else
stream.emit('error', err);
}

function endReadableNT(state, stream) {
debug('endReadableNT', state.endEmitted, state.length);

Expand All @@ -1112,7 +1097,7 @@ function endReadableNT(state, stream) {
stream.readable = false;
stream.emit('end');

if (state.autoDestroy && writableAutoDestroy(stream._writableState)) {
if (state.autoDestroy) {
// In case of duplex streams we need a way to detect
// if the writable side is ready for autoDestroy as well
const wState = stream._writableState;
Expand Down
18 changes: 2 additions & 16 deletions lib/_stream_writable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ const {
ERR_UNKNOWN_ENCODING
} = require('internal/errors').codes;

const { errorOrDestroy } = destroyImpl;

util.inherits(Writable, Stream);

function nop() {}
Expand Down Expand Up @@ -635,22 +637,6 @@ function prefinish(stream, state) {
}
}

function errorOrDestroy(stream, err) {
// We have tests that rely on errors being emitted
// in the same tick, so changing this is semver major.
// For now when you opt-in to autoDestroy we allow
// the error to be emitted nextTick. In a future
// semver major update we should change the default to this.

const rState = stream._readableState;
const wState = stream._writableState;

if ((rState && rState.autoDestroy) || (wState && wState.autoDestroy))
stream.destroy(err);
else
stream.emit('error', err);
}

function finishMaybe(stream, state) {
var need = needFinish(state);
if (need) {
Expand Down
20 changes: 19 additions & 1 deletion lib/internal/streams/destroy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,25 @@ function emitErrorNT(self, err) {
self.emit('error', err);
}

function errorOrDestroy(stream, err) {
// We have tests that rely on errors being emitted
// in the same tick, so changing this is semver major.
// For now when you opt-in to autoDestroy we allow
// the error to be emitted nextTick. In a future
// semver major update we should change the default to this.

const rState = stream._readableState;
const wState = stream._writableState;

if ((rState && rState.autoDestroy) || (wState && wState.autoDestroy))
stream.destroy(err);
else
stream.emit('error', err);
}


module.exports = {
destroy,
undestroy
undestroy,
errorOrDestroy
};