Skip to content

Commit

Permalink
stream: fix highwatermark threshold and add the missing error
Browse files Browse the repository at this point in the history
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 <[email protected]>

PR-URL: #38700
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
  • Loading branch information
pd4d10 authored and nodejs-github-bot committed Sep 7, 2021
1 parent b016d5d commit 0c6f345
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
6 changes: 3 additions & 3 deletions lib/internal/streams/readable.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ const {
codes: {
ERR_INVALID_ARG_TYPE,
ERR_METHOD_NOT_IMPLEMENTED,
ERR_OUT_OF_RANGE,
ERR_STREAM_PUSH_AFTER_EOF,
ERR_STREAM_UNSHIFT_AFTER_END_EVENT,
}
Expand Down Expand Up @@ -363,9 +364,8 @@ Readable.prototype.setEncoding = function(enc) {
// Don't raise the hwm > 1GB.
const MAX_HWM = 0x40000000;
function computeNewHighWaterMark(n) {
if (n >= MAX_HWM) {
// TODO(ronag): Throw ERR_VALUE_OUT_OF_RANGE.
n = MAX_HWM;
if (n > MAX_HWM) {
throw new ERR_OUT_OF_RANGE('size', '<= 1GiB', n);
} else {
// Get the next highest power of 2 to prevent increasing hwm excessively in
// tiny amounts.
Expand Down
15 changes: 15 additions & 0 deletions test/parallel/test-streams-highwatermark.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,18 @@ const { inspect } = require('util');
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,
}));
}

0 comments on commit 0c6f345

Please sign in to comment.