Skip to content

util: add inspection getter option - #24852

Closed
BridgeAR wants to merge 1 commit into
nodejs:masterfrom
BridgeAR:inspect-getters
Closed

util: add inspection getter option#24852
BridgeAR wants to merge 1 commit into
nodejs:masterfrom
BridgeAR:inspect-getters

Conversation

@BridgeAR

@BridgeARBridgeAR commented Dec 5, 2018

Copy link
Copy Markdown
Member

Currently it is not possible to inspect getters. To prevent any side
effects this should not become a default but under lots of
circumstances it would still be useful to inspect getters. This way
it is possible to actively opt into inspecting those.

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

@BridgeARBridgeAR added the semver-minor PRs that contain new features and should be released in the next minor version. label Dec 5, 2018
@nodejs-github-bot

nodejs-github-bot commented Dec 5, 2018

Copy link
Copy Markdown
Collaborator

@BridgeAR build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/1841/pipeline

@nodejs-github-botnodejs-github-bot added the util Issues and PRs related to the built-in util module. label Dec 5, 2018
vsemozhetbyt
vsemozhetbyt reviewed Dec 5, 2018
View reviewed changes
Comment threaddoc/api/util.md Outdated
Fishrock123
Fishrock123 reviewed Dec 5, 2018
View reviewed changes
Comment threadlib/internal/util/inspect.js Outdated
Fishrock123
Fishrock123 approved these changes Dec 5, 2018
View reviewed changes

@Fishrock123Fishrock123 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Seems fine

addaleax
addaleax approved these changes Dec 5, 2018
View reviewed changes
Comment threaddoc/api/util.md Outdated
@BridgeAR

BridgeAR commented Dec 5, 2018

Copy link
Copy Markdown
MemberAuthor

CI https://ci.nodejs.org/job/node-test-pull-request/19242/

@BridgeARBridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 5, 2018
@Trott

Trott commented Dec 5, 2018

Copy link
Copy Markdown
Member

Needs a rebase.

@devsnek

devsnek commented Dec 5, 2018

Copy link
Copy Markdown
Member

wouldn't this be better suited for the custom inspect symbol? i feel like this is too blunt a sword.

@BridgeAR

BridgeAR commented Dec 5, 2018

Copy link
Copy Markdown
MemberAuthor

@devsnek in what way? The default is set to off. In most code we do not check for the descriptors at all and just access the properties. In util.inspect we are more conservative and only allow direct access with an option.

@devsnek

devsnek commented Dec 6, 2018•
edited
Loading

Copy link
Copy Markdown
Member

@BridgeAR i'm just trying to imagine when i would personally use this, and the answer is either "something weird i don't own" in which case i wouldn't want to just willy-nilly trigger accessors, or something i own, in which case i would just add a custom inspect symbol.

an alternative to this could be using v8 side effect detection in the default inspector

@BridgeAR

BridgeAR commented Dec 6, 2018

Copy link
Copy Markdown
MemberAuthor

@devsnek I see your point but I still see further use cases and it is easier to use this option than writing a custom inspection function each time. I personally would like to use this while having customInspect = false and inside assert since we don't pay attention to getters when comparing objects and in that case the error output is not as it should be.

@BridgeAR

BridgeAR commented Dec 6, 2018

Copy link
Copy Markdown
MemberAuthor

Rebased due to conflicts.

CI https://ci.nodejs.org/job/node-test-pull-request/19280/

@BridgeAR

BridgeAR commented Dec 7, 2018•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Resumed CI https://ci.nodejs.org/job/node-test-pull-request/19300/

Rebased due to conflicts.

CI https://ci.nodejs.org/job/node-test-pull-request/19325/

@BridgeAR
util: add inspection getter option
d7b15c1
Currently it is not possible to inspect getters. To prevent any side
effects this should not become a default but under lots of
circumstances it would still be useful to inspect getters. This way
it is possible to actively opt into inspecting those.
@Trott

Trott commented Dec 8, 2018

Copy link
Copy Markdown
Member

CI: https://ci.nodejs.org/job/node-test-pull-request/19334/

@Trott

Trott commented Dec 9, 2018

Copy link
Copy Markdown
Member

Resume Build CI: https://ci.nodejs.org/job/node-test-pull-request/19341/

@Trott

Trott commented Dec 9, 2018

Copy link
Copy Markdown
Member

Resume Build CI: https://ci.nodejs.org/job/node-test-pull-request/19344/

@Trott

Trott commented Dec 9, 2018•
edited by BridgeAR
Loading

Copy link
Copy Markdown
Member

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

@danbev

danbev commented Dec 12, 2018

Copy link
Copy Markdown
Contributor

Landed in f194b7f.

@danbevdanbev closed this Dec 12, 2018
danbev pushed a commit that referenced this pull request Dec 12, 2018
@BridgeAR@danbev
util: add inspection getter option
f194b7f
Currently it is not possible to inspect getters. To prevent any side
effects this should not become a default but under lots of
circumstances it would still be useful to inspect getters. This way
it is possible to actively opt into inspecting those.
PR-URL: #24852
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@addaleaxaddaleax mentioned this pull request Dec 15, 2018
Closed
4 tasks
BethGriggs pushed a commit that referenced this pull request Dec 17, 2018
@BridgeAR@BethGriggs
util: add inspection getter option
117e991
Currently it is not possible to inspect getters. To prevent any side
effects this should not become a default but under lots of
circumstances it would still be useful to inspect getters. This way
it is possible to actively opt into inspecting those.
PR-URL: #24852
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@BethGriggsBethGriggs mentioned this pull request Dec 18, 2018
Merged
BethGriggs added a commit that referenced this pull request Dec 18, 2018
@BethGriggs
2018-12-18, Version 11.5.0 (Current)
c911de2
Notable changes:
* **test**:
* test TLS client authentication (Sam Roberts)
[#24733](#24733)
* **tls**:
* support "BEGIN TRUSTED CERTIFICATE" for ca: (Sam Roberts)
[#24733](#24733)
* **tools**:
* update ESLint to 5.10.0 (cjihrig)
[#24903](#24903)
* **util**:
* add inspection getter option (Ruben Bridgewater)
[#24852](#24852)
PR-URL: #25102
MylesBorins pushed a commit that referenced this pull request Dec 18, 2018
@BethGriggs@MylesBorins
2018-12-18, Version 11.5.0 (Current)
3a4c67d
Notable changes:
* **test**:
* test TLS client authentication (Sam Roberts)
[#24733](#24733)
* **tls**:
* support "BEGIN TRUSTED CERTIFICATE" for ca: (Sam Roberts)
[#24733](#24733)
* **tools**:
* update ESLint to 5.10.0 (cjihrig)
[#24903](#24903)
* **util**:
* add inspection getter option (Ruben Bridgewater)
[#24852](#24852)
PR-URL: #25102
BethGriggs added a commit that referenced this pull request Dec 18, 2018
@BethGriggs
2018-12-18, Version 11.5.0 (Current)
9a5b243
Notable changes:
* **tls**:
* support "BEGIN TRUSTED CERTIFICATE" for ca: (Sam Roberts)
[#24733](#24733)
* **util**:
* add inspection getter option (Ruben Bridgewater)
[#24852](#24852)
PR-URL: #25102
BethGriggs added a commit that referenced this pull request Dec 18, 2018
@BethGriggs
2018-12-18, Version 11.5.0 (Current)
74a1dfb
Notable changes:
* **tls**:
* support "BEGIN TRUSTED CERTIFICATE" for ca: (Sam Roberts)
[#24733](#24733)
* **util**:
* add inspection getter option (Ruben Bridgewater)
[#24852](#24852)
PR-URL: #25102
@beevelopbeevelop mentioned this pull request Dec 18, 2018
Closed
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
@BridgeAR@refack
util: add inspection getter option
cb283d7
Currently it is not possible to inspect getters. To prevent any side
effects this should not become a default but under lots of
circumstances it would still be useful to inspect getters. This way
it is possible to actively opt into inspecting those.
PR-URL: nodejs#24852
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
@BethGriggs@refack
2018-12-18, Version 11.5.0 (Current)
ee7f605
Notable changes:
* **tls**:
* support "BEGIN TRUSTED CERTIFICATE" for ca: (Sam Roberts)
[nodejs#24733](nodejs#24733)
* **util**:
* add inspection getter option (Ruben Bridgewater)
[nodejs#24852](nodejs#24852)
PR-URL: nodejs#25102
@BridgeAR
BridgeAR deleted the inspect-getters branch January 20, 2020 11:43
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@addaleaxaddaleaxaddaleax approved these changes
+2 more reviewers
@vsemozhetbytvsemozhetbytvsemozhetbyt left review comments
@Fishrock123Fishrock123Fishrock123 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.semver-minorPRs that contain new features and should be released in the next minor version.utilIssues and PRs related to the built-in util module.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@BridgeAR@nodejs-github-bot@Trott@devsnek@danbev@addaleax@Fishrock123@vsemozhetbyt@BethGriggs