Skip to content

stream: fix highwatermark threshold and add the missing error #38700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pd4d10 wants to merge 1 commit into from
Closed

stream: fix highwatermark threshold and add the missing error #38700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
stream: fix highwatermark threshold and add the missing error 
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>
  • Loading branch information
@pd4d10 @RaisinTen
pd4d10 and RaisinTen committed Sep 4, 2021
commit 0d5c2025c101d41a73dadcf8d0df9e72b723db97
6 changes: 3 additions & 3 deletions lib/internal/streams/readable.js
View file
Open in desktop
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
View file
Open in desktop
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,
}));
}