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: fix .format() not always calling toString when it should be #30343

Closed
wants to merge 2 commits 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
57 changes: 35 additions & 22 deletions lib/internal/util/inspect.js
Original file line number Diff line number Diff line change
Expand Up @@ -1571,6 +1571,31 @@ function reduceToSingleString(
return `${braces[0]}${ln}${join(output, `,\n${indentation} `)} ${braces[1]}`;
}

function hasBuiltInToString(value) {
// Count objects that have no `toString` function as built-in.
if (typeof value.toString !== '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;
}

// Find the object that has the `toString` property as own property in the
// prototype chain.
let pointer = value;
do {
pointer = ObjectGetPrototypeOf(pointer);
} while (!ObjectPrototypeHasOwnProperty(pointer, 'toString'));

// Check closer if the object is a built-in.
const descriptor = ObjectGetOwnPropertyDescriptor(pointer, 'constructor');
return descriptor !== undefined &&
typeof descriptor.value === 'function' &&
builtInObjects.has(descriptor.value.name);
}

const firstErrorLine = (error) => error.message.split('\n')[0];
let CIRCULAR_ERROR_MESSAGE;
function tryStringify(arg) {
Expand Down Expand Up @@ -1629,29 +1654,17 @@ function formatWithOptionsInternal(inspectOptions, ...args) {
tempStr = formatNumber(stylizeNoColor, tempArg);
} else if (typeof tempArg === 'bigint') {
tempStr = `${tempArg}n`;
} else if (typeof tempArg !== 'object' ||
tempArg === null ||
!hasBuiltInToString(tempArg)) {
tempStr = String(tempArg);
} else {
let constr;
if (typeof tempArg !== 'object' ||
tempArg === null ||
(typeof tempArg.toString === 'function' &&
// A direct own property.
(ObjectPrototypeHasOwnProperty(tempArg, 'toString') ||
// A direct own property on the constructor prototype in
// case the constructor is not an built-in object.
((constr = tempArg.constructor) &&
!builtInObjects.has(constr.name) &&
constr.prototype &&
ObjectPrototypeHasOwnProperty(constr.prototype,
'toString'))))) {
tempStr = String(tempArg);
} else {
tempStr = inspect(tempArg, {
...inspectOptions,
compact: 3,
colors: false,
depth: 0
});
}
tempStr = inspect(tempArg, {
...inspectOptions,
compact: 3,
colors: false,
depth: 0
});
}
break;
case 106: // 'j'
Expand Down
60 changes: 60 additions & 0 deletions test/parallel/test-util-format.js
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,66 @@ assert.strictEqual(util.format('%s', () => 5), '() => 5');
util.format('%s', new Foobar(5)),
'Foobar [ <5 empty items>, aaa: true ]'
);

// Subclassing:
class B extends Foo {}

function C() {}
C.prototype.toString = function() {
return 'Custom';
};

function D() {
C.call(this);
}
D.prototype = Object.create(C.prototype);

assert.strictEqual(
util.format('%s', new B()),
'Bar'
);
assert.strictEqual(
util.format('%s', new C()),
'Custom'
);
assert.strictEqual(
util.format('%s', new D()),
'Custom'
);

D.prototype.constructor = D;
assert.strictEqual(
util.format('%s', new D()),
'Custom'
);

D.prototype.constructor = null;
assert.strictEqual(
util.format('%s', new D()),
'Custom'
);

D.prototype.constructor = { name: 'Foobar' };
assert.strictEqual(
util.format('%s', new D()),
'Custom'
);

Object.defineProperty(D.prototype, 'constructor', {
get() {
throw new Error();
},
configurable: true
});
assert.strictEqual(
util.format('%s', new D()),
'Custom'
);

assert.strictEqual(
util.format('%s', Object.create(null)),
'[Object: null prototype] {}'
);
}

// JSON format specifier
Expand Down