Commit 2a3babb

Browse files
trivikraduh95
trivikr
authored and
aduh95
committed
stream: validate writer options signal
Validate options.signal for stream/iter writer write(), writev(), and end() methods across push, broadcast, and fromWritable. Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com> Assisted-by: openai:gpt-5.5 PR-URL: #64385Fixes: #64384 Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0ab8f26 commit 2a3babb

5 files changed

Lines changed: 93 additions & 22 deletions

File tree

‎lib/internal/streams/iter/broadcast.js‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ const {
5858
kResolvedPromise,
5959
clampHWM,
6060
convertChunks,
61+
getWriterSignal,
6162
getMinCursor,
6263
hasProtocol,
6364
onSignalAbort,
@@ -526,41 +527,41 @@ class BroadcastWriter {
526527
returnthis.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
527528
}
528529

529-
#canUseWriteFastPath(options){
530-
return!options?.signal&&!this.#isClosed()&&!this.#aborted &&
530+
#canUseWriteFastPath(signal){
531+
return!signal&&!this.#isClosed()&&!this.#aborted &&
531532
this.#broadcast[kCanWrite]();
532533
}
533534

534535
write(chunk,options){
536+
constsignal=getWriterSignal(options);
535537
// Fast path: no signal, writer open, buffer has space
536-
if(this.#canUseWriteFastPath(options)){
538+
if(this.#canUseWriteFastPath(signal)){
537539
constconverted=toUint8Array(chunk);
538540
this.#broadcast[kWrite]([converted]);
539541
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted);
540542
returnkResolvedPromise;
541543
}
542-
returnthis.#writevSlow([chunk],options);
544+
returnthis.#writevSlow([chunk],signal);
543545
}
544546

545547
writev(chunks,options){
546548
if(!ArrayIsArray(chunks)){
547549
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
548550
}
551+
constsignal=getWriterSignal(options);
549552
// Fast path: no signal, writer open, buffer has space
550-
if(this.#canUseWriteFastPath(options)){
553+
if(this.#canUseWriteFastPath(signal)){
551554
constconverted=convertChunks(chunks);
552555
this.#broadcast[kWrite](converted);
553556
for(leti=0;i<converted.length;i++){
554557
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted[i]);
555558
}
556559
returnkResolvedPromise;
557560
}
558-
returnthis.#writevSlow(chunks,options);
561+
returnthis.#writevSlow(chunks,signal);
559562
}
560563

561-
async #writevSlow(chunks,options){
562-
constsignal=options?.signal;
563-
564+
async #writevSlow(chunks,signal){
564565
// Check for pre-aborted
565566
signal?.throwIfAborted();
566567

@@ -623,6 +624,7 @@ class BroadcastWriter {
623624

624625
// end() is synchronous internally - signal accepted for interface compliance.
625626
end(options){
627+
getWriterSignal(options);
626628
if(this.#isClosed())returnthis.#closed;
627629
this.#closed =PromiseResolve(this.#totalBytes);
628630
this.#broadcast[kEnd]();

‎lib/internal/streams/iter/classic.js‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ const {
6161
}=require('internal/streams/iter/types');
6262

6363
const{
64+
getWriterSignal,
6465
validateBackpressure,
6566
toUint8Array,
6667
}=require('internal/streams/iter/utils');
@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
572573
// as 'error' events caught by our generic error handler, rejecting
573574
// the next pending operation rather than the already-resolved one.
574575
//
575-
// The options.signal parameter from the Writer interface is ignored.
576-
// Classic stream.Writable has no per-write abort signal support;
577-
// cancellation should be handled at the pipeline level instead.
578-
write(chunk){
576+
// The options.signal parameter from the Writer interface is validated but
577+
// otherwise ignored. Classic stream.Writable has no per-write abort signal
578+
// support; cancellation should be handled at the pipeline level instead.
579+
write(chunk,options){
580+
getWriterSignal(options);
579581
if(!isWritable()){
580582
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
581583
}
@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
617619
returnPromiseResolve();
618620
},
619621

620-
writev(chunks){
622+
writev(chunks,options){
621623
if(!ArrayIsArray(chunks)){
622624
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
623625
}
626+
getWriterSignal(options);
624627
if(!isWritable()){
625628
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
626629
}
@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
666669
return-1;
667670
},
668671

669-
// options.signal is ignored for the same reason as write().
670-
end(){
672+
// options.signal is validated but otherwise ignored for the same reason as
673+
// write().
674+
end(options){
675+
getWriterSignal(options);
671676
if((writable.writableFinished??false)||
672677
(writable.destroyed??false)){
673678
cleanup();

‎lib/internal/streams/iter/push.js‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const {
4242
onSignalAbort,
4343
toUint8Array,
4444
convertChunks,
45+
getWriterSignal,
4546
parsePullArgs,
4647
validateBackpressure,
4748
}=require('internal/streams/iter/utils');
@@ -565,26 +566,28 @@ class PushWriter {
565566
}
566567

567568
write(chunk,options){
568-
if(!options?.signal&&this.#queue.canWriteSync()){
569+
constsignal=getWriterSignal(options);
570+
if(!signal&&this.#queue.canWriteSync()){
569571
constbytes=toUint8Array(chunk);
570572
this.#queue.writeSync([bytes]);
571573
returnkResolvedPromise;
572574
}
573575
constbytes=toUint8Array(chunk);
574-
returnthis.#queue.writeAsync([bytes],options?.signal);
576+
returnthis.#queue.writeAsync([bytes],signal);
575577
}
576578

577579
writev(chunks,options){
578580
if(!ArrayIsArray(chunks)){
579581
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
580582
}
581-
if(!options?.signal&&this.#queue.canWriteSync()){
583+
constsignal=getWriterSignal(options);
584+
if(!signal&&this.#queue.canWriteSync()){
582585
constbytes=convertChunks(chunks);
583586
this.#queue.writeSync(bytes);
584587
returnkResolvedPromise;
585588
}
586589
constbytes=convertChunks(chunks);
587-
returnthis.#queue.writeAsync(bytes,options?.signal);
590+
returnthis.#queue.writeAsync(bytes,signal);
588591
}
589592

590593
writeSync(chunk){
@@ -601,6 +604,7 @@ class PushWriter {
601604
}
602605

603606
end(options){
607+
getWriterSignal(options);
604608
constresult=this.#queue.end();
605609
if(result===-2){
606610
// Errored: reject with stored error

‎lib/internal/streams/iter/utils.js‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ const { isError } = require('internal/util');
3535

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

38-
const{ validateOneOf }=require('internal/validators');
38+
const{
39+
validateAbortSignal,
40+
validateOneOf,
41+
}=require('internal/validators');
3942

4043
// Cached resolved promise to avoid allocating a new one on every sync fast-path.
4144
constkResolvedPromise=PromiseResolve();
@@ -267,6 +270,17 @@ function convertChunks(chunks) {
267270
returnresult;
268271
}
269272

273+
/**
274+
* Validate Writer options and return options.signal.
275+
* @param {object|undefined} options
276+
* @returns {AbortSignal|undefined}
277+
*/
278+
functiongetWriterSignal(options){
279+
constsignal=options?.signal;
280+
validateAbortSignal(signal,'options.signal');
281+
returnsignal;
282+
}
283+
270284
/**
271285
* Wrap a caught value as an Error, converting non-Error values.
272286
* @param {unknown} error
@@ -378,6 +392,7 @@ module.exports = {
378392
clampHWM,
379393
concatBytes,
380394
convertChunks,
395+
getWriterSignal,
381396
getMinCursor,
382397
hasProtocol,
383398
isPullOptions,

‎test/parallel/test-stream-iter-validation.js‎

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
constcommon=require('../common');
55
constassert=require('assert');
6+
const{ Writable }=require('stream');
67
const{
7-
from, fromSync, pull, pullSync, pipeTo,
8+
from, fromSync, pull, pullSync, pipeTo, fromWritable,
89
push, duplex, broadcast, Broadcast, share, shareSync,
910
Share, SyncShare,
1011
bytes, bytesSync, text, textSync,
@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
4243
assert.throws(()=>push(42,{}),{code: 'ERR_INVALID_ARG_TYPE'});
4344
assert.throws(()=>push('bad',{}),{code: 'ERR_INVALID_ARG_TYPE'});
4445

46+
// Writer options.signal must be AbortSignal
47+
{
48+
const{ writer }=push();
49+
constbadOptions={signal: 'bad'};
50+
assert.throws(()=>writer.write('a',badOptions),
51+
{code: 'ERR_INVALID_ARG_TYPE'});
52+
assert.throws(()=>writer.writev(['b'],badOptions),
53+
{code: 'ERR_INVALID_ARG_TYPE'});
54+
assert.throws(()=>writer.end(badOptions),
55+
{code: 'ERR_INVALID_ARG_TYPE'});
56+
writer.endSync();
57+
}
58+
4559
// Writer.writev requires array
4660
{
4761
const{ writer }=push();
@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
147161
assert.throws(()=>broadcast({signal: {}}),{code: 'ERR_INVALID_ARG_TYPE'});
148162
assert.throws(()=>broadcast({backpressure: 'bad'}),{code: 'ERR_INVALID_ARG_VALUE'});
149163

164+
// BroadcastWriter options.signal must be AbortSignal
165+
{
166+
const{ writer }=broadcast();
167+
constbadOptions={signal: 'bad'};
168+
assert.throws(()=>writer.write('a',badOptions),
169+
{code: 'ERR_INVALID_ARG_TYPE'});
170+
assert.throws(()=>writer.writev(['b'],badOptions),
171+
{code: 'ERR_INVALID_ARG_TYPE'});
172+
assert.throws(()=>writer.end(badOptions),
173+
{code: 'ERR_INVALID_ARG_TYPE'});
174+
writer.endSync();
175+
}
176+
150177
// BroadcastWriter.writev requires array
151178
{
152179
const{ writer }=broadcast();
@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
160187
// Broadcast.from rejects non-streamable input
161188
assert.throws(()=>Broadcast.from(42),{code: 'ERR_INVALID_ARG_TYPE'});
162189

190+
// fromWritable Writer options.signal must be AbortSignal
191+
{
192+
constwritable=newWritable({
193+
write(chunk,encoding,callback){
194+
callback();
195+
},
196+
});
197+
constwriter=fromWritable(writable);
198+
constbadOptions={signal: 'bad'};
199+
assert.throws(()=>writer.write('a',badOptions),
200+
{code: 'ERR_INVALID_ARG_TYPE'});
201+
assert.throws(()=>writer.writev(['b'],badOptions),
202+
{code: 'ERR_INVALID_ARG_TYPE'});
203+
assert.throws(()=>writer.end(badOptions),
204+
{code: 'ERR_INVALID_ARG_TYPE'});
205+
writable.destroy();
206+
}
207+
163208
// =============================================================================
164209
// share() / shareSync() validation
165210
// =============================================================================

0 commit comments

Comments
 (0)
, '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
Commit 2a3babb
Browse files
trivikraduh95
trivikr
authored and
aduh95
committed
stream: validate writer options signal
Validate options.signal for stream/iter writer write(), writev(),
and end() methods across push, broadcast, and fromWritable.
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
Assisted-by: openai:gpt-5.5
PR-URL: #64385Fixes: #64384
Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0ab8f26 commit 2a3babb
5 files changed
Lines changed: 93 additions & 22 deletions
File tree
‎lib/internal/streams/iter/broadcast.js‎
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ const {
5858
 kResolvedPromise,
5959
 clampHWM,
6060
 convertChunks,
61+
 getWriterSignal,
6162
 getMinCursor,
6263
 hasProtocol,
6364
 onSignalAbort,
@@ -526,41 +527,41 @@ class BroadcastWriter {
526527
returnthis.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
527528
}
528529

529-
 #canUseWriteFastPath(options){
530-
return!options?.signal&&!this.#isClosed()&&!this.#aborted &&
530+
 #canUseWriteFastPath(signal){
531+
return!signal&&!this.#isClosed()&&!this.#aborted &&
531532
this.#broadcast[kCanWrite]();
532533
}
533534

534535
write(chunk,options){
536+
constsignal=getWriterSignal(options);
535537
// Fast path: no signal, writer open, buffer has space
536-
if(this.#canUseWriteFastPath(options)){
538+
if(this.#canUseWriteFastPath(signal)){
537539
constconverted=toUint8Array(chunk);
538540
this.#broadcast[kWrite]([converted]);
539541
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted);
540542
returnkResolvedPromise;
541543
}
542-
returnthis.#writevSlow([chunk],options);
544+
returnthis.#writevSlow([chunk],signal);
543545
}
544546

545547
writev(chunks,options){
546548
if(!ArrayIsArray(chunks)){
547549
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
548550
}
551+
constsignal=getWriterSignal(options);
549552
// Fast path: no signal, writer open, buffer has space
550-
if(this.#canUseWriteFastPath(options)){
553+
if(this.#canUseWriteFastPath(signal)){
551554
constconverted=convertChunks(chunks);
552555
this.#broadcast[kWrite](converted);
553556
for(leti=0;i<converted.length;i++){
554557
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted[i]);
555558
}
556559
returnkResolvedPromise;
557560
}
558-
returnthis.#writevSlow(chunks,options);
561+
returnthis.#writevSlow(chunks,signal);
559562
}
560563

561-
async #writevSlow(chunks,options){
562-
constsignal=options?.signal;
563-
564+
async #writevSlow(chunks,signal){
564565
// Check for pre-aborted
565566
signal?.throwIfAborted();
566567

@@ -623,6 +624,7 @@ class BroadcastWriter {
623624

624625
// end() is synchronous internally - signal accepted for interface compliance.
625626
end(options){
627+
getWriterSignal(options);
626628
if(this.#isClosed())returnthis.#closed;
627629
this.#closed =PromiseResolve(this.#totalBytes);
628630
this.#broadcast[kEnd]();
‎lib/internal/streams/iter/classic.js‎
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ const {
6161
}=require('internal/streams/iter/types');
6262

6363
const{
64+
 getWriterSignal,
6465
 validateBackpressure,
6566
 toUint8Array,
6667
}=require('internal/streams/iter/utils');
@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
572573
// as 'error' events caught by our generic error handler, rejecting
573574
// the next pending operation rather than the already-resolved one.
574575
//
575-
// The options.signal parameter from the Writer interface is ignored.
576-
// Classic stream.Writable has no per-write abort signal support;
577-
// cancellation should be handled at the pipeline level instead.
578-
write(chunk){
576+
// The options.signal parameter from the Writer interface is validated but
577+
// otherwise ignored. Classic stream.Writable has no per-write abort signal
578+
// support; cancellation should be handled at the pipeline level instead.
579+
write(chunk,options){
580+
getWriterSignal(options);
579581
if(!isWritable()){
580582
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
581583
}
@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
617619
returnPromiseResolve();
618620
},
619621

620-
writev(chunks){
622+
writev(chunks,options){
621623
if(!ArrayIsArray(chunks)){
622624
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
623625
}
626+
getWriterSignal(options);
624627
if(!isWritable()){
625628
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
626629
}
@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
666669
return-1;
667670
},
668671

669-
// options.signal is ignored for the same reason as write().
670-
end(){
672+
// options.signal is validated but otherwise ignored for the same reason as
673+
// write().
674+
end(options){
675+
getWriterSignal(options);
671676
if((writable.writableFinished??false)||
672677
(writable.destroyed??false)){
673678
cleanup();
‎lib/internal/streams/iter/push.js‎
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const {
4242
 onSignalAbort,
4343
 toUint8Array,
4444
 convertChunks,
45+
 getWriterSignal,
4546
 parsePullArgs,
4647
 validateBackpressure,
4748
}=require('internal/streams/iter/utils');
@@ -565,26 +566,28 @@ class PushWriter {
565566
}
566567

567568
write(chunk,options){
568-
if(!options?.signal&&this.#queue.canWriteSync()){
569+
constsignal=getWriterSignal(options);
570+
if(!signal&&this.#queue.canWriteSync()){
569571
constbytes=toUint8Array(chunk);
570572
this.#queue.writeSync([bytes]);
571573
returnkResolvedPromise;
572574
}
573575
constbytes=toUint8Array(chunk);
574-
returnthis.#queue.writeAsync([bytes],options?.signal);
576+
returnthis.#queue.writeAsync([bytes],signal);
575577
}
576578

577579
writev(chunks,options){
578580
if(!ArrayIsArray(chunks)){
579581
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
580582
}
581-
if(!options?.signal&&this.#queue.canWriteSync()){
583+
constsignal=getWriterSignal(options);
584+
if(!signal&&this.#queue.canWriteSync()){
582585
constbytes=convertChunks(chunks);
583586
this.#queue.writeSync(bytes);
584587
returnkResolvedPromise;
585588
}
586589
constbytes=convertChunks(chunks);
587-
returnthis.#queue.writeAsync(bytes,options?.signal);
590+
returnthis.#queue.writeAsync(bytes,signal);
588591
}
589592

590593
writeSync(chunk){
@@ -601,6 +604,7 @@ class PushWriter {
601604
}
602605

603606
end(options){
607+
getWriterSignal(options);
604608
constresult=this.#queue.end();
605609
if(result===-2){
606610
// Errored: reject with stored error
‎lib/internal/streams/iter/utils.js‎
Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ const { isError } = require('internal/util');
3535

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

38-
const{ validateOneOf }=require('internal/validators');
38+
const{
39+
 validateAbortSignal,
40+
 validateOneOf,
41+
}=require('internal/validators');
3942

4043
// Cached resolved promise to avoid allocating a new one on every sync fast-path.
4144
constkResolvedPromise=PromiseResolve();
@@ -267,6 +270,17 @@ function convertChunks(chunks) {
267270
returnresult;
268271
}
269272

273+
/**
274+
 * Validate Writer options and return options.signal.
275+
 * @param {object|undefined} options
276+
 * @returns {AbortSignal|undefined}
277+
 */
278+
functiongetWriterSignal(options){
279+
constsignal=options?.signal;
280+
validateAbortSignal(signal,'options.signal');
281+
returnsignal;
282+
}
283+
270284
/**
271285
 * Wrap a caught value as an Error, converting non-Error values.
272286
 * @param {unknown} error
@@ -378,6 +392,7 @@ module.exports = {
378392
 clampHWM,
379393
 concatBytes,
380394
 convertChunks,
395+
 getWriterSignal,
381396
 getMinCursor,
382397
 hasProtocol,
383398
 isPullOptions,
‎test/parallel/test-stream-iter-validation.js‎
Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
constcommon=require('../common');
55
constassert=require('assert');
6+
const{ Writable }=require('stream');
67
const{
7-
 from, fromSync, pull, pullSync, pipeTo,
8+
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
89
 push, duplex, broadcast, Broadcast, share, shareSync,
910
 Share, SyncShare,
1011
 bytes, bytesSync, text, textSync,
@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
4243
assert.throws(()=>push(42,{}),{code: 'ERR_INVALID_ARG_TYPE'});
4344
assert.throws(()=>push('bad',{}),{code: 'ERR_INVALID_ARG_TYPE'});
4445

46+
// Writer options.signal must be AbortSignal
47+
{
48+
const{ writer }=push();
49+
constbadOptions={signal: 'bad'};
50+
assert.throws(()=>writer.write('a',badOptions),
51+
{code: 'ERR_INVALID_ARG_TYPE'});
52+
assert.throws(()=>writer.writev(['b'],badOptions),
53+
{code: 'ERR_INVALID_ARG_TYPE'});
54+
assert.throws(()=>writer.end(badOptions),
55+
{code: 'ERR_INVALID_ARG_TYPE'});
56+
writer.endSync();
57+
}
58+
4559
// Writer.writev requires array
4660
{
4761
const{ writer }=push();
@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
147161
assert.throws(()=>broadcast({signal: {}}),{code: 'ERR_INVALID_ARG_TYPE'});
148162
assert.throws(()=>broadcast({backpressure: 'bad'}),{code: 'ERR_INVALID_ARG_VALUE'});
149163

164+
// BroadcastWriter options.signal must be AbortSignal
165+
{
166+
const{ writer }=broadcast();
167+
constbadOptions={signal: 'bad'};
168+
assert.throws(()=>writer.write('a',badOptions),
169+
{code: 'ERR_INVALID_ARG_TYPE'});
170+
assert.throws(()=>writer.writev(['b'],badOptions),
171+
{code: 'ERR_INVALID_ARG_TYPE'});
172+
assert.throws(()=>writer.end(badOptions),
173+
{code: 'ERR_INVALID_ARG_TYPE'});
174+
writer.endSync();
175+
}
176+
150177
// BroadcastWriter.writev requires array
151178
{
152179
const{ writer }=broadcast();
@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
160187
// Broadcast.from rejects non-streamable input
161188
assert.throws(()=>Broadcast.from(42),{code: 'ERR_INVALID_ARG_TYPE'});
162189

190+
// fromWritable Writer options.signal must be AbortSignal
191+
{
192+
constwritable=newWritable({
193+
write(chunk,encoding,callback){
194+
callback();
195+
},
196+
});
197+
constwriter=fromWritable(writable);
198+
constbadOptions={signal: 'bad'};
199+
assert.throws(()=>writer.write('a',badOptions),
200+
{code: 'ERR_INVALID_ARG_TYPE'});
201+
assert.throws(()=>writer.writev(['b'],badOptions),
202+
{code: 'ERR_INVALID_ARG_TYPE'});
203+
assert.throws(()=>writer.end(badOptions),
204+
{code: 'ERR_INVALID_ARG_TYPE'});
205+
writable.destroy();
206+
}
207+
163208
// =============================================================================
164209
// share() / shareSync() validation
165210
// =============================================================================
0 commit comments
Comments
 (0)

, '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
Commit 2a3babb
Browse files
trivikraduh95
trivikr
authored and
aduh95
committed
stream: validate writer options signal
Validate options.signal for stream/iter writer write(), writev(),
and end() methods across push, broadcast, and fromWritable.
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
Assisted-by: openai:gpt-5.5
PR-URL: #64385Fixes: #64384
Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0ab8f26 commit 2a3babb
5 files changed
Lines changed: 93 additions & 22 deletions
File tree
‎lib/internal/streams/iter/broadcast.js‎
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ const {
5858
 kResolvedPromise,
5959
 clampHWM,
6060
 convertChunks,
61+
 getWriterSignal,
6162
 getMinCursor,
6263
 hasProtocol,
6364
 onSignalAbort,
@@ -526,41 +527,41 @@ class BroadcastWriter {
526527
returnthis.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
527528
}
528529

529-
 #canUseWriteFastPath(options){
530-
return!options?.signal&&!this.#isClosed()&&!this.#aborted &&
530+
 #canUseWriteFastPath(signal){
531+
return!signal&&!this.#isClosed()&&!this.#aborted &&
531532
this.#broadcast[kCanWrite]();
532533
}
533534

534535
write(chunk,options){
536+
constsignal=getWriterSignal(options);
535537
// Fast path: no signal, writer open, buffer has space
536-
if(this.#canUseWriteFastPath(options)){
538+
if(this.#canUseWriteFastPath(signal)){
537539
constconverted=toUint8Array(chunk);
538540
this.#broadcast[kWrite]([converted]);
539541
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted);
540542
returnkResolvedPromise;
541543
}
542-
returnthis.#writevSlow([chunk],options);
544+
returnthis.#writevSlow([chunk],signal);
543545
}
544546

545547
writev(chunks,options){
546548
if(!ArrayIsArray(chunks)){
547549
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
548550
}
551+
constsignal=getWriterSignal(options);
549552
// Fast path: no signal, writer open, buffer has space
550-
if(this.#canUseWriteFastPath(options)){
553+
if(this.#canUseWriteFastPath(signal)){
551554
constconverted=convertChunks(chunks);
552555
this.#broadcast[kWrite](converted);
553556
for(leti=0;i<converted.length;i++){
554557
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted[i]);
555558
}
556559
returnkResolvedPromise;
557560
}
558-
returnthis.#writevSlow(chunks,options);
561+
returnthis.#writevSlow(chunks,signal);
559562
}
560563

561-
async #writevSlow(chunks,options){
562-
constsignal=options?.signal;
563-
564+
async #writevSlow(chunks,signal){
564565
// Check for pre-aborted
565566
signal?.throwIfAborted();
566567

@@ -623,6 +624,7 @@ class BroadcastWriter {
623624

624625
// end() is synchronous internally - signal accepted for interface compliance.
625626
end(options){
627+
getWriterSignal(options);
626628
if(this.#isClosed())returnthis.#closed;
627629
this.#closed =PromiseResolve(this.#totalBytes);
628630
this.#broadcast[kEnd]();
‎lib/internal/streams/iter/classic.js‎
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ const {
6161
}=require('internal/streams/iter/types');
6262

6363
const{
64+
 getWriterSignal,
6465
 validateBackpressure,
6566
 toUint8Array,
6667
}=require('internal/streams/iter/utils');
@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
572573
// as 'error' events caught by our generic error handler, rejecting
573574
// the next pending operation rather than the already-resolved one.
574575
//
575-
// The options.signal parameter from the Writer interface is ignored.
576-
// Classic stream.Writable has no per-write abort signal support;
577-
// cancellation should be handled at the pipeline level instead.
578-
write(chunk){
576+
// The options.signal parameter from the Writer interface is validated but
577+
// otherwise ignored. Classic stream.Writable has no per-write abort signal
578+
// support; cancellation should be handled at the pipeline level instead.
579+
write(chunk,options){
580+
getWriterSignal(options);
579581
if(!isWritable()){
580582
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
581583
}
@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
617619
returnPromiseResolve();
618620
},
619621

620-
writev(chunks){
622+
writev(chunks,options){
621623
if(!ArrayIsArray(chunks)){
622624
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
623625
}
626+
getWriterSignal(options);
624627
if(!isWritable()){
625628
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
626629
}
@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
666669
return-1;
667670
},
668671

669-
// options.signal is ignored for the same reason as write().
670-
end(){
672+
// options.signal is validated but otherwise ignored for the same reason as
673+
// write().
674+
end(options){
675+
getWriterSignal(options);
671676
if((writable.writableFinished??false)||
672677
(writable.destroyed??false)){
673678
cleanup();
‎lib/internal/streams/iter/push.js‎
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const {
4242
 onSignalAbort,
4343
 toUint8Array,
4444
 convertChunks,
45+
 getWriterSignal,
4546
 parsePullArgs,
4647
 validateBackpressure,
4748
}=require('internal/streams/iter/utils');
@@ -565,26 +566,28 @@ class PushWriter {
565566
}
566567

567568
write(chunk,options){
568-
if(!options?.signal&&this.#queue.canWriteSync()){
569+
constsignal=getWriterSignal(options);
570+
if(!signal&&this.#queue.canWriteSync()){
569571
constbytes=toUint8Array(chunk);
570572
this.#queue.writeSync([bytes]);
571573
returnkResolvedPromise;
572574
}
573575
constbytes=toUint8Array(chunk);
574-
returnthis.#queue.writeAsync([bytes],options?.signal);
576+
returnthis.#queue.writeAsync([bytes],signal);
575577
}
576578

577579
writev(chunks,options){
578580
if(!ArrayIsArray(chunks)){
579581
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
580582
}
581-
if(!options?.signal&&this.#queue.canWriteSync()){
583+
constsignal=getWriterSignal(options);
584+
if(!signal&&this.#queue.canWriteSync()){
582585
constbytes=convertChunks(chunks);
583586
this.#queue.writeSync(bytes);
584587
returnkResolvedPromise;
585588
}
586589
constbytes=convertChunks(chunks);
587-
returnthis.#queue.writeAsync(bytes,options?.signal);
590+
returnthis.#queue.writeAsync(bytes,signal);
588591
}
589592

590593
writeSync(chunk){
@@ -601,6 +604,7 @@ class PushWriter {
601604
}
602605

603606
end(options){
607+
getWriterSignal(options);
604608
constresult=this.#queue.end();
605609
if(result===-2){
606610
// Errored: reject with stored error
‎lib/internal/streams/iter/utils.js‎
Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ const { isError } = require('internal/util');
3535

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

38-
const{ validateOneOf }=require('internal/validators');
38+
const{
39+
 validateAbortSignal,
40+
 validateOneOf,
41+
}=require('internal/validators');
3942

4043
// Cached resolved promise to avoid allocating a new one on every sync fast-path.
4144
constkResolvedPromise=PromiseResolve();
@@ -267,6 +270,17 @@ function convertChunks(chunks) {
267270
returnresult;
268271
}
269272

273+
/**
274+
 * Validate Writer options and return options.signal.
275+
 * @param {object|undefined} options
276+
 * @returns {AbortSignal|undefined}
277+
 */
278+
functiongetWriterSignal(options){
279+
constsignal=options?.signal;
280+
validateAbortSignal(signal,'options.signal');
281+
returnsignal;
282+
}
283+
270284
/**
271285
 * Wrap a caught value as an Error, converting non-Error values.
272286
 * @param {unknown} error
@@ -378,6 +392,7 @@ module.exports = {
378392
 clampHWM,
379393
 concatBytes,
380394
 convertChunks,
395+
 getWriterSignal,
381396
 getMinCursor,
382397
 hasProtocol,
383398
 isPullOptions,
‎test/parallel/test-stream-iter-validation.js‎
Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
constcommon=require('../common');
55
constassert=require('assert');
6+
const{ Writable }=require('stream');
67
const{
7-
 from, fromSync, pull, pullSync, pipeTo,
8+
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
89
 push, duplex, broadcast, Broadcast, share, shareSync,
910
 Share, SyncShare,
1011
 bytes, bytesSync, text, textSync,
@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
4243
assert.throws(()=>push(42,{}),{code: 'ERR_INVALID_ARG_TYPE'});
4344
assert.throws(()=>push('bad',{}),{code: 'ERR_INVALID_ARG_TYPE'});
4445

46+
// Writer options.signal must be AbortSignal
47+
{
48+
const{ writer }=push();
49+
constbadOptions={signal: 'bad'};
50+
assert.throws(()=>writer.write('a',badOptions),
51+
{code: 'ERR_INVALID_ARG_TYPE'});
52+
assert.throws(()=>writer.writev(['b'],badOptions),
53+
{code: 'ERR_INVALID_ARG_TYPE'});
54+
assert.throws(()=>writer.end(badOptions),
55+
{code: 'ERR_INVALID_ARG_TYPE'});
56+
writer.endSync();
57+
}
58+
4559
// Writer.writev requires array
4660
{
4761
const{ writer }=push();
@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
147161
assert.throws(()=>broadcast({signal: {}}),{code: 'ERR_INVALID_ARG_TYPE'});
148162
assert.throws(()=>broadcast({backpressure: 'bad'}),{code: 'ERR_INVALID_ARG_VALUE'});
149163

164+
// BroadcastWriter options.signal must be AbortSignal
165+
{
166+
const{ writer }=broadcast();
167+
constbadOptions={signal: 'bad'};
168+
assert.throws(()=>writer.write('a',badOptions),
169+
{code: 'ERR_INVALID_ARG_TYPE'});
170+
assert.throws(()=>writer.writev(['b'],badOptions),
171+
{code: 'ERR_INVALID_ARG_TYPE'});
172+
assert.throws(()=>writer.end(badOptions),
173+
{code: 'ERR_INVALID_ARG_TYPE'});
174+
writer.endSync();
175+
}
176+
150177
// BroadcastWriter.writev requires array
151178
{
152179
const{ writer }=broadcast();
@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
160187
// Broadcast.from rejects non-streamable input
161188
assert.throws(()=>Broadcast.from(42),{code: 'ERR_INVALID_ARG_TYPE'});
162189

190+
// fromWritable Writer options.signal must be AbortSignal
191+
{
192+
constwritable=newWritable({
193+
write(chunk,encoding,callback){
194+
callback();
195+
},
196+
});
197+
constwriter=fromWritable(writable);
198+
constbadOptions={signal: 'bad'};
199+
assert.throws(()=>writer.write('a',badOptions),
200+
{code: 'ERR_INVALID_ARG_TYPE'});
201+
assert.throws(()=>writer.writev(['b'],badOptions),
202+
{code: 'ERR_INVALID_ARG_TYPE'});
203+
assert.throws(()=>writer.end(badOptions),
204+
{code: 'ERR_INVALID_ARG_TYPE'});
205+
writable.destroy();
206+
}
207+
163208
// =============================================================================
164209
// share() / shareSync() validation
165210
// =============================================================================
0 commit comments
Comments
 (0)

, '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
Commit 2a3babb
Browse files
trivikraduh95
trivikr
authored and
aduh95
committed
stream: validate writer options signal
Validate options.signal for stream/iter writer write(), writev(),
and end() methods across push, broadcast, and fromWritable.
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
Assisted-by: openai:gpt-5.5
PR-URL: #64385Fixes: #64384
Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0ab8f26 commit 2a3babb
5 files changed
Lines changed: 93 additions & 22 deletions
File tree
‎lib/internal/streams/iter/broadcast.js‎
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ const {
5858
 kResolvedPromise,
5959
 clampHWM,
6060
 convertChunks,
61+
 getWriterSignal,
6162
 getMinCursor,
6263
 hasProtocol,
6364
 onSignalAbort,
@@ -526,41 +527,41 @@ class BroadcastWriter {
526527
returnthis.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
527528
}
528529

529-
 #canUseWriteFastPath(options){
530-
return!options?.signal&&!this.#isClosed()&&!this.#aborted &&
530+
 #canUseWriteFastPath(signal){
531+
return!signal&&!this.#isClosed()&&!this.#aborted &&
531532
this.#broadcast[kCanWrite]();
532533
}
533534

534535
write(chunk,options){
536+
constsignal=getWriterSignal(options);
535537
// Fast path: no signal, writer open, buffer has space
536-
if(this.#canUseWriteFastPath(options)){
538+
if(this.#canUseWriteFastPath(signal)){
537539
constconverted=toUint8Array(chunk);
538540
this.#broadcast[kWrite]([converted]);
539541
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted);
540542
returnkResolvedPromise;
541543
}
542-
returnthis.#writevSlow([chunk],options);
544+
returnthis.#writevSlow([chunk],signal);
543545
}
544546

545547
writev(chunks,options){
546548
if(!ArrayIsArray(chunks)){
547549
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
548550
}
551+
constsignal=getWriterSignal(options);
549552
// Fast path: no signal, writer open, buffer has space
550-
if(this.#canUseWriteFastPath(options)){
553+
if(this.#canUseWriteFastPath(signal)){
551554
constconverted=convertChunks(chunks);
552555
this.#broadcast[kWrite](converted);
553556
for(leti=0;i<converted.length;i++){
554557
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted[i]);
555558
}
556559
returnkResolvedPromise;
557560
}
558-
returnthis.#writevSlow(chunks,options);
561+
returnthis.#writevSlow(chunks,signal);
559562
}
560563

561-
async #writevSlow(chunks,options){
562-
constsignal=options?.signal;
563-
564+
async #writevSlow(chunks,signal){
564565
// Check for pre-aborted
565566
signal?.throwIfAborted();
566567

@@ -623,6 +624,7 @@ class BroadcastWriter {
623624

624625
// end() is synchronous internally - signal accepted for interface compliance.
625626
end(options){
627+
getWriterSignal(options);
626628
if(this.#isClosed())returnthis.#closed;
627629
this.#closed =PromiseResolve(this.#totalBytes);
628630
this.#broadcast[kEnd]();
‎lib/internal/streams/iter/classic.js‎
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ const {
6161
}=require('internal/streams/iter/types');
6262

6363
const{
64+
 getWriterSignal,
6465
 validateBackpressure,
6566
 toUint8Array,
6667
}=require('internal/streams/iter/utils');
@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
572573
// as 'error' events caught by our generic error handler, rejecting
573574
// the next pending operation rather than the already-resolved one.
574575
//
575-
// The options.signal parameter from the Writer interface is ignored.
576-
// Classic stream.Writable has no per-write abort signal support;
577-
// cancellation should be handled at the pipeline level instead.
578-
write(chunk){
576+
// The options.signal parameter from the Writer interface is validated but
577+
// otherwise ignored. Classic stream.Writable has no per-write abort signal
578+
// support; cancellation should be handled at the pipeline level instead.
579+
write(chunk,options){
580+
getWriterSignal(options);
579581
if(!isWritable()){
580582
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
581583
}
@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
617619
returnPromiseResolve();
618620
},
619621

620-
writev(chunks){
622+
writev(chunks,options){
621623
if(!ArrayIsArray(chunks)){
622624
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
623625
}
626+
getWriterSignal(options);
624627
if(!isWritable()){
625628
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
626629
}
@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
666669
return-1;
667670
},
668671

669-
// options.signal is ignored for the same reason as write().
670-
end(){
672+
// options.signal is validated but otherwise ignored for the same reason as
673+
// write().
674+
end(options){
675+
getWriterSignal(options);
671676
if((writable.writableFinished??false)||
672677
(writable.destroyed??false)){
673678
cleanup();
‎lib/internal/streams/iter/push.js‎
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const {
4242
 onSignalAbort,
4343
 toUint8Array,
4444
 convertChunks,
45+
 getWriterSignal,
4546
 parsePullArgs,
4647
 validateBackpressure,
4748
}=require('internal/streams/iter/utils');
@@ -565,26 +566,28 @@ class PushWriter {
565566
}
566567

567568
write(chunk,options){
568-
if(!options?.signal&&this.#queue.canWriteSync()){
569+
constsignal=getWriterSignal(options);
570+
if(!signal&&this.#queue.canWriteSync()){
569571
constbytes=toUint8Array(chunk);
570572
this.#queue.writeSync([bytes]);
571573
returnkResolvedPromise;
572574
}
573575
constbytes=toUint8Array(chunk);
574-
returnthis.#queue.writeAsync([bytes],options?.signal);
576+
returnthis.#queue.writeAsync([bytes],signal);
575577
}
576578

577579
writev(chunks,options){
578580
if(!ArrayIsArray(chunks)){
579581
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
580582
}
581-
if(!options?.signal&&this.#queue.canWriteSync()){
583+
constsignal=getWriterSignal(options);
584+
if(!signal&&this.#queue.canWriteSync()){
582585
constbytes=convertChunks(chunks);
583586
this.#queue.writeSync(bytes);
584587
returnkResolvedPromise;
585588
}
586589
constbytes=convertChunks(chunks);
587-
returnthis.#queue.writeAsync(bytes,options?.signal);
590+
returnthis.#queue.writeAsync(bytes,signal);
588591
}
589592

590593
writeSync(chunk){
@@ -601,6 +604,7 @@ class PushWriter {
601604
}
602605

603606
end(options){
607+
getWriterSignal(options);
604608
constresult=this.#queue.end();
605609
if(result===-2){
606610
// Errored: reject with stored error
‎lib/internal/streams/iter/utils.js‎
Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ const { isError } = require('internal/util');
3535

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

38-
const{ validateOneOf }=require('internal/validators');
38+
const{
39+
 validateAbortSignal,
40+
 validateOneOf,
41+
}=require('internal/validators');
3942

4043
// Cached resolved promise to avoid allocating a new one on every sync fast-path.
4144
constkResolvedPromise=PromiseResolve();
@@ -267,6 +270,17 @@ function convertChunks(chunks) {
267270
returnresult;
268271
}
269272

273+
/**
274+
 * Validate Writer options and return options.signal.
275+
 * @param {object|undefined} options
276+
 * @returns {AbortSignal|undefined}
277+
 */
278+
functiongetWriterSignal(options){
279+
constsignal=options?.signal;
280+
validateAbortSignal(signal,'options.signal');
281+
returnsignal;
282+
}
283+
270284
/**
271285
 * Wrap a caught value as an Error, converting non-Error values.
272286
 * @param {unknown} error
@@ -378,6 +392,7 @@ module.exports = {
378392
 clampHWM,
379393
 concatBytes,
380394
 convertChunks,
395+
 getWriterSignal,
381396
 getMinCursor,
382397
 hasProtocol,
383398
 isPullOptions,
‎test/parallel/test-stream-iter-validation.js‎
Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
constcommon=require('../common');
55
constassert=require('assert');
6+
const{ Writable }=require('stream');
67
const{
7-
 from, fromSync, pull, pullSync, pipeTo,
8+
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
89
 push, duplex, broadcast, Broadcast, share, shareSync,
910
 Share, SyncShare,
1011
 bytes, bytesSync, text, textSync,
@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
4243
assert.throws(()=>push(42,{}),{code: 'ERR_INVALID_ARG_TYPE'});
4344
assert.throws(()=>push('bad',{}),{code: 'ERR_INVALID_ARG_TYPE'});
4445

46+
// Writer options.signal must be AbortSignal
47+
{
48+
const{ writer }=push();
49+
constbadOptions={signal: 'bad'};
50+
assert.throws(()=>writer.write('a',badOptions),
51+
{code: 'ERR_INVALID_ARG_TYPE'});
52+
assert.throws(()=>writer.writev(['b'],badOptions),
53+
{code: 'ERR_INVALID_ARG_TYPE'});
54+
assert.throws(()=>writer.end(badOptions),
55+
{code: 'ERR_INVALID_ARG_TYPE'});
56+
writer.endSync();
57+
}
58+
4559
// Writer.writev requires array
4660
{
4761
const{ writer }=push();
@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
147161
assert.throws(()=>broadcast({signal: {}}),{code: 'ERR_INVALID_ARG_TYPE'});
148162
assert.throws(()=>broadcast({backpressure: 'bad'}),{code: 'ERR_INVALID_ARG_VALUE'});
149163

164+
// BroadcastWriter options.signal must be AbortSignal
165+
{
166+
const{ writer }=broadcast();
167+
constbadOptions={signal: 'bad'};
168+
assert.throws(()=>writer.write('a',badOptions),
169+
{code: 'ERR_INVALID_ARG_TYPE'});
170+
assert.throws(()=>writer.writev(['b'],badOptions),
171+
{code: 'ERR_INVALID_ARG_TYPE'});
172+
assert.throws(()=>writer.end(badOptions),
173+
{code: 'ERR_INVALID_ARG_TYPE'});
174+
writer.endSync();
175+
}
176+
150177
// BroadcastWriter.writev requires array
151178
{
152179
const{ writer }=broadcast();
@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
160187
// Broadcast.from rejects non-streamable input
161188
assert.throws(()=>Broadcast.from(42),{code: 'ERR_INVALID_ARG_TYPE'});
162189

190+
// fromWritable Writer options.signal must be AbortSignal
191+
{
192+
constwritable=newWritable({
193+
write(chunk,encoding,callback){
194+
callback();
195+
},
196+
});
197+
constwriter=fromWritable(writable);
198+
constbadOptions={signal: 'bad'};
199+
assert.throws(()=>writer.write('a',badOptions),
200+
{code: 'ERR_INVALID_ARG_TYPE'});
201+
assert.throws(()=>writer.writev(['b'],badOptions),
202+
{code: 'ERR_INVALID_ARG_TYPE'});
203+
assert.throws(()=>writer.end(badOptions),
204+
{code: 'ERR_INVALID_ARG_TYPE'});
205+
writable.destroy();
206+
}
207+
163208
// =============================================================================
164209
// share() / shareSync() validation
165210
// =============================================================================
0 commit comments
Comments
 (0)

, '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
Commit 2a3babb
Browse files
trivikraduh95
trivikr
authored and
aduh95
committed
stream: validate writer options signal
Validate options.signal for stream/iter writer write(), writev(),
and end() methods across push, broadcast, and fromWritable.
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
Assisted-by: openai:gpt-5.5
PR-URL: #64385Fixes: #64384
Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0ab8f26 commit 2a3babb
5 files changed
Lines changed: 93 additions & 22 deletions
File tree
‎lib/internal/streams/iter/broadcast.js‎
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ const {
5858
 kResolvedPromise,
5959
 clampHWM,
6060
 convertChunks,
61+
 getWriterSignal,
6162
 getMinCursor,
6263
 hasProtocol,
6364
 onSignalAbort,
@@ -526,41 +527,41 @@ class BroadcastWriter {
526527
returnthis.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
527528
}
528529

529-
 #canUseWriteFastPath(options){
530-
return!options?.signal&&!this.#isClosed()&&!this.#aborted &&
530+
 #canUseWriteFastPath(signal){
531+
return!signal&&!this.#isClosed()&&!this.#aborted &&
531532
this.#broadcast[kCanWrite]();
532533
}
533534

534535
write(chunk,options){
536+
constsignal=getWriterSignal(options);
535537
// Fast path: no signal, writer open, buffer has space
536-
if(this.#canUseWriteFastPath(options)){
538+
if(this.#canUseWriteFastPath(signal)){
537539
constconverted=toUint8Array(chunk);
538540
this.#broadcast[kWrite]([converted]);
539541
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted);
540542
returnkResolvedPromise;
541543
}
542-
returnthis.#writevSlow([chunk],options);
544+
returnthis.#writevSlow([chunk],signal);
543545
}
544546

545547
writev(chunks,options){
546548
if(!ArrayIsArray(chunks)){
547549
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
548550
}
551+
constsignal=getWriterSignal(options);
549552
// Fast path: no signal, writer open, buffer has space
550-
if(this.#canUseWriteFastPath(options)){
553+
if(this.#canUseWriteFastPath(signal)){
551554
constconverted=convertChunks(chunks);
552555
this.#broadcast[kWrite](converted);
553556
for(leti=0;i<converted.length;i++){
554557
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted[i]);
555558
}
556559
returnkResolvedPromise;
557560
}
558-
returnthis.#writevSlow(chunks,options);
561+
returnthis.#writevSlow(chunks,signal);
559562
}
560563

561-
async #writevSlow(chunks,options){
562-
constsignal=options?.signal;
563-
564+
async #writevSlow(chunks,signal){
564565
// Check for pre-aborted
565566
signal?.throwIfAborted();
566567

@@ -623,6 +624,7 @@ class BroadcastWriter {
623624

624625
// end() is synchronous internally - signal accepted for interface compliance.
625626
end(options){
627+
getWriterSignal(options);
626628
if(this.#isClosed())returnthis.#closed;
627629
this.#closed =PromiseResolve(this.#totalBytes);
628630
this.#broadcast[kEnd]();
‎lib/internal/streams/iter/classic.js‎
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ const {
6161
}=require('internal/streams/iter/types');
6262

6363
const{
64+
 getWriterSignal,
6465
 validateBackpressure,
6566
 toUint8Array,
6667
}=require('internal/streams/iter/utils');
@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
572573
// as 'error' events caught by our generic error handler, rejecting
573574
// the next pending operation rather than the already-resolved one.
574575
//
575-
// The options.signal parameter from the Writer interface is ignored.
576-
// Classic stream.Writable has no per-write abort signal support;
577-
// cancellation should be handled at the pipeline level instead.
578-
write(chunk){
576+
// The options.signal parameter from the Writer interface is validated but
577+
// otherwise ignored. Classic stream.Writable has no per-write abort signal
578+
// support; cancellation should be handled at the pipeline level instead.
579+
write(chunk,options){
580+
getWriterSignal(options);
579581
if(!isWritable()){
580582
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
581583
}
@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
617619
returnPromiseResolve();
618620
},
619621

620-
writev(chunks){
622+
writev(chunks,options){
621623
if(!ArrayIsArray(chunks)){
622624
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
623625
}
626+
getWriterSignal(options);
624627
if(!isWritable()){
625628
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
626629
}
@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
666669
return-1;
667670
},
668671

669-
// options.signal is ignored for the same reason as write().
670-
end(){
672+
// options.signal is validated but otherwise ignored for the same reason as
673+
// write().
674+
end(options){
675+
getWriterSignal(options);
671676
if((writable.writableFinished??false)||
672677
(writable.destroyed??false)){
673678
cleanup();
‎lib/internal/streams/iter/push.js‎
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const {
4242
 onSignalAbort,
4343
 toUint8Array,
4444
 convertChunks,
45+
 getWriterSignal,
4546
 parsePullArgs,
4647
 validateBackpressure,
4748
}=require('internal/streams/iter/utils');
@@ -565,26 +566,28 @@ class PushWriter {
565566
}
566567

567568
write(chunk,options){
568-
if(!options?.signal&&this.#queue.canWriteSync()){
569+
constsignal=getWriterSignal(options);
570+
if(!signal&&this.#queue.canWriteSync()){
569571
constbytes=toUint8Array(chunk);
570572
this.#queue.writeSync([bytes]);
571573
returnkResolvedPromise;
572574
}
573575
constbytes=toUint8Array(chunk);
574-
returnthis.#queue.writeAsync([bytes],options?.signal);
576+
returnthis.#queue.writeAsync([bytes],signal);
575577
}
576578

577579
writev(chunks,options){
578580
if(!ArrayIsArray(chunks)){
579581
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
580582
}
581-
if(!options?.signal&&this.#queue.canWriteSync()){
583+
constsignal=getWriterSignal(options);
584+
if(!signal&&this.#queue.canWriteSync()){
582585
constbytes=convertChunks(chunks);
583586
this.#queue.writeSync(bytes);
584587
returnkResolvedPromise;
585588
}
586589
constbytes=convertChunks(chunks);
587-
returnthis.#queue.writeAsync(bytes,options?.signal);
590+
returnthis.#queue.writeAsync(bytes,signal);
588591
}
589592

590593
writeSync(chunk){
@@ -601,6 +604,7 @@ class PushWriter {
601604
}
602605

603606
end(options){
607+
getWriterSignal(options);
604608
constresult=this.#queue.end();
605609
if(result===-2){
606610
// Errored: reject with stored error
‎lib/internal/streams/iter/utils.js‎
Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ const { isError } = require('internal/util');
3535

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

38-
const{ validateOneOf }=require('internal/validators');
38+
const{
39+
 validateAbortSignal,
40+
 validateOneOf,
41+
}=require('internal/validators');
3942

4043
// Cached resolved promise to avoid allocating a new one on every sync fast-path.
4144
constkResolvedPromise=PromiseResolve();
@@ -267,6 +270,17 @@ function convertChunks(chunks) {
267270
returnresult;
268271
}
269272

273+
/**
274+
 * Validate Writer options and return options.signal.
275+
 * @param {object|undefined} options
276+
 * @returns {AbortSignal|undefined}
277+
 */
278+
functiongetWriterSignal(options){
279+
constsignal=options?.signal;
280+
validateAbortSignal(signal,'options.signal');
281+
returnsignal;
282+
}
283+
270284
/**
271285
 * Wrap a caught value as an Error, converting non-Error values.
272286
 * @param {unknown} error
@@ -378,6 +392,7 @@ module.exports = {
378392
 clampHWM,
379393
 concatBytes,
380394
 convertChunks,
395+
 getWriterSignal,
381396
 getMinCursor,
382397
 hasProtocol,
383398
 isPullOptions,
‎test/parallel/test-stream-iter-validation.js‎
Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
constcommon=require('../common');
55
constassert=require('assert');
6+
const{ Writable }=require('stream');
67
const{
7-
 from, fromSync, pull, pullSync, pipeTo,
8+
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
89
 push, duplex, broadcast, Broadcast, share, shareSync,
910
 Share, SyncShare,
1011
 bytes, bytesSync, text, textSync,
@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
4243
assert.throws(()=>push(42,{}),{code: 'ERR_INVALID_ARG_TYPE'});
4344
assert.throws(()=>push('bad',{}),{code: 'ERR_INVALID_ARG_TYPE'});
4445

46+
// Writer options.signal must be AbortSignal
47+
{
48+
const{ writer }=push();
49+
constbadOptions={signal: 'bad'};
50+
assert.throws(()=>writer.write('a',badOptions),
51+
{code: 'ERR_INVALID_ARG_TYPE'});
52+
assert.throws(()=>writer.writev(['b'],badOptions),
53+
{code: 'ERR_INVALID_ARG_TYPE'});
54+
assert.throws(()=>writer.end(badOptions),
55+
{code: 'ERR_INVALID_ARG_TYPE'});
56+
writer.endSync();
57+
}
58+
4559
// Writer.writev requires array
4660
{
4761
const{ writer }=push();
@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
147161
assert.throws(()=>broadcast({signal: {}}),{code: 'ERR_INVALID_ARG_TYPE'});
148162
assert.throws(()=>broadcast({backpressure: 'bad'}),{code: 'ERR_INVALID_ARG_VALUE'});
149163

164+
// BroadcastWriter options.signal must be AbortSignal
165+
{
166+
const{ writer }=broadcast();
167+
constbadOptions={signal: 'bad'};
168+
assert.throws(()=>writer.write('a',badOptions),
169+
{code: 'ERR_INVALID_ARG_TYPE'});
170+
assert.throws(()=>writer.writev(['b'],badOptions),
171+
{code: 'ERR_INVALID_ARG_TYPE'});
172+
assert.throws(()=>writer.end(badOptions),
173+
{code: 'ERR_INVALID_ARG_TYPE'});
174+
writer.endSync();
175+
}
176+
150177
// BroadcastWriter.writev requires array
151178
{
152179
const{ writer }=broadcast();
@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
160187
// Broadcast.from rejects non-streamable input
161188
assert.throws(()=>Broadcast.from(42),{code: 'ERR_INVALID_ARG_TYPE'});
162189

190+
// fromWritable Writer options.signal must be AbortSignal
191+
{
192+
constwritable=newWritable({
193+
write(chunk,encoding,callback){
194+
callback();
195+
},
196+
});
197+
constwriter=fromWritable(writable);
198+
constbadOptions={signal: 'bad'};
199+
assert.throws(()=>writer.write('a',badOptions),
200+
{code: 'ERR_INVALID_ARG_TYPE'});
201+
assert.throws(()=>writer.writev(['b'],badOptions),
202+
{code: 'ERR_INVALID_ARG_TYPE'});
203+
assert.throws(()=>writer.end(badOptions),
204+
{code: 'ERR_INVALID_ARG_TYPE'});
205+
writable.destroy();
206+
}
207+
163208
// =============================================================================
164209
// share() / shareSync() validation
165210
// =============================================================================
0 commit comments
Comments
 (0)

, '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
Commit 2a3babb
Browse files
trivikraduh95
trivikr
authored and
aduh95
committed
stream: validate writer options signal
Validate options.signal for stream/iter writer write(), writev(),
and end() methods across push, broadcast, and fromWritable.
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
Assisted-by: openai:gpt-5.5
PR-URL: #64385Fixes: #64384
Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0ab8f26 commit 2a3babb
5 files changed
Lines changed: 93 additions & 22 deletions
File tree
‎lib/internal/streams/iter/broadcast.js‎
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ const {
5858
 kResolvedPromise,
5959
 clampHWM,
6060
 convertChunks,
61+
 getWriterSignal,
6162
 getMinCursor,
6263
 hasProtocol,
6364
 onSignalAbort,
@@ -526,41 +527,41 @@ class BroadcastWriter {
526527
returnthis.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
527528
}
528529

529-
 #canUseWriteFastPath(options){
530-
return!options?.signal&&!this.#isClosed()&&!this.#aborted &&
530+
 #canUseWriteFastPath(signal){
531+
return!signal&&!this.#isClosed()&&!this.#aborted &&
531532
this.#broadcast[kCanWrite]();
532533
}
533534

534535
write(chunk,options){
536+
constsignal=getWriterSignal(options);
535537
// Fast path: no signal, writer open, buffer has space
536-
if(this.#canUseWriteFastPath(options)){
538+
if(this.#canUseWriteFastPath(signal)){
537539
constconverted=toUint8Array(chunk);
538540
this.#broadcast[kWrite]([converted]);
539541
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted);
540542
returnkResolvedPromise;
541543
}
542-
returnthis.#writevSlow([chunk],options);
544+
returnthis.#writevSlow([chunk],signal);
543545
}
544546

545547
writev(chunks,options){
546548
if(!ArrayIsArray(chunks)){
547549
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
548550
}
551+
constsignal=getWriterSignal(options);
549552
// Fast path: no signal, writer open, buffer has space
550-
if(this.#canUseWriteFastPath(options)){
553+
if(this.#canUseWriteFastPath(signal)){
551554
constconverted=convertChunks(chunks);
552555
this.#broadcast[kWrite](converted);
553556
for(leti=0;i<converted.length;i++){
554557
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted[i]);
555558
}
556559
returnkResolvedPromise;
557560
}
558-
returnthis.#writevSlow(chunks,options);
561+
returnthis.#writevSlow(chunks,signal);
559562
}
560563

561-
async #writevSlow(chunks,options){
562-
constsignal=options?.signal;
563-
564+
async #writevSlow(chunks,signal){
564565
// Check for pre-aborted
565566
signal?.throwIfAborted();
566567

@@ -623,6 +624,7 @@ class BroadcastWriter {
623624

624625
// end() is synchronous internally - signal accepted for interface compliance.
625626
end(options){
627+
getWriterSignal(options);
626628
if(this.#isClosed())returnthis.#closed;
627629
this.#closed =PromiseResolve(this.#totalBytes);
628630
this.#broadcast[kEnd]();
‎lib/internal/streams/iter/classic.js‎
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ const {
6161
}=require('internal/streams/iter/types');
6262

6363
const{
64+
 getWriterSignal,
6465
 validateBackpressure,
6566
 toUint8Array,
6667
}=require('internal/streams/iter/utils');
@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
572573
// as 'error' events caught by our generic error handler, rejecting
573574
// the next pending operation rather than the already-resolved one.
574575
//
575-
// The options.signal parameter from the Writer interface is ignored.
576-
// Classic stream.Writable has no per-write abort signal support;
577-
// cancellation should be handled at the pipeline level instead.
578-
write(chunk){
576+
// The options.signal parameter from the Writer interface is validated but
577+
// otherwise ignored. Classic stream.Writable has no per-write abort signal
578+
// support; cancellation should be handled at the pipeline level instead.
579+
write(chunk,options){
580+
getWriterSignal(options);
579581
if(!isWritable()){
580582
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
581583
}
@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
617619
returnPromiseResolve();
618620
},
619621

620-
writev(chunks){
622+
writev(chunks,options){
621623
if(!ArrayIsArray(chunks)){
622624
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
623625
}
626+
getWriterSignal(options);
624627
if(!isWritable()){
625628
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
626629
}
@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
666669
return-1;
667670
},
668671

669-
// options.signal is ignored for the same reason as write().
670-
end(){
672+
// options.signal is validated but otherwise ignored for the same reason as
673+
// write().
674+
end(options){
675+
getWriterSignal(options);
671676
if((writable.writableFinished??false)||
672677
(writable.destroyed??false)){
673678
cleanup();
‎lib/internal/streams/iter/push.js‎
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const {
4242
 onSignalAbort,
4343
 toUint8Array,
4444
 convertChunks,
45+
 getWriterSignal,
4546
 parsePullArgs,
4647
 validateBackpressure,
4748
}=require('internal/streams/iter/utils');
@@ -565,26 +566,28 @@ class PushWriter {
565566
}
566567

567568
write(chunk,options){
568-
if(!options?.signal&&this.#queue.canWriteSync()){
569+
constsignal=getWriterSignal(options);
570+
if(!signal&&this.#queue.canWriteSync()){
569571
constbytes=toUint8Array(chunk);
570572
this.#queue.writeSync([bytes]);
571573
returnkResolvedPromise;
572574
}
573575
constbytes=toUint8Array(chunk);
574-
returnthis.#queue.writeAsync([bytes],options?.signal);
576+
returnthis.#queue.writeAsync([bytes],signal);
575577
}
576578

577579
writev(chunks,options){
578580
if(!ArrayIsArray(chunks)){
579581
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
580582
}
581-
if(!options?.signal&&this.#queue.canWriteSync()){
583+
constsignal=getWriterSignal(options);
584+
if(!signal&&this.#queue.canWriteSync()){
582585
constbytes=convertChunks(chunks);
583586
this.#queue.writeSync(bytes);
584587
returnkResolvedPromise;
585588
}
586589
constbytes=convertChunks(chunks);
587-
returnthis.#queue.writeAsync(bytes,options?.signal);
590+
returnthis.#queue.writeAsync(bytes,signal);
588591
}
589592

590593
writeSync(chunk){
@@ -601,6 +604,7 @@ class PushWriter {
601604
}
602605

603606
end(options){
607+
getWriterSignal(options);
604608
constresult=this.#queue.end();
605609
if(result===-2){
606610
// Errored: reject with stored error
‎lib/internal/streams/iter/utils.js‎
Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ const { isError } = require('internal/util');
3535

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

38-
const{ validateOneOf }=require('internal/validators');
38+
const{
39+
 validateAbortSignal,
40+
 validateOneOf,
41+
}=require('internal/validators');
3942

4043
// Cached resolved promise to avoid allocating a new one on every sync fast-path.
4144
constkResolvedPromise=PromiseResolve();
@@ -267,6 +270,17 @@ function convertChunks(chunks) {
267270
returnresult;
268271
}
269272

273+
/**
274+
 * Validate Writer options and return options.signal.
275+
 * @param {object|undefined} options
276+
 * @returns {AbortSignal|undefined}
277+
 */
278+
functiongetWriterSignal(options){
279+
constsignal=options?.signal;
280+
validateAbortSignal(signal,'options.signal');
281+
returnsignal;
282+
}
283+
270284
/**
271285
 * Wrap a caught value as an Error, converting non-Error values.
272286
 * @param {unknown} error
@@ -378,6 +392,7 @@ module.exports = {
378392
 clampHWM,
379393
 concatBytes,
380394
 convertChunks,
395+
 getWriterSignal,
381396
 getMinCursor,
382397
 hasProtocol,
383398
 isPullOptions,
‎test/parallel/test-stream-iter-validation.js‎
Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
constcommon=require('../common');
55
constassert=require('assert');
6+
const{ Writable }=require('stream');
67
const{
7-
 from, fromSync, pull, pullSync, pipeTo,
8+
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
89
 push, duplex, broadcast, Broadcast, share, shareSync,
910
 Share, SyncShare,
1011
 bytes, bytesSync, text, textSync,
@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
4243
assert.throws(()=>push(42,{}),{code: 'ERR_INVALID_ARG_TYPE'});
4344
assert.throws(()=>push('bad',{}),{code: 'ERR_INVALID_ARG_TYPE'});
4445

46+
// Writer options.signal must be AbortSignal
47+
{
48+
const{ writer }=push();
49+
constbadOptions={signal: 'bad'};
50+
assert.throws(()=>writer.write('a',badOptions),
51+
{code: 'ERR_INVALID_ARG_TYPE'});
52+
assert.throws(()=>writer.writev(['b'],badOptions),
53+
{code: 'ERR_INVALID_ARG_TYPE'});
54+
assert.throws(()=>writer.end(badOptions),
55+
{code: 'ERR_INVALID_ARG_TYPE'});
56+
writer.endSync();
57+
}
58+
4559
// Writer.writev requires array
4660
{
4761
const{ writer }=push();
@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
147161
assert.throws(()=>broadcast({signal: {}}),{code: 'ERR_INVALID_ARG_TYPE'});
148162
assert.throws(()=>broadcast({backpressure: 'bad'}),{code: 'ERR_INVALID_ARG_VALUE'});
149163

164+
// BroadcastWriter options.signal must be AbortSignal
165+
{
166+
const{ writer }=broadcast();
167+
constbadOptions={signal: 'bad'};
168+
assert.throws(()=>writer.write('a',badOptions),
169+
{code: 'ERR_INVALID_ARG_TYPE'});
170+
assert.throws(()=>writer.writev(['b'],badOptions),
171+
{code: 'ERR_INVALID_ARG_TYPE'});
172+
assert.throws(()=>writer.end(badOptions),
173+
{code: 'ERR_INVALID_ARG_TYPE'});
174+
writer.endSync();
175+
}
176+
150177
// BroadcastWriter.writev requires array
151178
{
152179
const{ writer }=broadcast();
@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
160187
// Broadcast.from rejects non-streamable input
161188
assert.throws(()=>Broadcast.from(42),{code: 'ERR_INVALID_ARG_TYPE'});
162189

190+
// fromWritable Writer options.signal must be AbortSignal
191+
{
192+
constwritable=newWritable({
193+
write(chunk,encoding,callback){
194+
callback();
195+
},
196+
});
197+
constwriter=fromWritable(writable);
198+
constbadOptions={signal: 'bad'};
199+
assert.throws(()=>writer.write('a',badOptions),
200+
{code: 'ERR_INVALID_ARG_TYPE'});
201+
assert.throws(()=>writer.writev(['b'],badOptions),
202+
{code: 'ERR_INVALID_ARG_TYPE'});
203+
assert.throws(()=>writer.end(badOptions),
204+
{code: 'ERR_INVALID_ARG_TYPE'});
205+
writable.destroy();
206+
}
207+
163208
// =============================================================================
164209
// share() / shareSync() validation
165210
// =============================================================================
0 commit comments
Comments
 (0)

, '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
Commit 2a3babb
Browse files
trivikraduh95
trivikr
authored and
aduh95
committed
stream: validate writer options signal
Validate options.signal for stream/iter writer write(), writev(),
and end() methods across push, broadcast, and fromWritable.
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
Assisted-by: openai:gpt-5.5
PR-URL: #64385Fixes: #64384
Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0ab8f26 commit 2a3babb
5 files changed
Lines changed: 93 additions & 22 deletions
File tree
‎lib/internal/streams/iter/broadcast.js‎
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ const {
5858
 kResolvedPromise,
5959
 clampHWM,
6060
 convertChunks,
61+
 getWriterSignal,
6162
 getMinCursor,
6263
 hasProtocol,
6364
 onSignalAbort,
@@ -526,41 +527,41 @@ class BroadcastWriter {
526527
returnthis.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
527528
}
528529

529-
 #canUseWriteFastPath(options){
530-
return!options?.signal&&!this.#isClosed()&&!this.#aborted &&
530+
 #canUseWriteFastPath(signal){
531+
return!signal&&!this.#isClosed()&&!this.#aborted &&
531532
this.#broadcast[kCanWrite]();
532533
}
533534

534535
write(chunk,options){
536+
constsignal=getWriterSignal(options);
535537
// Fast path: no signal, writer open, buffer has space
536-
if(this.#canUseWriteFastPath(options)){
538+
if(this.#canUseWriteFastPath(signal)){
537539
constconverted=toUint8Array(chunk);
538540
this.#broadcast[kWrite]([converted]);
539541
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted);
540542
returnkResolvedPromise;
541543
}
542-
returnthis.#writevSlow([chunk],options);
544+
returnthis.#writevSlow([chunk],signal);
543545
}
544546

545547
writev(chunks,options){
546548
if(!ArrayIsArray(chunks)){
547549
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
548550
}
551+
constsignal=getWriterSignal(options);
549552
// Fast path: no signal, writer open, buffer has space
550-
if(this.#canUseWriteFastPath(options)){
553+
if(this.#canUseWriteFastPath(signal)){
551554
constconverted=convertChunks(chunks);
552555
this.#broadcast[kWrite](converted);
553556
for(leti=0;i<converted.length;i++){
554557
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted[i]);
555558
}
556559
returnkResolvedPromise;
557560
}
558-
returnthis.#writevSlow(chunks,options);
561+
returnthis.#writevSlow(chunks,signal);
559562
}
560563

561-
async #writevSlow(chunks,options){
562-
constsignal=options?.signal;
563-
564+
async #writevSlow(chunks,signal){
564565
// Check for pre-aborted
565566
signal?.throwIfAborted();
566567

@@ -623,6 +624,7 @@ class BroadcastWriter {
623624

624625
// end() is synchronous internally - signal accepted for interface compliance.
625626
end(options){
627+
getWriterSignal(options);
626628
if(this.#isClosed())returnthis.#closed;
627629
this.#closed =PromiseResolve(this.#totalBytes);
628630
this.#broadcast[kEnd]();
‎lib/internal/streams/iter/classic.js‎
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ const {
6161
}=require('internal/streams/iter/types');
6262

6363
const{
64+
 getWriterSignal,
6465
 validateBackpressure,
6566
 toUint8Array,
6667
}=require('internal/streams/iter/utils');
@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
572573
// as 'error' events caught by our generic error handler, rejecting
573574
// the next pending operation rather than the already-resolved one.
574575
//
575-
// The options.signal parameter from the Writer interface is ignored.
576-
// Classic stream.Writable has no per-write abort signal support;
577-
// cancellation should be handled at the pipeline level instead.
578-
write(chunk){
576+
// The options.signal parameter from the Writer interface is validated but
577+
// otherwise ignored. Classic stream.Writable has no per-write abort signal
578+
// support; cancellation should be handled at the pipeline level instead.
579+
write(chunk,options){
580+
getWriterSignal(options);
579581
if(!isWritable()){
580582
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
581583
}
@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
617619
returnPromiseResolve();
618620
},
619621

620-
writev(chunks){
622+
writev(chunks,options){
621623
if(!ArrayIsArray(chunks)){
622624
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
623625
}
626+
getWriterSignal(options);
624627
if(!isWritable()){
625628
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
626629
}
@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
666669
return-1;
667670
},
668671

669-
// options.signal is ignored for the same reason as write().
670-
end(){
672+
// options.signal is validated but otherwise ignored for the same reason as
673+
// write().
674+
end(options){
675+
getWriterSignal(options);
671676
if((writable.writableFinished??false)||
672677
(writable.destroyed??false)){
673678
cleanup();
‎lib/internal/streams/iter/push.js‎
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const {
4242
 onSignalAbort,
4343
 toUint8Array,
4444
 convertChunks,
45+
 getWriterSignal,
4546
 parsePullArgs,
4647
 validateBackpressure,
4748
}=require('internal/streams/iter/utils');
@@ -565,26 +566,28 @@ class PushWriter {
565566
}
566567

567568
write(chunk,options){
568-
if(!options?.signal&&this.#queue.canWriteSync()){
569+
constsignal=getWriterSignal(options);
570+
if(!signal&&this.#queue.canWriteSync()){
569571
constbytes=toUint8Array(chunk);
570572
this.#queue.writeSync([bytes]);
571573
returnkResolvedPromise;
572574
}
573575
constbytes=toUint8Array(chunk);
574-
returnthis.#queue.writeAsync([bytes],options?.signal);
576+
returnthis.#queue.writeAsync([bytes],signal);
575577
}
576578

577579
writev(chunks,options){
578580
if(!ArrayIsArray(chunks)){
579581
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
580582
}
581-
if(!options?.signal&&this.#queue.canWriteSync()){
583+
constsignal=getWriterSignal(options);
584+
if(!signal&&this.#queue.canWriteSync()){
582585
constbytes=convertChunks(chunks);
583586
this.#queue.writeSync(bytes);
584587
returnkResolvedPromise;
585588
}
586589
constbytes=convertChunks(chunks);
587-
returnthis.#queue.writeAsync(bytes,options?.signal);
590+
returnthis.#queue.writeAsync(bytes,signal);
588591
}
589592

590593
writeSync(chunk){
@@ -601,6 +604,7 @@ class PushWriter {
601604
}
602605

603606
end(options){
607+
getWriterSignal(options);
604608
constresult=this.#queue.end();
605609
if(result===-2){
606610
// Errored: reject with stored error
‎lib/internal/streams/iter/utils.js‎
Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ const { isError } = require('internal/util');
3535

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

38-
const{ validateOneOf }=require('internal/validators');
38+
const{
39+
 validateAbortSignal,
40+
 validateOneOf,
41+
}=require('internal/validators');
3942

4043
// Cached resolved promise to avoid allocating a new one on every sync fast-path.
4144
constkResolvedPromise=PromiseResolve();
@@ -267,6 +270,17 @@ function convertChunks(chunks) {
267270
returnresult;
268271
}
269272

273+
/**
274+
 * Validate Writer options and return options.signal.
275+
 * @param {object|undefined} options
276+
 * @returns {AbortSignal|undefined}
277+
 */
278+
functiongetWriterSignal(options){
279+
constsignal=options?.signal;
280+
validateAbortSignal(signal,'options.signal');
281+
returnsignal;
282+
}
283+
270284
/**
271285
 * Wrap a caught value as an Error, converting non-Error values.
272286
 * @param {unknown} error
@@ -378,6 +392,7 @@ module.exports = {
378392
 clampHWM,
379393
 concatBytes,
380394
 convertChunks,
395+
 getWriterSignal,
381396
 getMinCursor,
382397
 hasProtocol,
383398
 isPullOptions,
‎test/parallel/test-stream-iter-validation.js‎
Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
constcommon=require('../common');
55
constassert=require('assert');
6+
const{ Writable }=require('stream');
67
const{
7-
 from, fromSync, pull, pullSync, pipeTo,
8+
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
89
 push, duplex, broadcast, Broadcast, share, shareSync,
910
 Share, SyncShare,
1011
 bytes, bytesSync, text, textSync,
@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
4243
assert.throws(()=>push(42,{}),{code: 'ERR_INVALID_ARG_TYPE'});
4344
assert.throws(()=>push('bad',{}),{code: 'ERR_INVALID_ARG_TYPE'});
4445

46+
// Writer options.signal must be AbortSignal
47+
{
48+
const{ writer }=push();
49+
constbadOptions={signal: 'bad'};
50+
assert.throws(()=>writer.write('a',badOptions),
51+
{code: 'ERR_INVALID_ARG_TYPE'});
52+
assert.throws(()=>writer.writev(['b'],badOptions),
53+
{code: 'ERR_INVALID_ARG_TYPE'});
54+
assert.throws(()=>writer.end(badOptions),
55+
{code: 'ERR_INVALID_ARG_TYPE'});
56+
writer.endSync();
57+
}
58+
4559
// Writer.writev requires array
4660
{
4761
const{ writer }=push();
@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
147161
assert.throws(()=>broadcast({signal: {}}),{code: 'ERR_INVALID_ARG_TYPE'});
148162
assert.throws(()=>broadcast({backpressure: 'bad'}),{code: 'ERR_INVALID_ARG_VALUE'});
149163

164+
// BroadcastWriter options.signal must be AbortSignal
165+
{
166+
const{ writer }=broadcast();
167+
constbadOptions={signal: 'bad'};
168+
assert.throws(()=>writer.write('a',badOptions),
169+
{code: 'ERR_INVALID_ARG_TYPE'});
170+
assert.throws(()=>writer.writev(['b'],badOptions),
171+
{code: 'ERR_INVALID_ARG_TYPE'});
172+
assert.throws(()=>writer.end(badOptions),
173+
{code: 'ERR_INVALID_ARG_TYPE'});
174+
writer.endSync();
175+
}
176+
150177
// BroadcastWriter.writev requires array
151178
{
152179
const{ writer }=broadcast();
@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
160187
// Broadcast.from rejects non-streamable input
161188
assert.throws(()=>Broadcast.from(42),{code: 'ERR_INVALID_ARG_TYPE'});
162189

190+
// fromWritable Writer options.signal must be AbortSignal
191+
{
192+
constwritable=newWritable({
193+
write(chunk,encoding,callback){
194+
callback();
195+
},
196+
});
197+
constwriter=fromWritable(writable);
198+
constbadOptions={signal: 'bad'};
199+
assert.throws(()=>writer.write('a',badOptions),
200+
{code: 'ERR_INVALID_ARG_TYPE'});
201+
assert.throws(()=>writer.writev(['b'],badOptions),
202+
{code: 'ERR_INVALID_ARG_TYPE'});
203+
assert.throws(()=>writer.end(badOptions),
204+
{code: 'ERR_INVALID_ARG_TYPE'});
205+
writable.destroy();
206+
}
207+
163208
// =============================================================================
164209
// share() / shareSync() validation
165210
// =============================================================================
0 commit comments
Comments
 (0)

, '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
Commit 2a3babb
Browse files
trivikraduh95
trivikr
authored and
aduh95
committed
stream: validate writer options signal
Validate options.signal for stream/iter writer write(), writev(),
and end() methods across push, broadcast, and fromWritable.
Signed-off-by: Kamat, Trivikram <16024985+trivikr@users.noreply.github.com>
Assisted-by: openai:gpt-5.5
PR-URL: #64385Fixes: #64384
Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 0ab8f26 commit 2a3babb
5 files changed
Lines changed: 93 additions & 22 deletions
File tree
‎lib/internal/streams/iter/broadcast.js‎
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ const {
5858
 kResolvedPromise,
5959
 clampHWM,
6060
 convertChunks,
61+
 getWriterSignal,
6162
 getMinCursor,
6263
 hasProtocol,
6364
 onSignalAbort,
@@ -526,41 +527,41 @@ class BroadcastWriter {
526527
returnthis.#isClosedOrAborted() ? null : this.#broadcast[kGetDesiredSize]();
527528
}
528529

529-
 #canUseWriteFastPath(options){
530-
return!options?.signal&&!this.#isClosed()&&!this.#aborted &&
530+
 #canUseWriteFastPath(signal){
531+
return!signal&&!this.#isClosed()&&!this.#aborted &&
531532
this.#broadcast[kCanWrite]();
532533
}
533534

534535
write(chunk,options){
536+
constsignal=getWriterSignal(options);
535537
// Fast path: no signal, writer open, buffer has space
536-
if(this.#canUseWriteFastPath(options)){
538+
if(this.#canUseWriteFastPath(signal)){
537539
constconverted=toUint8Array(chunk);
538540
this.#broadcast[kWrite]([converted]);
539541
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted);
540542
returnkResolvedPromise;
541543
}
542-
returnthis.#writevSlow([chunk],options);
544+
returnthis.#writevSlow([chunk],signal);
543545
}
544546

545547
writev(chunks,options){
546548
if(!ArrayIsArray(chunks)){
547549
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
548550
}
551+
constsignal=getWriterSignal(options);
549552
// Fast path: no signal, writer open, buffer has space
550-
if(this.#canUseWriteFastPath(options)){
553+
if(this.#canUseWriteFastPath(signal)){
551554
constconverted=convertChunks(chunks);
552555
this.#broadcast[kWrite](converted);
553556
for(leti=0;i<converted.length;i++){
554557
this.#totalBytes +=TypedArrayPrototypeGetByteLength(converted[i]);
555558
}
556559
returnkResolvedPromise;
557560
}
558-
returnthis.#writevSlow(chunks,options);
561+
returnthis.#writevSlow(chunks,signal);
559562
}
560563

561-
async #writevSlow(chunks,options){
562-
constsignal=options?.signal;
563-
564+
async #writevSlow(chunks,signal){
564565
// Check for pre-aborted
565566
signal?.throwIfAborted();
566567

@@ -623,6 +624,7 @@ class BroadcastWriter {
623624

624625
// end() is synchronous internally - signal accepted for interface compliance.
625626
end(options){
627+
getWriterSignal(options);
626628
if(this.#isClosed())returnthis.#closed;
627629
this.#closed =PromiseResolve(this.#totalBytes);
628630
this.#broadcast[kEnd]();
‎lib/internal/streams/iter/classic.js‎
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ const {
6161
}=require('internal/streams/iter/types');
6262

6363
const{
64+
 getWriterSignal,
6465
 validateBackpressure,
6566
 toUint8Array,
6667
}=require('internal/streams/iter/utils');
@@ -572,10 +573,11 @@ function fromWritable(writable, options = kNullPrototype) {
572573
// as 'error' events caught by our generic error handler, rejecting
573574
// the next pending operation rather than the already-resolved one.
574575
//
575-
// The options.signal parameter from the Writer interface is ignored.
576-
// Classic stream.Writable has no per-write abort signal support;
577-
// cancellation should be handled at the pipeline level instead.
578-
write(chunk){
576+
// The options.signal parameter from the Writer interface is validated but
577+
// otherwise ignored. Classic stream.Writable has no per-write abort signal
578+
// support; cancellation should be handled at the pipeline level instead.
579+
write(chunk,options){
580+
getWriterSignal(options);
579581
if(!isWritable()){
580582
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
581583
}
@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
617619
returnPromiseResolve();
618620
},
619621

620-
writev(chunks){
622+
writev(chunks,options){
621623
if(!ArrayIsArray(chunks)){
622624
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
623625
}
626+
getWriterSignal(options);
624627
if(!isWritable()){
625628
returnPromiseReject(newERR_STREAM_WRITE_AFTER_END());
626629
}
@@ -666,8 +669,10 @@ function fromWritable(writable, options = kNullPrototype) {
666669
return-1;
667670
},
668671

669-
// options.signal is ignored for the same reason as write().
670-
end(){
672+
// options.signal is validated but otherwise ignored for the same reason as
673+
// write().
674+
end(options){
675+
getWriterSignal(options);
671676
if((writable.writableFinished??false)||
672677
(writable.destroyed??false)){
673678
cleanup();
‎lib/internal/streams/iter/push.js‎
Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const {
4242
 onSignalAbort,
4343
 toUint8Array,
4444
 convertChunks,
45+
 getWriterSignal,
4546
 parsePullArgs,
4647
 validateBackpressure,
4748
}=require('internal/streams/iter/utils');
@@ -565,26 +566,28 @@ class PushWriter {
565566
}
566567

567568
write(chunk,options){
568-
if(!options?.signal&&this.#queue.canWriteSync()){
569+
constsignal=getWriterSignal(options);
570+
if(!signal&&this.#queue.canWriteSync()){
569571
constbytes=toUint8Array(chunk);
570572
this.#queue.writeSync([bytes]);
571573
returnkResolvedPromise;
572574
}
573575
constbytes=toUint8Array(chunk);
574-
returnthis.#queue.writeAsync([bytes],options?.signal);
576+
returnthis.#queue.writeAsync([bytes],signal);
575577
}
576578

577579
writev(chunks,options){
578580
if(!ArrayIsArray(chunks)){
579581
thrownewERR_INVALID_ARG_TYPE('chunks','Array',chunks);
580582
}
581-
if(!options?.signal&&this.#queue.canWriteSync()){
583+
constsignal=getWriterSignal(options);
584+
if(!signal&&this.#queue.canWriteSync()){
582585
constbytes=convertChunks(chunks);
583586
this.#queue.writeSync(bytes);
584587
returnkResolvedPromise;
585588
}
586589
constbytes=convertChunks(chunks);
587-
returnthis.#queue.writeAsync(bytes,options?.signal);
590+
returnthis.#queue.writeAsync(bytes,signal);
588591
}
589592

590593
writeSync(chunk){
@@ -601,6 +604,7 @@ class PushWriter {
601604
}
602605

603606
end(options){
607+
getWriterSignal(options);
604608
constresult=this.#queue.end();
605609
if(result===-2){
606610
// Errored: reject with stored error
‎lib/internal/streams/iter/utils.js‎
Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ const { isError } = require('internal/util');
3535

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

38-
const{ validateOneOf }=require('internal/validators');
38+
const{
39+
 validateAbortSignal,
40+
 validateOneOf,
41+
}=require('internal/validators');
3942

4043
// Cached resolved promise to avoid allocating a new one on every sync fast-path.
4144
constkResolvedPromise=PromiseResolve();
@@ -267,6 +270,17 @@ function convertChunks(chunks) {
267270
returnresult;
268271
}
269272

273+
/**
274+
 * Validate Writer options and return options.signal.
275+
 * @param {object|undefined} options
276+
 * @returns {AbortSignal|undefined}
277+
 */
278+
functiongetWriterSignal(options){
279+
constsignal=options?.signal;
280+
validateAbortSignal(signal,'options.signal');
281+
returnsignal;
282+
}
283+
270284
/**
271285
 * Wrap a caught value as an Error, converting non-Error values.
272286
 * @param {unknown} error
@@ -378,6 +392,7 @@ module.exports = {
378392
 clampHWM,
379393
 concatBytes,
380394
 convertChunks,
395+
 getWriterSignal,
381396
 getMinCursor,
382397
 hasProtocol,
383398
 isPullOptions,
‎test/parallel/test-stream-iter-validation.js‎
Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
constcommon=require('../common');
55
constassert=require('assert');
6+
const{ Writable }=require('stream');
67
const{
7-
 from, fromSync, pull, pullSync, pipeTo,
8+
 from, fromSync, pull, pullSync, pipeTo, fromWritable,
89
 push, duplex, broadcast, Broadcast, share, shareSync,
910
 Share, SyncShare,
1011
 bytes, bytesSync, text, textSync,
@@ -42,6 +43,19 @@ assert.throws(() => push({ signal: {} }), { code: 'ERR_INVALID_ARG_TYPE' });
4243
assert.throws(()=>push(42,{}),{code: 'ERR_INVALID_ARG_TYPE'});
4344
assert.throws(()=>push('bad',{}),{code: 'ERR_INVALID_ARG_TYPE'});
4445

46+
// Writer options.signal must be AbortSignal
47+
{
48+
const{ writer }=push();
49+
constbadOptions={signal: 'bad'};
50+
assert.throws(()=>writer.write('a',badOptions),
51+
{code: 'ERR_INVALID_ARG_TYPE'});
52+
assert.throws(()=>writer.writev(['b'],badOptions),
53+
{code: 'ERR_INVALID_ARG_TYPE'});
54+
assert.throws(()=>writer.end(badOptions),
55+
{code: 'ERR_INVALID_ARG_TYPE'});
56+
writer.endSync();
57+
}
58+
4559
// Writer.writev requires array
4660
{
4761
const{ writer }=push();
@@ -147,6 +161,19 @@ assert.throws(() => broadcast({ highWaterMark: Number.MAX_SAFE_INTEGER + 1 }),
147161
assert.throws(()=>broadcast({signal: {}}),{code: 'ERR_INVALID_ARG_TYPE'});
148162
assert.throws(()=>broadcast({backpressure: 'bad'}),{code: 'ERR_INVALID_ARG_VALUE'});
149163

164+
// BroadcastWriter options.signal must be AbortSignal
165+
{
166+
const{ writer }=broadcast();
167+
constbadOptions={signal: 'bad'};
168+
assert.throws(()=>writer.write('a',badOptions),
169+
{code: 'ERR_INVALID_ARG_TYPE'});
170+
assert.throws(()=>writer.writev(['b'],badOptions),
171+
{code: 'ERR_INVALID_ARG_TYPE'});
172+
assert.throws(()=>writer.end(badOptions),
173+
{code: 'ERR_INVALID_ARG_TYPE'});
174+
writer.endSync();
175+
}
176+
150177
// BroadcastWriter.writev requires array
151178
{
152179
const{ writer }=broadcast();
@@ -160,6 +187,24 @@ assert.throws(() => broadcast({ backpressure: 'bad' }), { code: 'ERR_INVALID_ARG
160187
// Broadcast.from rejects non-streamable input
161188
assert.throws(()=>Broadcast.from(42),{code: 'ERR_INVALID_ARG_TYPE'});
162189

190+
// fromWritable Writer options.signal must be AbortSignal
191+
{
192+
constwritable=newWritable({
193+
write(chunk,encoding,callback){
194+
callback();
195+
},
196+
});
197+
constwriter=fromWritable(writable);
198+
constbadOptions={signal: 'bad'};
199+
assert.throws(()=>writer.write('a',badOptions),
200+
{code: 'ERR_INVALID_ARG_TYPE'});
201+
assert.throws(()=>writer.writev(['b'],badOptions),
202+
{code: 'ERR_INVALID_ARG_TYPE'});
203+
assert.throws(()=>writer.end(badOptions),
204+
{code: 'ERR_INVALID_ARG_TYPE'});
205+
writable.destroy();
206+
}
207+
163208
// =============================================================================
164209
// share() / shareSync() validation
165210
// =============================================================================
0 commit comments
Comments
 (0)