Skip to content

stream: validate streams in pipeline #62214

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

Draft
efekrskl wants to merge 2 commits into
base: main
Choose a base branch
from
+71 −7
Draft

stream: validate streams in pipeline #62214

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab68aad
stream: validate streams in pipeline
efekrskl Mar 11, 2026
c5da09b
stream: inline name arg creation
efekrskl Mar 11, 2026
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
78 changes: 71 additions & 7 deletions lib/internal/streams/pipeline.js
View file
Open in desktop
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,68 @@ async function pumpToWeb(readable, writable, finish, { end }) {
}
}

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;
}

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

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

if (!isValidPipelineTransform(stream)) {
throw new ERR_INVALID_ARG_TYPE(
`transform[${i - 1}]`,
['Duplex', 'Transform', 'TransformStream'],
stream,
);
}
}

function pipeline(...streams) {
return pipelineImpl(streams, once(popCallback(streams)));
}
Expand All @@ -192,6 +256,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 +366,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);
ret = stream;
}
} else if (typeof stream === 'function') {
if (isTransformStream(ret)) {
Expand Down Expand Up @@ -402,8 +468,6 @@ function pipelineImpl(streams, callback, opts) {
'val', ['Readable', 'Iterable', 'AsyncIterable', 'ReadableStream', 'TransformStream'], ret);
}
ret = stream;
} else {
ret = Duplex.from(stream);
}
}

Expand Down