Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

inspector: expose original console #21659

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/api/inspector.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions lib/inspector.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const {
} = require('internal/errors').codes;
const util = require('util');
const { Connection, open, url } = process.binding('inspector');
const { originalConsole } = require('internal/process/per_thread');

if (!Connection || !require('internal/worker').isMainThread)
throw new ERR_INSPECTOR_NOT_AVAILABLE();
Expand Down Expand Up @@ -103,5 +104,6 @@ module.exports = {
open: (port, host, wait) => open(port, host, !!wait),
close: process._debugEnd,
url: url,
console: originalConsole,
Session
};
2 changes: 2 additions & 0 deletions lib/internal/bootstrap/node.js
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@

const browserGlobals = !process._noBrowserGlobals;
if (browserGlobals) {
// we are setting this here to foward it to the inspector later
perThreadSetup.originalConsole = global.console;
setupGlobalTimeouts();
setupGlobalConsole();
setupGlobalURL();
Expand Down
10 changes: 8 additions & 2 deletions test/common/inspector-helper.js
Original file line number Diff line number Diff line change
Expand Up @@ -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');
const DEBUG = false;
Expand Down Expand Up @@ -311,10 +312,12 @@ class InspectorSession {
}
}

class NodeInstance {
class NodeInstance extends EventEmitter {
constructor(inspectorFlags = ['--inspect-brk=0'],
scriptContents = '',
scriptFile = _MAINSCRIPT) {
super();

this._scriptPath = scriptFile;
this._script = scriptFile ? null : scriptContents;
this._portCallback = null;
Expand All @@ -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)));
Expand Down
39 changes: 39 additions & 0 deletions test/sequential/test-inspector-console.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// Flags: --expose-internals
'use strict';

const common = require('../common');
common.skipIfInspectorDisabled();

const { NodeInstance } = require('../common/inspector-helper.js');
const assert = require('assert');

async function runTest() {
const script = 'require(\'inspector\').console.log(\'hello world\');';
const child = new NodeInstance('--inspect-brk=0', script, '');

let out = '';
child.on('stdout', (line) => out += line);

const session = await child.connectInspectorSession();

const commands = [
{ 'method': 'Runtime.enable' },
{ 'method': 'Runtime.runIfWaitingForDebugger' }
];

session.send(commands);

const msg = await session.waitForNotification('Runtime.consoleAPICalled');

assert.strictEqual(msg.params.type, 'log');
assert.deepStrictEqual(msg.params.args, [{
type: 'string',
value: 'hello world'
}]);
Copy link
Member

Choose a reason for hiding this comment

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

This should also check if stdout is empty.

assert.strictEqual(out, '');

session.disconnect();
}

common.crashOnUnhandledRejection();
runTest();