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

util: only inspect error properties that are not visible otherwise #32327

Closed
wants to merge 1 commit into from
Closed
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
16 changes: 14 additions & 2 deletions lib/internal/util/inspect.js
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,7 @@ function formatRaw(ctx, value, recurseTimes, typedArray) {
return ctx.stylize(base, 'date');
}
} else if (isError(value)) {
base = formatError(value, constructor, tag, ctx);
base = formatError(value, constructor, tag, ctx, keys);
if (keys.length === 0 && protoProps === undefined)
return base;
} else if (isAnyArrayBuffer(value)) {
Expand Down Expand Up @@ -1078,11 +1078,23 @@ function getFunctionBase(value, constructor, tag) {
return base;
}

function formatError(err, constructor, tag, ctx) {
function formatError(err, constructor, tag, ctx, keys) {
const name = err.name != null ? String(err.name) : 'Error';
let len = name.length;
let stack = err.stack ? String(err.stack) : ErrorPrototypeToString(err);

// Do not "duplicate" error properties that are already included in the output
// otherwise.
if (!ctx.showHidden && keys.length !== 0) {
for (const name of ['name', 'message', 'stack']) {
const index = keys.indexOf(name);
// Only hide the property in case it's part of the original stack
if (index !== -1 && stack.includes(err[name])) {
keys.splice(index, 1);
}
}
}

// A stack trace may contain arbitrary data. Only manipulate the output
// for "regular errors" (errors that "look normal") for now.
if (constructor === null ||
Expand Down
22 changes: 22 additions & 0 deletions test/parallel/test-util-inspect.js
Original file line number Diff line number Diff line change
Expand Up @@ -696,6 +696,28 @@ assert.strictEqual(util.inspect(-5e-324), '-5e-324');
Error.stackTraceLimit = tmp;
}

// Prevent enumerable error properties from being printed.
{
let err = new Error();
err.message = 'foobar';
let out = util.inspect(err).split('\n');
assert.strictEqual(out[0], 'Error: foobar');
assert(out[out.length - 1].startsWith(' at '));
// Reset the error, the stack is otherwise not recreated.
err = new Error();
err.message = 'foobar';
err.name = 'Unique';
Object.defineProperty(err, 'stack', { value: err.stack, enumerable: true });
out = util.inspect(err).split('\n');
assert.strictEqual(out[0], 'Unique: foobar');
assert(out[out.length - 1].startsWith(' at '));
err.name = 'Baz';
out = util.inspect(err).split('\n');
assert.strictEqual(out[0], 'Unique: foobar');
assert.strictEqual(out[out.length - 2], " name: 'Baz'");
assert.strictEqual(out[out.length - 1], '}');
}

// Doesn't capture stack trace.
{
function BadCustomError(msg) {
Expand Down