Skip to content

lib: fix inspect deduplication logic #59687

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

Merged
nodejs-github-bot merged 11 commits into from
Sep 21, 2025
Merged

lib: fix inspect deduplication logic #59687

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
70e89c4
lib: update inspect output format for subclasses
miguelmarcondesf Aug 30, 2025
de5c769
test: add inspect tests for null constructor scenarios
miguelmarcondesf Aug 30, 2025
f9306e7
test: update syntax error assertion in ESM loader test
miguelmarcondesf Aug 30, 2025
6122451
lib: revert tag exclusion for getClassBase
miguelmarcondesf Sep 1, 2025
6fa46c4
lib: revert tag exclusion for getFunctionBase
miguelmarcondesf Sep 1, 2025
26a46ae
test: rename subclasses for Map and Promise in inspect tests
miguelmarcondesf Sep 5, 2025
4daec61
lib: Update lib/internal/util/inspect.js
miguelmarcondesf Sep 13, 2025
a5fc528
test: enhance util.inspect assertions
miguelmarcondesf Sep 13, 2025
f38e4e8
lib: fix an off by one error
miguelmarcondesf Sep 19, 2025
0b314ef
lib: enhance error formatting in util.inspect
miguelmarcondesf Sep 19, 2025
a3816c8
lib: remove unnecessary error formatting
miguelmarcondesf Sep 20, 2025
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
Prev Previous commit
Next Next commit
lib: enhance error formatting in util.inspect
  • Loading branch information
@miguelmarcondesf
miguelmarcondesf committed Sep 19, 2025
commit 0b314ef65e6e6581cffc35c8c84e7817620de304
7 changes: 7 additions & 0 deletions lib/internal/util/inspect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1902,6 +1902,13 @@ function formatError(err, constructor, tag, ctx, keys) {
const name = err.name != null ? err.name : 'Error';
let stack = getStackString(ctx, err);

if (tag !== '' && constructor !== null &&
StringPrototypeIncludes(constructor, 'Error') &&
!StringPrototypeIncludes(tag, 'Error') &&
StringPrototypeStartsWith(constructor, tag)) {
return `[${tag}: ${err.message}]`;
}

removeDuplicateErrorKeys(ctx, keys, err, stack);

if ('cause' in err &&
Expand Down
120 changes: 17 additions & 103 deletions test/parallel/test-util-inspect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,88 +85,6 @@ assert.strictEqual(util.inspect(async () => {}), '[AsyncFunction (anonymous)]');
);
}

// Null constructor scenarios
{
function fnNull() {}
Object.setPrototypeOf(fnNull, null);
assert.strictEqual(
util.inspect(fnNull),
'[Function (null prototype): fnNull]'
);

function fnNullAndStringTag() {}
Object.defineProperty(fnNullAndStringTag, Symbol.toStringTag, {
value: 'CustomTag',
configurable: true
});
Object.setPrototypeOf(fnNullAndStringTag, null);
assert.strictEqual(
util.inspect(fnNullAndStringTag),
'[Function (null prototype): fnNullAndStringTag] [CustomTag]'
);

function fnAnonymous() {}
Object.defineProperty(fnAnonymous, Symbol.toStringTag, {
value: 'AnonymousCustom',
configurable: true
});
Object.setPrototypeOf(fnAnonymous, null);
assert.strictEqual(
util.inspect(fnAnonymous),
'[Function (null prototype): fnAnonymous] [AnonymousCustom]'
);

const fnArrow = () => {};
Object.setPrototypeOf(fnArrow, null);
assert.strictEqual(
util.inspect(fnArrow),
'[Function (null prototype): fnArrow]'
);

async function fnAsync() {}
Object.defineProperty(fnAsync, Symbol.toStringTag, {
value: 'AsyncCustom',
configurable: true
});
Object.setPrototypeOf(fnAsync, null);
assert.strictEqual(
util.inspect(fnAsync),
'[AsyncFunction (null prototype): fnAsync] [AsyncCustom]'
);

class TestClass {}
Object.defineProperty(TestClass, Symbol.toStringTag, {
value: 'ClassTag',
configurable: true
});
Object.setPrototypeOf(TestClass, null);
assert.strictEqual(
util.inspect(TestClass),
'[class TestClass [ClassTag] extends [null prototype]]'
);

function fnMatchConstructor() {}
Object.defineProperty(fnMatchConstructor, Symbol.toStringTag, {
value: 'Function',
configurable: true
});
assert.strictEqual(
util.inspect(fnMatchConstructor),
'[Function: fnMatchConstructor]'
);

function fnNullMatchConstructor() {}
Object.defineProperty(fnNullMatchConstructor, Symbol.toStringTag, {
value: 'Function',
configurable: true
});
Object.setPrototypeOf(fnNullMatchConstructor, null);
assert.strictEqual(
util.inspect(fnNullMatchConstructor),
'[Function (null prototype): fnNullMatchConstructor] [Function]'
);
}

assert.strictEqual(util.inspect(undefined), 'undefined');
assert.strictEqual(util.inspect(null), 'null');
assert.strictEqual(util.inspect(/foo(bar\n)?/gi), '/foo(bar\\n)?/gi');
Expand Down Expand Up @@ -1497,11 +1415,11 @@ if (typeof Symbol !== 'undefined') {
assert.strictEqual(util.inspect(new ArraySubclass(1, 2, 3)),
'ArraySubclass(3) [ 1, 2, 3 ]');
assert.strictEqual(util.inspect(new SetSubclass([1, 2, 3])),
'SetSubclass(3) [Set] { 1, 2, 3 }');
'SetSubclass(3) { 1, 2, 3 }');
assert.strictEqual(util.inspect(new MapSubclass([['foo', 42]])),
"MapSubclass(1) [Map] { 'foo' => 42 }");
"MapSubclass(1) { 'foo' => 42 }");
assert.strictEqual(util.inspect(new PromiseSubclass(() => {})),
'PromiseSubclass [Promise] { <pending> }');
'PromiseSubclass { <pending> }');
Comment thread
miguelmarcondesf marked this conversation as resolved.
assert.strictEqual(util.inspect(new SymbolNameClass()),
'Symbol(name) {}');
assert.strictEqual(
Expand All @@ -1513,35 +1431,31 @@ if (typeof Symbol !== 'undefined') {
'[ObjectSubclass: null prototype] { foo: 42 }'
);

class CustomClass {}
Object.defineProperty(CustomClass.prototype, Symbol.toStringTag, {
value: 'Custom',
class MiddleErrorPart extends Error {}
Object.defineProperty(MiddleErrorPart.prototype, Symbol.toStringTag, {
value: 'Middle',
configurable: true
});
assert.strictEqual(util.inspect(new CustomClass()),
'CustomClass [Custom] {}');
assert.strictEqual(util.inspect(new MiddleErrorPart('foo')),
'[Middle: foo]');

class MapClass extends Map {}
Object.defineProperty(MapClass.prototype, Symbol.toStringTag, {
value: 'Map',
configurable: true
});
assert.strictEqual(util.inspect(new MapClass([['key', 'value']])),
"MapClass(1) [Map] { 'key' => 'value' }");
"MapClass(1) { 'key' => 'value' }");

class AbcMap extends Map {}
assert.strictEqual(util.inspect(new AbcMap([['key', 'value']])),
"AbcMap(1) { 'key' => 'value' }");

class SetAbc extends Set {}
assert.strictEqual(util.inspect(new SetAbc([1, 2, 3])),
'SetAbc(3) { 1, 2, 3 }');

class FooSet extends Set {}
Object.defineProperty(FooSet.prototype, Symbol.toStringTag, {
value: 'Set',
configurable: true
});
assert.strictEqual(util.inspect(new FooSet([1, 2, 3])),
'FooSet(3) { 1, 2, 3 }');

class Settings extends Set {}
Object.defineProperty(Settings.prototype, Symbol.toStringTag, {
value: 'Set',
configurable: true
});
assert.strictEqual(util.inspect(new Settings([1, 2, 3])),
'Settings(3) [Set] { 1, 2, 3 }');
}
Expand Down
Loading