inspector: expose original console

Adds require('inspector').console, mapping it to the original global.console of V8. This enables applications to send messages to the inspector console programmatically. Fixes: #21651 PR-URL: #21659 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>

Author: mcollina

doc/api/inspector.md

@@ -28,6 +28,17 @@ started.
 If wait is `true`, will block until a client has connected to the inspect port
 and flow control has been passed to the debugger client.
 
+### inspector.console
+
+An object to send messages to the remote inspector console.
+
+```js
+require('inspector').console.log('a message');
+```
+
+The inspector console does not have API parity with Node.js
+console.
+
 ### inspector.close()
 
 Deactivate the inspector. Blocks until there are no active connections.

lib/inspector.js

@@ -11,6 +11,7 @@ const{
 }=require('internal/errors').codes;
 constutil=require('util');
 const{ Connection, open, url }=process.binding('inspector');
+const{ originalConsole }=require('internal/process/per_thread');
 
 if(!Connection||!require('internal/worker').isMainThread)
 thrownewERR_INSPECTOR_NOT_AVAILABLE();
@@ -103,5 +104,6 @@ module.exports ={
 open: (port,host,wait)=>open(port,host,!!wait),
 close: process._debugEnd,
 url: url,
+console: originalConsole,
  Session
 };

lib/internal/bootstrap/node.js

@@ -120,6 +120,8 @@
 
 constbrowserGlobals=!process._noBrowserGlobals;
 if(browserGlobals){
+// we are setting this here to foward it to the inspector later
+perThreadSetup.originalConsole=global.console;
 setupGlobalTimeouts();
 setupGlobalConsole();
 setupGlobalURL();

test/common/inspector-helper.js

@@ -7,6 +7,7 @@ const fixtures = require('../common/fixtures');
 const{ spawn }=require('child_process');
 const{parse: parseURL}=require('url');
 const{ getURLFromFilePath }=require('internal/url');
+const{ EventEmitter }=require('events');
 
 const_MAINSCRIPT=fixtures.path('loop.js');
 constDEBUG=false;
@@ -311,10 +312,12 @@ class InspectorSession{
 }
 }
 
-classNodeInstance{
+classNodeInstanceextendsEventEmitter{
 constructor(inspectorFlags=['--inspect-brk=0'],
 scriptContents='',
 scriptFile=_MAINSCRIPT){
+super();
+
 this._scriptPath=scriptFile;
 this._script=scriptFile ? null : scriptContents;
 this._portCallback=null;
@@ -326,7 +329,10 @@ class NodeInstance{
 this._unprocessedStderrLines=[];
 
 this._process.stdout.on('data',makeBufferingDataCallback(
-(line)=>console.log('[out]',line)));
+(line)=>{
+this.emit('stdout',line);
+console.log('[out]',line);
+}));
 
 this._process.stderr.on('data',makeBufferingDataCallback(
 (message)=>this.onStderrLine(message)));

test/sequential/test-inspector-console.js

@@ -0,0 +1,39 @@
+// Flags: --expose-internals
+'use strict';
+
+constcommon=require('../common');
+common.skipIfInspectorDisabled();
+
+const{ NodeInstance }=require('../common/inspector-helper.js');
+constassert=require('assert');
+
+asyncfunctionrunTest(){
+constscript='require(\'inspector\').console.log(\'hello world\');';
+constchild=newNodeInstance('--inspect-brk=0',script,'');
+
+letout='';
+child.on('stdout',(line)=>out+=line);
+
+constsession=awaitchild.connectInspectorSession();
+
+constcommands=[
+{'method': 'Runtime.enable'},
+{'method': 'Runtime.runIfWaitingForDebugger'}
+];
+
+session.send(commands);
+
+constmsg=awaitsession.waitForNotification('Runtime.consoleAPICalled');
+
+assert.strictEqual(msg.params.type,'log');
+assert.deepStrictEqual(msg.params.args,[{
+type: 'string',
+value: 'hello world'
+}]);
+assert.strictEqual(out,'');
+
+session.disconnect();
+}
+
+common.crashOnUnhandledRejection();
+runTest();