stream: prevent pipeline() callback after sync throw#65165

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
pacocartones wants to merge 1 commit into from
+197 −148
Closed

stream: prevent pipeline() callback after sync throw #65165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
320 changes: 172 additions & 148 deletions lib/internal/streams/pipeline.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -217,6 +217,7 @@ function pipelineImpl(streams, callback, opts) {
const destroys = [];

let finishCount = 0;
let syncThrow = false;

function finish(err) {
finishImpl(err, --finishCount === 0);
Expand All@@ -227,6 +228,14 @@ function pipelineImpl(streams, callback, opts) {
}

function finishImpl(err, final) {
// If pipeline() threw synchronously while wiring the streams together,
// the caller already received the error. Any finish callbacks that fire
// afterwards (from stages already wired, which incremented finishCount)
// must not invoke the completion callback — doing so would report the
// same failure twice, once as an exception and once as a success.
if (syncThrow) {
return;
}
if (err && (!error || error.code === 'ERR_STREAM_PREMATURE_CLOSE' || error.name === 'AbortError')) {
error = err;
}
Expand All@@ -251,160 +260,175 @@ function pipelineImpl(streams, callback, opts) {
}

let ret;
for (let i = 0; i < streams.length; i++) {
const stream = streams[i];
const reading = i < streams.length - 1;
const writing = i > 0;
const next = i + 1 < streams.length ? streams[i + 1] : null;
const end = reading || opts?.end !== false;
const isLastStream = i === streams.length - 1;

if (isNodeStream(stream)) {
if (next !== null && (next?.closed || next?.destroyed)) {
throw new ERR_STREAM_UNABLE_TO_PIPE();
}

if (end) {
const { destroy, cleanup } = destroyer(stream, reading, writing);
destroys.push(destroy);

if (isReadable(stream) && isLastStream) {
lastStreamCleanup.push(cleanup);
}
}

// Catch stream errors that occur after pipe/pump has completed.
function onError(err) {
if (
err &&
err.name !== 'AbortError' &&
err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
) {
finishOnlyHandleError(err);
}
}
stream.on('error', onError);
if (isReadable(stream) && isLastStream) {
lastStreamCleanup.push(() => {
stream.removeListener('error', onError);
});
}
}

if (i === 0) {
if (typeof stream === 'function') {
ret = stream({ signal });
if (!isIterable(ret)) {
throw new ERR_INVALID_RETURN_VALUE(
'Iterable, AsyncIterable or Stream', 'source', ret);
try {
for (let i = 0; i < streams.length; i++) {
const stream = streams[i];
const reading = i < streams.length - 1;
const writing = i > 0;
const next = i + 1 < streams.length ? streams[i + 1] : null;
const end = reading || opts?.end !== false;
const isLastStream = i === streams.length - 1;

if (isNodeStream(stream)) {
if (next !== null && (next?.closed || next?.destroyed)) {
throw new ERR_STREAM_UNABLE_TO_PIPE();
}

if (end) {
const { destroy, cleanup } = destroyer(stream, reading, writing);
destroys.push(destroy);

if (isReadable(stream) && isLastStream) {
lastStreamCleanup.push(cleanup);
}
}

// Catch stream errors that occur after pipe/pump has completed.
function onError(err) {
if (
err &&
err.name !== 'AbortError' &&
err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
) {
finishOnlyHandleError(err);
}
}
stream.on('error', onError);
if (isReadable(stream) && isLastStream) {
lastStreamCleanup.push(() => {
stream.removeListener('error', onError);
});
}
}
} else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
ret = stream;
} else {
ret = Duplex.from(stream);
}
} else if (typeof stream === 'function') {
if (isTransformStream(ret)) {
ret = makeAsyncIterable(ret?.readable);
} else {
ret = makeAsyncIterable(ret);
}
ret = stream(ret, { signal });

if (reading) {
if (!isIterable(ret, true)) {
throw new ERR_INVALID_RETURN_VALUE(
'AsyncIterable', `transform[${i - 1}]`, ret);
}
} else {
PassThrough ??= require('internal/streams/passthrough');

// If the last argument to pipeline is not a stream
// we must create a proxy stream so that pipeline(...)
// always returns a stream which can be further
// composed through `.pipe(stream)`.

const pt = new PassThrough({
objectMode: true,
});

// Handle Promises/A+ spec, `then` could be a getter that throws on
// second use.
const then = ret?.then;
if (typeof then === 'function') {
finishCount++;
then.call(ret,
(val) => {
value = val;
if (val != null) {
pt.write(val);
}
if (end) {
pt.end();
}
process.nextTick(finish);
}, (err) => {
pt.destroy(err);
process.nextTick(finish, err);
},
);
} else if (isIterable(ret, true)) {
finishCount++;
pumpToNode(ret, pt, finish, { end });
} else if (isReadableStream(ret) || isTransformStream(ret)) {
const toRead = ret.readable || ret;
finishCount++;
pumpToNode(toRead, pt, finish, { end });
if (i === 0) {
if (typeof stream === 'function') {
ret = stream({ signal });
if (!isIterable(ret)) {
throw new ERR_INVALID_RETURN_VALUE(
'Iterable, AsyncIterable or Stream', 'source', ret);
}
} else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
ret = stream;
} else {
ret = Duplex.from(stream);
}
} else if (typeof stream === 'function') {
if (isTransformStream(ret)) {
ret = makeAsyncIterable(ret?.readable);
} else {
ret = makeAsyncIterable(ret);
}
ret = stream(ret, { signal });

if (reading) {
if (!isIterable(ret, true)) {
throw new ERR_INVALID_RETURN_VALUE(
'AsyncIterable', `transform[${i - 1}]`, ret);
}
} else {
PassThrough ??= require('internal/streams/passthrough');

// If the last argument to pipeline is not a stream
// we must create a proxy stream so that pipeline(...)
// always returns a stream which can be further
// composed through `.pipe(stream)`.

const pt = new PassThrough({
objectMode: true,
});

// Handle Promises/A+ spec, `then` could be a getter that throws on
// second use.
const then = ret?.then;
if (typeof then === 'function') {
finishCount++;
then.call(ret,
(val) => {
value = val;
if (val != null) {
pt.write(val);
}
if (end) {
pt.end();
}
process.nextTick(finish);
}, (err) => {
pt.destroy(err);
process.nextTick(finish, err);
},
);
} else if (isIterable(ret, true)) {
finishCount++;
pumpToNode(ret, pt, finish, { end });
} else if (isReadableStream(ret) || isTransformStream(ret)) {
const toRead = ret.readable || ret;
finishCount++;
pumpToNode(toRead, pt, finish, { end });
} else {
throw new ERR_INVALID_RETURN_VALUE(
'AsyncIterable or Promise', 'destination', ret);
}

ret = pt;

const { destroy, cleanup } = destroyer(ret, false, true);
destroys.push(destroy);
if (isLastStream) {
lastStreamCleanup.push(cleanup);
}
}
} else if (isNodeStream(stream)) {
if (isReadableNodeStream(ret)) {
finishCount += 2;
const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
if (isReadable(stream) && isLastStream) {
lastStreamCleanup.push(cleanup);
}
} else if (isTransformStream(ret) || isReadableStream(ret)) {
const toRead = ret.readable || ret;
finishCount++;
pumpToNode(toRead, stream, finish, { end });
} else if (isIterable(ret)) {
finishCount++;
pumpToNode(ret, stream, finish, { end });
} else {
throw new ERR_INVALID_ARG_TYPE(
'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
}
ret = stream;
} else if (isWebStream(stream)) {
if (isReadableNodeStream(ret)) {
finishCount++;
pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
} else if (isReadableStream(ret) || isIterable(ret)) {
finishCount++;
pumpToWeb(ret, stream, finish, { end });
} else if (isTransformStream(ret)) {
finishCount++;
pumpToWeb(ret.readable, stream, finish, { end });
} else {
throw new ERR_INVALID_ARG_TYPE(
'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
}
ret = stream;
} else {
throw new ERR_INVALID_RETURN_VALUE(
'AsyncIterable or Promise', 'destination', ret);
}

ret = pt;

const { destroy, cleanup } = destroyer(ret, false, true);
destroys.push(destroy);
if (isLastStream) {
lastStreamCleanup.push(cleanup);
}
}
} else if (isNodeStream(stream)) {
if (isReadableNodeStream(ret)) {
finishCount += 2;
const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
if (isReadable(stream) && isLastStream) {
lastStreamCleanup.push(cleanup);
ret = Duplex.from(stream);
}
} else if (isTransformStream(ret) || isReadableStream(ret)) {
const toRead = ret.readable || ret;
finishCount++;
pumpToNode(toRead, stream, finish, { end });
} else if (isIterable(ret)) {
finishCount++;
pumpToNode(ret, stream, finish, { end });
} else {
throw new ERR_INVALID_ARG_TYPE(
'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
}
ret = stream;
} else if (isWebStream(stream)) {
if (isReadableNodeStream(ret)) {
finishCount++;
pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
} else if (isReadableStream(ret) || isIterable(ret)) {
finishCount++;
pumpToWeb(ret, stream, finish, { end });
} else if (isTransformStream(ret)) {
finishCount++;
pumpToWeb(ret.readable, stream, finish, { end });
} else {
throw new ERR_INVALID_ARG_TYPE(
'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
}
ret = stream;
} else {
ret = Duplex.from(stream);
} catch (err) {
// A synchronous throw while wiring the streams (e.g. an invalid
// stream/function in the middle) leaves stages already wired alive:
// their finish callbacks would otherwise report success to the caller,
// who already received the exception. Destroy the wired stages, mark
// the sync throw so no finish callback can fire, and rethrow.
syncThrow = true;
while (destroys.length) {
destroys.shift()(err);
}
disposable?.[SymbolDispose]();
ac.abort();
throw err;
}

if (signal?.aborted || outerSignal?.aborted) {
Expand Down
25 changes: 25 additions & 0 deletions test/parallel/test-stream-pipeline.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1774,3 +1774,28 @@ tmpdir.refresh();
}),
);
}
{
// https://github.com/nodejs/node/issues/65127
// When pipeline() throws synchronously while wiring streams together,
// it must NOT also invoke the callback — and never with success.
// A node stream wired before the throwing stage increments finishCount,
// so a naive teardown would fire the callback with no error (double
// report: the caller already received the exception).
const r = Readable.from(['a']);
const t = new Transform({
transform(chunk, encoding, callback) {
callback(null, chunk);
},
});
let threw = false;
try {
pipeline(r, t, () => 42, common.mustNotCall());
} catch (err) {
threw = true;
assert.strictEqual(err.code, 'ERR_INVALID_RETURN_VALUE');
}
assert.strictEqual(threw, true);
// Give any stray finish callbacks a chance to fire; if the bug
// regresses, common.mustNotCall() fails the test.
setTimeout(() => {}, 100);
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
stream: prevent pipeline() callback after sync throw#65165

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

pacocartones
wants to merge
1
commit into

from


+197

−148

 Closed


stream: prevent pipeline() callback after sync throw
#65165
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


320 changes: 172 additions & 148 deletions
lib/internal/streams/pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,6 +217,7 @@ function pipelineImpl(streams, callback, opts) {
 const destroys = [];

 let finishCount = 0;
 let syncThrow = false;

 function finish(err) {
 finishImpl(err, --finishCount === 0);
Expand All@@ -227,6 +228,14 @@ function pipelineImpl(streams, callback, opts) {
 }

 function finishImpl(err, final) {
 // If pipeline() threw synchronously while wiring the streams together,
 // the caller already received the error. Any finish callbacks that fire
 // afterwards (from stages already wired, which incremented finishCount)
 // must not invoke the completion callback — doing so would report the
 // same failure twice, once as an exception and once as a success.
 if (syncThrow) {
 return;
 }
 if (err && (!error || error.code === 'ERR_STREAM_PREMATURE_CLOSE' || error.name === 'AbortError')) {
 error = err;
 }
Expand All@@ -251,160 +260,175 @@ function pipelineImpl(streams, callback, opts) {
 }

 let ret;
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }

 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 try {
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 ret = Duplex.from(stream);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 } catch (err) {
 // A synchronous throw while wiring the streams (e.g. an invalid
 // stream/function in the middle) leaves stages already wired alive:
 // their finish callbacks would otherwise report success to the caller,
 // who already received the exception. Destroy the wired stages, mark
 // the sync throw so no finish callback can fire, and rethrow.
 syncThrow = true;
 while (destroys.length) {
 destroys.shift()(err);
 }
 disposable?.[SymbolDispose]();
 ac.abort();
 throw err;
 }

 if (signal?.aborted || outerSignal?.aborted) {
Expand Down

25 changes: 25 additions & 0 deletions
test/parallel/test-stream-pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1774,3 +1774,28 @@ tmpdir.refresh();
 }),
 );
}
{
 // https://github.com/nodejs/node/issues/65127
 // When pipeline() throws synchronously while wiring streams together,
 // it must NOT also invoke the callback — and never with success.
 // A node stream wired before the throwing stage increments finishCount,
 // so a naive teardown would fire the callback with no error (double
 // report: the caller already received the exception).
 const r = Readable.from(['a']);
 const t = new Transform({
 transform(chunk, encoding, callback) {
 callback(null, chunk);
 },
 });
 let threw = false;
 try {
 pipeline(r, t, () => 42, common.mustNotCall());
 } catch (err) {
 threw = true;
 assert.strictEqual(err.code, 'ERR_INVALID_RETURN_VALUE');
 }
 assert.strictEqual(threw, true);
 // Give any stray finish callbacks a chance to fire; if the bug
 // regresses, common.mustNotCall() fails the test.
 setTimeout(() => {}, 100);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
stream: prevent pipeline() callback after sync throw#65165

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

pacocartones
wants to merge
1
commit into

from


+197

−148

 Closed


stream: prevent pipeline() callback after sync throw
#65165
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


320 changes: 172 additions & 148 deletions
lib/internal/streams/pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,6 +217,7 @@ function pipelineImpl(streams, callback, opts) {
 const destroys = [];

 let finishCount = 0;
 let syncThrow = false;

 function finish(err) {
 finishImpl(err, --finishCount === 0);
Expand All@@ -227,6 +228,14 @@ function pipelineImpl(streams, callback, opts) {
 }

 function finishImpl(err, final) {
 // If pipeline() threw synchronously while wiring the streams together,
 // the caller already received the error. Any finish callbacks that fire
 // afterwards (from stages already wired, which incremented finishCount)
 // must not invoke the completion callback — doing so would report the
 // same failure twice, once as an exception and once as a success.
 if (syncThrow) {
 return;
 }
 if (err && (!error || error.code === 'ERR_STREAM_PREMATURE_CLOSE' || error.name === 'AbortError')) {
 error = err;
 }
Expand All@@ -251,160 +260,175 @@ function pipelineImpl(streams, callback, opts) {
 }

 let ret;
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }

 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 try {
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 ret = Duplex.from(stream);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 } catch (err) {
 // A synchronous throw while wiring the streams (e.g. an invalid
 // stream/function in the middle) leaves stages already wired alive:
 // their finish callbacks would otherwise report success to the caller,
 // who already received the exception. Destroy the wired stages, mark
 // the sync throw so no finish callback can fire, and rethrow.
 syncThrow = true;
 while (destroys.length) {
 destroys.shift()(err);
 }
 disposable?.[SymbolDispose]();
 ac.abort();
 throw err;
 }

 if (signal?.aborted || outerSignal?.aborted) {
Expand Down

25 changes: 25 additions & 0 deletions
test/parallel/test-stream-pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1774,3 +1774,28 @@ tmpdir.refresh();
 }),
 );
}
{
 // https://github.com/nodejs/node/issues/65127
 // When pipeline() throws synchronously while wiring streams together,
 // it must NOT also invoke the callback — and never with success.
 // A node stream wired before the throwing stage increments finishCount,
 // so a naive teardown would fire the callback with no error (double
 // report: the caller already received the exception).
 const r = Readable.from(['a']);
 const t = new Transform({
 transform(chunk, encoding, callback) {
 callback(null, chunk);
 },
 });
 let threw = false;
 try {
 pipeline(r, t, () => 42, common.mustNotCall());
 } catch (err) {
 threw = true;
 assert.strictEqual(err.code, 'ERR_INVALID_RETURN_VALUE');
 }
 assert.strictEqual(threw, true);
 // Give any stray finish callbacks a chance to fire; if the bug
 // regresses, common.mustNotCall() fails the test.
 setTimeout(() => {}, 100);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
stream: prevent pipeline() callback after sync throw#65165

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

pacocartones
wants to merge
1
commit into

from


+197

−148

 Closed


stream: prevent pipeline() callback after sync throw
#65165
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


320 changes: 172 additions & 148 deletions
lib/internal/streams/pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,6 +217,7 @@ function pipelineImpl(streams, callback, opts) {
 const destroys = [];

 let finishCount = 0;
 let syncThrow = false;

 function finish(err) {
 finishImpl(err, --finishCount === 0);
Expand All@@ -227,6 +228,14 @@ function pipelineImpl(streams, callback, opts) {
 }

 function finishImpl(err, final) {
 // If pipeline() threw synchronously while wiring the streams together,
 // the caller already received the error. Any finish callbacks that fire
 // afterwards (from stages already wired, which incremented finishCount)
 // must not invoke the completion callback — doing so would report the
 // same failure twice, once as an exception and once as a success.
 if (syncThrow) {
 return;
 }
 if (err && (!error || error.code === 'ERR_STREAM_PREMATURE_CLOSE' || error.name === 'AbortError')) {
 error = err;
 }
Expand All@@ -251,160 +260,175 @@ function pipelineImpl(streams, callback, opts) {
 }

 let ret;
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }

 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 try {
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 ret = Duplex.from(stream);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 } catch (err) {
 // A synchronous throw while wiring the streams (e.g. an invalid
 // stream/function in the middle) leaves stages already wired alive:
 // their finish callbacks would otherwise report success to the caller,
 // who already received the exception. Destroy the wired stages, mark
 // the sync throw so no finish callback can fire, and rethrow.
 syncThrow = true;
 while (destroys.length) {
 destroys.shift()(err);
 }
 disposable?.[SymbolDispose]();
 ac.abort();
 throw err;
 }

 if (signal?.aborted || outerSignal?.aborted) {
Expand Down

25 changes: 25 additions & 0 deletions
test/parallel/test-stream-pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1774,3 +1774,28 @@ tmpdir.refresh();
 }),
 );
}
{
 // https://github.com/nodejs/node/issues/65127
 // When pipeline() throws synchronously while wiring streams together,
 // it must NOT also invoke the callback — and never with success.
 // A node stream wired before the throwing stage increments finishCount,
 // so a naive teardown would fire the callback with no error (double
 // report: the caller already received the exception).
 const r = Readable.from(['a']);
 const t = new Transform({
 transform(chunk, encoding, callback) {
 callback(null, chunk);
 },
 });
 let threw = false;
 try {
 pipeline(r, t, () => 42, common.mustNotCall());
 } catch (err) {
 threw = true;
 assert.strictEqual(err.code, 'ERR_INVALID_RETURN_VALUE');
 }
 assert.strictEqual(threw, true);
 // Give any stray finish callbacks a chance to fire; if the bug
 // regresses, common.mustNotCall() fails the test.
 setTimeout(() => {}, 100);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
stream: prevent pipeline() callback after sync throw#65165

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

pacocartones
wants to merge
1
commit into

from


+197

−148

 Closed


stream: prevent pipeline() callback after sync throw
#65165
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


320 changes: 172 additions & 148 deletions
lib/internal/streams/pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,6 +217,7 @@ function pipelineImpl(streams, callback, opts) {
 const destroys = [];

 let finishCount = 0;
 let syncThrow = false;

 function finish(err) {
 finishImpl(err, --finishCount === 0);
Expand All@@ -227,6 +228,14 @@ function pipelineImpl(streams, callback, opts) {
 }

 function finishImpl(err, final) {
 // If pipeline() threw synchronously while wiring the streams together,
 // the caller already received the error. Any finish callbacks that fire
 // afterwards (from stages already wired, which incremented finishCount)
 // must not invoke the completion callback — doing so would report the
 // same failure twice, once as an exception and once as a success.
 if (syncThrow) {
 return;
 }
 if (err && (!error || error.code === 'ERR_STREAM_PREMATURE_CLOSE' || error.name === 'AbortError')) {
 error = err;
 }
Expand All@@ -251,160 +260,175 @@ function pipelineImpl(streams, callback, opts) {
 }

 let ret;
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }

 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 try {
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 ret = Duplex.from(stream);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 } catch (err) {
 // A synchronous throw while wiring the streams (e.g. an invalid
 // stream/function in the middle) leaves stages already wired alive:
 // their finish callbacks would otherwise report success to the caller,
 // who already received the exception. Destroy the wired stages, mark
 // the sync throw so no finish callback can fire, and rethrow.
 syncThrow = true;
 while (destroys.length) {
 destroys.shift()(err);
 }
 disposable?.[SymbolDispose]();
 ac.abort();
 throw err;
 }

 if (signal?.aborted || outerSignal?.aborted) {
Expand Down

25 changes: 25 additions & 0 deletions
test/parallel/test-stream-pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1774,3 +1774,28 @@ tmpdir.refresh();
 }),
 );
}
{
 // https://github.com/nodejs/node/issues/65127
 // When pipeline() throws synchronously while wiring streams together,
 // it must NOT also invoke the callback — and never with success.
 // A node stream wired before the throwing stage increments finishCount,
 // so a naive teardown would fire the callback with no error (double
 // report: the caller already received the exception).
 const r = Readable.from(['a']);
 const t = new Transform({
 transform(chunk, encoding, callback) {
 callback(null, chunk);
 },
 });
 let threw = false;
 try {
 pipeline(r, t, () => 42, common.mustNotCall());
 } catch (err) {
 threw = true;
 assert.strictEqual(err.code, 'ERR_INVALID_RETURN_VALUE');
 }
 assert.strictEqual(threw, true);
 // Give any stray finish callbacks a chance to fire; if the bug
 // regresses, common.mustNotCall() fails the test.
 setTimeout(() => {}, 100);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
stream: prevent pipeline() callback after sync throw#65165

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

pacocartones
wants to merge
1
commit into

from


+197

−148

 Closed


stream: prevent pipeline() callback after sync throw
#65165
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


320 changes: 172 additions & 148 deletions
lib/internal/streams/pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,6 +217,7 @@ function pipelineImpl(streams, callback, opts) {
 const destroys = [];

 let finishCount = 0;
 let syncThrow = false;

 function finish(err) {
 finishImpl(err, --finishCount === 0);
Expand All@@ -227,6 +228,14 @@ function pipelineImpl(streams, callback, opts) {
 }

 function finishImpl(err, final) {
 // If pipeline() threw synchronously while wiring the streams together,
 // the caller already received the error. Any finish callbacks that fire
 // afterwards (from stages already wired, which incremented finishCount)
 // must not invoke the completion callback — doing so would report the
 // same failure twice, once as an exception and once as a success.
 if (syncThrow) {
 return;
 }
 if (err && (!error || error.code === 'ERR_STREAM_PREMATURE_CLOSE' || error.name === 'AbortError')) {
 error = err;
 }
Expand All@@ -251,160 +260,175 @@ function pipelineImpl(streams, callback, opts) {
 }

 let ret;
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }

 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 try {
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 ret = Duplex.from(stream);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 } catch (err) {
 // A synchronous throw while wiring the streams (e.g. an invalid
 // stream/function in the middle) leaves stages already wired alive:
 // their finish callbacks would otherwise report success to the caller,
 // who already received the exception. Destroy the wired stages, mark
 // the sync throw so no finish callback can fire, and rethrow.
 syncThrow = true;
 while (destroys.length) {
 destroys.shift()(err);
 }
 disposable?.[SymbolDispose]();
 ac.abort();
 throw err;
 }

 if (signal?.aborted || outerSignal?.aborted) {
Expand Down

25 changes: 25 additions & 0 deletions
test/parallel/test-stream-pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1774,3 +1774,28 @@ tmpdir.refresh();
 }),
 );
}
{
 // https://github.com/nodejs/node/issues/65127
 // When pipeline() throws synchronously while wiring streams together,
 // it must NOT also invoke the callback — and never with success.
 // A node stream wired before the throwing stage increments finishCount,
 // so a naive teardown would fire the callback with no error (double
 // report: the caller already received the exception).
 const r = Readable.from(['a']);
 const t = new Transform({
 transform(chunk, encoding, callback) {
 callback(null, chunk);
 },
 });
 let threw = false;
 try {
 pipeline(r, t, () => 42, common.mustNotCall());
 } catch (err) {
 threw = true;
 assert.strictEqual(err.code, 'ERR_INVALID_RETURN_VALUE');
 }
 assert.strictEqual(threw, true);
 // Give any stray finish callbacks a chance to fire; if the bug
 // regresses, common.mustNotCall() fails the test.
 setTimeout(() => {}, 100);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
stream: prevent pipeline() callback after sync throw#65165

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

pacocartones
wants to merge
1
commit into

from


+197

−148

 Closed


stream: prevent pipeline() callback after sync throw
#65165
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


320 changes: 172 additions & 148 deletions
lib/internal/streams/pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,6 +217,7 @@ function pipelineImpl(streams, callback, opts) {
 const destroys = [];

 let finishCount = 0;
 let syncThrow = false;

 function finish(err) {
 finishImpl(err, --finishCount === 0);
Expand All@@ -227,6 +228,14 @@ function pipelineImpl(streams, callback, opts) {
 }

 function finishImpl(err, final) {
 // If pipeline() threw synchronously while wiring the streams together,
 // the caller already received the error. Any finish callbacks that fire
 // afterwards (from stages already wired, which incremented finishCount)
 // must not invoke the completion callback — doing so would report the
 // same failure twice, once as an exception and once as a success.
 if (syncThrow) {
 return;
 }
 if (err && (!error || error.code === 'ERR_STREAM_PREMATURE_CLOSE' || error.name === 'AbortError')) {
 error = err;
 }
Expand All@@ -251,160 +260,175 @@ function pipelineImpl(streams, callback, opts) {
 }

 let ret;
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }

 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 try {
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 ret = Duplex.from(stream);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 } catch (err) {
 // A synchronous throw while wiring the streams (e.g. an invalid
 // stream/function in the middle) leaves stages already wired alive:
 // their finish callbacks would otherwise report success to the caller,
 // who already received the exception. Destroy the wired stages, mark
 // the sync throw so no finish callback can fire, and rethrow.
 syncThrow = true;
 while (destroys.length) {
 destroys.shift()(err);
 }
 disposable?.[SymbolDispose]();
 ac.abort();
 throw err;
 }

 if (signal?.aborted || outerSignal?.aborted) {
Expand Down

25 changes: 25 additions & 0 deletions
test/parallel/test-stream-pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1774,3 +1774,28 @@ tmpdir.refresh();
 }),
 );
}
{
 // https://github.com/nodejs/node/issues/65127
 // When pipeline() throws synchronously while wiring streams together,
 // it must NOT also invoke the callback — and never with success.
 // A node stream wired before the throwing stage increments finishCount,
 // so a naive teardown would fire the callback with no error (double
 // report: the caller already received the exception).
 const r = Readable.from(['a']);
 const t = new Transform({
 transform(chunk, encoding, callback) {
 callback(null, chunk);
 },
 });
 let threw = false;
 try {
 pipeline(r, t, () => 42, common.mustNotCall());
 } catch (err) {
 threw = true;
 assert.strictEqual(err.code, 'ERR_INVALID_RETURN_VALUE');
 }
 assert.strictEqual(threw, true);
 // Give any stray finish callbacks a chance to fire; if the bug
 // regresses, common.mustNotCall() fails the test.
 setTimeout(() => {}, 100);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
stream: prevent pipeline() callback after sync throw#65165

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

pacocartones
wants to merge
1
commit into

from


+197

−148

 Closed


stream: prevent pipeline() callback after sync throw
#65165
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


320 changes: 172 additions & 148 deletions
lib/internal/streams/pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -217,6 +217,7 @@ function pipelineImpl(streams, callback, opts) {
 const destroys = [];

 let finishCount = 0;
 let syncThrow = false;

 function finish(err) {
 finishImpl(err, --finishCount === 0);
Expand All@@ -227,6 +228,14 @@ function pipelineImpl(streams, callback, opts) {
 }

 function finishImpl(err, final) {
 // If pipeline() threw synchronously while wiring the streams together,
 // the caller already received the error. Any finish callbacks that fire
 // afterwards (from stages already wired, which incremented finishCount)
 // must not invoke the completion callback — doing so would report the
 // same failure twice, once as an exception and once as a success.
 if (syncThrow) {
 return;
 }
 if (err && (!error || error.code === 'ERR_STREAM_PREMATURE_CLOSE' || error.name === 'AbortError')) {
 error = err;
 }
Expand All@@ -251,160 +260,175 @@ function pipelineImpl(streams, callback, opts) {
 }

 let ret;
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }

 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 try {
 for (let i = 0; i < streams.length; i++) {
 const stream = streams[i];
 const reading = i < streams.length - 1;
 const writing = i > 0;
 const next = i + 1 < streams.length ? streams[i + 1] : null;
 const end = reading || opts?.end !== false;
 const isLastStream = i === streams.length - 1;

 if (isNodeStream(stream)) {
 if (next !== null && (next?.closed || next?.destroyed)) {
 throw new ERR_STREAM_UNABLE_TO_PIPE();
 }

 if (end) {
 const { destroy, cleanup } = destroyer(stream, reading, writing);
 destroys.push(destroy);

 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }

 // Catch stream errors that occur after pipe/pump has completed.
 function onError(err) {
 if (
 err &&
 err.name !== 'AbortError' &&
 err.code !== 'ERR_STREAM_PREMATURE_CLOSE'
 ) {
 finishOnlyHandleError(err);
 }
 }
 stream.on('error', onError);
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(() => {
 stream.removeListener('error', onError);
 });
 }
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 if (i === 0) {
 if (typeof stream === 'function') {
 ret = stream({ signal });
 if (!isIterable(ret)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'Iterable, AsyncIterable or Stream', 'source', ret);
 }
 } else if (isIterable(stream) || isReadableNodeStream(stream) || isTransformStream(stream)) {
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 }
 } else if (typeof stream === 'function') {
 if (isTransformStream(ret)) {
 ret = makeAsyncIterable(ret?.readable);
 } else {
 ret = makeAsyncIterable(ret);
 }
 ret = stream(ret, { signal });

 if (reading) {
 if (!isIterable(ret, true)) {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable', `transform[${i - 1}]`, ret);
 }
 } else {
 PassThrough ??= require('internal/streams/passthrough');

 // If the last argument to pipeline is not a stream
 // we must create a proxy stream so that pipeline(...)
 // always returns a stream which can be further
 // composed through `.pipe(stream)`.

 const pt = new PassThrough({
 objectMode: true,
 });

 // Handle Promises/A+ spec, `then` could be a getter that throws on
 // second use.
 const then = ret?.then;
 if (typeof then === 'function') {
 finishCount++;
 then.call(ret,
 (val) => {
 value = val;
 if (val != null) {
 pt.write(val);
 }
 if (end) {
 pt.end();
 }
 process.nextTick(finish);
 }, (err) => {
 pt.destroy(err);
 process.nextTick(finish, err);
 },
 );
 } else if (isIterable(ret, true)) {
 finishCount++;
 pumpToNode(ret, pt, finish, { end });
 } else if (isReadableStream(ret) || isTransformStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, pt, finish, { end });
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 throw new ERR_INVALID_RETURN_VALUE(
 'AsyncIterable or Promise', 'destination', ret);
 }

 ret = pt;

 const { destroy, cleanup } = destroyer(ret, false, true);
 destroys.push(destroy);
 if (isLastStream) {
 lastStreamCleanup.push(cleanup);
 }
 }
 } else if (isNodeStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount += 2;
 const cleanup = pipe(ret, stream, finish, finishOnlyHandleError, { end });
 if (isReadable(stream) && isLastStream) {
 lastStreamCleanup.push(cleanup);
 ret = Duplex.from(stream);
 }
 } else if (isTransformStream(ret) || isReadableStream(ret)) {
 const toRead = ret.readable || ret;
 finishCount++;
 pumpToNode(toRead, stream, finish, { end });
 } else if (isIterable(ret)) {
 finishCount++;
 pumpToNode(ret, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else if (isWebStream(stream)) {
 if (isReadableNodeStream(ret)) {
 finishCount++;
 pumpToWeb(makeAsyncIterable(ret), stream, finish, { end });
 } else if (isReadableStream(ret) || isIterable(ret)) {
 finishCount++;
 pumpToWeb(ret, stream, finish, { end });
 } else if (isTransformStream(ret)) {
 finishCount++;
 pumpToWeb(ret.readable, stream, finish, { end });
 } else {
 throw new ERR_INVALID_ARG_TYPE(
 'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
 }
 ret = stream;
 } else {
 ret = Duplex.from(stream);
 } catch (err) {
 // A synchronous throw while wiring the streams (e.g. an invalid
 // stream/function in the middle) leaves stages already wired alive:
 // their finish callbacks would otherwise report success to the caller,
 // who already received the exception. Destroy the wired stages, mark
 // the sync throw so no finish callback can fire, and rethrow.
 syncThrow = true;
 while (destroys.length) {
 destroys.shift()(err);
 }
 disposable?.[SymbolDispose]();
 ac.abort();
 throw err;
 }

 if (signal?.aborted || outerSignal?.aborted) {
Expand Down

25 changes: 25 additions & 0 deletions
test/parallel/test-stream-pipeline.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1774,3 +1774,28 @@ tmpdir.refresh();
 }),
 );
}
{
 // https://github.com/nodejs/node/issues/65127
 // When pipeline() throws synchronously while wiring streams together,
 // it must NOT also invoke the callback — and never with success.
 // A node stream wired before the throwing stage increments finishCount,
 // so a naive teardown would fire the callback with no error (double
 // report: the caller already received the exception).
 const r = Readable.from(['a']);
 const t = new Transform({
 transform(chunk, encoding, callback) {
 callback(null, chunk);
 },
 });
 let threw = false;
 try {
 pipeline(r, t, () => 42, common.mustNotCall());
 } catch (err) {
 threw = true;
 assert.strictEqual(err.code, 'ERR_INVALID_RETURN_VALUE');
 }
 assert.strictEqual(threw, true);
 // Give any stray finish callbacks a chance to fire; if the bug
 // regresses, common.mustNotCall() fails the test.
 setTimeout(() => {}, 100);
}