1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

stream: fix highwatermark threshold and add the missing error

Browse Source 
1. Fix highwatermark threshold: `< 1GiB` -> `<= 1GiB`
2. Add the missing error: Size out of range

Update test/parallel/test-streams-highwatermark.js

Co-authored-by: Darshan Sen <raisinten@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/38700
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
This commit is contained in:
Rongjian Zhang 2021-05-16 21:45:31 +08:00 committed by Node.js GitHub Bot
parent b016d5dffc
commit 0c6f345cda
2 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/internal/streams/readable.js
View File

@ -62,6 +62,7 @@ const {
codes: { codes: {
ERR_INVALID_ARG_TYPE, ERR_INVALID_ARG_TYPE,
ERR_METHOD_NOT_IMPLEMENTED, ERR_METHOD_NOT_IMPLEMENTED,
ERR_OUT_OF_RANGE,
ERR_STREAM_PUSH_AFTER_EOF, ERR_STREAM_PUSH_AFTER_EOF,
ERR_STREAM_UNSHIFT_AFTER_END_EVENT, ERR_STREAM_UNSHIFT_AFTER_END_EVENT,
} }
@ -363,9 +364,8 @@ Readable.prototype.setEncoding = function(enc) {
// Don't raise the hwm > 1GB. // Don't raise the hwm > 1GB.
const MAX_HWM = 0x40000000; const MAX_HWM = 0x40000000;
function computeNewHighWaterMark(n) { function computeNewHighWaterMark(n) {
if (n >= MAX_HWM) { if (n > MAX_HWM) {
// TODO(ronag): Throw ERR_VALUE_OUT_OF_RANGE. throw new ERR_OUT_OF_RANGE('size', '<= 1GiB', n);
n = MAX_HWM;
} else { } else {
// Get the next highest power of 2 to prevent increasing hwm excessively in // Get the next highest power of 2 to prevent increasing hwm excessively in
// tiny amounts. // tiny amounts.

15
test/parallel/test-streams-highwatermark.js
View File

@ -70,3 +70,18 @@ const { inspect } = require('util');
assert.strictEqual(readable._readableState.highWaterMark, Number(size)); assert.strictEqual(readable._readableState.highWaterMark, Number(size));
}); });
} }
{
// Test highwatermark limit
const hwm = 0x40000000 + 1;
const readable = stream.Readable({
read() {},
});
assert.throws(() => readable.read(hwm), common.expectsError({
code: 'ERR_OUT_OF_RANGE',
message: 'The value of "size" is out of range.' +
' It must be <= 1GiB. Received ' +
hwm,
}));
}