Skip to content

errors: improve the description of ERR_INVALID_ARG_VALUE #18358

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
joyeecheung wants to merge 1 commit into from
Closed

errors: improve the description of ERR_INVALID_ARG_VALUE #18358

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
errors: improve the description of ERR_INVALID_ARG_VALUE 
- Allow user to customize why the argument is invalid
- Display the argument with util.inspect so null bytes can be
  displayed properly.
  • Loading branch information
@joyeecheung
joyeecheung committed Jan 24, 2018
commit 69933b8659286b05bb00c09965c7318c5eb64814
34 changes: 23 additions & 11 deletions lib/internal/errors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,16 @@ const { kMaxLength } = process.binding('buffer');
const { defineProperty } = Object;

// Lazily loaded
var util = null;
var util_ = null;
var buffer;

function lazyUtil() {
if (!util_) {
util_ = require('util');
}
return util_;
}

function makeNodeError(Base) {
return class NodeError extends Base {
constructor(key, ...args) {
Expand Down Expand Up @@ -142,6 +149,7 @@ function createErrDiff(actual, expected, operator) {
var lastPos = 0;
var end = '';
var skipped = false;
const util = lazyUtil();
const actualLines = util
.inspect(actual, { compact: false }).split('\n');
const expectedLines = util
Expand Down Expand Up @@ -262,13 +270,11 @@ class AssertionError extends Error {
if (message != null) {
super(message);
} else {
if (util === null) {
util = require('util');
if (process.stdout.isTTY && process.stdout.getColorDepth() !== 1) {
green = '\u001b[32m';
white = '\u001b[39m';
red = '\u001b[31m';
}
const util = lazyUtil();
if (process.stdout.isTTY && process.stdout.getColorDepth() !== 1) {
green = '\u001b[32m';
white = '\u001b[39m';
red = '\u001b[31m';
}

if (actual && actual.stack && actual instanceof Error)
Expand Down Expand Up @@ -333,7 +339,7 @@ function message(key, args) {
if (typeof msg === 'function') {
fmt = msg;
} else {
if (util === null) util = require('util');
const util = lazyUtil();
fmt = util.format;
if (args === undefined || args.length === 0)
return msg;
Expand Down Expand Up @@ -537,8 +543,14 @@ E('ERR_INSPECTOR_CLOSED', 'Session was closed');
E('ERR_INSPECTOR_NOT_AVAILABLE', 'Inspector is not available');
E('ERR_INSPECTOR_NOT_CONNECTED', 'Session is not connected');
E('ERR_INVALID_ARG_TYPE', invalidArgType);
E('ERR_INVALID_ARG_VALUE', (name, value) =>
`The value "${String(value)}" is invalid for argument "${name}"`);
E('ERR_INVALID_ARG_VALUE', (name, value, reason = 'is invalid') => {
const util = lazyUtil();
let inspected = util.inspect(value);
if (inspected.length > 128) {
inspected = inspected.slice(0, 128) + '...';
}
return `The argument '${name}' ${reason}. Received ${inspected}`;
}),
E('ERR_INVALID_ARRAY_LENGTH',
(name, len, actual) => {
internalAssert(typeof actual === 'number', 'actual must be a number');
Expand Down
14 changes: 12 additions & 2 deletions test/parallel/test-internal-errors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,10 +351,20 @@ assert.strictEqual(
}

{
const error = new errors.Error('ERR_INVALID_ARG_VALUE', 'foo', 'bar');
const error = new errors.Error('ERR_INVALID_ARG_VALUE', 'foo', '\u0000bar');
assert.strictEqual(
error.message,
'The value "bar" is invalid for argument "foo"'
'The argument \'foo\' is invalid. Received \'\\u0000bar\''
);
}

{
const error = new errors.Error(
'ERR_INVALID_ARG_VALUE',
'foo', { a: 1 }, 'must have property \'b\'');
assert.strictEqual(
error.message,
'The argument \'foo\' must have property \'b\'. Received { a: 1 }'
);
}

Expand Down