From c2898f393bafc220b620145d26a9cad1dba33570 Mon Sep 17 00:00:00 2001 From: Pranshu Srivastava Date: Thu, 16 Apr 2020 06:07:47 +0530 Subject: [PATCH] stream: add null check in Readable.from MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Throws `ERR_STREAM_NULL_VALUES` error if a null value is passed to `Readable.from`. Also added docs for the same. Co-Authored-By: 扩散性百万甜面包 Fixes: https://github.com/nodejs/node/issues/32845 PR-URL: https://github.com/nodejs/node/pull/32873 Reviewed-By: Ruben Bridgewater Reviewed-By: Anna Henningsen Reviewed-By: Robert Nagy Reviewed-By: Matteo Collina --- doc/api/stream.md | 3 ++- lib/internal/streams/from.js | 16 +++++++++++----- .../test-readable-from-iterator-closing.js | 5 ++--- .../test-stream-readable-next-no-null.js | 19 +++++++++++++++++++ 4 files changed, 34 insertions(+), 9 deletions(-) create mode 100644 test/parallel/test-stream-readable-next-no-null.js diff --git a/doc/api/stream.md b/doc/api/stream.md index 72163fc62b749d..8b87f79cc72bc0 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1621,7 +1621,8 @@ added: --> * `iterable` {Iterable} Object implementing the `Symbol.asyncIterator` or - `Symbol.iterator` iterable protocol. + `Symbol.iterator` iterable protocol. Emits an 'error' event if a null + value is passed. * `options` {Object} Options provided to `new stream.Readable([options])`. By default, `Readable.from()` will set `options.objectMode` to `true`, unless this is explicitly opted out by setting `options.objectMode` to `false`. diff --git a/lib/internal/streams/from.js b/lib/internal/streams/from.js index ca567914bbf0fe..6752679ae3bc2b 100644 --- a/lib/internal/streams/from.js +++ b/lib/internal/streams/from.js @@ -7,7 +7,8 @@ const { const { Buffer } = require('buffer'); const { - ERR_INVALID_ARG_TYPE + ERR_INVALID_ARG_TYPE, + ERR_STREAM_NULL_VALUES } = require('internal/errors').codes; function from(Readable, iterable, opts) { @@ -73,15 +74,20 @@ function from(Readable, iterable, opts) { needToClose = false; const { value, done } = await iterator.next(); needToClose = !done; - const resolved = await value; if (done) { readable.push(null); } else if (readable.destroyed) { await close(); - } else if (readable.push(resolved)) { - next(); } else { - reading = false; + const res = await value; + if (res === null) { + reading = false; + throw new ERR_STREAM_NULL_VALUES(); + } else if (readable.push(res)) { + next(); + } else { + reading = false; + } } } catch (err) { readable.destroy(err); diff --git a/test/parallel/test-readable-from-iterator-closing.js b/test/parallel/test-readable-from-iterator-closing.js index 0254ccfc163093..02252ffe56854c 100644 --- a/test/parallel/test-readable-from-iterator-closing.js +++ b/test/parallel/test-readable-from-iterator-closing.js @@ -168,18 +168,17 @@ async function closeAfterNullYielded() { const finallyMustCall = mustCall(); const dataMustCall = mustCall(3); - function* infiniteGenerate() { + function* generate() { try { yield 'a'; yield 'a'; yield 'a'; - while (true) yield null; } finally { finallyMustCall(); } } - const stream = Readable.from(infiniteGenerate()); + const stream = Readable.from(generate()); stream.on('data', (chunk) => { dataMustCall(); diff --git a/test/parallel/test-stream-readable-next-no-null.js b/test/parallel/test-stream-readable-next-no-null.js new file mode 100644 index 00000000000000..64ca40be11ed03 --- /dev/null +++ b/test/parallel/test-stream-readable-next-no-null.js @@ -0,0 +1,19 @@ +'use strict'; +const { mustNotCall, expectsError } = require('../common'); +const { Readable } = require('stream'); + +async function* generate() { + yield null; +} + +const stream = Readable.from(generate()); + +stream.on('error', expectsError({ + code: 'ERR_STREAM_NULL_VALUES', + name: 'TypeError', + message: 'May not write null values to stream' +})); + +stream.on('data', mustNotCall((chunk) => {})); + +stream.on('end', mustNotCall());