console: refactor inspector console extension installation #25450

joyeecheung · 2019-01-11T19:32:23Z

Instead of creating the console extensions eagerly during bootstrap
and storing them on an object, wrap the code into a function to be
called during installAdditionalCommandLineAPI only when the extensions
are actually needed, which may not even happen if the user do not
use the console in an inspector session, and does not need to happen
during bootstrap unconditionally.
Simplify the console methods wrapping and move the consoleFromVM
storage to internal/util/inspector.js

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

nodejs-github-bot · 2019-01-11T19:32:25Z

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

eugeneo

This change messes the top stack frame - instead of displaying user code location it returns internal/util/inspector.js:42

This is unacceptable as some popular tools (e.g. Chrome DevTools Console) only display that location and open it in an editor when the user clicks it.

joyeecheung · 2019-01-11T21:36:20Z

This change messes the top stack frame - instead of displaying user code location it returns internal/util/inspector.js:42

Is it possible to write a test for this? It seems pretty fragile to have this contract depended on by external tools without any tests.

Also, is it talking about the error stacks or the stack frames returned through the inspector protocol?

eugeneo · 2019-01-11T22:51:46Z

I created a new pull request with a test: #25455

jdalton

In addition to the issue @eugeneo highlighted with the call stack, removing .consoleCall from inspector binding makes it impossible to customize console methods for inspector use. We should expose consoleCall in a similar way to inspector.console.

joyeecheung · 2019-01-16T06:03:52Z

Rebased after #25455 and removed consoleCall changes. @eugeneo @jdalton PTAL.

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

- Instead of creating the console extensions eagerly during bootstrap and storing them on an object, wrap the code into a function to be called during `installAdditionalCommandLineAPI` only when the extensions are actually needed, which may not even happen if the user do not use the console in an inspector session, and does not need to happen during bootstrap unconditionally. - Simplify the console methods wrapping and move the `consoleFromVM` storage to `internal/util/inspector.js`

jdalton · 2019-01-16T14:32:05Z

lib/internal/util/inspector.js

+  consoleAPIModule.paths =
+      CJSModule._nodeModulePaths(cwd).concat(CJSModule.globalPaths);
+  commandLineApi.require = makeRequireFunction(consoleAPIModule);
+}


👆 Could someone explain this bit. I'm unfamiliar with the '<inspector console>' and commandLineApi.require bits. Is there a require exposed in the Chrome inspector console?

The inspector console is the one in the chrome inspector. By doing this, a require is exposed when you connect a chrome inspector to node. (And Runtime.evaluate if you enable it)

Is this something user accessible? If so, what does accessing it look like?

@jdalton: it's accessed when using require in DevTools console.

joyeecheung · 2019-01-18T11:15:38Z

Ping @eugeneo I've removed the consoleCall changes, can you take a look again? I'd like to land this so that 'internal/modules/cjs/loader' does not have to be loaded this early during bootstrap so that we can split the bootstrapping process from the execution mode selection which helps the snapshot effort.

joyeecheung · 2019-01-21T10:04:34Z

Ping @eugeneo

joyeecheung · 2019-01-23T09:31:19Z

I am going to dismiss #25450 (review) since it's been addressed a week ago without response, and it no longer applies to this PR since this passes the test added in #25455

outdated

joyeecheung · 2019-01-23T09:32:22Z

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

BridgeAR · 2019-01-23T10:13:37Z

lib/internal/util/inspector.js

 function sendInspectorCommand(cb, onError) {
+  const { hasInspector } = internalBinding('config');
+  const inspector = hasInspector ? require('inspector') : undefined;
  if (!hasInspector) return onError();


Nit: maybe just switch around the above two lines? That way there's no need for the ternary conditional.

BridgeAR · 2019-01-23T10:29:05Z

lib/internal/bootstrap/node.js

-    const inspector =
-      NativeModule.require('internal/console/inspector');
-    inspector.addInspectorApis(consoleFromNode, consoleFromVM);
+    const inspector = NativeModule.require('internal/util/inspector');
    // This will be exposed by `require('inspector').console` later.
    inspector.consoleFromVM = consoleFromVM;


I suggest to move this into internal/util/inspector. That way there's no need for the getter on module.exports.

The console from the VM is only accessible during bootstrap, global.console gets overridden with our console implementation - an alternative may be to store it in C++ and make it accessible (and cached) through 'internal/util/inspector', but otherwise this has to be done in lib/internal/bootstrap/node.js one way or another (stored either as a value or through a setter)

consoleFromVM is passed to inspector.wrapConsole() in the line below. Therefore the consoleFromVM variable in lib/internal/util/inspector.js could be set during the wrapConsole function call.

But it's just a nit and is not blocking for me.

joyeecheung · 2019-01-23T11:12:57Z

Resume: https://ci.nodejs.org/job/node-test-pull-request/20282/

- Instead of creating the console extensions eagerly during bootstrap and storing them on an object, wrap the code into a function to be called during `installAdditionalCommandLineAPI` only when the extensions are actually needed, which may not even happen if the user do not use the console in an inspector session, and does not need to happen during bootstrap unconditionally. - Simplify the console methods wrapping and move the `consoleFromVM` storage to `internal/util/inspector.js` PR-URL: #25450 Reviewed-By: John-David Dalton <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

joyeecheung · 2019-01-23T12:29:28Z

Landed in d3806f9

- Instead of creating the console extensions eagerly during bootstrap and storing them on an object, wrap the code into a function to be called during `installAdditionalCommandLineAPI` only when the extensions are actually needed, which may not even happen if the user do not use the console in an inspector session, and does not need to happen during bootstrap unconditionally. - Simplify the console methods wrapping and move the `consoleFromVM` storage to `internal/util/inspector.js` PR-URL: #25450 Reviewed-By: John-David Dalton <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>

nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label Jan 11, 2019

eugeneo previously requested changes Jan 11, 2019

View reviewed changes

joyeecheung added the blocked PRs that are blocked by other issues or PRs. label Jan 12, 2019

jdalton suggested changes Jan 12, 2019

View reviewed changes

joyeecheung added inspector Issues and PRs related to the V8 inspector protocol console Issues and PRs related to the console subsystem. and removed blocked PRs that are blocked by other issues or PRs. labels Jan 16, 2019

joyeecheung force-pushed the inspector-console branch from 0ace617 to d4a1e4c Compare January 16, 2019 06:05

jdalton approved these changes Jan 16, 2019

View reviewed changes

jdalton reviewed Jan 16, 2019

View reviewed changes

jasnell approved these changes Jan 18, 2019

View reviewed changes

BridgeAR approved these changes Jan 23, 2019

View reviewed changes

joyeecheung closed this Jan 23, 2019

MylesBorins mentioned this pull request Jan 24, 2019

v11.8.0 proposal #25687

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

console: refactor inspector console extension installation #25450

console: refactor inspector console extension installation #25450

joyeecheung commented Jan 11, 2019 •

edited

Loading

nodejs-github-bot commented Jan 11, 2019

eugeneo left a comment

joyeecheung commented Jan 11, 2019 •

edited

Loading

eugeneo commented Jan 11, 2019

jdalton left a comment

joyeecheung commented Jan 16, 2019 •

edited

Loading

jdalton Jan 16, 2019

devsnek Jan 16, 2019 •

edited

Loading

jdalton Jan 16, 2019 •

edited

Loading

joyeecheung Jan 18, 2019

joyeecheung commented Jan 18, 2019 •

edited

Loading

joyeecheung commented Jan 21, 2019

joyeecheung commented Jan 23, 2019

joyeecheung commented Jan 23, 2019

BridgeAR Jan 23, 2019

BridgeAR Jan 23, 2019

joyeecheung Jan 23, 2019 •

edited

Loading

BridgeAR Jan 23, 2019

joyeecheung commented Jan 23, 2019

joyeecheung commented Jan 23, 2019

console: refactor inspector console extension installation #25450

console: refactor inspector console extension installation #25450

Conversation

joyeecheung commented Jan 11, 2019 • edited Loading

Checklist

nodejs-github-bot commented Jan 11, 2019

eugeneo left a comment

Choose a reason for hiding this comment

joyeecheung commented Jan 11, 2019 • edited Loading

eugeneo commented Jan 11, 2019

jdalton left a comment

Choose a reason for hiding this comment

joyeecheung commented Jan 16, 2019 • edited Loading

jdalton Jan 16, 2019

Choose a reason for hiding this comment

devsnek Jan 16, 2019 • edited Loading

Choose a reason for hiding this comment

jdalton Jan 16, 2019 • edited Loading

Choose a reason for hiding this comment

joyeecheung Jan 18, 2019

Choose a reason for hiding this comment

joyeecheung commented Jan 18, 2019 • edited Loading

joyeecheung commented Jan 21, 2019

joyeecheung commented Jan 23, 2019

joyeecheung commented Jan 23, 2019

BridgeAR Jan 23, 2019

Choose a reason for hiding this comment

BridgeAR Jan 23, 2019

Choose a reason for hiding this comment

joyeecheung Jan 23, 2019 • edited Loading

Choose a reason for hiding this comment

BridgeAR Jan 23, 2019

Choose a reason for hiding this comment

joyeecheung commented Jan 23, 2019

joyeecheung commented Jan 23, 2019

joyeecheung commented Jan 11, 2019 •

edited

Loading

joyeecheung commented Jan 11, 2019 •

edited

Loading

joyeecheung commented Jan 16, 2019 •

edited

Loading

devsnek Jan 16, 2019 •

edited

Loading

jdalton Jan 16, 2019 •

edited

Loading

joyeecheung commented Jan 18, 2019 •

edited

Loading

joyeecheung Jan 23, 2019 •

edited

Loading