Skip to content
Draft
Changes from 1 commit
Commits
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
86 changes: 79 additions & 7 deletions lib/internal/streams/pipeline.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ const {
const { eos } = require('internal/streams/end-of-stream');
const { once } = require('internal/util');
const destroyImpl = require('internal/streams/destroy');
const Duplex = require('internal/streams/duplex');
const {
AbortError,
aggregateTwoErrors,
Expand All @@ -36,6 +35,8 @@ const {
isIterable,
isReadable,
isReadableNodeStream,
isWritableNodeStream,
isWritableStream,
isNodeStream,
isTransformStream,
isWebStream,
Expand Down Expand Up @@ -159,7 +160,8 @@ async function pumpToWeb(readable, writable, finish, { end }) {
try {
for await (const chunk of readable) {
await writer.ready;
writer.write(chunk).catch(() => {});
writer.write(chunk).catch(() => {
});
}

await writer.ready;
Expand All @@ -179,6 +181,76 @@ async function pumpToWeb(readable, writable, finish, { end }) {
}
}

function getPipelineArgName(i, len) {
if (i === 0) return 'source';
if (i === len - 1) return 'destination';
return `transform[${i - 1}]`;
}

function isValidPipelineSource(stream) {
return (
isIterable(stream) ||
isReadableNodeStream(stream) ||
isReadableStream(stream) ||
isTransformStream(stream)
);
}

function isValidPipelineTransform(stream) {
return (
isTransformStream(stream) ||
(isNodeStream(stream) &&
isReadableNodeStream(stream) &&
isWritableNodeStream(stream))
);
}

function isValidPipelineDestination(stream) {
return (
isWritableNodeStream(stream) ||
isWritableStream(stream) ||
isTransformStream(stream)
);
}

function validatePipelineStream(stream, i, len) {
if (typeof stream === 'function') {
return;
}

const name = getPipelineArgName(i, len);

if (i === 0) {
if (!isValidPipelineSource(stream)) {
throw new ERR_INVALID_ARG_TYPE(
name,
['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'],
stream,
);
}
return;
}

if (i === len - 1) {
if (!isValidPipelineDestination(stream)) {
throw new ERR_INVALID_ARG_TYPE(
name,
['Writable', 'WritableStream', 'TransformStream'],
stream,
);
}
return;
}

if (!isValidPipelineTransform(stream)) {
throw new ERR_INVALID_ARG_TYPE(
name,
['Duplex', 'Transform', 'TransformStream'],
stream,
);
}
}

function pipeline(...streams) {
return pipelineImpl(streams, once(popCallback(streams)));
}
Expand All @@ -192,6 +264,10 @@ function pipelineImpl(streams, callback, opts) {
throw new ERR_MISSING_ARGS('streams');
}

for (let i = 0; i < streams.length; i++) {
validatePipelineStream(streams[i], i, streams.length);
}

const ac = new AbortController();
const signal = ac.signal;
const outerSignal = opts?.signal;
Expand Down Expand Up @@ -298,10 +374,8 @@ function pipelineImpl(streams, callback, opts) {
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);
Copy link
Member

Choose a reason for hiding this comment

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

why?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As far as I see by validating and throwing early this becomes dead code. This is the branch for the "source stream" and the only case this was being used was a non-readable node stream which will now throw

ret = stream;
}
} else if (typeof stream === 'function') {
if (isTransformStream(ret)) {
Expand Down Expand Up @@ -402,8 +476,6 @@ function pipelineImpl(streams, callback, opts) {
'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
}
ret = stream;
} else {
ret = Duplex.from(stream);
Copy link
Member

Choose a reason for hiding this comment

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

why?

Copy link
Contributor Author

@efekrskl efekrskl Mar 12, 2026

Choose a reason for hiding this comment

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

Similar to above, unless I'm missing something with the early validation this becomes dead code. I'm less confident on this one though 😅

}
}

Expand Down