console: make console more standard compliant #17708

BridgeAR · 2017-12-16T07:32:08Z

According to the standard the property descriptor of console
should be writable and non-enumerable.

Refs #12454
Fixes: #11805

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

Affected core subsystem(s)

console

Trott · 2017-12-16T14:50:30Z

test/parallel/test-console-is-a-namespace.js

+  const prototype1 = Object.getPrototypeOf(console);
+  const prototype2 = Object.getPrototypeOf(prototype1);
+
+  // This got commented out from the original test because in Node.js all functions are declared on the prototype.


Nit: Even though the test isn't ours, this comment is, right? If so, maybe wrap it at 80 chars?

Trott · 2017-12-16T14:56:34Z

pinging previous approvers: @TimothyGu @refack @bnoordhuis @addaleax @benjamingr @watilde @cjihrig

pinging author of first commit: @Wandalen

bnoordhuis · 2017-12-16T17:37:49Z

lib/internal/bootstrap_node.js

@@ -354,10 +352,9 @@
                                             originalConsole[key],
                                             wrappedConsole[key],
                                             config);
+      delete originalConsole[key];


Why was this added and why were the two lines below removed?

Ah, this should probably be a individual commit. It is only about a few entries but it did not feel good that we checked all entries again instead of just removing them beforehand.

Hmm, I'm not sure what effect deleting originalConsole[key] could have. Is it really safe?

bnoordhuis · 2017-12-16T17:38:53Z

test/parallel/test-console-assign-undefined.js

+
+// Should be above require, because code in require read console
+// what we are trying to avoid
+// set should be earlier than get


Cryptic comment. Maybe this?

Patch global.console before importing modules that may modify the console object.

bnoordhuis · 2017-12-16T17:43:12Z

test/parallel/test-console-assign-undefined.js

+// global.console's getter is called
+// Since the `console` cache variable is `undefined` and therefore false-y,
+// the getter still calls NativeModule.require() and returns the object
+// obtained from it, instead of returning `undefined` as expected.


Incomprehensible comment... I'd remove it.

After reading it... I totally agree. I have no idea what it stands for.

BridgeAR · 2017-12-16T18:38:05Z

I addressed the comments and refactored the test as it did feel like it could need some further polishing. Originally I did not touch the version from @Wandalen to keep the authorship in tact. This way it diverges quite a lot from the original.

@bnoordhuis I also separated the other bootstrapping part. It was just to minimize the necessary operations. Since delete is actually still slow, it might not yield any performance benefit but the opposite, so I am also totally fine with removing that part again.

BridgeAR · 2017-12-18T16:34:02Z

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

BridgeAR · 2017-12-21T07:12:30Z

@nodejs/tsc PTAL. This needs more LGs.

mcollina

LGTM

BridgeAR · 2017-12-21T14:20:26Z

@Wandalen I do not feel comfortable landing this with my changes to the tests without your permission. Would you be so kind and have a look?

A alternative would probably be to use the original code from @Wandalen and have a separate commit from me that changes the file accordingly. What do you all think about that?

According to the standard the property descriptor of console should be writable and non-enumerable. Fixes: nodejs#11805

BridgeAR · 2018-01-17T00:26:10Z

I separated the code from @Wandalen and me.

apapirovski

LGTM but the one delete statement flagged by @bnoordhuis does concern me.

apapirovski · 2018-01-17T20:42:01Z

lib/internal/bootstrap_node.js

@@ -354,10 +352,9 @@
                                             originalConsole[key],
                                             wrappedConsole[key],
                                             config);
+      delete originalConsole[key];


Hmm, I'm not sure what effect deleting originalConsole[key] could have. Is it really safe?

apapirovski · 2018-01-17T20:44:33Z

Also, FWIW, I think the check is very likely faster than the delete. The latter is very expensive in my experience.

BridgeAR · 2018-01-17T20:46:26Z

@apapirovski that is indeed probably true. It just felt more natural for me this way. I am also sure it is a safe thing to do but due to the concerns and since it is not necessary at all, I am going to remove that commit.

This imports a standard test from w3c/web-platform-tests (console-is-a-namespace).

BridgeAR · 2018-01-17T20:49:36Z

New CI https://ci.nodejs.org/job/node-test-pull-request/12590/
~~CITGM https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/1207/~~ (broken CITGM)

According to the standard the property descriptor of console should be writable and non-enumerable. PR-URL: nodejs#17708 Fixes: nodejs#11805 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>

This imports a standard test from w3c/web-platform-tests (console-is-a-namespace). PR-URL: nodejs#17708 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>

PR-URL: nodejs#17708 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>

BridgeAR · 2018-01-18T17:13:22Z

Landed in f054855...7809f38

The code currently assumes that `console` is already writable, but that's only if it was previously defined as writable. If it hasn't already been defined then the default value is false. Refs: #17708 PR-URL: #20185 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

According to the standard the property descriptor of console should be writable and non-enumerable. PR-URL: nodejs#17708 Fixes: nodejs#11805 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>

This imports a standard test from w3c/web-platform-tests (console-is-a-namespace). PR-URL: nodejs#17708 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>

PR-URL: nodejs#17708 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>

The code attaches global properties to the sandbox context by iterating over all the enumerable properties of `global`. However, in node v10, `console` switched [to being non-enmuerable][1]. This means that for users of this library with node>10, any `console.log`s in evaluated scripts will fail. This commit fixes this issue by manually attaching console to the sandbox (when globals are being used). A test has been added. Prior to the change to eval.js, the test would pass in node v8 but fail in v10 and v12. Also, the tests were already failing in v12, because in v12 `process` also became non-enumerable. I've applied a similar fix to `process` to ensure that it's always available too. [1]: nodejs/node#17708

BridgeAR added the semver-major PRs that contain breaking changes and should be released in the next major version. label Dec 16, 2017

nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label Dec 16, 2017

Trott reviewed Dec 16, 2017

View reviewed changes

benjamingr approved these changes Dec 16, 2017

View reviewed changes

bnoordhuis reviewed Dec 16, 2017

View reviewed changes

BridgeAR force-pushed the console-standard branch 2 times, most recently from 44ea72f to 965146c Compare December 16, 2017 18:35

jasnell approved these changes Dec 18, 2017

View reviewed changes

BridgeAR added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Dec 18, 2017

BridgeAR requested a review from a team December 18, 2017 16:35

targos approved these changes Dec 21, 2017

View reviewed changes

mcollina approved these changes Dec 21, 2017

View reviewed changes

lib: make console writable and non-enumerable

e6b42ee

According to the standard the property descriptor of console should be writable and non-enumerable. Fixes: nodejs#11805

BridgeAR force-pushed the console-standard branch from 965146c to 8388836 Compare January 17, 2018 00:24

BridgeAR requested a review from apapirovski January 17, 2018 20:34

apapirovski approved these changes Jan 17, 2018

View reviewed changes

Wandalen and others added 2 commits January 17, 2018 21:47

test: add standard console tests

b7ce7b3

This imports a standard test from w3c/web-platform-tests (console-is-a-namespace).

test: improve console tests

1193065

BridgeAR force-pushed the console-standard branch from 8388836 to 1193065 Compare January 17, 2018 20:47

jasnell approved these changes Jan 18, 2018

View reviewed changes

BridgeAR closed this Jan 18, 2018

SimenB mentioned this pull request Apr 19, 2018

Cannot extend Console in node 10 rc.0 #20157

Closed

kfarnung mentioned this pull request Apr 21, 2018

lib: make sure console is writable #20185

Closed

2 tasks

BridgeAR deleted the console-standard branch April 1, 2019 23:38

rensbaardman mentioned this pull request Jun 11, 2019

Modifying globals within module leaks to global with Node >=10 jhnns/rewire#167

Closed

teamdandelion mentioned this pull request Jul 5, 2019

ensure that globals includes process and console pierrec/node-eval#18

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

console: make console more standard compliant #17708

console: make console more standard compliant #17708

BridgeAR commented Dec 16, 2017

Trott Dec 16, 2017

BridgeAR Dec 16, 2017

Trott commented Dec 16, 2017

bnoordhuis Dec 16, 2017

BridgeAR Dec 16, 2017

apapirovski Jan 17, 2018

bnoordhuis Dec 16, 2017

bnoordhuis Dec 16, 2017

BridgeAR Dec 16, 2017

BridgeAR commented Dec 16, 2017

BridgeAR commented Dec 18, 2017

BridgeAR commented Dec 21, 2017

mcollina left a comment

BridgeAR commented Dec 21, 2017

BridgeAR commented Jan 17, 2018

apapirovski left a comment

apapirovski Jan 17, 2018

apapirovski commented Jan 17, 2018

BridgeAR commented Jan 17, 2018

BridgeAR commented Jan 17, 2018 •

edited

Loading

BridgeAR commented Jan 18, 2018

console: make console more standard compliant #17708

console: make console more standard compliant #17708

Conversation

BridgeAR commented Dec 16, 2017

Checklist

Affected core subsystem(s)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trott commented Dec 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BridgeAR commented Dec 16, 2017

BridgeAR commented Dec 18, 2017

BridgeAR commented Dec 21, 2017

mcollina left a comment

Choose a reason for hiding this comment

BridgeAR commented Dec 21, 2017

BridgeAR commented Jan 17, 2018

apapirovski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

apapirovski commented Jan 17, 2018

BridgeAR commented Jan 17, 2018

BridgeAR commented Jan 17, 2018 • edited Loading

BridgeAR commented Jan 18, 2018

BridgeAR commented Jan 17, 2018 •

edited

Loading