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: unify inspection #27733

Closed
wants to merge 3 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
44 changes: 21 additions & 23 deletions lib/internal/util/inspect.js
Original file line number Diff line number Diff line change
Expand Up @@ -418,8 +418,15 @@ function getKeys(value, showHidden) {
return keys;
}

function getCtxStyle(constructor, tag) {
return constructor || tag || 'Object';
function getCtxStyle(value, constructor, tag) {
let fallback = '';
if (constructor === null) {
fallback = internalGetConstructorName(value);
if (fallback === tag) {
fallback = 'Object';
}
}
return getPrefix(constructor, tag, fallback);
}

function formatProxy(ctx, proxy, recurseTimes) {
Expand Down Expand Up @@ -520,17 +527,12 @@ function formatValue(ctx, value, recurseTimes, typedArray) {
// any proxy handlers.
const proxy = getProxyDetails(value);
if (proxy !== undefined) {
if (ctx.showProxy && ctx.stop === undefined) {
if (ctx.showProxy) {
return formatProxy(ctx, proxy, recurseTimes);
}
value = proxy[0];
}

if (ctx.stop !== undefined) {
const name = getConstructorName(value, ctx) || value[Symbol.toStringTag];
return ctx.stylize(`[${name || 'Object'}]`, 'special');
}

// Provide a hook for user-specified inspect functions.
// Check that value is an object with an inspect function on it.
if (ctx.customInspect) {
Expand Down Expand Up @@ -728,25 +730,21 @@ function formatRaw(ctx, value, recurseTimes, typedArray) {
formatter = formatIterator;
// Handle other regular objects again.
} else {
let fallback = '';
if (constructor === null) {
fallback = internalGetConstructorName(value);
if (fallback === tag) {
fallback = 'Object';
}
}
if (keys.length === 0) {
if (isExternal(value))
return ctx.stylize('[External]', 'special');
return `${getPrefix(constructor, tag, fallback)}{}`;
return `${getCtxStyle(value, constructor, tag)}{}`;
}
braces[0] = `${getPrefix(constructor, tag, fallback)}{`;
braces[0] = `${getCtxStyle(value, constructor, tag)}{`;
}
}
}

if (recurseTimes > ctx.depth && ctx.depth !== null) {
return ctx.stylize(`[${getCtxStyle(constructor, tag)}]`, 'special');
let constructorName = getCtxStyle(value, constructor, tag).slice(0, -1);
if (constructor !== null)
constructorName = `[${constructorName}]`;
return ctx.stylize(constructorName, 'special');
}
recurseTimes += 1;

Expand All @@ -761,7 +759,8 @@ function formatRaw(ctx, value, recurseTimes, typedArray) {
formatProperty(ctx, value, recurseTimes, keys[i], extrasType));
}
} catch (err) {
return handleMaxCallStackSize(ctx, err, constructor, tag, indentationLvl);
const constructorName = getCtxStyle(value, constructor, tag).slice(0, -1);
return handleMaxCallStackSize(ctx, err, constructorName, indentationLvl);
}
ctx.seen.pop();

Expand All @@ -788,7 +787,7 @@ function formatRaw(ctx, value, recurseTimes, typedArray) {
// This limit also makes sure that huge objects don't block the event loop
// significantly.
if (newLength > 2 ** 27) {
ctx.stop = true;
ctx.depth = -1;
}
return res;
}
Expand Down Expand Up @@ -869,7 +868,6 @@ function getFunctionBase(value, constructor, tag) {
}

function formatError(err, constructor, tag, ctx) {
// TODO(BridgeAR): Always show the error code if present.
let stack = err.stack || ErrorPrototype.toString(err);

// A stack trace may contain arbitrary data. Only manipulate the output
Expand Down Expand Up @@ -1021,12 +1019,12 @@ function groupArrayElements(ctx, output) {
return output;
}

function handleMaxCallStackSize(ctx, err, constructor, tag, indentationLvl) {
function handleMaxCallStackSize(ctx, err, constructorName, indentationLvl) {
if (isStackOverflowError(err)) {
ctx.seen.pop();
ctx.indentationLvl = indentationLvl;
return ctx.stylize(
`[${getCtxStyle(constructor, tag)}: Inspection interrupted ` +
`[${constructorName}: Inspection interrupted ` +
'prematurely. Maximum call stack size exceeded.]',
'special'
);
Expand Down
41 changes: 41 additions & 0 deletions test/parallel/test-util-inspect.js
Original file line number Diff line number Diff line change
Expand Up @@ -1094,6 +1094,47 @@ if (typeof Symbol !== 'undefined') {
'[Set Iterator] { 1, ... 1 more item, extra: true }');
}

// Minimal inspection should still return as much information as possible about
// the constructor and Symbol.toStringTag.
{
class Foo {
get [Symbol.toStringTag]() {
return 'ABC';
}
}
const a = new Foo();
assert.strictEqual(inspect(a, { depth: -1 }), 'Foo [ABC] {}');
a.foo = true;
assert.strictEqual(inspect(a, { depth: -1 }), '[Foo [ABC]]');
Object.defineProperty(a, Symbol.toStringTag, {
value: 'Foo',
configurable: true,
writable: true
});
assert.strictEqual(inspect(a, { depth: -1 }), '[Foo]');
delete a[Symbol.toStringTag];
Object.setPrototypeOf(a, null);
assert.strictEqual(inspect(a, { depth: -1 }), '[Foo: null prototype]');
delete a.foo;
assert.strictEqual(inspect(a, { depth: -1 }), '[Foo: null prototype] {}');
Object.defineProperty(a, Symbol.toStringTag, {
value: 'ABC',
configurable: true
});
assert.strictEqual(
inspect(a, { depth: -1 }),
'[Foo: null prototype] [ABC] {}'
);
Object.defineProperty(a, Symbol.toStringTag, {
value: 'Foo',
configurable: true
});
assert.strictEqual(
inspect(a, { depth: -1 }),
'[Object: null prototype] [Foo] {}'
);
}

// Test alignment of items in container.
// Assumes that the first numeric character is the start of an item.
{
Expand Down