Skip to content

[x] stream: eos avoid listeners when possible #28751

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
wants to merge 4 commits into from
Closed

[x] stream: eos avoid listeners when possible #28751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
feaa7a3
stream: eos avoid listeners when not legacy compat
ronag Jul 18, 2019
07a93a0
stream: conditionally create legacy handlers
ronag Jul 30, 2019
d213f7a
stream: prefer let over var
ronag Jul 30, 2019
edb7e47
stream: conditionally create error handler
ronag Jul 30, 2019
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
103 changes: 61 additions & 42 deletions lib/internal/streams/end-of-stream.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ const {
} = require('internal/errors').codes;
const { once } = require('internal/util');

function isRequest(stream) {
return stream.setHeader && typeof stream.abort === 'function';
}

function eos(stream, opts, callback) {
if (arguments.length === 2) {
callback = opts;
Expand All @@ -31,28 +27,33 @@ function eos(stream, opts, callback) {
let readable = opts.readable || (opts.readable !== false && stream.readable);
let writable = opts.writable || (opts.writable !== false && stream.writable);

const onlegacyfinish = () => {
if (!stream.writable) onfinish();
};

var writableEnded = stream._writableState && stream._writableState.finished;
const onfinish = () => {
writable = false;
writableEnded = true;
if (!readable) callback.call(stream);
};
const isLegacyRequest = typeof stream.writableFinished !== 'boolean' &&
stream.setHeader && typeof stream.abort === 'function';
const isLegacyWritable = typeof stream.writableFinished !== 'boolean' &&
writable && !stream._writableState;

let writableEnded = stream._writableState && stream._writableState.finished;
let onfinish;
if (writable || isLegacyRequest || isLegacyWritable) {
onfinish = () => {
writable = false;
writableEnded = true;
if (!readable) callback.call(stream);
};
stream.on('finish', onfinish);
}

var readableEnded = stream.readableEnded ||
let readableEnded = stream.readableEnded ||
(stream._readableState && stream._readableState.endEmitted);
const onend = () => {
readable = false;
readableEnded = true;
if (!writable) callback.call(stream);
};

const onerror = (err) => {
callback.call(stream, err);
};
let onend;
if (readable) {
onend = () => {
readable = false;
readableEnded = true;
if (!writable) callback.call(stream);
};
stream.on('end', onend);
}

const onclose = () => {
let err;
Expand All @@ -67,36 +68,54 @@ function eos(stream, opts, callback) {
return callback.call(stream, err);
}
};
stream.on('close', onclose);

const onrequest = () => {
stream.req.on('finish', onfinish);
};
let onrequest;
let onlegacyfinish;

if (isRequest(stream)) {
if (isLegacyRequest) {
onrequest = () => {
stream.req.on('finish', onfinish);
};
stream.on('complete', onfinish);
stream.on('abort', onclose);
if (stream.req) onrequest();
else stream.on('request', onrequest);
} else if (writable && !stream._writableState) { // legacy streams
} else if (isLegacyWritable) {
onlegacyfinish = () => {
if (!stream.writable) onfinish();
};
stream.on('end', onlegacyfinish);
stream.on('close', onlegacyfinish);
}

stream.on('end', onend);
stream.on('finish', onfinish);
if (opts.error !== false) stream.on('error', onerror);
stream.on('close', onclose);
let onerror;
if (opts.error !== false) {
onerror = (err) => {
callback.call(stream, err);
};
stream.on('error', onerror);
}

return function() {
stream.removeListener('complete', onfinish);
stream.removeListener('abort', onclose);
stream.removeListener('request', onrequest);
if (stream.req) stream.req.removeListener('finish', onfinish);
stream.removeListener('end', onlegacyfinish);
stream.removeListener('close', onlegacyfinish);
stream.removeListener('finish', onfinish);
stream.removeListener('end', onend);
stream.removeListener('error', onerror);
if (onrequest) {
stream.removeListener('complete', onfinish);
stream.removeListener('abort', onclose);
stream.removeListener('request', onrequest);
if (stream.req) stream.req.removeListener('finish', onfinish);
} else if (onlegacyfinish) {
stream.removeListener('end', onlegacyfinish);
stream.removeListener('close', onlegacyfinish);
}
if (onerror) {
stream.removeListener('error', onerror);
}
if (onfinish) {
stream.removeListener('finish', onfinish);
}
if (onend) {
stream.removeListener('end', onend);
}
stream.removeListener('close', onclose);
};
}
Expand Down
77 changes: 75 additions & 2 deletions test/parallel/test-stream-finished.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,15 @@ const { promisify } = require('util');
rs.resume();
}

{
const streamLike = new EE();
streamLike.readableEnded = true;
streamLike.readable = true;
finished(streamLike, common.mustCall);
checkListeners(streamLike, 'legacy');
streamLike.emit('close');
}

// Test that calling returned function removes listeners
{
const ws = new Writable({
Expand All @@ -163,24 +172,88 @@ const { promisify } = require('util');
}
});
const removeListener = finished(ws, common.mustNotCall());
checkListeners(ws);
removeListener();
checkListeners(ws, 'none');
ws.end();
}

{
const rs = new Readable();
const removeListeners = finished(rs, common.mustNotCall());
checkListeners(rs);
removeListeners();
checkListeners(rs, 'none');

rs.emit('close');
rs.push(null);
rs.resume();
}

{
const req = Object.assign(new EE(), {
setHeader() {},
abort() {}
});
const removeListeners = finished(req, common.mustNotCall());
checkListeners(req, 'legacyrequest');
removeListeners();
checkListeners(req, 'none');
}

{
const streamLike = new EE();
streamLike.readableEnded = true;
streamLike.readable = true;
finished(streamLike, common.mustCall);
streamLike.emit('close');
const removeListeners = finished(streamLike, common.mustCall);
checkListeners(streamLike);
removeListeners();
checkListeners(streamLike, 'none');
}

{
const streamLike = new EE();
streamLike.readableEnded = true;
streamLike.writable = true;
const removeListeners = finished(streamLike, common.mustCall);
checkListeners(streamLike, 'legacywritable');
removeListeners();
checkListeners(streamLike, 'none');
}

function checkListeners(stream, type) {
if (type === 'legacyrequest') {
assert.strictEqual(stream.listenerCount('complete'), 1);
assert.strictEqual(stream.listenerCount('abort'), 1);
assert.strictEqual(stream.listenerCount('request'), 1);
assert.strictEqual(stream.listenerCount('close'), 1);
assert.strictEqual(stream.listenerCount('finish'), 1);
assert.strictEqual(stream.listenerCount('end'), 0);
assert.strictEqual(stream.listenerCount('request'), 1);
} else if (type === 'legacywritable') {
assert.strictEqual(stream.listenerCount('complete'), 0);
assert.strictEqual(stream.listenerCount('abort'), 0);
assert.strictEqual(stream.listenerCount('request'), 0);
assert.strictEqual(stream.listenerCount('close'), 2);
assert.strictEqual(stream.listenerCount('finish'), 1);
assert.strictEqual(stream.listenerCount('end'), 1);
} else if (type === 'none') {
assert.strictEqual(stream.listenerCount('complete'), 0);
assert.strictEqual(stream.listenerCount('abort'), 0);
assert.strictEqual(stream.listenerCount('request'), 0);
assert.strictEqual(stream.listenerCount('close'), 0);
assert.strictEqual(stream.listenerCount('end'), 0);
assert.strictEqual(stream.listenerCount('finish'), 0);
} else {
assert.strictEqual(stream.listenerCount('complete'), 0);
assert.strictEqual(stream.listenerCount('abort'), 0);
assert.strictEqual(stream.listenerCount('request'), 0);
assert.strictEqual(stream.listenerCount('close'), 1);
if (stream.writable) {
assert.strictEqual(stream.listenerCount('finish'), 1);
}
if (stream.readable) {
assert.strictEqual(stream.listenerCount('end'), 1);
}
}
}