src: deprecate legacy node::MakeCallback #18632

ofrobots · 2018-02-08T01:23:42Z

The legacy MakeCallback functions do not provide a mechanism to
propagate async context. This means that any native modules using these
directly is likely breaking async debugging & tracing tools. For
example it is possible that such a module will cause incorrect async
stack traces to be reported (even when the module is not on the stack).

We've had context preserving versions of MakeCallback available since Node 8.x.

Ref: #13254, specifically #13254 (comment).
Related: nodejs/nan#729

This doesn't fit into any of the categories of deprecations as defined in our Deprecation policy. This is an API available to native modules via node.h. It is not otherwise documented. Chances are high that any given native module would be using this API. The migration path is fairly easy though.

We will now give a compile time warning when a module using the deprecated API is being compiled against Node 10. There is no runtime impact at this point. From this point of view, I guess this is closest to a Documentation-only deprecation.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
commit message follows commit guidelines

Affected core subsystem(s)

src, async_hooks

/cc @nodejs/async_hooks @nodejs/addon-api @nodejs/diagnostics

CI: https://ci.nodejs.org/job/node-test-pull-request/13042/

vsemozhetbyt · 2018-02-08T01:35:18Z

doc/api/deprecations.md

+Type: Compile-time
+
+Certain versions of `node::MakeCallback` APIs available to native modules are
+deprecated. Please use the versions of the API that accept a `async_context`


Nit: a `async_context` -> an `async_context`

ofrobots · 2018-02-08T18:13:48Z

As a semver-major this needs two @nodejs/tsc approvals.

AndreasMadsen

LGTM. Although, I think we need to declare C++ AsyncHooks Embedder API stable before we can do this. But I'm okay with that.

ofrobots · 2018-02-09T14:15:07Z

@AndreasMadsen

Although, I think we need to declare C++ AsyncHooks Embedder API stable before we can do this. But I'm okay with that.

This would have been an ideal way of doing things, but it should not be a requirement IMHO:

We would want to have some feedback on the C++ AsyncHooks Embedder API before we move it out of experimental. It has been available since Node 8.x, and approximately 0% of modules are using it.
This is a compile-time warning only. People are not prevented from using the deprecated functions. It does encourage modules to switch to the C++ API, and that will drive feedback for the AsyncHooks embedder API.

IOW, we need this change if we want to move the C++ AsynchHooks Embedder API to move out of experimental.

AndreasMadsen · 2018-02-09T14:52:45Z

@ofrobots Yeah, there is definitely conflicting interests. I think this will be for the TSC to decide.

The issue with deprecating it before the C++ Embedder API is marked stable, is that there will be no API for calling a callback that isn't either deprecated or experimental.

ofrobots · 2018-02-09T15:06:56Z

@AndreasMadsen there are prior examples of that. For example, Domains are deprecated even though there is no stable alternative to them (still).

there will be no API for calling a callback that isn't either deprecated or experimental.

To be pedantic, MakeCallback is not experimental. It is always possible for people to pass in a nullary async_context.

addaleax · 2018-02-09T17:18:51Z

This is a compile-time warning only. People are not prevented from using the deprecated functions. It does encourage modules to switch to the C++ API, and that will drive feedback for the AsyncHooks embedder API.

Maybe we could just set a time frame for the actual removal that is far enough in the future, or even better, indicate that we will never actually remove these functions?

BridgeAR · 2018-02-10T14:32:24Z

Landed in a570aca 🎉

The legacy MakeCallback functions do not provide a mechanism to propagate async context. This means that any native modules using these directly is likely breaking async debugging & tracing tools. For examples it is possible that such a module will cause incorrect async stack traces to be reported (even when the module is not on the stack). The new MakeCallback allow the user to specify the async context in which the callback is to be executed. Ref: nodejs#13254 PR-URL: nodejs#18632 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Jan Krems <[email protected]> Reviewed-By: Andreas Madsen <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>

apapirovski · 2018-02-10T14:34:32Z

Should this really have landed with a tsc-review label on it? 😕

BridgeAR · 2018-02-10T14:46:42Z

Uh, gosh... I missed that... Hm, I am going to force push it out again as it is only a few minutes ago.

ofrobots · 2018-02-12T19:35:18Z

@nodejs/tsc, this has the tsc-review label so please review.

Specifically @AndreasMadsen added the label around this question: #18632 (comment). He has LGTM'd this PR, so there isn't a conflict here, I think the intent is to make sure that the TSC is aware that this is happening. @AndreasMadsen please correct me if I misinterpreted your intent here. There are already the requisite 2 TSC LGTMs on this PR required for semver majors.

This is time sensitive, and should get into Node 10. As a semver major, it would be good to get this in before March. I am OOO starting next week, so I would like to make progress on this this week.

apapirovski · 2018-02-12T19:36:40Z

Perhaps something that could be discussed at the Diagnostics Summit even, given that @AndreasMadsen is in attendance, I believe.

ofrobots · 2018-02-13T03:53:27Z

@apapirovski We already have an LGTM from @AndreasMadsen. There is nothing to discuss. Unless if some questions/concerns come from the TSC as a result of the tsc-review label.

MylesBorins · 2018-02-13T06:29:30Z

I think discussing how this API will be handled long term doesn't require blocking this deprecation landing if there is already consensus on doing so.

Unless someone has an explicit -1 I feel like perhaps this should land and an issue to discuss long term deprecation should be opened.

ofrobots · 2018-02-15T15:35:53Z

Removing tsc-review as the tsc has been adequately pinged. I will land this later today.

sam-github · 2018-02-15T22:39:18Z

Unlike a docs-only deprecation, when native addons are installed, they will start printing compiler warnings about deprecated APIs to the console, where the installer of the addon (who is probably only installing it indirectly via a npm dep, and can't do anything about this) will see them, right? This strikes me as slightly more similar to a run-time deprecation that a doc deprecation.

I agree the problematic functions should be completely dropped ASAP so context propagation is preserved.

ofrobots · 2018-02-15T22:56:54Z

@sam-github You're right. I guess it is somewhere in the middle. Compile warnings show up at npm install time, for modules that don't ship pre-compiled blobs. A runtime deprecation, on the other hand, would show up each time the app is run.

The legacy MakeCallback functions do not provide a mechanism to propagate async context. This means that any native modules using these directly is likely breaking async debugging & tracing tools. For example it is possible that such a module will cause incorrect async stack traces to be reported (even when the module is not on the stack). The new MakeCallback allow the user to specify the async context in which the callback is to be executed. Ref: nodejs#13254 PR-URL: nodejs#18632 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Jan Krems <[email protected]> Reviewed-By: Andreas Madsen <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>

ofrobots · 2018-02-16T02:35:42Z

Landed as efb3259.

The legacy MakeCallback deprecation was resulting in compile time warnings in adddon tests. Fix them. Ref: nodejs#18632

The legacy MakeCallback deprecation was resulting in compile time warnings in adddon tests. Fix them. Ref: #18632 PR-URL: #18810 Refs: #18632 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

The legacy MakeCallback functions do not provide a mechanism to propagate async context. This means that any native modules using these directly is likely breaking async debugging & tracing tools. For example it is possible that such a module will cause incorrect async stack traces to be reported (even when the module is not on the stack). The new MakeCallback allow the user to specify the async context in which the callback is to be executed. Ref: nodejs#13254 PR-URL: nodejs#18632 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Jan Krems <[email protected]> Reviewed-By: Andreas Madsen <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>

The legacy MakeCallback deprecation was resulting in compile time warnings in adddon tests. Fix them. Ref: nodejs#18632 PR-URL: nodejs#18810 Refs: nodejs#18632 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

AsyncResource.emitBefore and AsyncResource.emitAfter have been deprecated in nodejs#18632. This PR removes it all. This commit also updates some embedder tests to use internal APIs. The conditions are still possible for Node.js core developers but not for end users.

AsyncResource.emitBefore and AsyncResource.emitAfter have been deprecated in #18632. This PR removes it all. This commit also updates some embedder tests to use internal APIs. The conditions are still possible for Node.js core developers but not for end users. PR-URL: #26530 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ali Ijaz Sheikh <[email protected]> Reviewed-By: Benedikt Meurer <[email protected]> Reviewed-By: Yang Guo <[email protected]> Reviewed-By: Andreas Madsen <[email protected]> Reviewed-By: James M Snell <[email protected]>

ofrobots added the semver-major PRs that contain breaking changes and should be released in the next major version. label Feb 8, 2018

nodejs-github-bot added the c++ Issues and PRs that require attention from people who are familiar with C++. label Feb 8, 2018

ofrobots mentioned this pull request Feb 8, 2018

Integrate C++ AsyncHooks Embedder API with native abstraction #13254

Closed

vsemozhetbyt reviewed Feb 8, 2018

View reviewed changes

BridgeAR requested a review from AndreasMadsen February 8, 2018 11:49

cjihrig approved these changes Feb 8, 2018

View reviewed changes

evanlucas approved these changes Feb 8, 2018

View reviewed changes

jkrems approved these changes Feb 8, 2018

View reviewed changes

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 8, 2018

AndreasMadsen approved these changes Feb 9, 2018

View reviewed changes

AndreasMadsen added the tsc-review label Feb 9, 2018

addaleax approved these changes Feb 9, 2018

View reviewed changes

BridgeAR closed this Feb 10, 2018

BridgeAR reopened this Feb 10, 2018

BridgeAR removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 10, 2018

gibfahn approved these changes Feb 13, 2018

View reviewed changes

ofrobots mentioned this pull request Feb 13, 2018

Deprecate old Callback::Call nodejs/nan#733

Merged

ofrobots added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed tsc-review labels Feb 15, 2018

ofrobots force-pushed the deprecate-old-make-callback branch from 6bf6eee to efb3259 Compare February 16, 2018 02:20

ofrobots merged commit efb3259 into nodejs:master Feb 16, 2018

ofrobots deleted the deprecate-old-make-callback branch February 16, 2018 02:35

ofrobots added a commit to ofrobots/node that referenced this pull request Feb 16, 2018

test: fix warnings in addon tests

51a71c8

The legacy MakeCallback deprecation was resulting in compile time warnings in adddon tests. Fix them. Ref: nodejs#18632

ofrobots mentioned this pull request Feb 16, 2018

test: fix warnings in addon tests #18810

Closed

2 tasks

AndreasMadsen mentioned this pull request Mar 7, 2018

[async_hooks] stable API - tracking issue nodejs/diagnostics#124

Closed

20 tasks

mcollina mentioned this pull request Mar 8, 2019

async_hooks: remove deprecated emitBefore and emitAfter #26530

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: deprecate legacy node::MakeCallback #18632

src: deprecate legacy node::MakeCallback #18632

ofrobots commented Feb 8, 2018 •

edited

Loading

vsemozhetbyt Feb 8, 2018

ofrobots Feb 8, 2018

ofrobots commented Feb 8, 2018

AndreasMadsen left a comment

ofrobots commented Feb 9, 2018 •

edited

Loading

AndreasMadsen commented Feb 9, 2018

ofrobots commented Feb 9, 2018

addaleax commented Feb 9, 2018

BridgeAR commented Feb 10, 2018

apapirovski commented Feb 10, 2018

BridgeAR commented Feb 10, 2018

ofrobots commented Feb 12, 2018

apapirovski commented Feb 12, 2018

ofrobots commented Feb 13, 2018

MylesBorins commented Feb 13, 2018

ofrobots commented Feb 15, 2018

sam-github commented Feb 15, 2018

ofrobots commented Feb 15, 2018

ofrobots commented Feb 16, 2018

src: deprecate legacy node::MakeCallback #18632

src: deprecate legacy node::MakeCallback #18632

Conversation

ofrobots commented Feb 8, 2018 • edited Loading

Checklist

Affected core subsystem(s)

vsemozhetbyt Feb 8, 2018

Choose a reason for hiding this comment

ofrobots Feb 8, 2018

Choose a reason for hiding this comment

ofrobots commented Feb 8, 2018

AndreasMadsen left a comment

Choose a reason for hiding this comment

ofrobots commented Feb 9, 2018 • edited Loading

AndreasMadsen commented Feb 9, 2018

ofrobots commented Feb 9, 2018

addaleax commented Feb 9, 2018

BridgeAR commented Feb 10, 2018

apapirovski commented Feb 10, 2018

BridgeAR commented Feb 10, 2018

ofrobots commented Feb 12, 2018

apapirovski commented Feb 12, 2018

ofrobots commented Feb 13, 2018

MylesBorins commented Feb 13, 2018

ofrobots commented Feb 15, 2018

sam-github commented Feb 15, 2018

ofrobots commented Feb 15, 2018

ofrobots commented Feb 16, 2018

ofrobots commented Feb 8, 2018 •

edited

Loading

ofrobots commented Feb 9, 2018 •

edited

Loading