lib: deprecate node --debug at runtime #10970

joshgav · 2017-01-23T23:26:43Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

Affected core subsystem(s)

lib, debug

This PR is a runtime deprecation for node --debug; it replaces #10276. A docs deprecation landed previously at #10320.

The @nodejs/diagnostics WG discussed in our most recent meeting whether to land a runtime deprecation in 7.x or 8.x and tentatively concluded that this depends on the version of V8 shipped with Node@8, see #9789 and #10117. That is, if Node@8 ships with V8 5.7 and thus the legacy Debugger remains available, we may be able to delay landing the runtime deprecation till 8.x as well.

But if Node@8 will ship with V8 5.8 and thus no legacy Debugger, we should include this deprecation in the next 7.x release. Even though we don't typically allow deprecations in the middle of a major, this would be an exception since it needs to be included before 8.x.

It was also raised that even if Node@8 will ship with V8 5.7 and the legacy Debugger, Node's policy is to deprecate for two major versions before removing a feature, so perhaps even in this case we should land the runtime deprecation already in a 7.x release.

@jasnell: Per #10116, I'm reserving DEP0062 for this deprecation, and will note in that thread too.

/cc @ofrobots

bnoordhuis · 2017-01-24T11:42:24Z

test/parallel/test-debug-port-from-cmdline.js

-    'Starting debugger agent.',
-    'Debugger listening on 127.0.0.1:' + debugPort,
+    /Starting debugger agent./,
+    /\(node:\d+\) DeprecationWarning:.*/,


Can you make the regex more specific? It catches all DeprecationWarnings now.

Might be better to use common.expectWarning() (I may have the name wrong... there's a function for this tho :-) ..)

I looked into common.expectWarning() but it won't be possible to use here since we're checking stderr from a child process, so left logic as is.

Added more of the deprecation warning to the regex.

bnoordhuis · 2017-01-24T11:44:29Z

test/parallel/test-debug-port-from-cmdline.js

  ];

  assert.strictEqual(outputLines.length, expectedLines.length);
  for (let i = 0; i < expectedLines.length; i++)
-    assert(expectedLines[i].includes(outputLines[i]));
+    assert(outputLines[i].match(expectedLines[i]));


assert(expectedLines[i].test(outputLines[i]));?

bnoordhuis · 2017-01-24T11:46:17Z

test/parallel/test-debug-signal-cluster.js

@@ -29,6 +29,10 @@ let pids;

 child.stderr.on('data', function(data) {
  const childStderrOutputString = data.toString();
+  if (childStderrOutputString
+    .match(/DeprecationWarning: node --debug is deprecated\./))


.test(...) if you don't use the match result.

jasnell · 2017-01-24T21:08:03Z

This depends somewhat on landing the deprecation codes PR

Trott · 2017-01-31T02:52:04Z

test/parallel/test-debug-signal-cluster.js

@@ -29,6 +29,10 @@ let pids;

 child.stderr.on('data', function(data) {
  const childStderrOutputString = data.toString();
+  if (/DeprecationWarning: node --debug is deprecated\./
+    .test(childStderrOutputString))


This seems to rely on only one line coming in per data event whereas subsequent lines suggest that it is possible that more than one line will come in at a time.

Rather than this check, it might be better to add the deprecation text three times to the expectedContent array defined earlier in the test.

subsequent lines suggest that it is possible that more than one line will come in at a time

yes, I see that now. will work on it and your other comments.

@Trott as I reviewed I think it might be best to keep the deprecation warning isolated from the existing part of the test so it can be better understood and maintained/removed in the future. So instead I updated to address multi-line incoming data, PTAL and let me know what you think. Thanks!

Trott · 2017-01-31T02:53:24Z

test/parallel/test-debug-port-from-cmdline.js

@@ -38,11 +38,12 @@ function processStderrLine(line) {

 function assertOutputLines() {
  const expectedLines = [
-    'Starting debugger agent.',
-    'Debugger listening on 127.0.0.1:' + debugPort,
+    /Starting debugger agent./,


Probably a good idea to start with ^ and end with $ for this and the other regular expressions.

Trott · 2017-01-31T02:56:47Z

test/parallel/test-debug-port-from-cmdline.js

-    'Debugger listening on 127.0.0.1:' + debugPort,
+    /Starting debugger agent./,
+    /\(node:\d+\) DeprecationWarning: node --debug is deprecated./,
+    /Debugger listening on 127.0.0.1:\d+/


I'd prefer we match on the actual debugPort:

new RegExp(`^Debugger listening on 127.0.0.1:${debugPort}$`);

Trott · 2017-01-31T02:57:56Z

@joshgav Is there a specific aspect of this that requires ctc-review? Or is that just a general "CTC ought to know about and look at this?"

evanlucas

LGTM with @Trott's nits addressed. I'm also +1 for landing this in v7.x. I think we should give as much of a heads up as possible and April is coming fast.

jasnell · 2017-01-31T17:21:06Z

just a heads up. The static deprecation codes PR landed in master. It is a semver-major. If this PR gets backported to v7, the static id code on the emitWarning should be removed.

joshgav · 2017-02-09T22:57:28Z

All tests pass now (ARM is a false negative), but had to refactor the tests a bit and add --no-deprecation to bypass the cluster signal one.

@Trott @jasnell @evanlucas could you review again when you have a moment? Thanks.

Trott · 2017-02-09T23:15:08Z

@Trott @jasnell @evanlucas could you review again when you have a moment?

Seems A-OK to me.

Trott · 2017-02-09T23:16:26Z

doc/api/deprecations.md

+
+Type: Runtime
+
+`--debug` activates the legacy V8 debugger, which has been removed as of V8 5.8.


Is it worth being specific about V8 removing the JSON API and not the debugger per se? Or would that just be more confusing? (And am I even correct about that? :-P )

How about "V8 debugger API"?

jasnell · 2017-02-10T00:07:55Z

Still LGTM

Fixes: nodejs#9789 PR-URL: nodejs#10970 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

joshgav · 2017-02-10T20:42:06Z

Landed in dfdd911. Thanks!

Fixes: #9789 PR-URL: #10970 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

joshgav · 2017-02-10T20:42:47Z

Backport in progress at #11275

Fixes: nodejs#9789 PR-URL: nodejs#10970 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

PR-URL: nodejs#11275 Backport-of: nodejs#10970 Reviewed-By: James M Snell <jasnell@gmail.com>

joshgav added ctc-review notable-change PRs with changes that should be highlighted in changelogs. semver-major PRs that contain breaking changes and should be released in the next major version. labels Jan 23, 2017

nodejs-github-bot added debugger labels Jan 23, 2017

joshgav mentioned this pull request Jan 23, 2017

src, lib: deprecate old debug-agent and CLI debugger #10276

Closed

4 tasks

jkrems mentioned this pull request Jan 23, 2017

Bringing node-inspect into the fold nodejs/diagnostics#67

Closed

9 tasks

joshgav mentioned this pull request Jan 23, 2017

process: Add code to warnings, assign codes to deprecations #10116

Closed

4 tasks

bnoordhuis requested changes Jan 24, 2017

View reviewed changes

ofrobots mentioned this pull request Jan 24, 2017

deps: update V8 to 5.5 #9618

Closed

2 tasks

joshgav force-pushed the deprecate-dash-dash-debug branch from a4ab6db to de8d389 Compare January 24, 2017 20:54

nodejs-github-bot added the dont-land-on-v7.x label Jan 24, 2017

jasnell approved these changes Jan 24, 2017

View reviewed changes

bnoordhuis approved these changes Jan 24, 2017

View reviewed changes

joshgav mentioned this pull request Jan 25, 2017

Node.js Foundation Core Technical Committee (CTC) Meeting 2017-01-25 nodejs/CTC#63

Closed

targos removed dont-land-on-v4.x labels Jan 28, 2017

Trott mentioned this pull request Jan 31, 2017

Node.js Foundation Core Technical Committee (CTC) Meeting 2017-02-01 nodejs/CTC#65

Closed

Trott reviewed Jan 31, 2017

View reviewed changes

evanlucas approved these changes Jan 31, 2017

View reviewed changes

joshgav force-pushed the deprecate-dash-dash-debug branch from 551faaa to 9d8b26d Compare February 9, 2017 19:19

joshgav force-pushed the deprecate-dash-dash-debug branch from 9d8b26d to 07a6a68 Compare February 9, 2017 19:20

joshgav force-pushed the deprecate-dash-dash-debug branch from 07a6a68 to 818427e Compare February 9, 2017 22:03

joshgav force-pushed the deprecate-dash-dash-debug branch from 818427e to c362672 Compare February 9, 2017 22:10

joshgav force-pushed the deprecate-dash-dash-debug branch from c362672 to ff4f1fd Compare February 9, 2017 22:12

joshgav mentioned this pull request Feb 9, 2017

(backport 7.x) lib: deprecate node --debug at runtime #11275

Closed

4 tasks

Trott reviewed Feb 9, 2017

View reviewed changes

lib: deprecate node --debug at runtime

e99228a

Fixes: nodejs#9789 PR-URL: nodejs#10970 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Rich Trott <rtrott@gmail.com>

joshgav force-pushed the deprecate-dash-dash-debug branch from ff4f1fd to e99228a Compare February 10, 2017 20:38

joshgav closed this Feb 10, 2017

Trott removed the ctc-review label Feb 13, 2017

jkrems mentioned this pull request Feb 16, 2017

Switch the CLI debugger to V8 inspector #11421

Closed

14 tasks

italoacasas pushed a commit to italoacasas/node that referenced this pull request Feb 27, 2017

lib: deprecate node --debug at runtime

614742b

PR-URL: nodejs#11275 Backport-of: nodejs#10970 Reviewed-By: James M Snell <jasnell@gmail.com>

mutantcornholio mentioned this pull request Mar 3, 2017

cluster: fixing debug port logic for forking workers #9659

Closed

3 tasks

jasnell mentioned this pull request Apr 4, 2017

8.0.0 Release Proposal #12220

Closed

tniessen added the deprecations Issues and PRs related to deprecations. label Sep 7, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: deprecate node --debug at runtime #10970

lib: deprecate node --debug at runtime #10970

joshgav commented Jan 23, 2017

bnoordhuis Jan 24, 2017

jasnell Jan 24, 2017

joshgav Jan 24, 2017

bnoordhuis Jan 24, 2017

bnoordhuis Jan 24, 2017

jasnell commented Jan 24, 2017

Trott Jan 31, 2017

joshgav Feb 1, 2017

joshgav Feb 1, 2017

Trott Jan 31, 2017

Trott Jan 31, 2017

Trott commented Jan 31, 2017

evanlucas left a comment

jasnell commented Jan 31, 2017

joshgav commented Feb 9, 2017

Trott commented Feb 9, 2017

Trott Feb 9, 2017

joshgav Feb 9, 2017

jasnell commented Feb 10, 2017

joshgav commented Feb 10, 2017

joshgav commented Feb 10, 2017


		Type: Runtime

		`--debug` activates the legacy V8 debugger, which has been removed as of V8 5.8.

lib: deprecate node --debug at runtime #10970

lib: deprecate node --debug at runtime #10970

Conversation

joshgav commented Jan 23, 2017

Checklist

Affected core subsystem(s)

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

Choose a reason for hiding this comment

jasnell commented Jan 24, 2017

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

Choose a reason for hiding this comment

Trott commented Jan 31, 2017

evanlucas left a comment

Choose a reason for hiding this comment

jasnell commented Jan 31, 2017

joshgav commented Feb 9, 2017

Trott commented Feb 9, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell commented Feb 10, 2017

joshgav commented Feb 10, 2017

joshgav commented Feb 10, 2017