-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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
Symbol key props visible in inspection by default #9726
Changes from all commits
903f353
192d79a
3ace6a9
8e73c95
3cbd847
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -371,10 +371,13 @@ function formatValue(ctx, value, recurseTimes) { | |
// Look up the keys of the object. | ||
var keys = Object.keys(value); | ||
var visibleKeys = arrayToHash(keys); | ||
const symbolKeys = Object.getOwnPropertySymbols(value); | ||
const enumSymbolKeys = symbolKeys | ||
.filter((key) => value.propertyIsEnumerable(key)); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This would break if |
||
keys = keys.concat(enumSymbolKeys); | ||
|
||
if (ctx.showHidden) { | ||
keys = Object.getOwnPropertyNames(value); | ||
keys = keys.concat(Object.getOwnPropertySymbols(value)); | ||
keys = Object.getOwnPropertyNames(value).concat(symbolKeys); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the same result. The change is to not get the symbols twice. |
||
} | ||
|
||
// This could be a boxed primitive (new String(), etc.), check valueOf() | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -588,8 +588,9 @@ assert.doesNotThrow(function() { | |
'{ a: 123, inspect: [Function: inspect] }'); | ||
|
||
const subject = { a: 123, [util.inspect.custom]() { return this; } }; | ||
const UIC = 'util.inspect.custom'; | ||
assert.strictEqual(util.inspect(subject), | ||
'{ a: 123 }'); | ||
`{ a: 123,\n [Symbol(${UIC})]: [Function: [${UIC}]] }`); | ||
} | ||
|
||
// util.inspect with "colors" option should produce as many lines as without it | ||
|
@@ -659,18 +660,27 @@ if (typeof Symbol !== 'undefined') { | |
|
||
subject[Symbol('symbol')] = 42; | ||
|
||
assert.strictEqual(util.inspect(subject), '{}'); | ||
assert.strictEqual(util.inspect(subject), '{ [Symbol(symbol)]: 42 }'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This demonstrates the change. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just the way I like it 😉 |
||
assert.strictEqual( | ||
util.inspect(subject, options), | ||
'{ [Symbol(symbol)]: 42 }' | ||
); | ||
|
||
Object.defineProperty( | ||
subject, | ||
Symbol(), | ||
{enumerable: false, value: 'non-enum'}); | ||
assert.strictEqual(util.inspect(subject), '{ [Symbol(symbol)]: 42 }'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This assertion is removed because we already have an assertion above that symbol key properties are visible with |
||
assert.strictEqual( | ||
util.inspect(subject, options), | ||
'{ [Symbol(symbol)]: 42, [Symbol()]: \'non-enum\' }' | ||
); | ||
|
||
subject = [1, 2, 3]; | ||
subject[Symbol('symbol')] = 42; | ||
|
||
assert.strictEqual(util.inspect(subject), '[ 1, 2, 3 ]'); | ||
assert.strictEqual(util.inspect(subject, options), | ||
'[ 1, 2, 3, [length]: 3, [Symbol(symbol)]: 42 ]'); | ||
assert.strictEqual(util.inspect(subject), | ||
'[ 1, 2, 3, [Symbol(symbol)]: 42 ]'); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So in essence, this assertion is not instead of the one in 672, but instead of the one in 671. I guess it shows that symbol key properties can coexist peacefully with other properties in inspection. Or something about the order of properties? In any case, I'm guessing that the essence is preserved. |
||
} | ||
|
||
// test Set | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't fully understand what goes on with
keys
vs.visibleKeys
, yet, this seems to work.