stream: validate writer options signal#64385

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

Merged
nodejs-github-bot merged 1 commit into from
Jul 16, 2026
Merged

stream: validate writer options signal #64385

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
20 changes: 11 additions & 9 deletions lib/internal/streams/iter/broadcast.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ const {
kResolvedPromise,
clampHWM,
convertChunks,
getWriterSignal,
getMinCursor,
hasProtocol,
onSignalAbort,
Expand DownExpand Up@@ -526,41 +527,41 @@ class BroadcastWriter {
return this.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
}

#canUseWriteFastPath(options) {
return !options?.signal && !this.#isClosed() && !this.#aborted &&
#canUseWriteFastPath(signal) {
return !signal && !this.#isClosed() && !this.#aborted &&
this.#broadcast[kCanWrite]();
}

write(chunk, options) {
const signal = getWriterSignal(options);
// Fast path: no signal, writer open, buffer has space
if (this.#canUseWriteFastPath(options)) {
if (this.#canUseWriteFastPath(signal)) {
const converted = toUint8Array(chunk);
this.#broadcast[kWrite]([converted]);
this.#totalBytes += TypedArrayPrototypeGetByteLength(converted);
return kResolvedPromise;
}
return this.#writevSlow([chunk], options);
return this.#writevSlow([chunk], signal);
}

writev(chunks, options) {
if (!ArrayIsArray(chunks)) {
throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
}
const signal = getWriterSignal(options);
// Fast path: no signal, writer open, buffer has space
if (this.#canUseWriteFastPath(options)) {
if (this.#canUseWriteFastPath(signal)) {
const converted = convertChunks(chunks);
this.#broadcast[kWrite](converted);
for (let i = 0; i < converted.length; i++) {
this.#totalBytes += TypedArrayPrototypeGetByteLength(converted[i]);
}
return kResolvedPromise;
}
return this.#writevSlow(chunks, options);
return this.#writevSlow(chunks, signal);
}

async #writevSlow(chunks, options) {
const signal = options?.signal;

async #writevSlow(chunks, signal) {
// Check for pre-aborted
signal?.throwIfAborted();

Expand DownExpand Up@@ -623,6 +624,7 @@ class BroadcastWriter {

// end() is synchronous internally - signal accepted for interface compliance.
end(options) {
getWriterSignal(options);
if (this.#isClosed()) return this.#closed;
this.#closed = PromiseResolve(this.#totalBytes);
this.#broadcast[kEnd]();
Expand Down
19 changes: 12 additions & 7 deletions lib/internal/streams/iter/classic.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@ const {
} = require('internal/streams/iter/types');

const {
getWriterSignal,
validateBackpressure,
toUint8Array,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
// as 'error' events caught by our generic error handler, rejecting
// the next pending operation rather than the already-resolved one.
//
// The options.signal parameter from the Writer interface is ignored.
// Classic stream.Writable has no per-write abort signal support;
// cancellation should be handled at the pipeline level instead.
write(chunk) {
// The options.signal parameter from the Writer interface is validated but
// otherwise ignored. Classic stream.Writable has no per-write abort signal
// support; cancellation should be handled at the pipeline level instead.
write(chunk, options) {
getWriterSignal(options);
if (!isWritable()) {
return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
}
Expand DownExpand Up@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
return PromiseResolve();
},

writev(chunks) {
writev(chunks, options) {
if (!ArrayIsArray(chunks)) {
throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
}
getWriterSignal(options);
if (!isWritable()) {
return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
}
Expand DownExpand Up@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
return -1;
},

// options.signal is ignored for the same reason as write().
end() {
// options.signal is validated but otherwise ignored for the same reason as
// write().
end(options) {
getWriterSignal(options);
if ((writable.writableFinished ?? false) ||
(writable.destroyed ?? false)) {
cleanup();
Expand Down
12 changes: 8 additions & 4 deletions lib/internal/streams/iter/push.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const {
onSignalAbort,
toUint8Array,
convertChunks,
getWriterSignal,
parsePullArgs,
validateBackpressure,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -565,26 +566,28 @@ class PushWriter {
}

write(chunk, options) {
if (!options?.signal && this.#queue.canWriteSync()) {
const signal = getWriterSignal(options);
if (!signal && this.#queue.canWriteSync()) {
const bytes = toUint8Array(chunk);
this.#queue.writeSync([bytes]);
return kResolvedPromise;
}
const bytes = toUint8Array(chunk);
return this.#queue.writeAsync([bytes], options?.signal);
return this.#queue.writeAsync([bytes], signal);
}

writev(chunks, options) {
if (!ArrayIsArray(chunks)) {
throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
}
if (!options?.signal && this.#queue.canWriteSync()) {
const signal = getWriterSignal(options);
if (!signal && this.#queue.canWriteSync()) {
const bytes = convertChunks(chunks);
this.#queue.writeSync(bytes);
return kResolvedPromise;
}
const bytes = convertChunks(chunks);
return this.#queue.writeAsync(bytes, options?.signal);
return this.#queue.writeAsync(bytes, signal);
}

writeSync(chunk) {
Expand All@@ -601,6 +604,7 @@ class PushWriter {
}

end(options) {
getWriterSignal(options);
const result = this.#queue.end();
if (result === -2) {
// Errored: reject with stored error
Expand Down
17 changes: 16 additions & 1 deletion lib/internal/streams/iter/utils.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,10 @@ const { isError } = require('internal/util');

const { isSharedArrayBuffer, isUint8Array } = require('internal/util/types');

const { validateOneOf } = require('internal/validators');
const {
validateAbortSignal,
validateOneOf,
} = require('internal/validators');

// Cached resolved promise to avoid allocating a new one on every sync fast-path.
const kResolvedPromise = PromiseResolve();
Expand DownExpand Up@@ -263,6 +266,17 @@ function convertChunks(chunks) {
return result;
}

/**
* Validate Writer options and return options.signal.
* @param {object|undefined} options
* @returns {AbortSignal|undefined}
*/
function getWriterSignal(options) {
const signal = options?.signal;
validateAbortSignal(signal, 'options.signal');
return signal;
}

/**
* Wrap a caught value as an Error, converting non-Error values.
* @param {unknown} error
Expand DownExpand Up@@ -374,6 +388,7 @@ module.exports = {
clampHWM,
concatBytes,
convertChunks,
getWriterSignal,
getMinCursor,
hasProtocol,
isPullOptions,
Expand Down
47 changes: 46 additions & 1 deletion test/parallel/test-stream-iter-validation.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,9 @@

const common = require('../common');
const assert = require('assert');
const { Writable } = require('stream');
const {
from, fromSync, pull, pullSync, pipeTo,
from, fromSync, pull, pullSync, pipeTo, fromWritable,
push, duplex, broadcast, Broadcast, share, shareSync,
Share, SyncShare,
bytes, bytesSync, text, textSync,
Expand DownExpand Up@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push(42, {}), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push('bad', {}), { code: 'ERR_INVALID_ARG_TYPE' });

// Writer options.signal must be AbortSignal
{
const { writer } = push();
const badOptions = { signal: 'bad' };
assert.throws(() => writer.write('a', badOptions),
{ code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => writer.writev(['b'], badOptions),
{ code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => writer.end(badOptions),
{ code: 'ERR_INVALID_ARG_TYPE' });
writer.endSync();
}

// Writer.writev requires array
{
const { writer } = push();
Expand DownExpand Up@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
assert.throws(() => broadcast({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG_VALUE' });

// BroadcastWriter options.signal must be AbortSignal
{
const { writer } = broadcast();
const badOptions = { signal: 'bad' };
assert.throws(() => writer.write('a', badOptions),
{ code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => writer.writev(['b'], badOptions),
{ code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => writer.end(badOptions),
{ code: 'ERR_INVALID_ARG_TYPE' });
writer.endSync();
}

// BroadcastWriter.writev requires array
{
const { writer } = broadcast();
Expand All@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
// Broadcast.from rejects non-streamable input
assert.throws(() => Broadcast.from(42), { code: 'ERR_INVALID_ARG_TYPE' });

// fromWritable Writer options.signal must be AbortSignal
{
const writable = new Writable({
write(chunk, encoding, callback) {
callback();
},
});
const writer = fromWritable(writable);
const badOptions = { signal: 'bad' };
assert.throws(() => writer.write('a', badOptions),
{ code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => writer.writev(['b'], badOptions),
{ code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => writer.end(badOptions),
{ code: 'ERR_INVALID_ARG_TYPE' });
writable.destroy();
}

// =============================================================================
// share() / shareSync() validation
// =============================================================================
Expand Down
Loading
, '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: validate writer options signal#64385

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Jul 16, 2026
 Merged


stream: validate writer options signal
#64385
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


20 changes: 11 additions & 9 deletions
lib/internal/streams/iter/broadcast.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ const {
 kResolvedPromise,
 clampHWM,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 onSignalAbort,
Expand DownExpand Up@@ -526,41 +527,41 @@ class BroadcastWriter {
 return this.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
 }

 #canUseWriteFastPath(options) {
 return !options?.signal && !this.#isClosed() && !this.#aborted &&
 #canUseWriteFastPath(signal) {
 return !signal && !this.#isClosed() && !this.#aborted &&
 this.#broadcast[kCanWrite]();
 }

 write(chunk, options) {
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = toUint8Array(chunk);
 this.#broadcast[kWrite]([converted]);
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted);
 return kResolvedPromise;
 }
 return this.#writevSlow([chunk], options);
 return this.#writevSlow([chunk], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = convertChunks(chunks);
 this.#broadcast[kWrite](converted);
 for (let i = 0; i < converted.length; i++) {
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted[i]);
 }
 return kResolvedPromise;
 }
 return this.#writevSlow(chunks, options);
 return this.#writevSlow(chunks, signal);
 }

 async #writevSlow(chunks, options) {
 const signal = options?.signal;

 async #writevSlow(chunks, signal) {
 // Check for pre-aborted
 signal?.throwIfAborted();

Expand DownExpand Up@@ -623,6 +624,7 @@ class BroadcastWriter {

 // end() is synchronous internally - signal accepted for interface compliance.
 end(options) {
 getWriterSignal(options);
 if (this.#isClosed()) return this.#closed;
 this.#closed = PromiseResolve(this.#totalBytes);
 this.#broadcast[kEnd]();
Expand Down

19 changes: 12 additions & 7 deletions
lib/internal/streams/iter/classic.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@ const {
} = require('internal/streams/iter/types');

const {
 getWriterSignal,
 validateBackpressure,
 toUint8Array,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
 // as 'error' events caught by our generic error handler, rejecting
 // the next pending operation rather than the already-resolved one.
 //
 // The options.signal parameter from the Writer interface is ignored.
 // Classic stream.Writable has no per-write abort signal support;
 // cancellation should be handled at the pipeline level instead.
 write(chunk) {
 // The options.signal parameter from the Writer interface is validated but
 // otherwise ignored. Classic stream.Writable has no per-write abort signal
 // support; cancellation should be handled at the pipeline level instead.
 write(chunk, options) {
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
 return PromiseResolve();
 },

 writev(chunks) {
 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
 return -1;
 },

 // options.signal is ignored for the same reason as write().
 end() {
 // options.signal is validated but otherwise ignored for the same reason as
 // write().
 end(options) {
 getWriterSignal(options);
 if ((writable.writableFinished ?? false) ||
 (writable.destroyed ?? false)) {
 cleanup();
Expand Down

12 changes: 8 additions & 4 deletions
lib/internal/streams/iter/push.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const {
 onSignalAbort,
 toUint8Array,
 convertChunks,
 getWriterSignal,
 parsePullArgs,
 validateBackpressure,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -565,26 +566,28 @@ class PushWriter {
 }

 write(chunk, options) {
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = toUint8Array(chunk);
 this.#queue.writeSync([bytes]);
 return kResolvedPromise;
 }
 const bytes = toUint8Array(chunk);
 return this.#queue.writeAsync([bytes], options?.signal);
 return this.#queue.writeAsync([bytes], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = convertChunks(chunks);
 this.#queue.writeSync(bytes);
 return kResolvedPromise;
 }
 const bytes = convertChunks(chunks);
 return this.#queue.writeAsync(bytes, options?.signal);
 return this.#queue.writeAsync(bytes, signal);
 }

 writeSync(chunk) {
Expand All@@ -601,6 +604,7 @@ class PushWriter {
 }

 end(options) {
 getWriterSignal(options);
 const result = this.#queue.end();
 if (result === -2) {
 // Errored: reject with stored error
Expand Down

17 changes: 16 additions & 1 deletion
lib/internal/streams/iter/utils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,10 @@ const { isError } = require('internal/util');

const { isSharedArrayBuffer, isUint8Array } = require('internal/util/types');

const { validateOneOf } = require('internal/validators');
const {
 validateAbortSignal,
 validateOneOf,
} = require('internal/validators');

// Cached resolved promise to avoid allocating a new one on every sync fast-path.
const kResolvedPromise = PromiseResolve();
Expand DownExpand Up@@ -263,6 +266,17 @@ function convertChunks(chunks) {
 return result;
}

/**
 * Validate Writer options and return options.signal.
 * @param {object|undefined} options
 * @returns {AbortSignal|undefined}
 */
function getWriterSignal(options) {
 const signal = options?.signal;
 validateAbortSignal(signal, 'options.signal');
 return signal;
}

/**
 * Wrap a caught value as an Error, converting non-Error values.
 * @param {unknown} error
Expand DownExpand Up@@ -374,6 +388,7 @@ module.exports = {
 clampHWM,
 concatBytes,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 isPullOptions,
Expand Down

47 changes: 46 additions & 1 deletion
test/parallel/test-stream-iter-validation.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,9 @@

const common = require('../common');
const assert = require('assert');
const { Writable } = require('stream');
const {
 from, fromSync, pull, pullSync, pipeTo,
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
 push, duplex, broadcast, Broadcast, share, shareSync,
 Share, SyncShare,
 bytes, bytesSync, text, textSync,
Expand DownExpand Up@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push(42, {}), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push('bad', {}), { code: 'ERR_INVALID_ARG_TYPE' });

// Writer options.signal must be AbortSignal
{
 const { writer } = push();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// Writer.writev requires array
{
 const { writer } = push();
Expand DownExpand Up@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
assert.throws(() => broadcast({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG_VALUE' });

// BroadcastWriter options.signal must be AbortSignal
{
 const { writer } = broadcast();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// BroadcastWriter.writev requires array
{
 const { writer } = broadcast();
Expand All@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
// Broadcast.from rejects non-streamable input
assert.throws(() => Broadcast.from(42), { code: 'ERR_INVALID_ARG_TYPE' });

// fromWritable Writer options.signal must be AbortSignal
{
 const writable = new Writable({
 write(chunk, encoding, callback) {
 callback();
 },
 });
 const writer = fromWritable(writable);
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writable.destroy();
}

// =============================================================================
// share() / shareSync() validation
// =============================================================================
Expand Down
Loading

, '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: validate writer options signal#64385

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Jul 16, 2026
 Merged


stream: validate writer options signal
#64385
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


20 changes: 11 additions & 9 deletions
lib/internal/streams/iter/broadcast.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ const {
 kResolvedPromise,
 clampHWM,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 onSignalAbort,
Expand DownExpand Up@@ -526,41 +527,41 @@ class BroadcastWriter {
 return this.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
 }

 #canUseWriteFastPath(options) {
 return !options?.signal && !this.#isClosed() && !this.#aborted &&
 #canUseWriteFastPath(signal) {
 return !signal && !this.#isClosed() && !this.#aborted &&
 this.#broadcast[kCanWrite]();
 }

 write(chunk, options) {
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = toUint8Array(chunk);
 this.#broadcast[kWrite]([converted]);
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted);
 return kResolvedPromise;
 }
 return this.#writevSlow([chunk], options);
 return this.#writevSlow([chunk], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = convertChunks(chunks);
 this.#broadcast[kWrite](converted);
 for (let i = 0; i < converted.length; i++) {
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted[i]);
 }
 return kResolvedPromise;
 }
 return this.#writevSlow(chunks, options);
 return this.#writevSlow(chunks, signal);
 }

 async #writevSlow(chunks, options) {
 const signal = options?.signal;

 async #writevSlow(chunks, signal) {
 // Check for pre-aborted
 signal?.throwIfAborted();

Expand DownExpand Up@@ -623,6 +624,7 @@ class BroadcastWriter {

 // end() is synchronous internally - signal accepted for interface compliance.
 end(options) {
 getWriterSignal(options);
 if (this.#isClosed()) return this.#closed;
 this.#closed = PromiseResolve(this.#totalBytes);
 this.#broadcast[kEnd]();
Expand Down

19 changes: 12 additions & 7 deletions
lib/internal/streams/iter/classic.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@ const {
} = require('internal/streams/iter/types');

const {
 getWriterSignal,
 validateBackpressure,
 toUint8Array,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
 // as 'error' events caught by our generic error handler, rejecting
 // the next pending operation rather than the already-resolved one.
 //
 // The options.signal parameter from the Writer interface is ignored.
 // Classic stream.Writable has no per-write abort signal support;
 // cancellation should be handled at the pipeline level instead.
 write(chunk) {
 // The options.signal parameter from the Writer interface is validated but
 // otherwise ignored. Classic stream.Writable has no per-write abort signal
 // support; cancellation should be handled at the pipeline level instead.
 write(chunk, options) {
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
 return PromiseResolve();
 },

 writev(chunks) {
 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
 return -1;
 },

 // options.signal is ignored for the same reason as write().
 end() {
 // options.signal is validated but otherwise ignored for the same reason as
 // write().
 end(options) {
 getWriterSignal(options);
 if ((writable.writableFinished ?? false) ||
 (writable.destroyed ?? false)) {
 cleanup();
Expand Down

12 changes: 8 additions & 4 deletions
lib/internal/streams/iter/push.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const {
 onSignalAbort,
 toUint8Array,
 convertChunks,
 getWriterSignal,
 parsePullArgs,
 validateBackpressure,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -565,26 +566,28 @@ class PushWriter {
 }

 write(chunk, options) {
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = toUint8Array(chunk);
 this.#queue.writeSync([bytes]);
 return kResolvedPromise;
 }
 const bytes = toUint8Array(chunk);
 return this.#queue.writeAsync([bytes], options?.signal);
 return this.#queue.writeAsync([bytes], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = convertChunks(chunks);
 this.#queue.writeSync(bytes);
 return kResolvedPromise;
 }
 const bytes = convertChunks(chunks);
 return this.#queue.writeAsync(bytes, options?.signal);
 return this.#queue.writeAsync(bytes, signal);
 }

 writeSync(chunk) {
Expand All@@ -601,6 +604,7 @@ class PushWriter {
 }

 end(options) {
 getWriterSignal(options);
 const result = this.#queue.end();
 if (result === -2) {
 // Errored: reject with stored error
Expand Down

17 changes: 16 additions & 1 deletion
lib/internal/streams/iter/utils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,10 @@ const { isError } = require('internal/util');

const { isSharedArrayBuffer, isUint8Array } = require('internal/util/types');

const { validateOneOf } = require('internal/validators');
const {
 validateAbortSignal,
 validateOneOf,
} = require('internal/validators');

// Cached resolved promise to avoid allocating a new one on every sync fast-path.
const kResolvedPromise = PromiseResolve();
Expand DownExpand Up@@ -263,6 +266,17 @@ function convertChunks(chunks) {
 return result;
}

/**
 * Validate Writer options and return options.signal.
 * @param {object|undefined} options
 * @returns {AbortSignal|undefined}
 */
function getWriterSignal(options) {
 const signal = options?.signal;
 validateAbortSignal(signal, 'options.signal');
 return signal;
}

/**
 * Wrap a caught value as an Error, converting non-Error values.
 * @param {unknown} error
Expand DownExpand Up@@ -374,6 +388,7 @@ module.exports = {
 clampHWM,
 concatBytes,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 isPullOptions,
Expand Down

47 changes: 46 additions & 1 deletion
test/parallel/test-stream-iter-validation.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,9 @@

const common = require('../common');
const assert = require('assert');
const { Writable } = require('stream');
const {
 from, fromSync, pull, pullSync, pipeTo,
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
 push, duplex, broadcast, Broadcast, share, shareSync,
 Share, SyncShare,
 bytes, bytesSync, text, textSync,
Expand DownExpand Up@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push(42, {}), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push('bad', {}), { code: 'ERR_INVALID_ARG_TYPE' });

// Writer options.signal must be AbortSignal
{
 const { writer } = push();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// Writer.writev requires array
{
 const { writer } = push();
Expand DownExpand Up@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
assert.throws(() => broadcast({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG_VALUE' });

// BroadcastWriter options.signal must be AbortSignal
{
 const { writer } = broadcast();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// BroadcastWriter.writev requires array
{
 const { writer } = broadcast();
Expand All@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
// Broadcast.from rejects non-streamable input
assert.throws(() => Broadcast.from(42), { code: 'ERR_INVALID_ARG_TYPE' });

// fromWritable Writer options.signal must be AbortSignal
{
 const writable = new Writable({
 write(chunk, encoding, callback) {
 callback();
 },
 });
 const writer = fromWritable(writable);
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writable.destroy();
}

// =============================================================================
// share() / shareSync() validation
// =============================================================================
Expand Down
Loading

, '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: validate writer options signal#64385

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Jul 16, 2026
 Merged


stream: validate writer options signal
#64385
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


20 changes: 11 additions & 9 deletions
lib/internal/streams/iter/broadcast.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ const {
 kResolvedPromise,
 clampHWM,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 onSignalAbort,
Expand DownExpand Up@@ -526,41 +527,41 @@ class BroadcastWriter {
 return this.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
 }

 #canUseWriteFastPath(options) {
 return !options?.signal && !this.#isClosed() && !this.#aborted &&
 #canUseWriteFastPath(signal) {
 return !signal && !this.#isClosed() && !this.#aborted &&
 this.#broadcast[kCanWrite]();
 }

 write(chunk, options) {
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = toUint8Array(chunk);
 this.#broadcast[kWrite]([converted]);
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted);
 return kResolvedPromise;
 }
 return this.#writevSlow([chunk], options);
 return this.#writevSlow([chunk], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = convertChunks(chunks);
 this.#broadcast[kWrite](converted);
 for (let i = 0; i < converted.length; i++) {
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted[i]);
 }
 return kResolvedPromise;
 }
 return this.#writevSlow(chunks, options);
 return this.#writevSlow(chunks, signal);
 }

 async #writevSlow(chunks, options) {
 const signal = options?.signal;

 async #writevSlow(chunks, signal) {
 // Check for pre-aborted
 signal?.throwIfAborted();

Expand DownExpand Up@@ -623,6 +624,7 @@ class BroadcastWriter {

 // end() is synchronous internally - signal accepted for interface compliance.
 end(options) {
 getWriterSignal(options);
 if (this.#isClosed()) return this.#closed;
 this.#closed = PromiseResolve(this.#totalBytes);
 this.#broadcast[kEnd]();
Expand Down

19 changes: 12 additions & 7 deletions
lib/internal/streams/iter/classic.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@ const {
} = require('internal/streams/iter/types');

const {
 getWriterSignal,
 validateBackpressure,
 toUint8Array,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
 // as 'error' events caught by our generic error handler, rejecting
 // the next pending operation rather than the already-resolved one.
 //
 // The options.signal parameter from the Writer interface is ignored.
 // Classic stream.Writable has no per-write abort signal support;
 // cancellation should be handled at the pipeline level instead.
 write(chunk) {
 // The options.signal parameter from the Writer interface is validated but
 // otherwise ignored. Classic stream.Writable has no per-write abort signal
 // support; cancellation should be handled at the pipeline level instead.
 write(chunk, options) {
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
 return PromiseResolve();
 },

 writev(chunks) {
 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
 return -1;
 },

 // options.signal is ignored for the same reason as write().
 end() {
 // options.signal is validated but otherwise ignored for the same reason as
 // write().
 end(options) {
 getWriterSignal(options);
 if ((writable.writableFinished ?? false) ||
 (writable.destroyed ?? false)) {
 cleanup();
Expand Down

12 changes: 8 additions & 4 deletions
lib/internal/streams/iter/push.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const {
 onSignalAbort,
 toUint8Array,
 convertChunks,
 getWriterSignal,
 parsePullArgs,
 validateBackpressure,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -565,26 +566,28 @@ class PushWriter {
 }

 write(chunk, options) {
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = toUint8Array(chunk);
 this.#queue.writeSync([bytes]);
 return kResolvedPromise;
 }
 const bytes = toUint8Array(chunk);
 return this.#queue.writeAsync([bytes], options?.signal);
 return this.#queue.writeAsync([bytes], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = convertChunks(chunks);
 this.#queue.writeSync(bytes);
 return kResolvedPromise;
 }
 const bytes = convertChunks(chunks);
 return this.#queue.writeAsync(bytes, options?.signal);
 return this.#queue.writeAsync(bytes, signal);
 }

 writeSync(chunk) {
Expand All@@ -601,6 +604,7 @@ class PushWriter {
 }

 end(options) {
 getWriterSignal(options);
 const result = this.#queue.end();
 if (result === -2) {
 // Errored: reject with stored error
Expand Down

17 changes: 16 additions & 1 deletion
lib/internal/streams/iter/utils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,10 @@ const { isError } = require('internal/util');

const { isSharedArrayBuffer, isUint8Array } = require('internal/util/types');

const { validateOneOf } = require('internal/validators');
const {
 validateAbortSignal,
 validateOneOf,
} = require('internal/validators');

// Cached resolved promise to avoid allocating a new one on every sync fast-path.
const kResolvedPromise = PromiseResolve();
Expand DownExpand Up@@ -263,6 +266,17 @@ function convertChunks(chunks) {
 return result;
}

/**
 * Validate Writer options and return options.signal.
 * @param {object|undefined} options
 * @returns {AbortSignal|undefined}
 */
function getWriterSignal(options) {
 const signal = options?.signal;
 validateAbortSignal(signal, 'options.signal');
 return signal;
}

/**
 * Wrap a caught value as an Error, converting non-Error values.
 * @param {unknown} error
Expand DownExpand Up@@ -374,6 +388,7 @@ module.exports = {
 clampHWM,
 concatBytes,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 isPullOptions,
Expand Down

47 changes: 46 additions & 1 deletion
test/parallel/test-stream-iter-validation.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,9 @@

const common = require('../common');
const assert = require('assert');
const { Writable } = require('stream');
const {
 from, fromSync, pull, pullSync, pipeTo,
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
 push, duplex, broadcast, Broadcast, share, shareSync,
 Share, SyncShare,
 bytes, bytesSync, text, textSync,
Expand DownExpand Up@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push(42, {}), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push('bad', {}), { code: 'ERR_INVALID_ARG_TYPE' });

// Writer options.signal must be AbortSignal
{
 const { writer } = push();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// Writer.writev requires array
{
 const { writer } = push();
Expand DownExpand Up@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
assert.throws(() => broadcast({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG_VALUE' });

// BroadcastWriter options.signal must be AbortSignal
{
 const { writer } = broadcast();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// BroadcastWriter.writev requires array
{
 const { writer } = broadcast();
Expand All@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
// Broadcast.from rejects non-streamable input
assert.throws(() => Broadcast.from(42), { code: 'ERR_INVALID_ARG_TYPE' });

// fromWritable Writer options.signal must be AbortSignal
{
 const writable = new Writable({
 write(chunk, encoding, callback) {
 callback();
 },
 });
 const writer = fromWritable(writable);
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writable.destroy();
}

// =============================================================================
// share() / shareSync() validation
// =============================================================================
Expand Down
Loading

, '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: validate writer options signal#64385

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Jul 16, 2026
 Merged


stream: validate writer options signal
#64385
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


20 changes: 11 additions & 9 deletions
lib/internal/streams/iter/broadcast.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ const {
 kResolvedPromise,
 clampHWM,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 onSignalAbort,
Expand DownExpand Up@@ -526,41 +527,41 @@ class BroadcastWriter {
 return this.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
 }

 #canUseWriteFastPath(options) {
 return !options?.signal && !this.#isClosed() && !this.#aborted &&
 #canUseWriteFastPath(signal) {
 return !signal && !this.#isClosed() && !this.#aborted &&
 this.#broadcast[kCanWrite]();
 }

 write(chunk, options) {
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = toUint8Array(chunk);
 this.#broadcast[kWrite]([converted]);
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted);
 return kResolvedPromise;
 }
 return this.#writevSlow([chunk], options);
 return this.#writevSlow([chunk], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = convertChunks(chunks);
 this.#broadcast[kWrite](converted);
 for (let i = 0; i < converted.length; i++) {
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted[i]);
 }
 return kResolvedPromise;
 }
 return this.#writevSlow(chunks, options);
 return this.#writevSlow(chunks, signal);
 }

 async #writevSlow(chunks, options) {
 const signal = options?.signal;

 async #writevSlow(chunks, signal) {
 // Check for pre-aborted
 signal?.throwIfAborted();

Expand DownExpand Up@@ -623,6 +624,7 @@ class BroadcastWriter {

 // end() is synchronous internally - signal accepted for interface compliance.
 end(options) {
 getWriterSignal(options);
 if (this.#isClosed()) return this.#closed;
 this.#closed = PromiseResolve(this.#totalBytes);
 this.#broadcast[kEnd]();
Expand Down

19 changes: 12 additions & 7 deletions
lib/internal/streams/iter/classic.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@ const {
} = require('internal/streams/iter/types');

const {
 getWriterSignal,
 validateBackpressure,
 toUint8Array,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
 // as 'error' events caught by our generic error handler, rejecting
 // the next pending operation rather than the already-resolved one.
 //
 // The options.signal parameter from the Writer interface is ignored.
 // Classic stream.Writable has no per-write abort signal support;
 // cancellation should be handled at the pipeline level instead.
 write(chunk) {
 // The options.signal parameter from the Writer interface is validated but
 // otherwise ignored. Classic stream.Writable has no per-write abort signal
 // support; cancellation should be handled at the pipeline level instead.
 write(chunk, options) {
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
 return PromiseResolve();
 },

 writev(chunks) {
 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
 return -1;
 },

 // options.signal is ignored for the same reason as write().
 end() {
 // options.signal is validated but otherwise ignored for the same reason as
 // write().
 end(options) {
 getWriterSignal(options);
 if ((writable.writableFinished ?? false) ||
 (writable.destroyed ?? false)) {
 cleanup();
Expand Down

12 changes: 8 additions & 4 deletions
lib/internal/streams/iter/push.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const {
 onSignalAbort,
 toUint8Array,
 convertChunks,
 getWriterSignal,
 parsePullArgs,
 validateBackpressure,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -565,26 +566,28 @@ class PushWriter {
 }

 write(chunk, options) {
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = toUint8Array(chunk);
 this.#queue.writeSync([bytes]);
 return kResolvedPromise;
 }
 const bytes = toUint8Array(chunk);
 return this.#queue.writeAsync([bytes], options?.signal);
 return this.#queue.writeAsync([bytes], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = convertChunks(chunks);
 this.#queue.writeSync(bytes);
 return kResolvedPromise;
 }
 const bytes = convertChunks(chunks);
 return this.#queue.writeAsync(bytes, options?.signal);
 return this.#queue.writeAsync(bytes, signal);
 }

 writeSync(chunk) {
Expand All@@ -601,6 +604,7 @@ class PushWriter {
 }

 end(options) {
 getWriterSignal(options);
 const result = this.#queue.end();
 if (result === -2) {
 // Errored: reject with stored error
Expand Down

17 changes: 16 additions & 1 deletion
lib/internal/streams/iter/utils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,10 @@ const { isError } = require('internal/util');

const { isSharedArrayBuffer, isUint8Array } = require('internal/util/types');

const { validateOneOf } = require('internal/validators');
const {
 validateAbortSignal,
 validateOneOf,
} = require('internal/validators');

// Cached resolved promise to avoid allocating a new one on every sync fast-path.
const kResolvedPromise = PromiseResolve();
Expand DownExpand Up@@ -263,6 +266,17 @@ function convertChunks(chunks) {
 return result;
}

/**
 * Validate Writer options and return options.signal.
 * @param {object|undefined} options
 * @returns {AbortSignal|undefined}
 */
function getWriterSignal(options) {
 const signal = options?.signal;
 validateAbortSignal(signal, 'options.signal');
 return signal;
}

/**
 * Wrap a caught value as an Error, converting non-Error values.
 * @param {unknown} error
Expand DownExpand Up@@ -374,6 +388,7 @@ module.exports = {
 clampHWM,
 concatBytes,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 isPullOptions,
Expand Down

47 changes: 46 additions & 1 deletion
test/parallel/test-stream-iter-validation.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,9 @@

const common = require('../common');
const assert = require('assert');
const { Writable } = require('stream');
const {
 from, fromSync, pull, pullSync, pipeTo,
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
 push, duplex, broadcast, Broadcast, share, shareSync,
 Share, SyncShare,
 bytes, bytesSync, text, textSync,
Expand DownExpand Up@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push(42, {}), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push('bad', {}), { code: 'ERR_INVALID_ARG_TYPE' });

// Writer options.signal must be AbortSignal
{
 const { writer } = push();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// Writer.writev requires array
{
 const { writer } = push();
Expand DownExpand Up@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
assert.throws(() => broadcast({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG_VALUE' });

// BroadcastWriter options.signal must be AbortSignal
{
 const { writer } = broadcast();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// BroadcastWriter.writev requires array
{
 const { writer } = broadcast();
Expand All@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
// Broadcast.from rejects non-streamable input
assert.throws(() => Broadcast.from(42), { code: 'ERR_INVALID_ARG_TYPE' });

// fromWritable Writer options.signal must be AbortSignal
{
 const writable = new Writable({
 write(chunk, encoding, callback) {
 callback();
 },
 });
 const writer = fromWritable(writable);
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writable.destroy();
}

// =============================================================================
// share() / shareSync() validation
// =============================================================================
Expand Down
Loading

, '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: validate writer options signal#64385

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Jul 16, 2026
 Merged


stream: validate writer options signal
#64385
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


20 changes: 11 additions & 9 deletions
lib/internal/streams/iter/broadcast.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ const {
 kResolvedPromise,
 clampHWM,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 onSignalAbort,
Expand DownExpand Up@@ -526,41 +527,41 @@ class BroadcastWriter {
 return this.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
 }

 #canUseWriteFastPath(options) {
 return !options?.signal && !this.#isClosed() && !this.#aborted &&
 #canUseWriteFastPath(signal) {
 return !signal && !this.#isClosed() && !this.#aborted &&
 this.#broadcast[kCanWrite]();
 }

 write(chunk, options) {
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = toUint8Array(chunk);
 this.#broadcast[kWrite]([converted]);
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted);
 return kResolvedPromise;
 }
 return this.#writevSlow([chunk], options);
 return this.#writevSlow([chunk], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = convertChunks(chunks);
 this.#broadcast[kWrite](converted);
 for (let i = 0; i < converted.length; i++) {
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted[i]);
 }
 return kResolvedPromise;
 }
 return this.#writevSlow(chunks, options);
 return this.#writevSlow(chunks, signal);
 }

 async #writevSlow(chunks, options) {
 const signal = options?.signal;

 async #writevSlow(chunks, signal) {
 // Check for pre-aborted
 signal?.throwIfAborted();

Expand DownExpand Up@@ -623,6 +624,7 @@ class BroadcastWriter {

 // end() is synchronous internally - signal accepted for interface compliance.
 end(options) {
 getWriterSignal(options);
 if (this.#isClosed()) return this.#closed;
 this.#closed = PromiseResolve(this.#totalBytes);
 this.#broadcast[kEnd]();
Expand Down

19 changes: 12 additions & 7 deletions
lib/internal/streams/iter/classic.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@ const {
} = require('internal/streams/iter/types');

const {
 getWriterSignal,
 validateBackpressure,
 toUint8Array,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
 // as 'error' events caught by our generic error handler, rejecting
 // the next pending operation rather than the already-resolved one.
 //
 // The options.signal parameter from the Writer interface is ignored.
 // Classic stream.Writable has no per-write abort signal support;
 // cancellation should be handled at the pipeline level instead.
 write(chunk) {
 // The options.signal parameter from the Writer interface is validated but
 // otherwise ignored. Classic stream.Writable has no per-write abort signal
 // support; cancellation should be handled at the pipeline level instead.
 write(chunk, options) {
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
 return PromiseResolve();
 },

 writev(chunks) {
 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
 return -1;
 },

 // options.signal is ignored for the same reason as write().
 end() {
 // options.signal is validated but otherwise ignored for the same reason as
 // write().
 end(options) {
 getWriterSignal(options);
 if ((writable.writableFinished ?? false) ||
 (writable.destroyed ?? false)) {
 cleanup();
Expand Down

12 changes: 8 additions & 4 deletions
lib/internal/streams/iter/push.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const {
 onSignalAbort,
 toUint8Array,
 convertChunks,
 getWriterSignal,
 parsePullArgs,
 validateBackpressure,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -565,26 +566,28 @@ class PushWriter {
 }

 write(chunk, options) {
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = toUint8Array(chunk);
 this.#queue.writeSync([bytes]);
 return kResolvedPromise;
 }
 const bytes = toUint8Array(chunk);
 return this.#queue.writeAsync([bytes], options?.signal);
 return this.#queue.writeAsync([bytes], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = convertChunks(chunks);
 this.#queue.writeSync(bytes);
 return kResolvedPromise;
 }
 const bytes = convertChunks(chunks);
 return this.#queue.writeAsync(bytes, options?.signal);
 return this.#queue.writeAsync(bytes, signal);
 }

 writeSync(chunk) {
Expand All@@ -601,6 +604,7 @@ class PushWriter {
 }

 end(options) {
 getWriterSignal(options);
 const result = this.#queue.end();
 if (result === -2) {
 // Errored: reject with stored error
Expand Down

17 changes: 16 additions & 1 deletion
lib/internal/streams/iter/utils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,10 @@ const { isError } = require('internal/util');

const { isSharedArrayBuffer, isUint8Array } = require('internal/util/types');

const { validateOneOf } = require('internal/validators');
const {
 validateAbortSignal,
 validateOneOf,
} = require('internal/validators');

// Cached resolved promise to avoid allocating a new one on every sync fast-path.
const kResolvedPromise = PromiseResolve();
Expand DownExpand Up@@ -263,6 +266,17 @@ function convertChunks(chunks) {
 return result;
}

/**
 * Validate Writer options and return options.signal.
 * @param {object|undefined} options
 * @returns {AbortSignal|undefined}
 */
function getWriterSignal(options) {
 const signal = options?.signal;
 validateAbortSignal(signal, 'options.signal');
 return signal;
}

/**
 * Wrap a caught value as an Error, converting non-Error values.
 * @param {unknown} error
Expand DownExpand Up@@ -374,6 +388,7 @@ module.exports = {
 clampHWM,
 concatBytes,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 isPullOptions,
Expand Down

47 changes: 46 additions & 1 deletion
test/parallel/test-stream-iter-validation.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,9 @@

const common = require('../common');
const assert = require('assert');
const { Writable } = require('stream');
const {
 from, fromSync, pull, pullSync, pipeTo,
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
 push, duplex, broadcast, Broadcast, share, shareSync,
 Share, SyncShare,
 bytes, bytesSync, text, textSync,
Expand DownExpand Up@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push(42, {}), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push('bad', {}), { code: 'ERR_INVALID_ARG_TYPE' });

// Writer options.signal must be AbortSignal
{
 const { writer } = push();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// Writer.writev requires array
{
 const { writer } = push();
Expand DownExpand Up@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
assert.throws(() => broadcast({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG_VALUE' });

// BroadcastWriter options.signal must be AbortSignal
{
 const { writer } = broadcast();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// BroadcastWriter.writev requires array
{
 const { writer } = broadcast();
Expand All@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
// Broadcast.from rejects non-streamable input
assert.throws(() => Broadcast.from(42), { code: 'ERR_INVALID_ARG_TYPE' });

// fromWritable Writer options.signal must be AbortSignal
{
 const writable = new Writable({
 write(chunk, encoding, callback) {
 callback();
 },
 });
 const writer = fromWritable(writable);
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writable.destroy();
}

// =============================================================================
// share() / shareSync() validation
// =============================================================================
Expand Down
Loading

, '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: validate writer options signal#64385

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Jul 16, 2026
 Merged


stream: validate writer options signal
#64385
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


20 changes: 11 additions & 9 deletions
lib/internal/streams/iter/broadcast.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ const {
 kResolvedPromise,
 clampHWM,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 onSignalAbort,
Expand DownExpand Up@@ -526,41 +527,41 @@ class BroadcastWriter {
 return this.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
 }

 #canUseWriteFastPath(options) {
 return !options?.signal && !this.#isClosed() && !this.#aborted &&
 #canUseWriteFastPath(signal) {
 return !signal && !this.#isClosed() && !this.#aborted &&
 this.#broadcast[kCanWrite]();
 }

 write(chunk, options) {
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = toUint8Array(chunk);
 this.#broadcast[kWrite]([converted]);
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted);
 return kResolvedPromise;
 }
 return this.#writevSlow([chunk], options);
 return this.#writevSlow([chunk], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = convertChunks(chunks);
 this.#broadcast[kWrite](converted);
 for (let i = 0; i < converted.length; i++) {
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted[i]);
 }
 return kResolvedPromise;
 }
 return this.#writevSlow(chunks, options);
 return this.#writevSlow(chunks, signal);
 }

 async #writevSlow(chunks, options) {
 const signal = options?.signal;

 async #writevSlow(chunks, signal) {
 // Check for pre-aborted
 signal?.throwIfAborted();

Expand DownExpand Up@@ -623,6 +624,7 @@ class BroadcastWriter {

 // end() is synchronous internally - signal accepted for interface compliance.
 end(options) {
 getWriterSignal(options);
 if (this.#isClosed()) return this.#closed;
 this.#closed = PromiseResolve(this.#totalBytes);
 this.#broadcast[kEnd]();
Expand Down

19 changes: 12 additions & 7 deletions
lib/internal/streams/iter/classic.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@ const {
} = require('internal/streams/iter/types');

const {
 getWriterSignal,
 validateBackpressure,
 toUint8Array,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
 // as 'error' events caught by our generic error handler, rejecting
 // the next pending operation rather than the already-resolved one.
 //
 // The options.signal parameter from the Writer interface is ignored.
 // Classic stream.Writable has no per-write abort signal support;
 // cancellation should be handled at the pipeline level instead.
 write(chunk) {
 // The options.signal parameter from the Writer interface is validated but
 // otherwise ignored. Classic stream.Writable has no per-write abort signal
 // support; cancellation should be handled at the pipeline level instead.
 write(chunk, options) {
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
 return PromiseResolve();
 },

 writev(chunks) {
 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
 return -1;
 },

 // options.signal is ignored for the same reason as write().
 end() {
 // options.signal is validated but otherwise ignored for the same reason as
 // write().
 end(options) {
 getWriterSignal(options);
 if ((writable.writableFinished ?? false) ||
 (writable.destroyed ?? false)) {
 cleanup();
Expand Down

12 changes: 8 additions & 4 deletions
lib/internal/streams/iter/push.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const {
 onSignalAbort,
 toUint8Array,
 convertChunks,
 getWriterSignal,
 parsePullArgs,
 validateBackpressure,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -565,26 +566,28 @@ class PushWriter {
 }

 write(chunk, options) {
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = toUint8Array(chunk);
 this.#queue.writeSync([bytes]);
 return kResolvedPromise;
 }
 const bytes = toUint8Array(chunk);
 return this.#queue.writeAsync([bytes], options?.signal);
 return this.#queue.writeAsync([bytes], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = convertChunks(chunks);
 this.#queue.writeSync(bytes);
 return kResolvedPromise;
 }
 const bytes = convertChunks(chunks);
 return this.#queue.writeAsync(bytes, options?.signal);
 return this.#queue.writeAsync(bytes, signal);
 }

 writeSync(chunk) {
Expand All@@ -601,6 +604,7 @@ class PushWriter {
 }

 end(options) {
 getWriterSignal(options);
 const result = this.#queue.end();
 if (result === -2) {
 // Errored: reject with stored error
Expand Down

17 changes: 16 additions & 1 deletion
lib/internal/streams/iter/utils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,10 @@ const { isError } = require('internal/util');

const { isSharedArrayBuffer, isUint8Array } = require('internal/util/types');

const { validateOneOf } = require('internal/validators');
const {
 validateAbortSignal,
 validateOneOf,
} = require('internal/validators');

// Cached resolved promise to avoid allocating a new one on every sync fast-path.
const kResolvedPromise = PromiseResolve();
Expand DownExpand Up@@ -263,6 +266,17 @@ function convertChunks(chunks) {
 return result;
}

/**
 * Validate Writer options and return options.signal.
 * @param {object|undefined} options
 * @returns {AbortSignal|undefined}
 */
function getWriterSignal(options) {
 const signal = options?.signal;
 validateAbortSignal(signal, 'options.signal');
 return signal;
}

/**
 * Wrap a caught value as an Error, converting non-Error values.
 * @param {unknown} error
Expand DownExpand Up@@ -374,6 +388,7 @@ module.exports = {
 clampHWM,
 concatBytes,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 isPullOptions,
Expand Down

47 changes: 46 additions & 1 deletion
test/parallel/test-stream-iter-validation.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,9 @@

const common = require('../common');
const assert = require('assert');
const { Writable } = require('stream');
const {
 from, fromSync, pull, pullSync, pipeTo,
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
 push, duplex, broadcast, Broadcast, share, shareSync,
 Share, SyncShare,
 bytes, bytesSync, text, textSync,
Expand DownExpand Up@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push(42, {}), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push('bad', {}), { code: 'ERR_INVALID_ARG_TYPE' });

// Writer options.signal must be AbortSignal
{
 const { writer } = push();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// Writer.writev requires array
{
 const { writer } = push();
Expand DownExpand Up@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
assert.throws(() => broadcast({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG_VALUE' });

// BroadcastWriter options.signal must be AbortSignal
{
 const { writer } = broadcast();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// BroadcastWriter.writev requires array
{
 const { writer } = broadcast();
Expand All@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
// Broadcast.from rejects non-streamable input
assert.throws(() => Broadcast.from(42), { code: 'ERR_INVALID_ARG_TYPE' });

// fromWritable Writer options.signal must be AbortSignal
{
 const writable = new Writable({
 write(chunk, encoding, callback) {
 callback();
 },
 });
 const writer = fromWritable(writable);
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writable.destroy();
}

// =============================================================================
// share() / shareSync() validation
// =============================================================================
Expand Down
Loading

, '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: validate writer options signal#64385

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

 Merged

nodejs-github-bot
merged 1 commit into

from

Jul 16, 2026
 Merged


stream: validate writer options signal
#64385
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


20 changes: 11 additions & 9 deletions
lib/internal/streams/iter/broadcast.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,6 +58,7 @@ const {
 kResolvedPromise,
 clampHWM,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 onSignalAbort,
Expand DownExpand Up@@ -526,41 +527,41 @@ class BroadcastWriter {
 return this.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
 }

 #canUseWriteFastPath(options) {
 return !options?.signal && !this.#isClosed() && !this.#aborted &&
 #canUseWriteFastPath(signal) {
 return !signal && !this.#isClosed() && !this.#aborted &&
 this.#broadcast[kCanWrite]();
 }

 write(chunk, options) {
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = toUint8Array(chunk);
 this.#broadcast[kWrite]([converted]);
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted);
 return kResolvedPromise;
 }
 return this.#writevSlow([chunk], options);
 return this.#writevSlow([chunk], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 const signal = getWriterSignal(options);
 // Fast path: no signal, writer open, buffer has space
 if (this.#canUseWriteFastPath(options)) {
 if (this.#canUseWriteFastPath(signal)) {
 const converted = convertChunks(chunks);
 this.#broadcast[kWrite](converted);
 for (let i = 0; i < converted.length; i++) {
 this.#totalBytes += TypedArrayPrototypeGetByteLength(converted[i]);
 }
 return kResolvedPromise;
 }
 return this.#writevSlow(chunks, options);
 return this.#writevSlow(chunks, signal);
 }

 async #writevSlow(chunks, options) {
 const signal = options?.signal;

 async #writevSlow(chunks, signal) {
 // Check for pre-aborted
 signal?.throwIfAborted();

Expand DownExpand Up@@ -623,6 +624,7 @@ class BroadcastWriter {

 // end() is synchronous internally - signal accepted for interface compliance.
 end(options) {
 getWriterSignal(options);
 if (this.#isClosed()) return this.#closed;
 this.#closed = PromiseResolve(this.#totalBytes);
 this.#broadcast[kEnd]();
Expand Down

19 changes: 12 additions & 7 deletions
lib/internal/streams/iter/classic.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -61,6 +61,7 @@ const {
} = require('internal/streams/iter/types');

const {
 getWriterSignal,
 validateBackpressure,
 toUint8Array,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
 // as 'error' events caught by our generic error handler, rejecting
 // the next pending operation rather than the already-resolved one.
 //
 // The options.signal parameter from the Writer interface is ignored.
 // Classic stream.Writable has no per-write abort signal support;
 // cancellation should be handled at the pipeline level instead.
 write(chunk) {
 // The options.signal parameter from the Writer interface is validated but
 // otherwise ignored. Classic stream.Writable has no per-write abort signal
 // support; cancellation should be handled at the pipeline level instead.
 write(chunk, options) {
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
 return PromiseResolve();
 },

 writev(chunks) {
 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 getWriterSignal(options);
 if (!isWritable()) {
 return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
 }
Expand DownExpand Up@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
 return -1;
 },

 // options.signal is ignored for the same reason as write().
 end() {
 // options.signal is validated but otherwise ignored for the same reason as
 // write().
 end(options) {
 getWriterSignal(options);
 if ((writable.writableFinished ?? false) ||
 (writable.destroyed ?? false)) {
 cleanup();
Expand Down

12 changes: 8 additions & 4 deletions
lib/internal/streams/iter/push.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,6 +42,7 @@ const {
 onSignalAbort,
 toUint8Array,
 convertChunks,
 getWriterSignal,
 parsePullArgs,
 validateBackpressure,
} = require('internal/streams/iter/utils');
Expand DownExpand Up@@ -565,26 +566,28 @@ class PushWriter {
 }

 write(chunk, options) {
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = toUint8Array(chunk);
 this.#queue.writeSync([bytes]);
 return kResolvedPromise;
 }
 const bytes = toUint8Array(chunk);
 return this.#queue.writeAsync([bytes], options?.signal);
 return this.#queue.writeAsync([bytes], signal);
 }

 writev(chunks, options) {
 if (!ArrayIsArray(chunks)) {
 throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
 }
 if (!options?.signal && this.#queue.canWriteSync()) {
 const signal = getWriterSignal(options);
 if (!signal && this.#queue.canWriteSync()) {
 const bytes = convertChunks(chunks);
 this.#queue.writeSync(bytes);
 return kResolvedPromise;
 }
 const bytes = convertChunks(chunks);
 return this.#queue.writeAsync(bytes, options?.signal);
 return this.#queue.writeAsync(bytes, signal);
 }

 writeSync(chunk) {
Expand All@@ -601,6 +604,7 @@ class PushWriter {
 }

 end(options) {
 getWriterSignal(options);
 const result = this.#queue.end();
 if (result === -2) {
 // Errored: reject with stored error
Expand Down

17 changes: 16 additions & 1 deletion
lib/internal/streams/iter/utils.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,10 @@ const { isError } = require('internal/util');

const { isSharedArrayBuffer, isUint8Array } = require('internal/util/types');

const { validateOneOf } = require('internal/validators');
const {
 validateAbortSignal,
 validateOneOf,
} = require('internal/validators');

// Cached resolved promise to avoid allocating a new one on every sync fast-path.
const kResolvedPromise = PromiseResolve();
Expand DownExpand Up@@ -263,6 +266,17 @@ function convertChunks(chunks) {
 return result;
}

/**
 * Validate Writer options and return options.signal.
 * @param {object|undefined} options
 * @returns {AbortSignal|undefined}
 */
function getWriterSignal(options) {
 const signal = options?.signal;
 validateAbortSignal(signal, 'options.signal');
 return signal;
}

/**
 * Wrap a caught value as an Error, converting non-Error values.
 * @param {unknown} error
Expand DownExpand Up@@ -374,6 +388,7 @@ module.exports = {
 clampHWM,
 concatBytes,
 convertChunks,
 getWriterSignal,
 getMinCursor,
 hasProtocol,
 isPullOptions,
Expand Down

47 changes: 46 additions & 1 deletion
test/parallel/test-stream-iter-validation.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,8 +3,9 @@

const common = require('../common');
const assert = require('assert');
const { Writable } = require('stream');
const {
 from, fromSync, pull, pullSync, pipeTo,
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
 push, duplex, broadcast, Broadcast, share, shareSync,
 Share, SyncShare,
 bytes, bytesSync, text, textSync,
Expand DownExpand Up@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push(42, {}), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => push('bad', {}), { code: 'ERR_INVALID_ARG_TYPE' });

// Writer options.signal must be AbortSignal
{
 const { writer } = push();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// Writer.writev requires array
{
 const { writer } = push();
Expand DownExpand Up@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
assert.throws(() => broadcast({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG_VALUE' });

// BroadcastWriter options.signal must be AbortSignal
{
 const { writer } = broadcast();
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writer.endSync();
}

// BroadcastWriter.writev requires array
{
 const { writer } = broadcast();
Expand All@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
// Broadcast.from rejects non-streamable input
assert.throws(() => Broadcast.from(42), { code: 'ERR_INVALID_ARG_TYPE' });

// fromWritable Writer options.signal must be AbortSignal
{
 const writable = new Writable({
 write(chunk, encoding, callback) {
 callback();
 },
 });
 const writer = fromWritable(writable);
 const badOptions = { signal: 'bad' };
 assert.throws(() => writer.write('a', badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.writev(['b'], badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 assert.throws(() => writer.end(badOptions),
 { code: 'ERR_INVALID_ARG_TYPE' });
 writable.destroy();
}

// =============================================================================
// share() / shareSync() validation
// =============================================================================
Expand Down
Loading