Skip to content

Commit

Permalink
lib: guard inspector console using process var
Browse files Browse the repository at this point in the history
Currently the inspector module is always loaded and if it does not
return anything the inspector console setup is skipped.

This commit uses the process.config.variables.v8_enable_inspector
variable to only load the inspector module if it is enabled.

PR-URL: #15008
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
danbev authored and MylesBorins committed Nov 17, 2017
1 parent 85fd7bb commit 14f8cee
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
4 changes: 2 additions & 2 deletions lib/internal/bootstrap_node.js
Original file line number Diff line number Diff line change
Expand Up @@ -319,10 +319,10 @@
}

function setupInspector(originalConsole, wrappedConsole, Module) {
const { addCommandLineAPI, consoleCall } = process.binding('inspector');
if (!consoleCall) {
if (!process.config.variables.v8_enable_inspector) {
return;
}
const { addCommandLineAPI, consoleCall } = process.binding('inspector');
// Setup inspector command line API
const { makeRequireFunction } = NativeModule.require('internal/module');
const path = NativeModule.require('path');
Expand Down
5 changes: 5 additions & 0 deletions test/fixtures/overwrite-config-preload-module.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
'use strict'
const common = require('../common');
common.skipIfInspectorDisabled();

process.config = {};
41 changes: 41 additions & 0 deletions test/sequential/test-inspector-overwrite-config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// Flags: --require ./test/fixtures/overwrite-config-preload-module.js
'use strict';

// This test ensures that overwriting a process configuration
// value does not affect code in bootstrap_node.js. Specifically this tests
// that the inspector console functions are bound even though
// overwrite-config-preload-module.js overwrote the process.config variable.

// We cannot do a check for the inspector because the configuration variables
// were reset/removed by overwrite-config-preload-module.js.
/* eslint-disable inspector-check */

const common = require('../common');
const assert = require('assert');
const inspector = require('inspector');
const msg = 'Test inspector logging';
let asserted = false;

async function testConsoleLog() {
const session = new inspector.Session();
session.connect();
session.on('inspectorNotification', (data) => {
if (data.method === 'Runtime.consoleAPICalled') {
assert.strictEqual(data.params.args.length, 1);
assert.strictEqual(data.params.args[0].value, msg);
asserted = true;
}
});
session.post('Runtime.enable');
console.log(msg);
session.disconnect();
}

common.crashOnUnhandledRejection();

async function runTests() {
await testConsoleLog();
assert.ok(asserted, 'log statement did not reach the inspector');
}

runTests();

0 comments on commit 14f8cee

Please sign in to comment.