FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

stream: validate writer options signal · nodejs/node@2a3babb · GitHub

/ node Public

Commit 2a3babb

Browse files
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: #64385 Fixes: #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
return this.#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+
const signal = getWriterSignal(options);
535537
// Fast path: no signal, writer open, buffer has space
536-
if (this.#canUseWriteFastPath(options)) {
538+
if (this.#canUseWriteFastPath(signal)) {
537539
const converted = toUint8Array(chunk);
538540
this.#broadcast[kWrite]([converted]);
539541
this.#totalBytes += TypedArrayPrototypeGetByteLength(converted);
540542
return kResolvedPromise;
541543
}
542-
return this.#writevSlow([chunk], options);
544+
return this.#writevSlow([chunk], signal);
543545
}
544546

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

561-
async #writevSlow(chunks, options) {
562-
const signal = 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()) return this.#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
return PromiseReject(new ERR_STREAM_WRITE_AFTER_END());
581583
}
@@ -617,10 +619,11 @@ function fromWritable(writable, options = kNullPrototype) {
617619
return PromiseResolve();
618620
},
619621

620-
writev(chunks) {
622+
writev(chunks, options) {
621623
if (!ArrayIsArray(chunks)) {
622624
throw new ERR_INVALID_ARG_TYPE('chunks', 'Array', chunks);
623625
}
626+
getWriterSignal(options);
624627
if (!isWritable()) {
625628
return PromiseReject(new ERR_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+
const signal = getWriterSignal(options);
570+
if (!signal && this.#queue.canWriteSync()) {
569571
const bytes = toUint8Array(chunk);
570572
this.#queue.writeSync([bytes]);
571573
return kResolvedPromise;
572574
}
573575
const bytes = toUint8Array(chunk);
574-
return this.#queue.writeAsync([bytes], options?.signal);
576+
return this.#queue.writeAsync([bytes], signal);
575577
}
576578

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

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

603606
end(options) {
607+
getWriterSignal(options);
604608
const result = 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
const kResolvedPromise = PromiseResolve();
@@ -267,6 +270,17 @@ function convertChunks(chunks) {
267270
return result;
268271
}
269272

273+
/**
274+
* Validate Writer options and return options.signal.
275+
* @param {object|undefined} options
276+
* @returns {AbortSignal|undefined}
277+
*/
278+
function getWriterSignal(options) {
279+
const signal = options?.signal;
280+
validateAbortSignal(signal, 'options.signal');
281+
return signal;
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
const common = require('../common');
55
const assert = 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+
const badOptions = { 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+
const badOptions = { 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+
const writable = new Writable({
193+
write(chunk, encoding, callback) {
194+
callback();
195+
},
196+
});
197+
const writer = fromWritable(writable);
198+
const badOptions = { 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)
Back | FazBrowse Home | New Git URL