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

deps: update node-inspect to v2.0.0 #33447

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
31 changes: 31 additions & 0 deletions deps/node-inspect/.github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Node CI

on: [push, pull_request]

jobs:
build:

runs-on: ubuntu-latest

strategy:
fail-fast: false
matrix:
node-version:
# See https://github.com/nodejs/node-inspect/pull/78
# - 10.x
- 12.x
- 13.x

steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: npm install, build, and test
run: |
npm install
npm run build --if-present
npm test
env:
CI: true
40 changes: 20 additions & 20 deletions deps/node-inspect/lib/_inspect.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ const runAsStandalone = typeof __dirname !== 'undefined';
const [ InspectClient, createRepl ] =
runAsStandalone ?
// This copy of node-inspect is on-disk, relative paths make sense.
[
require('./internal/inspect_client'),
require('./internal/inspect_repl')
] :
[
require('./internal/inspect_client'),
require('./internal/inspect_repl')
] :
// This copy of node-inspect is built into the node executable.
[
require('node-inspect/lib/internal/inspect_client'),
require('node-inspect/lib/internal/inspect_repl')
];
[
require('node-inspect/lib/internal/inspect_client'),
require('node-inspect/lib/internal/inspect_repl')
];

const debuglog = util.debuglog('inspect');

Expand All @@ -49,8 +49,8 @@ class StartupError extends Error {
}
}

function portIsFree(host, port, timeout = 2000) {
if (port === 0) return Promise.resolve(); // Binding to a random port.
function portIsFree(host, port, timeout = 9999) {
if (port === 0) return Promise.resolve(); // Binding to a random port.

const retryDelay = 150;
let didTimeOut = false;
Expand Down Expand Up @@ -96,9 +96,9 @@ function runScript(script, scriptArgs, inspectHost, inspectPort, childPrint) {
return new Promise((resolve) => {
const needDebugBrk = process.version.match(/^v(6|7)\./);
const args = (needDebugBrk ?
['--inspect', `--debug-brk=${inspectPort}`] :
[`--inspect-brk=${inspectPort}`])
.concat([script], scriptArgs);
['--inspect', `--debug-brk=${inspectPort}`] :
[`--inspect-brk=${inspectPort}`])
.concat([script], scriptArgs);
const child = spawn(process.execPath, args);
child.stdout.setEncoding('utf8');
child.stderr.setEncoding('utf8');
Expand Down Expand Up @@ -154,11 +154,11 @@ class NodeInspector {

if (options.script) {
this._runScript = runScript.bind(null,
options.script,
options.scriptArgs,
options.host,
options.port,
this.childPrint.bind(this));
options.script,
options.scriptArgs,
options.host,
options.port,
this.childPrint.bind(this));
} else {
this._runScript =
() => Promise.resolve([null, options.port, options.host]);
Expand Down Expand Up @@ -333,8 +333,8 @@ function parseArgv([target, ...args]) {
}

function startInspect(argv = process.argv.slice(2),
stdin = process.stdin,
stdout = process.stdout) {
stdin = process.stdin,
stdout = process.stdout) {
/* eslint-disable no-console */
if (argv.length < 1) {
const invokedAs = runAsStandalone ?
Expand Down
19 changes: 17 additions & 2 deletions deps/node-inspect/lib/internal/inspect_repl.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,16 @@ function extractFunctionName(description) {
return fnNameMatch ? `: ${fnNameMatch[1]}` : '';
}

const NATIVES = process.binding('natives');
const PUBLIC_BUILTINS = require('module').builtinModules;
const NATIVES = PUBLIC_BUILTINS ? process.binding('natives') : {};
function isNativeUrl(url) {
return url.replace('.js', '') in NATIVES || url === 'bootstrap_node.js';
url = url.replace(/\.js$/, '');
if (PUBLIC_BUILTINS) {
if (url.startsWith('internal/') || PUBLIC_BUILTINS.includes(url))
return true;
}

return url in NATIVES || url === 'bootstrap_node';
}

function getRelativePath(filenameOrURL) {
Expand Down Expand Up @@ -775,6 +782,14 @@ function createRepl(inspector) {
}

Debugger.on('paused', ({ callFrames, reason /* , hitBreakpoints */ }) => {
if (process.env.NODE_INSPECT_RESUME_ON_START === '1' &&
reason === 'Break on start') {
debuglog('Paused on start, but NODE_INSPECT_RESUME_ON_START' +
' environment variable is set to 1, resuming');
inspector.client.callMethod('Debugger.resume');
return;
}

// Save execution context's data
currentBacktrace = Backtrace.from(callFrames);
selectedFrame = currentBacktrace[0];
Expand Down
4 changes: 2 additions & 2 deletions deps/node-inspect/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-inspect",
"version": "1.11.6",
"version": "2.0.0",
"description": "Node Inspect",
"license": "MIT",
"main": "lib/_inspect.js",
Expand All @@ -27,7 +27,7 @@
},
"dependencies": {},
"devDependencies": {
"eslint": "^3.10.2",
"eslint": "^6.8.0",
"nlm": "^3.0.0",
"tap": "^10.7.0"
},
Expand Down
71 changes: 71 additions & 0 deletions deps/node-inspect/test/cli/address.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
'use strict';
const { spawn } = require('child_process');
const Path = require('path');
const { test } = require('tap');

const startCLI = require('./start-cli');

// NOTE(oyyd): We might want to import this regexp from "lib/_inspect.js"?
const kDebuggerMsgReg = /Debugger listening on ws:\/\/\[?(.+?)\]?:(\d+)\//;

function launchTarget(...args) {
const childProc = spawn(process.execPath, args);
return new Promise((resolve, reject) => {
const onExit = () => {
reject(new Error('Child process exits unexpectly'));
};
childProc.on('exit', onExit);
childProc.stderr.setEncoding('utf8');
childProc.stderr.on('data', (data) => {
const ret = kDebuggerMsgReg.exec(data);
childProc.removeListener('exit', onExit);
if (ret) {
resolve({
childProc,
host: ret[1],
port: ret[2],
});
}
});
});
}

// process.debugPort is our proxy for "the version of node used to run this
// test suite doesn't support SIGUSR1 for enabling --inspect for a process".
const defaultsToOldProtocol = process.debugPort === 5858;

test('examples/alive.js', { skip: defaultsToOldProtocol }, (t) => {
const script = Path.join('examples', 'alive.js');
let cli = null;
let target = null;

function cleanup(error) {
if (cli) {
cli.quit();
cli = null;
}
if (target) {
target.kill();
target = null;
}
if (error) throw error;
}

return launchTarget('--inspect=0', script)
.then(({ childProc, host, port }) => {
target = childProc;
cli = startCLI([`${host || '127.0.0.1'}:${port}`]);
return cli.waitForPrompt();
})
.then(() => cli.command('sb("alive.js", 3)'))
.then(() => cli.waitFor(/break/))
.then(() => cli.waitForPrompt())
.then(() => {
t.match(
cli.output,
'> 3 ++x;',
'marks the 3rd line');
})
.then(() => cleanup())
.then(null, cleanup);
});
2 changes: 1 addition & 1 deletion deps/node-inspect/test/cli/invalid-args.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ test('launch w/ invalid host:port', (t) => {
});
});

test('launch w/ unavailable port', async (t) => {
test('launch w/ unavailable port', async(t) => {
const blocker = createServer((socket) => socket.end());
const port = await new Promise((resolve, reject) => {
blocker.on('error', reject);
Expand Down
20 changes: 20 additions & 0 deletions deps/node-inspect/test/cli/launch.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -174,3 +174,23 @@ test('run after quit / restart', (t) => {
.then(() => cli.quit())
.then(null, onFatal);
});

test('auto-resume on start if the environment variable is defined', (t) => {
const script = Path.join('examples', 'break.js');

const cli = startCLI([script], [], {
env: { NODE_INSPECT_RESUME_ON_START: '1' }
});

return cli.waitForInitialBreak()
.then(() => {
t.match(
cli.breakInfo,
{ filename: script, line: 10 },
'skips to the first breakpoint');
})
.then(() => cli.quit())
.then((code) => {
t.equal(code, 0, 'exits with success');
});
});
8 changes: 4 additions & 4 deletions deps/node-inspect/test/cli/start-cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ tap.test('startCLI', (t) => t.end());

const CLI =
process.env.USE_EMBEDDED_NODE_INSPECT === '1' ?
'inspect' :
require.resolve('../../cli.js');
'inspect' :
require.resolve('../../cli.js');

const BREAK_MESSAGE = new RegExp('(?:' + [
'assert', 'break', 'break on start', 'debugCommand',
Expand All @@ -20,8 +20,8 @@ function isPreBreak(output) {
return /Break on start/.test(output) && /1 \(function \(exports/.test(output);
}

function startCLI(args, flags = []) {
const child = spawn(process.execPath, [...flags, CLI, ...args]);
function startCLI(args, flags = [], spawnOpts = {}) {
const child = spawn(process.execPath, [...flags, CLI, ...args], spawnOpts);
let isFirstStdoutChunk = true;

const outputBuffer = [];
Expand Down