doc: deprecate vm.runInDebugContext #12243

joshgav · 2017-04-05T19:47:10Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows [commit guidelines][]

Affected core subsystem(s)

src, debugger

Per https://github.com/nodejs/diagnostics/blob/master/wg-meetings/2017-03-23.md#3-deprecate-vmrunindebugcontext-api:

vm.runInDebugContext will go away at end of 2017, so we should deprecate now in preparation for Node 10 (April 2018).

@jasnell should this be included in 8.0.0? Sorry it's late...

cc @ofrobots @eugeneo

joshgav · 2017-04-05T19:48:19Z

doc/api/deprecations.md

@@ -582,6 +582,16 @@ deprecated.
 *Note*: `OutgoingMessage.prototype._renderHeaders` was never documented as
 an officially supported API.

+<a id="DEP0068"></a>
+### DEP0064: vm.runInDebugContext(string)


Oops, need to update string to DEP0068 or whatever the final number is.

richardlau · 2017-04-05T19:48:56Z

doc/api/deprecations.md

@@ -582,6 +582,16 @@ deprecated.
 *Note*: `OutgoingMessage.prototype._renderHeaders` was never documented as
 an officially supported API.

+<a id="DEP0068"></a>
+### DEP0064: vm.runInDebugContext(string)


Shouldn't these match?

indeed :) fixed.

sam-github · 2017-04-05T20:26:25Z

FYI, https://github.com/strongloop/strong-agent/blob/7c3109b140678b98bda19ff914d9937c886e21e3/lib/dyninst.js#L19-L27, @ofrobots

I think it was added because it can be useful, and had that specific use of accessing Debug, I'm not sure if it was ever used much or at all for anything else.

sam-github · 2017-04-05T20:27:08Z

If its going to break, I'm +1 for deprecating in 8.x, to give people a chance to work around the upcoming disappearance.

jasnell · 2017-04-05T22:34:08Z

If this is dependent in any way on the V8 debugger, then it absolutely would need to be pulled in 8.0.0 since the debugger is going to be pulled.

jasnell · 2017-04-05T22:46:50Z

Regarding the DEP00NN number, we should actually get some tooling in to handle these like the REPLACEME tags. The number should be assigned either when the PR lands or when the release is cut.

ofrobots · 2017-04-05T23:54:26Z

This is not dependent on the JSON Debug Protocol (--debug) which is gone in V8 5.8. This is dependent on the in process debug context which is slated to go away by EOY (i.e. will not be available in Node 10.x). Getting this deprecation landed in 8.x gives people time to migrate away.

@sam-github Speaking of migration, the idea is that V8-inspector can be used for in process debugging. The first step in enabling this is #11431. We are planning on a few follow-on PRs that will make the inspector available to userspace to allow functionality equivalent to what the Debug context is used for today.

TimothyGu · 2017-04-06T01:01:57Z

Before deprecating the function, I think we should at least make sure our code base is no longer using it (#11875)

ofrobots · 2017-04-06T01:07:37Z

@TimothyGu Indeed. However It is hard to do that before 8.x because we need some semver major changes to land before the alternative API is possible. I do think you have a valid point however, it is not nice to deprecate an API before the alternative is really possible.

This would leave us with NOT deprecating this at 8.0 which would give us less than 2 major cycles before it gets removed in 10.x.

TimothyGu · 2017-04-06T01:15:11Z

@ofrobots To be clear I'm not against this PR, since whether we warn or not the API is going to be removed from V8 very very soon. What concerns me more is the fact that none of our publicly-exposed functions should be printing a deprecation warning. Well, except for that deprecated function itself.

For example, until modern V8 APIs that support what we need are in, I'm fine with a function accessible only internally that does not print a deprecation warning, and an externally accessible function that does.

jasnell · 2017-04-06T02:14:24Z

Good point, we cannot have core generate deprecation notices from it's own use of APIs. That's just bad form. Having an internal/*.js method that does the right thing with the public facing API generating the deprecation is a good compromise that we use in other places.

TimothyGu

Blocking this before #12243 (comment) is resolved.

ofrobots · 2017-04-06T17:31:28Z

PR for JavaScript bindings for the inspector is now open: #12263.

joshgav · 2017-04-07T02:24:27Z

@TimothyGu

none of our publicly-exposed functions should be printing a deprecation warning

Would it be reasonable to wrap ensureDebugIsInitialized with a process.noDeprecation = true statement in the meantime?

TimothyGu · 2017-04-07T04:05:23Z

@joshgav That'd work for me.

joshgav · 2017-04-07T13:05:36Z

@TimothyGu done, PTAL.

refack · 2017-04-09T20:38:15Z

Sorry to join in late, can I ask what will be the alternative?

addaleax · 2017-04-10T12:15:38Z

@refack Depending on your use case, better native APIs (e.g. for inspecting Promises) or something like #12263 …

sam-github · 2017-04-10T19:45:43Z

@ofrobots any suggestions? We could not deprecate it... but then it will simply disappear without a full deprecation cycle, and v8 doesn't have an alternative yet if I understood the comments correctly, so we seem to be stuck between a rock and a hard place.

sam-github · 2017-04-11T14:10:15Z

doc/api/deprecations.md

+Type: Runtime
+
+The DebugContext is being removed from V8 5.8+ along with the legacy debugger
+interface.


is it possible to mention when v8 5.8 is expected to land? Most people don't know what version of v8 is in specific node versions, so I suggest adding something like "Deprecated to warn users that this function will have to be deleted when Node.js next updates V8." (or something of the like).

This is actually not accurate. The Debug context is slated to go away at the end of the year which would probably be either M63 or M64. It might be better to state the Node version (10.0) that this is expected to land in.

The legacy debugger interface is gone in V8 5.8.

ofrobots · 2017-04-11T17:10:27Z

@ofrobots any suggestions? We could not deprecate it... but then it will simply disappear without a full deprecation cycle, and v8 doesn't have an alternative yet if I understood the comments correctly, so we seem to be stuck between a rock and a hard place.

It seems that the API was experimental and it is not clear if the 2-major deprecation policy applies to V8 APIs anyway. IMO we should allow something like #12263 to happen and add the deprecation message around the time 8.x goes LTS. This will give allow the ecosystem to migrate. Perhaps this can be one of the new 'pending deprecations' for now?

sam-github · 2017-04-11T19:24:06Z

@ofrobots We skip the 2-major rule when forced to by external deps, but you anticipate this API going away in 10.x?

If its going to disappear in node 10.x, then we could docs-only deprecate in 8.x, and runtime deprecate in 9.x, and outright delete in 10.x, which is as smooth as any deprecation cycle can be.

ofrobots · 2017-04-11T22:22:33Z

Good point. I agree that this should be a doc-only deprecation in 8.x. /cc @joshgav.

At the CTC-V8 meeting in February, the V8 team indicated that debug context will be removed by EOY, which lines up with Node 10.x.

joshgav · 2017-04-14T18:07:00Z

@ofrobots @sam-github okay will update to docs-only deprecation, mention 10.x instead of a V8 version, and include @addaleax's suggestions above.

@ofrobots

we are deprecating the API without providing the ecosystem with an alternative

Is #12263 a sufficient alternative?

ofrobots · 2017-04-17T19:25:52Z

Is #12263 a sufficient alternative?

That's the hope. I think all the ecosystem uses can be addressed by it, but it is a sufficiently different API and mechanism. It would be good to offer this as an experimental API and get feedback from the ecosystem on whether it addresses all the use-cases.

jasnell · 2017-04-18T18:11:40Z

this needs a rebase :-)

joshgav · 2017-05-03T19:05:51Z

Split runtime deprecation into #12815 to land on 9.x. Updated this PR to only be a docs deprecation.

Docs-only deprecation for v8.0.0. Runtime deprecation planned for v9.0.0. Removal planned for v10.0.0. PR-URL: nodejs#12243 Reviewed-By: _tbd_ Reviewed-By: _tbd_

addaleax

Yeah, looks good to me. It’s a bit unfortunate we have to go with just “An alternative is in development” but I guess that’s just the truth… ¯_(ツ)_/¯

joshgav · 2017-05-03T21:35:41Z

Landed in eb535c5. Thanks!

Docs-only deprecation for v8.0.0. Runtime deprecation planned for v9.0.0. Removal planned for v10.0.0. PR-URL: #12243 Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

Docs-only deprecation for v8.0.0. Runtime deprecation planned for v9.0.0. Removal planned for v10.0.0. PR-URL: nodejs#12243 Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

joshgav added debugger semver-major PRs that contain breaking changes and should be released in the next major version. labels Apr 5, 2017

joshgav added this to the 8.0.0 milestone Apr 5, 2017

nodejs-github-bot added the vm Issues and PRs related to the vm subsystem. label Apr 5, 2017

joshgav commented Apr 5, 2017

View reviewed changes

richardlau requested changes Apr 5, 2017

View reviewed changes

joshgav force-pushed the deprecate-debugcontext branch from 573f9d7 to 51a0031 Compare April 5, 2017 20:44

richardlau approved these changes Apr 5, 2017

View reviewed changes

TimothyGu mentioned this pull request Apr 6, 2017

util: use V8 C++ API for inspecting Promises #12254

Merged

2 tasks

TimothyGu suggested changes Apr 6, 2017

View reviewed changes

joshgav force-pushed the deprecate-debugcontext branch from 51a0031 to c1f6282 Compare April 7, 2017 13:03

TimothyGu approved these changes Apr 7, 2017

View reviewed changes

addaleax approved these changes Apr 9, 2017

View reviewed changes

jasnell approved these changes Apr 11, 2017

View reviewed changes

sam-github reviewed Apr 11, 2017

View reviewed changes

refack mentioned this pull request Apr 12, 2017

Discussion: v8 / nodejs relationship - The way to constant improvment nodejs/CTC#100

Closed

refack force-pushed the master branch from 16073c0 to fbe946b Compare April 14, 2017 04:11

joshgav force-pushed the deprecate-debugcontext branch from c1f6282 to a7fcb0a Compare May 3, 2017 18:40

joshgav changed the title ~~src: deprecate vm.runInDebugContext~~ doc: deprecate vm.runInDebugContext May 3, 2017

doc: deprecate vm.runInDebugContext

7271988

Docs-only deprecation for v8.0.0. Runtime deprecation planned for v9.0.0. Removal planned for v10.0.0. PR-URL: nodejs#12243 Reviewed-By: _tbd_ Reviewed-By: _tbd_

joshgav force-pushed the deprecate-debugcontext branch from a7fcb0a to 7271988 Compare May 3, 2017 19:15

addaleax approved these changes May 3, 2017

View reviewed changes

ofrobots approved these changes May 3, 2017

View reviewed changes

refack approved these changes May 3, 2017

View reviewed changes

joshgav closed this May 3, 2017

jasnell mentioned this pull request May 11, 2017

8.0.0 Release Proposal #12220

Closed

targos mentioned this pull request May 30, 2017

lib,src: remove vm.runInDebugContext() #13295

Merged

refack mentioned this pull request Jul 14, 2017

[wip] src, inspector: support opted-in VM contexts #14231

Closed

4 tasks

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

This was referenced Apr 19, 2024

doc: deprecate --experimental-policy #52602

Closed

lib,src: remove --experimental-policy #52583

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: deprecate vm.runInDebugContext #12243

doc: deprecate vm.runInDebugContext #12243

joshgav commented Apr 5, 2017

joshgav Apr 5, 2017

richardlau Apr 5, 2017

joshgav Apr 5, 2017

sam-github commented Apr 5, 2017

sam-github commented Apr 5, 2017

jasnell commented Apr 5, 2017

jasnell commented Apr 5, 2017

ofrobots commented Apr 5, 2017

TimothyGu commented Apr 6, 2017

ofrobots commented Apr 6, 2017

TimothyGu commented Apr 6, 2017 •

edited

Loading

jasnell commented Apr 6, 2017

TimothyGu left a comment •

edited

Loading

ofrobots commented Apr 6, 2017

joshgav commented Apr 7, 2017

TimothyGu commented Apr 7, 2017

joshgav commented Apr 7, 2017

refack commented Apr 9, 2017

addaleax commented Apr 10, 2017

sam-github commented Apr 10, 2017

sam-github Apr 11, 2017

ofrobots Apr 11, 2017

ofrobots commented Apr 11, 2017

sam-github commented Apr 11, 2017

ofrobots commented Apr 11, 2017

joshgav commented Apr 14, 2017

ofrobots commented Apr 17, 2017

jasnell commented Apr 18, 2017

joshgav commented May 3, 2017

addaleax left a comment

joshgav commented May 3, 2017

doc: deprecate vm.runInDebugContext #12243

doc: deprecate vm.runInDebugContext #12243

Conversation

joshgav commented Apr 5, 2017

Checklist

Affected core subsystem(s)

joshgav Apr 5, 2017

Choose a reason for hiding this comment

richardlau Apr 5, 2017

Choose a reason for hiding this comment

joshgav Apr 5, 2017

Choose a reason for hiding this comment

sam-github commented Apr 5, 2017

sam-github commented Apr 5, 2017

jasnell commented Apr 5, 2017

jasnell commented Apr 5, 2017

ofrobots commented Apr 5, 2017

TimothyGu commented Apr 6, 2017

ofrobots commented Apr 6, 2017

TimothyGu commented Apr 6, 2017 • edited Loading

jasnell commented Apr 6, 2017

TimothyGu left a comment • edited Loading

Choose a reason for hiding this comment

ofrobots commented Apr 6, 2017

joshgav commented Apr 7, 2017

TimothyGu commented Apr 7, 2017

joshgav commented Apr 7, 2017

refack commented Apr 9, 2017

addaleax commented Apr 10, 2017

sam-github commented Apr 10, 2017

sam-github Apr 11, 2017

Choose a reason for hiding this comment

ofrobots Apr 11, 2017

Choose a reason for hiding this comment

ofrobots commented Apr 11, 2017

sam-github commented Apr 11, 2017

ofrobots commented Apr 11, 2017

joshgav commented Apr 14, 2017

ofrobots commented Apr 17, 2017

jasnell commented Apr 18, 2017

joshgav commented May 3, 2017

addaleax left a comment

Choose a reason for hiding this comment

joshgav commented May 3, 2017

TimothyGu commented Apr 6, 2017 •

edited

Loading

TimothyGu left a comment •

edited

Loading