Skip to content

util: inspect: do not crash on an Error stack that contains a Symbol #56573

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

util: inspect: do not crash on an Error stack that contains a Symbol #56573

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
14 changes: 10 additions & 4 deletions lib/internal/util/inspect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1287,8 +1287,14 @@ function identicalSequenceRange(a, b) {
return { len: 0, offset: 0 };
}

function getStackString(error) {
return error.stack ? String(error.stack) : ErrorPrototypeToString(error);
function getStackString(ctx, error) {
if (error.stack) {
if (typeof error.stack === 'string') {
return error.stack;
}
return formatValue(ctx, error.stack);
}
return ErrorPrototypeToString(error);
}

function getStackFrames(ctx, err, stack) {
Expand All @@ -1303,7 +1309,7 @@ function getStackFrames(ctx, err, stack) {

// Remove stack frames identical to frames in cause.
if (cause != null && isError(cause)) {
const causeStack = getStackString(cause);
const causeStack = getStackString(ctx, cause);
const causeStackStart = StringPrototypeIndexOf(causeStack, '\n at');
if (causeStackStart !== -1) {
const causeFrames = StringPrototypeSplit(StringPrototypeSlice(causeStack, causeStackStart + 1), '\n');
Expand Down Expand Up @@ -1426,7 +1432,7 @@ function safeGetCWD() {

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

removeDuplicateErrorKeys(ctx, keys, err, stack);

Expand Down
20 changes: 16 additions & 4 deletions test/parallel/test-util-inspect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,16 +777,18 @@ assert.strictEqual(util.inspect(-5e-324), '-5e-324');
[undefined, 'RangeError: foo', '[RangeError: foo]'],
[false, 'false [RangeError]: foo', '[RangeError: foo]'],
['', 'foo', '[RangeError: foo]'],
[[1, 2, 3], '1,2,3 [RangeError]: foo', '[1,2,3]'],
[[1, 2, 3], '1,2,3 [RangeError]: foo', '[[\n 1,\n 2,\n 3\n]]'],
].forEach(([value, outputStart, stack]) => {
let err = new RangeError('foo');
err.name = value;
const result = util.inspect(err);
assert(
util.inspect(err).startsWith(outputStart),
result.startsWith(outputStart),
util.format(
'The name set to %o did not result in the expected output "%s"',
'The name set to %o did not result in the expected output "%s", got "%s"',
value,
outputStart
outputStart,
result.split('\n')[0]
)
);

Expand Down Expand Up @@ -3448,3 +3450,13 @@ assert.strictEqual(
${error.stack.split('\n').slice(1).join('\n')}`,
);
}

{
const error = new Error();
error.stack = [Symbol('foo')];

assert.strictEqual(
inspect(error),
'[[\n Symbol(foo)\n]]'
);
}
Loading