Skip to content
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.

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

stream: validate readable defaultEncoding #46430

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 9 additions & 1 deletion lib/internal/streams/readable.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ const {
ERR_OUT_OF_RANGE,
ERR_STREAM_PUSH_AFTER_EOF,
ERR_STREAM_UNSHIFT_AFTER_END_EVENT,
ERR_UNKNOWN_ENCODING
}
} = require('internal/errors');
const { validateObject } = require('internal/validators');
Expand Down Expand Up @@ -162,7 +163,14 @@ function ReadableState(options, stream, isDuplex) {
// Crypto is kind of old and crusty. Historically, its default string
// encoding is 'binary' so we have to make this configurable.
// Everything else in the universe uses 'utf8', though.
this.defaultEncoding = (options && options.defaultEncoding) || 'utf8';
const defaultEncoding = options?.defaultEncoding;
if (defaultEncoding == null) {
this.defaultEncoding = 'utf8';
} else if (Buffer.isEncoding(defaultEncoding)) {
this.defaultEncoding = defaultEncoding;
} else {
throw new ERR_UNKNOWN_ENCODING(defaultEncoding);
}
marco-ippolito marked this conversation as resolved.
Show resolved Hide resolved

// Ref the piped dest which we need a drain event on it
// type: null | Writable | Set<Writable>.
Expand Down
37 changes: 37 additions & 0 deletions test/parallel/test-stream-readable-default-encoding.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
'use strict';
const common = require('../common');
const assert = require('assert');
const { Readable } = require('stream');

{
assert.throws(() => {
new Readable({
read: () => {},
defaultEncoding: 'my invalid encoding',
});
}, {
code: 'ERR_UNKNOWN_ENCODING',
});
}

{
const r = new Readable({
read() {},
defaultEncoding: 'hex'
});

r.push('ab');

r.on('data', common.mustCall((chunk) => assert.strictEqual(chunk.toString('hex'), 'ab')), 1);
}

{
const r = new Readable({
read() {},
defaultEncoding: 'hex',
});

r.push('xy', 'utf-8');

r.on('data', common.mustCall((chunk) => assert.strictEqual(chunk.toString('utf-8'), 'xy')), 1);
}