util: add Set and Map size to the inspect output #30225

BridgeAR · 2019-11-02T18:42:46Z

This adds the set or map size while serializing those with inspect().
That aligns the output with the one from Chromium. To do so, I refactored some code that special handled iterators that had the prototype set to null. That is not required anymore. It was necessary to bind some properties to later on used functions to keep the performance profile in tact and the implementation similar to the way it used to work.
Due to the refactoring a few more edge cases will also from now on be handled properly (inspecting a set or map with a broken iterator symbol or the size property manipulated will still work).

This should be semver-minor, since we explicitly note that people should not rely on the inspect output programmatically.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

lib/internal/util/inspect.js

addaleax · 2019-11-02T18:56:08Z

Would it be a bit more intuitive (and more consistent) to handle this like we do for e.g. ArrayBuffers, i.e. print size as a property (which is how you’d access it in JS)?

> a = new ArrayBuffer(4)
ArrayBuffer { [Uint8Contents]: <00 00 00 00>, byteLength: 4 }
> a = new Map([[1,2],[3,4]])
Map { 1 => 2, 3 => 4, size: 2 }

devsnek · 2019-11-02T18:56:58Z

I don't think it's immediately clear what the number on the map means. Can we just show 'size' as a normal property? if someone overrides it they probably would want our inspection to show the overridden one anyway.

BridgeAR · 2019-11-02T19:07:48Z

I am fine to print that instead. This implementation is just not possible to manipulate. The other one could show something else (I actually added a test for that).

BridgeAR · 2019-11-02T19:30:09Z

Just as a note: I personally think the shorter notation is nicer to read (even though it definitely requires a short moment to understand the number when seeing this notation for the first time).

I updated the implementation nevertheless. PTAL.

addaleax

I find the brackets around [size] weird and would recommend to omit them, but either way this LGTM

joyeecheung · 2019-11-02T19:39:35Z

This is how things look like in the Chrome DevTools BTW.

Do we really need to display the size when the number of entries are small enough so that they are all displayed?

Outdated due to a changed implementation.

BridgeAR · 2019-11-18T22:52:47Z

I went ahead and created a twitter pool for this: https://twitter.com/BridgeAR/status/1195687117080408067
I tried to keep the question as neutral as possible.

Seems like 72% of all 115 participants would like to have the size as part of the default output. 28% are happy with the output as it is.

62.5% percent (of the 72%) are in favor of Set(n) { ... } or Map(n) { ... } while 37.5% would favor output similar to a property (the latter number is the sum of the output visualized as own property and as computed/prototype property).

I therefore went back to my initial implementation. @addaleax I removed your LG due to that change. PTAL

@joyeecheung we could in theory only add the number in a couple of cases (depending on the size). Set and Map entries can in general look very different though and in some cases it might be straight forward to see how many entries they are while it's more difficult in other cases. Thus I think it's best to be consistent. Especially as it might also be confusing to some users to see different output depending on the size.

@nodejs/util PTAL

BridgeAR · 2019-11-26T17:21:52Z

Rebased due to conflicts @nodejs/util this could use some reviews.

nodejs-github-bot · 2019-12-03T17:44:13Z

CI: https://ci.nodejs.org/job/node-test-pull-request/27310/ ✔️

targos · 2019-12-06T11:10:43Z

I think this can be semver-patch. There are no additions to the public API.
Edit: could stay semver-minor if you think the change is substantial enough.

BridgeAR · 2019-12-06T17:40:22Z

I am fine with this being a patch as well. We treat most of our util changes as patches. I'll follow your recommendation while I am fine both ways.

nodejs-github-bot · 2019-12-07T08:50:58Z

CI: https://ci.nodejs.org/job/node-test-pull-request/27448/ ✅ (yellow build with a known Windows flake)

Trott · 2019-12-14T05:36:07Z

Out of caution, here's a CITGM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/2127/ ✔️

This removes the special handling to inspect iterable objects with a null prototype. It is now handled together with the regular prototype. PR-URL: #30225 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Rich Trott <[email protected]>

This adds the size of a set and map to the output. This aligns the output with the one from Chromium. PR-URL: #30225 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Rich Trott <[email protected]>

BridgeAR · 2019-12-15T14:01:02Z

Landed in eeae598, ab59989 🎉

This removes the special handling to inspect iterable objects with a null prototype. It is now handled together with the regular prototype. PR-URL: #30225 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Rich Trott <[email protected]>

This adds the size of a set and map to the output. This aligns the output with the one from Chromium. PR-URL: #30225 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Notable Changes: * cli: * add --trace-exit cli option (legendecas) #30516 * http,https: * increase server headers timeout (Tim Costa) #30071 * readline: * update ansi-regex (Ruben Bridgewater) #30907 * promote \_getCursorPos to public api (Jeremy Albright) #30687 * repl: * add completion preview (Ruben Bridgewater) #30907 * util: * add Set and map size to inspect output (Ruben Bridgewater) #30225 * wasi: * require CLI flag to require() wasi module (Colin Ihrig) #30963 PR-URL: #31010

targos · 2020-01-14T12:15:00Z

This doesn't land cleanly on v12.x-staging and probably depends on previous PRs that were not backported yet.

This removes the special handling to inspect iterable objects with a null prototype. It is now handled together with the regular prototype. PR-URL: nodejs#30225 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Rich Trott <[email protected]>

This removes the special handling to inspect iterable objects with a null prototype. It is now handled together with the regular prototype. Backport-PR-URL: #31431 PR-URL: #30225 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Rich Trott <[email protected]>

BridgeAR added util Issues and PRs related to the built-in util module. semver-minor PRs that contain new features and should be released in the next minor version. labels Nov 2, 2019

BridgeAR force-pushed the add-set-map-size branch from 9863eb1 to 8d6cd92 Compare November 2, 2019 18:50

BridgeAR commented Nov 2, 2019

View reviewed changes

lib/internal/util/inspect.js Outdated Show resolved Hide resolved

addaleax previously approved these changes Nov 2, 2019

View reviewed changes

BridgeAR added blocked PRs that are blocked by other issues or PRs. and removed blocked PRs that are blocked by other issues or PRs. labels Nov 17, 2019

This comment has been minimized.

Sign in to view

BridgeAR added the review wanted PRs that need reviews. label Nov 19, 2019

This comment has been minimized.

Sign in to view

BridgeAR force-pushed the add-set-map-size branch from a9b559d to 402f9be Compare November 26, 2019 17:21

This comment has been minimized.

Sign in to view

targos approved these changes Dec 6, 2019

View reviewed changes

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 6, 2019

BridgeAR removed the semver-minor PRs that contain new features and should be released in the next minor version. label Dec 6, 2019

This comment has been minimized.

Sign in to view

Trott approved these changes Dec 14, 2019

View reviewed changes

BridgeAR closed this Dec 15, 2019

MylesBorins mentioned this pull request Dec 17, 2019

v13.5.0 proposal #31010

Merged

targos added the backport-blocked-v12.x label Jan 14, 2020

BridgeAR deleted the add-set-map-size branch January 20, 2020 12:07

BridgeAR added backport-requested-v12.x and removed backport-blocked-v12.x review wanted PRs that need reviews. labels Jan 22, 2020

BridgeAR mentioned this pull request Jan 22, 2020

[v12.x] multiple util and assert backports #31431

Closed

4 tasks

MylesBorins added backported-to-v12.x and removed backport-requested-v12.x labels Jan 30, 2020

targos mentioned this pull request Jan 30, 2020

v12.15.0 release proposal #31368

Closed

MylesBorins mentioned this pull request Feb 8, 2020

v12.16.0 proposal #31691

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: add Set and Map size to the inspect output #30225

util: add Set and Map size to the inspect output #30225

BridgeAR commented Nov 2, 2019

addaleax commented Nov 2, 2019 •

edited

Loading

devsnek commented Nov 2, 2019

BridgeAR commented Nov 2, 2019

BridgeAR commented Nov 2, 2019

addaleax left a comment

joyeecheung commented Nov 2, 2019

BridgeAR commented Nov 18, 2019 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

BridgeAR commented Nov 26, 2019

This comment has been minimized.

nodejs-github-bot commented Dec 3, 2019 •

edited by BridgeAR

Loading

targos commented Dec 6, 2019 •

edited

Loading

BridgeAR commented Dec 6, 2019

This comment has been minimized.

This comment has been minimized.

nodejs-github-bot commented Dec 7, 2019 •

edited by BridgeAR

Loading

Trott commented Dec 14, 2019 •

edited by BridgeAR

Loading

BridgeAR commented Dec 15, 2019

targos commented Jan 14, 2020

util: add Set and Map size to the inspect output #30225

util: add Set and Map size to the inspect output #30225

Conversation

BridgeAR commented Nov 2, 2019

Checklist

addaleax commented Nov 2, 2019 • edited Loading

devsnek commented Nov 2, 2019

BridgeAR commented Nov 2, 2019

BridgeAR commented Nov 2, 2019

addaleax left a comment

Choose a reason for hiding this comment

joyeecheung commented Nov 2, 2019

BridgeAR commented Nov 18, 2019 • edited Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

BridgeAR commented Nov 26, 2019

This comment has been minimized.

nodejs-github-bot commented Dec 3, 2019 • edited by BridgeAR Loading

targos commented Dec 6, 2019 • edited Loading

BridgeAR commented Dec 6, 2019

This comment has been minimized.

This comment has been minimized.

nodejs-github-bot commented Dec 7, 2019 • edited by BridgeAR Loading

Trott commented Dec 14, 2019 • edited by BridgeAR Loading

BridgeAR commented Dec 15, 2019

targos commented Jan 14, 2020

addaleax commented Nov 2, 2019 •

edited

Loading

BridgeAR commented Nov 18, 2019 •

edited

Loading

nodejs-github-bot commented Dec 3, 2019 •

edited by BridgeAR

Loading

targos commented Dec 6, 2019 •

edited

Loading

nodejs-github-bot commented Dec 7, 2019 •

edited by BridgeAR

Loading

Trott commented Dec 14, 2019 •

edited by BridgeAR

Loading