Skip to content
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.

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

fix: Ensure Duplex streams are returned unwrapped in stream operators #55394

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
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
10 changes: 9 additions & 1 deletion lib/stream.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ const {
const {
codes: {
ERR_ILLEGAL_CONSTRUCTOR,
ERR_INVALID_ARG_VALUE,
},
} = require('internal/errors');
const compose = require('internal/streams/compose');
Expand Down Expand Up @@ -69,7 +70,14 @@ for (let i = 0; i < streamKeys.length; i++) {
if (new.target) {
throw new ERR_ILLEGAL_CONSTRUCTOR();
}
return Stream.Readable.from(ReflectApply(op, this, args));
const result = (ReflectApply(op, this, args));
if (result instanceof Stream.Duplex) {
return result;
}
if (utils.isReadable(result) || utils.isWritable(result)) {
return Stream.compose(result);
}
throw new ERR_INVALID_ARG_VALUE('result', result, 'must be a Duplex, Readable, or Writable stream');
}
ObjectDefineProperty(fn, 'name', { __proto__: null, value: op.name });
ObjectDefineProperty(fn, 'length', { __proto__: null, value: op.length });
Expand Down
45 changes: 45 additions & 0 deletions test/parallel/test-stream-duplex.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
const common = require('../common');
const assert = require('assert');
const Duplex = require('stream').Duplex;
const { Readable, Writable } = require('stream');
const { ReadableStream, WritableStream } = require('stream/web');

const stream = new Duplex({ objectMode: true });
Expand Down Expand Up @@ -131,3 +132,47 @@ process.on('exit', () => {
assert.deepStrictEqual(Buffer.from(result.value), dataToRead);
}));
}

const assertMessages = {
isDuplex: 'Expected a Duplex stream',
duplexUnchanged: 'Expected the Duplex stream to be returned unchanged',
notDuplex: 'Expected a non-Duplex stream',
isReadable: 'Expected a Readable stream'
};

// readable.compose - Duplex stream unchanged
{
const readable = new Readable({
read() {}
});

const duplex = new Duplex({
read() {},
write(chunk, encoding, callback) {
callback();
}
});

const composedStream = readable.compose(duplex);

assert(composedStream instanceof Duplex, assertMessages.isDuplex);
assert.strictEqual(composedStream, duplex, assertMessages.duplexUnchanged);
}

// readable.compose - wraps non-Duplex streams
{
const readable = new Readable({
read() {}
});

const writable = new Writable({
write(chunk, encoding, callback) {
callback();
}
});

const composedStream = readable.compose(writable);

assert(!(composedStream instanceof Duplex), assertMessages.notDuplex);
assert(composedStream instanceof Readable, assertMessages.isReadable);
}