Skip to content
Permalink
Browse files

console: improve inspectOptions validation

This commit adds stricter type checking to the inspectOptions
option to the Console constructor.

PR-URL: #25090
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information...
cjihrig authored and addaleax committed Dec 17, 2018
1 parent 65d485b commit 272ddb1765f732b119d3d74150b00591a363a56f
Showing with 21 additions and 1 deletion.
  1. +3 −1 lib/internal/console/constructor.js
  2. +18 −0 test/parallel/test-console-instance.js
@@ -91,13 +91,15 @@ function Console(options /* or: stdout, stderr, ignoreErrors = true */) {
if (typeof colorMode !== 'boolean' && colorMode !== 'auto')
throw new ERR_INVALID_ARG_VALUE('colorMode', colorMode);

if (inspectOptions) {
if (typeof inspectOptions === 'object' && inspectOptions !== null) {
if (inspectOptions.colors !== undefined &&
options.colorMode !== undefined) {
throw new ERR_INCOMPATIBLE_OPTION_PAIR(
'inspectOptions.color', 'colorMode');
}
optionsMap.set(this, inspectOptions);
} else if (inspectOptions !== undefined) {
throw new ERR_INVALID_ARG_TYPE('inspectOptions', 'object', inspectOptions);
}

// Bind the prototype functions to this Console instance
@@ -128,3 +128,21 @@ out.write = err.write = (d) => {};
assert.throws(() => c2.warn('foo'), /^Error: err$/);
assert.throws(() => c2.dir('foo'), /^Error: out$/);
}

// Console constructor throws if inspectOptions is not an object.
[null, true, false, 'foo', 5, Symbol()].forEach((inspectOptions) => {
assert.throws(
() => {
new Console({
stdout: out,
stderr: err,
inspectOptions
});
},
{
message: 'The "inspectOptions" argument must be of type object.' +
` Received type ${typeof inspectOptions}`,
code: 'ERR_INVALID_ARG_TYPE'
}
);
});

0 comments on commit 272ddb1

Please sign in to comment.
You can’t perform that action at this time.