Skip to content

util: fix formatting of objects with built-in Symbol.toPrimitive #57832

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 6 commits into from
Apr 17, 2025
Merged

util: fix formatting of objects with built-in Symbol.toPrimitive #57832

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
74e49ba
util: fix formatting of objects with built-in Symbol.toPrimitive
islandryu Apr 11, 2025
9941038
add symbol test
islandryu Apr 11, 2025
140a6f2
handle the case toPrimitive is defined in prototype
islandryu Apr 12, 2025
476a700
add test
islandryu Apr 12, 2025
5b0ac9b
add comment
islandryu Apr 12, 2025
412347c
fix to not call unnecessary hasOwnProperty
islandryu Apr 14, 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
fix to not call unnecessary hasOwnProperty
  • Loading branch information
@islandryu
islandryu committed Apr 14, 2025
commit 412347c141a2d8a429ed359a649e69ff9e3519d7
33 changes: 21 additions & 12 deletions lib/internal/util/inspect.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2160,18 +2160,23 @@ function hasBuiltInToString(value) {
}
value = proxyTarget;
}
// Count objects without `toString` and `Symbol.toPrimitive` function as built-in.
if (typeof value.toString !== 'function' && typeof value[SymbolToPrimitive] !== 'function') {
return true;
}

// The object has a own `toString` property. Thus it's not not a built-in one.
if (ObjectPrototypeHasOwnProperty(value, 'toString')) {
return false;
}
let hasOwnToString = ObjectPrototypeHasOwnProperty;
let hasOwnToPrimitive = ObjectPrototypeHasOwnProperty;

// The object has a own `Symbol.toPrimitive` property. Thus it's not not a built-in one.
if (ObjectPrototypeHasOwnProperty(value, SymbolToPrimitive)) {
// Count objects without `toString` and `Symbol.toPrimitive` function as built-in.
if (typeof value.toString !== 'function') {
if (typeof value[SymbolToPrimitive] !== 'function') {
return true;
} else if (ObjectPrototypeHasOwnProperty(value, SymbolToPrimitive)) {
return false;
}
hasOwnToString = returnFalse;
} else if (ObjectPrototypeHasOwnProperty(value, 'toString')) {
return false;
} else if (typeof value[SymbolToPrimitive] !== 'function') {
hasOwnToPrimitive = returnFalse;
} else if (ObjectPrototypeHasOwnProperty(value, SymbolToPrimitive)) {
return false;
}

Expand All @@ -2180,8 +2185,8 @@ function hasBuiltInToString(value) {
let pointer = value;
do {
pointer = ObjectGetPrototypeOf(pointer);
} while (!ObjectPrototypeHasOwnProperty(pointer, 'toString') &&
!ObjectPrototypeHasOwnProperty(pointer, SymbolToPrimitive));
} while (!hasOwnToString(pointer, 'toString') &&
!hasOwnToPrimitive(pointer, SymbolToPrimitive));

// Check closer if the object is a built-in.
const descriptor = ObjectGetOwnPropertyDescriptor(pointer, 'constructor');
Expand All @@ -2190,6 +2195,10 @@ function hasBuiltInToString(value) {
builtInObjects.has(descriptor.value.name);
}

function returnFalse() {
return false;
}
Comment on lines +2198 to +2200
Copy link
Copy Markdown
Member

@ljharb ljharb Apr 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this faster than nulling out hasOwnToPrimitive and checking for that, avoiding the function call?

Copy link
Copy Markdown
Member

@BridgeAR BridgeAR Apr 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That likely depends on a) the inlining and b) if it is more common to have to check for both methods (if that's the case, any additional check is more expensive).


const firstErrorLine = (error) => StringPrototypeSplit(error.message, '\n', 1)[0];
let CIRCULAR_ERROR_MESSAGE;
function tryStringify(arg) {
Expand Down