inspector: make `debug` an alias for `inspect` #11441

ofrobots · 2017-02-17T15:40:12Z

node debug is now an alias of node inspect. This is intended to be a minimal change – it does
not get rid of the old debugger code. That can be done in a follow-on.

~~This commit has a circular dependency on Take --debug-port into account node-inspect#26. I propose that we land here, and then later land upstream.~~
test-debugger-pid.js disabled because it depends on ability to debug a
pid in node-inspect. Once upstream adds this capability, we can enable
the test back again.

/cc @nodejs/diagnostics @eugeneo @jkrems

ofrobots · 2017-02-17T15:49:53Z

test/parallel/test-debug-brk-no-arg.js

@@ -1,13 +0,0 @@
-'use strict';


Removed because inspect behaviour is different from debug. The former stops before reaching the repl. This test doesn't make sense anymore.

jkrems · 2017-02-23T16:24:22Z

deps/node-inspect/lib/_inspect.js

@@ -39,7 +39,7 @@ const [ InspectClient, createRepl ] =

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

-exports.port = 9229;


I assume this is to support node --{inspect,debug}-port=1234 {inspect,debug} my-script.js etc.? If so, I'd rather make that explicit.

Maybe something like this? nodejs/node-inspect#26

joshgav

Summary: I think we should wait to alias debug till Node integrates V8 5.8+, and not at the start of Node 8, assuming Node 8 uses V8 5.7. This provides more notification time for those depending on the legacy interface.

Also, there's a lot of code here unrelated to aliasing debug. Could that be separated into another PR? It would make review easier. Thanks!

joshgav · 2017-03-07T16:06:47Z

src/node_debug_options.cc

@@ -93,15 +93,15 @@ bool DebugOptions::ParseOption(const std::string& option) {
  }

  // --debug and --inspect are mutually exclusive
-  if (option_name == "--debug") {
+  /*if (option_name == "--debug") {


--debug is the primary way to activate the legacy debugger interface. Aliasing it to --inspect instead would make it impossible to start that interface. That would break tools which still depend on it.

I think we should keep --debug associated with the legacy debugger as long as possible, i.e. till we update to V8 5.8+.

joshgav · 2017-03-07T16:08:52Z

lib/internal/bootstrap_node.js

-      NativeModule.require('_debugger').start();
-
-    } else if (process.argv[1] === 'inspect') {
+    } else if (process.argv[1] === 'inspect' || process.argv[1] === 'debug') {


Per my previous comment, I think we should not yet alias --debug to --inspect. The reason for not yet aliasing --debug doesn't apply to node debug, but for consistency's sake, we should probably not yet alias node debug to node inspect either.

ofrobots · 2017-03-14T21:52:25Z

@joshgav I have updated the PR to only make debug and alias of inspect. --debug will continue to start the old debug protocol. PTAL.
@jkrems This includes Take --debug-port into account node-inspect#26. This is a circular dependency, but I propose we land it here first (assuming tests pass upstream). Also, once node-inspect has the ability to debug PIDs, we can re-enable test-debugger-pid.js.

This PR no longer affects --debug

jkrems · 2017-03-14T22:16:47Z

test/parallel/test-debug-usage.js

-const expectedUsageMessage = `Usage: node debug script.js
-       node debug <host>:<port>
-       node debug -p <pid>
+const expectedUsageMessage = `Usage: node-inspect script.js


Note to future self: This test will need to be updated once we pull in @addaleax's usage text fix. https://github.com/nodejs/node-inspect/pull/20/files

jkrems · 2017-03-14T22:19:25Z

👍 to "cherry-picking" that change (I'll try to do another dependency pull soon so the two code bases don't drift apart too much).

bnoordhuis

LGTM modulo comment.

bnoordhuis · 2017-04-04T07:23:59Z

test/parallel/test-debug-brk.js

@@ -65,6 +65,6 @@ function test(extraArgs, stdoutPattern) {

 test(['-e', '0']);
 test(['-e', '0', 'foo']);
-test(['-p', 'process.argv[1]', 'foo'], /^\s*foo\s*$/);
+test(['-p', 'process.argv[1]', 'foo']);


You're leaving behind dead code with this change. Remove stdoutPattern and outputMatched from test(). There may be more.

bnoordhuis · 2017-04-04T16:50:31Z

I'm afraid this needs a rebase. Seems some conflicting changes were landed today.

ofrobots · 2017-04-04T16:55:06Z

Yep, working on that now. In any case, I think it might make sense to land after #11431 and #12197 have landed to minimize conflicts.

addaleax · 2017-05-10T20:55:39Z

Assuming the diag-agenda label can be removed now that this is merged.

ofrobots added semver-major PRs that contain breaking changes and should be released in the next major version. inspector Issues and PRs related to the V8 inspector protocol and removed inspector Issues and PRs related to the V8 inspector protocol labels Feb 17, 2017

jkrems mentioned this pull request Feb 17, 2017

Switch the CLI debugger to V8 inspector #11421

Closed

14 tasks

ofrobots commented Feb 17, 2017

View reviewed changes

jasnell added the wip Issues and PRs that are still a work in progress. label Feb 17, 2017

joshgav changed the title ~~inspector: make debug and alias for inspect~~ inspector: make debug an alias for inspect Feb 22, 2017

joshgav added the diag-agenda Issues and PRs to discuss during the meetings of the diagnostics working group. label Feb 23, 2017

joshgav mentioned this pull request Feb 23, 2017

Diag WG Meeting - 2017-02 nodejs/diagnostics#85

Closed

jkrems reviewed Feb 23, 2017

View reviewed changes

jkrems mentioned this pull request Feb 23, 2017

Take --debug-port into account nodejs/node-inspect#26

Merged

joshgav mentioned this pull request Feb 24, 2017

blog: diag wg update and --debug deprecation nodejs/nodejs.org#1156

Closed

joshgav previously requested changes Mar 7, 2017

View reviewed changes

joshgav mentioned this pull request Mar 13, 2017

Diag WG Meeting - 2017-03 nodejs/diagnostics#89

Closed

ofrobots force-pushed the debug-alias branch from e0a5d3d to 4b47636 Compare March 14, 2017 21:44

jkrems reviewed Mar 14, 2017

View reviewed changes

ofrobots added this to the 8.0.0 milestone Mar 15, 2017

MylesBorins mentioned this pull request Apr 3, 2017

Remove Legacy Debugger for 8.0.0 nodejs/CTC#94

Closed

bnoordhuis approved these changes Apr 4, 2017

View reviewed changes

This was referenced Apr 23, 2017

regression: 3rd party debuggers are incompatible with node8 nighlies #12364

Closed

inspector: restore --debug-brk alias #12580

Closed

Uniform way to trigger debugger on first line #12630

Closed

addaleax removed the diag-agenda Issues and PRs to discuss during the meetings of the diagnostics working group. label May 10, 2017

jasnell mentioned this pull request May 11, 2017

8.0.0 Release Proposal #12220

Closed

js-choi mentioned this pull request Aug 13, 2017

Support --inspect tapjs/tapjs#363

Closed

tniessen added deprecations Issues and PRs related to deprecations. and removed wip Issues and PRs that are still a work in progress. labels Sep 7, 2018

This was referenced Jul 6, 2023

[Snyk] Fix for 2 vulnerabilities leonardoadame/node#23

Open

[Snyk] Fix for 2 vulnerabilities leonardoadame/node#57

Open

[Snyk] Fix for 2 vulnerabilities leonardoadame/node#77

Open

[Snyk] Security upgrade jest from 25.5.4 to 27.0.0 leonardoadame/node#147

Open

aliscco mentioned this pull request Jul 10, 2023

[Snyk] Security upgrade jest from 24.9.0 to 27.0.0 aliscco/alisco-node#628

Open

leonardoadame mentioned this pull request Nov 28, 2023

[Snyk] Security upgrade jest from 26.6.3 to 27.0.0 leonardoadame/node#199

Open

This was referenced Nov 29, 2023

[Snyk] Security upgrade jest from 26.4.2 to 27.0.0 aliscco/alisco-node#785

Open

[Snyk] Security upgrade jest from 24.9.0 to 27.0.0 aliscco/alisco-node#799

Open

leonardoadame mentioned this pull request Nov 30, 2023

[Snyk] Security upgrade jest from 25.5.4 to 27.0.0 leonardoadame/node#281

Open

aliscco mentioned this pull request Dec 2, 2023

[Snyk] Fix for 6 vulnerabilities aliscco/alisco-node#1050

Open

leonardoadame mentioned this pull request Dec 5, 2023

[Snyk] Security upgrade jest from 25.5.4 to 27.0.0 leonardoadame/node#539

Open

aliscco mentioned this pull request Dec 8, 2023

[Snyk] Security upgrade jest from 24.9.0 to 27.0.0 aliscco/alisco-node#1158

Open

This was referenced Dec 10, 2023

[Snyk] Security upgrade jest from 25.5.4 to 27.0.0 leonardoadame/node#577

Open

[Snyk] Security upgrade jest from 24.9.0 to 27.0.0 leonardoadame/node#578

Open

This was referenced Dec 10, 2023

[Snyk] Security upgrade jest from 26.4.2 to 27.0.0 aliscco/alisco-node#1165

Open

[Snyk] Security upgrade jest from 24.9.0 to 27.0.0 aliscco/alisco-node#1167

Open

leonardoadame mentioned this pull request Dec 19, 2023

[Snyk] Security upgrade jest from 26.6.3 to 27.0.0 leonardoadame/node#581

Open

aliscco mentioned this pull request Jan 1, 2024

[Snyk] Security upgrade jest from 26.4.2 to 27.0.0 aliscco/alisco-node#1182

Open

aliscco mentioned this pull request Jan 31, 2024

[Snyk] Security upgrade jest from 24.9.0 to 27.0.0 aliscco/alisco-node#1205

Open

leonardoadame mentioned this pull request Feb 12, 2024

[Snyk] Fix for 3 vulnerabilities leonardoadame/node#684

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

inspector: make `debug` an alias for `inspect` #11441

inspector: make `debug` an alias for `inspect` #11441

ofrobots commented Feb 17, 2017 •

edited

ofrobots Feb 17, 2017

jkrems Feb 23, 2017

jkrems Feb 23, 2017

ofrobots Mar 14, 2017

joshgav left a comment

joshgav Mar 7, 2017

joshgav Mar 7, 2017 •

edited

ofrobots commented Mar 14, 2017

jkrems Mar 14, 2017

jkrems commented Mar 14, 2017

bnoordhuis left a comment

bnoordhuis Apr 4, 2017

ofrobots Apr 4, 2017

bnoordhuis commented Apr 4, 2017

ofrobots commented Apr 4, 2017

addaleax commented May 10, 2017

		@@ -39,7 +39,7 @@ const [ InspectClient, createRepl ] =

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

		exports.port = 9229;

inspector: make debug an alias for inspect #11441

inspector: make debug an alias for inspect #11441

Conversation

ofrobots commented Feb 17, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshgav left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshgav Mar 7, 2017 • edited

Choose a reason for hiding this comment

ofrobots commented Mar 14, 2017

Choose a reason for hiding this comment

jkrems commented Mar 14, 2017

bnoordhuis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bnoordhuis commented Apr 4, 2017

ofrobots commented Apr 4, 2017

addaleax commented May 10, 2017

inspector: make `debug` an alias for `inspect` #11441

inspector: make `debug` an alias for `inspect` #11441

ofrobots commented Feb 17, 2017 •

edited

joshgav Mar 7, 2017 •

edited