allow passing custom async_id to node::AsyncWrap::AsyncWrap #14208

trevnorris · 2017-07-12T22:52:32Z

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)

async_wrap, async_hooks

Added make test-with-async-hooks that adds the environment variable NODE_TEST_WITH_ASYNC_HOOKS and skips the async-hooks test suite.
Improve output when running tests with NODE_TEST_WITH_ASYNC_HOOKS
Add a new AsyncWrap constructor specifically for PromiseWrap, since it's a special case, to prevent constantly needing to add new arguments to the general constructor
Allow passing a custom async_id to node::AsyncWrap::AsyncWrap that is used, instead of generating a new one. Also allows passing an async_id in via asyncReset(). (note: this doesn't include a change to AsyncResource in lib/async_hooks.js because want to have discussion on argument ordering)

IMPORTANT: Only the API to allow passing a new async_id has been added, but hasn't been implemented yet because of various issues. Next I will create a tracking issue with all cases, and that link will be added here after it's posted.

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

UPDATE: Tracking issue for edge cases using this API: #14209

AndreasMadsen · 2017-07-13T08:30:42Z

src/async-wrap.cc

+                     Local<Object> object,
+                     bool silent)
+    : BaseObject(env, object),
+      provider_type_(PROVIDER_PROMISE) {


I don't like this. It is not clear from the constructor signature that this is only for promises. It would be better with a unified constructor function, like how AsyncReset is now implemented.

I don't agree that adding another parameter to the constructor for a single case is a good idea. The general constructor is currently used in 12 locations outside of async-wrap.cc. I only allowed AsyncWrap::AsyncReset() the additional parameter because it's only used in a single location outside of async-wrap.cc and only 3 locations in async-wrap.cc. Also I think the fact that PROVIDER_PROMISE is explicitly passed to provider_type_ makes it clear that the constructor is only meant to be used for Promises.

If everyone is absolutely against the new constructor then I'll figure out another way to have the constructor not call init(), without needing to pass the additional argument.

The general constructor is currently used in 12 locations outside of async-wrap.cc.

I can't follow that argument at all. To me, using default arguments is only an issue if there become too many of them, I don't see that happening here. Besides, your solution is just a different kind of default argument.

Also I think the fact that PROVIDER_PROMISE is explicitly passed to provider_type_ makes it clear that the constructor is only meant to be used for Promises.

It is not clear from the calling code.

I can't follow that argument at all. To me, using default arguments is only an issue if there become too many of them, I don't see that happening here.

If there's a parameter that will only ever be used by one other class, in the same file, I don't see a good reason that it should pollute the general constructor. Even if it has a default.

Besides, your solution is just a different kind of default argument.

Don't follow what you're saying.

It is not clear from the calling code.

I'm really not worried about that since it's only called once from the same file.

I'm really not worried about that since it's only called once from the same file.

For the mere mortals who didn't write the file, it is actually a really big file that and it is hard for me to orient myself when reading it.

@AndreasMadsen Does is not feel like a wart on the API to add a parameter with default value just to accommodate a class that isn't public? To make the intention of the alternative class constructor clear beyond the fact that PROMISE_PROVIDER is force-ably passed I added the following to the private class declaration:

friend class PromiseWrap; // Constructor specifically for PromiseWrap. AsyncWrap(Environment* env, v8::Local<v8::Object> promise, bool silent);

so there would be no ambiguity as to why that alternative constructor exists, and so no other classes could accidentally call that constructor. I believe the intention of this code is reasonably clear.

/cc @bnoordhuis if you're around, mind giving feedback on how you'd approach this scenario?

Does is not feel like a wart on the API to add a parameter with default value just to accommodate a class that isn't public?

No. At least not when it is just relaying the parameter to AsyncReset.

I think this is about minimizing complexity and readability. I think the default parameter is simultaneously a more simple solution and more readable.

I'm not strong enough in C++ to give a better argument and "wart" is not concrete enough for me to argue against. I will let others take the argument from here.

/cc @nodejs/async_hooks

I think this is about minimizing complexity and readability. I think the default parameter is simultaneously a more simple solution and more readable.

At this point I think we just have a different aesthetic. IMO it's more clear to have a second documented constructor dedicated to a singular edge case usage than use an additional optional parameter.

The key here is that in no foreseeable case will the optional parameter be used by anything other than PromiseWrap. If there were even the slightest chance of that possibility then I'd agree that adding the optional parameter would be the correct approach.

IMHO an adding a comment stating that this ctor is for use by PromiseWrap only, in order not to expose a rarely used argument, is a decent compromise.

AndreasMadsen · 2017-07-13T08:34:17Z

src/async-wrap.h

@@ -117,7 +117,7 @@ class AsyncWrap : public BaseObject {

  inline double get_trigger_id() const;

-  void AsyncReset(bool silent = false);
+  void AsyncReset(double eid = 0, bool silent = false);


I think we should use -1 as the value to check, this is also how the triggerAsyncId works in the public API. 0 as an asyncId has another meaning.

Sounds good. There are benefits for each case, but I was on the fence about which to always default to. If everyone else thinks -1 is the better value then I'll be happy to go with that.

AndreasMadsen · 2017-07-13T08:35:38Z

How does the CI addition work? Will it always run or is there a special job?

Also, we need to make sure it runs on Windows too. Let's not repeat that mistake :)

trevnorris · 2017-07-13T21:17:05Z

@AndreasMadsen

How does the CI addition work? Will it always run or is there a special job?

The additional make target was only made be run manually, while developing. I wanted to have a conversation about how to best accommodate this (i.e. should it run by default, or should there be a special command). Any thoughts are welcome. cc @nodejs/build

refack · 2017-07-14T22:56:17Z

Vaguely apropo #14241

BridgeAR · 2017-09-02T07:41:57Z

Where do we stand here? Is there any conclusion? And this needs a rebase.

trevnorris · 2017-09-14T19:32:41Z

@BridgeAR Forgot about this. going to rebase and retest.

trevnorris · 2017-09-14T19:56:07Z

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

refack · 2017-09-15T22:17:00Z

Makefile

@@ -434,6 +436,14 @@ test-timers-clean:
 test-async-hooks:
 	$(PYTHON) tools/test.py --mode=release async-hooks


$(PYTHON) tools/test.py --mode=release $(CI_ASYNC_HOOKS)?

refack · 2017-09-15T22:23:15Z

src/async-wrap.cc

+                     Local<Object> object,
+                     bool silent)
+    : BaseObject(env, object),
+      provider_type_(PROVIDER_PROMISE) {


IMHO an adding a comment stating that this ctor is for use by PromiseWrap only, in order not to expose a rarely used argument, is a decent compromise.

refack · 2017-09-15T22:27:26Z

src/async-wrap.cc

@@ -428,7 +428,8 @@ void AsyncWrap::ClearIdStack(const FunctionCallbackInfo<Value>& args) {
 void AsyncWrap::AsyncReset(const FunctionCallbackInfo<Value>& args) {
  AsyncWrap* wrap;
  ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder());
-  wrap->AsyncReset();
+  double eid = args[0]->IsNumber() ? args[0]->NumberValue() : -1;


Could you use a more verbose name instead of eid?

but execution_async_id is a bit long. would exec_id be good enough?

exec_id is great.

Imho, execution_async_id is great, too – let’s choose verbose names whenever we can, a lot more people need to understand rather the code than need to write it.

refack · 2017-09-15T22:34:53Z

test/addons/async-hooks-promise/test.js

@@ -5,6 +5,11 @@ const assert = require('assert');
 const async_hooks = require('async_hooks');
 const binding = require(`./build/${common.buildType}/binding`);

+if (process.env.NODE_TEST_WITH_ASYNC_HOOKS) {


What are the tradeoffs of this VS doing delete process.env.NODE_TEST_WITH_ASYNC_HOOKS before L3

Not sure what you mean. Mind clarifying?

If we delete NODE_TEST_WITH_ASYNC_HOOKS before the L3 (const common = require('../../common');) it will not run the hooking logic of the harness https://github.com/nodejs/node/blob/b2865ba8a3330f763e8a3833a82bef24660de916/test/common/index.js#L64-L65

Will that make this testable?

while the possibility does exist, we depend on env vars existing for other things that could also be deleted. So I'm not going to worry about it.

trevnorris · 2017-09-26T21:42:25Z

@refack Comments (except for Makefile) have been addressed.

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

The new test-with-async-hooks runs all normal tests (except async-hooks) with the environment variable NODE_TEST_WITH_ASYNC_HOOKS set. These extra checks do a minimum check to make sure async_hooks operates normally under all other tests. e.g. if init() or destroy() is called twice for the same id. Also move test "async-hooks" from CI_JS_SUITES into its own CI_ASYNC_HOOKS. Makes it cleaner to add, instead of supplying a massive list of tests that may change in the future. PR-URL: nodejs#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

When running tests with NODE_TEST_WITH_ASYNC_HOOKS and the same asyncId is detected twice print the stack traces of both init() calls. Also print if the resource is the same instance. PR-URL: nodejs#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

The test addons/async-hooks-promise depends on there being only one hook available. So skip it if NODE_TEST_WITH_ASYNC_HOOKS is set. PR-URL: nodejs#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Another optional argument is about to be added to AsyncWrap. So instead of piling them on, create a separate constructor specifically for PromiseWrap since it's the only class that uses the "silent" argument. PR-URL: nodejs#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Allow the user to pass in an execution_async_id instead of always generating one. This way the JS API can be used to pre-allocate the execution_async_id when the JS object is instantiated, before the native resource is created. Also allow the new execution_async_id to be passed via asyncReset(). PR-URL: nodejs#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

The new test-with-async-hooks runs all normal tests (except async-hooks) with the environment variable NODE_TEST_WITH_ASYNC_HOOKS set. These extra checks do a minimum check to make sure async_hooks operates normally under all other tests. e.g. if init() or destroy() is called twice for the same id. Also move test "async-hooks" from CI_JS_SUITES into its own CI_ASYNC_HOOKS. Makes it cleaner to add, instead of supplying a massive list of tests that may change in the future. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

When running tests with NODE_TEST_WITH_ASYNC_HOOKS and the same asyncId is detected twice print the stack traces of both init() calls. Also print if the resource is the same instance. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

The test addons/async-hooks-promise depends on there being only one hook available. So skip it if NODE_TEST_WITH_ASYNC_HOOKS is set. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Another optional argument is about to be added to AsyncWrap. So instead of piling them on, create a separate constructor specifically for PromiseWrap since it's the only class that uses the "silent" argument. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Allow the user to pass in an execution_async_id instead of always generating one. This way the JS API can be used to pre-allocate the execution_async_id when the JS object is instantiated, before the native resource is created. Also allow the new execution_async_id to be passed via asyncReset(). PR-URL: nodejs#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

The new test-with-async-hooks runs all normal tests (except async-hooks) with the environment variable NODE_TEST_WITH_ASYNC_HOOKS set. These extra checks do a minimum check to make sure async_hooks operates normally under all other tests. e.g. if init() or destroy() is called twice for the same id. Also move test "async-hooks" from CI_JS_SUITES into its own CI_ASYNC_HOOKS. Makes it cleaner to add, instead of supplying a massive list of tests that may change in the future. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

When running tests with NODE_TEST_WITH_ASYNC_HOOKS and the same asyncId is detected twice print the stack traces of both init() calls. Also print if the resource is the same instance. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

The test addons/async-hooks-promise depends on there being only one hook available. So skip it if NODE_TEST_WITH_ASYNC_HOOKS is set. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Another optional argument is about to be added to AsyncWrap. So instead of piling them on, create a separate constructor specifically for PromiseWrap since it's the only class that uses the "silent" argument. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Allow the user to pass in an execution_async_id instead of always generating one. This way the JS API can be used to pre-allocate the execution_async_id when the JS object is instantiated, before the native resource is created. Also allow the new execution_async_id to be passed via asyncReset(). PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

The new test-with-async-hooks runs all normal tests (except async-hooks) with the environment variable NODE_TEST_WITH_ASYNC_HOOKS set. These extra checks do a minimum check to make sure async_hooks operates normally under all other tests. e.g. if init() or destroy() is called twice for the same id. Also move test "async-hooks" from CI_JS_SUITES into its own CI_ASYNC_HOOKS. Makes it cleaner to add, instead of supplying a massive list of tests that may change in the future. PR-URL: nodejs/node#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

When running tests with NODE_TEST_WITH_ASYNC_HOOKS and the same asyncId is detected twice print the stack traces of both init() calls. Also print if the resource is the same instance. PR-URL: nodejs/node#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

The test addons/async-hooks-promise depends on there being only one hook available. So skip it if NODE_TEST_WITH_ASYNC_HOOKS is set. PR-URL: nodejs/node#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Another optional argument is about to be added to AsyncWrap. So instead of piling them on, create a separate constructor specifically for PromiseWrap since it's the only class that uses the "silent" argument. PR-URL: nodejs/node#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Allow the user to pass in an execution_async_id instead of always generating one. This way the JS API can be used to pre-allocate the execution_async_id when the JS object is instantiated, before the native resource is created. Also allow the new execution_async_id to be passed via asyncReset(). PR-URL: nodejs/node#14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

The new test-with-async-hooks runs all normal tests (except async-hooks) with the environment variable NODE_TEST_WITH_ASYNC_HOOKS set. These extra checks do a minimum check to make sure async_hooks operates normally under all other tests. e.g. if init() or destroy() is called twice for the same id. Also move test "async-hooks" from CI_JS_SUITES into its own CI_ASYNC_HOOKS. Makes it cleaner to add, instead of supplying a massive list of tests that may change in the future. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

When running tests with NODE_TEST_WITH_ASYNC_HOOKS and the same asyncId is detected twice print the stack traces of both init() calls. Also print if the resource is the same instance. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

The test addons/async-hooks-promise depends on there being only one hook available. So skip it if NODE_TEST_WITH_ASYNC_HOOKS is set. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Another optional argument is about to be added to AsyncWrap. So instead of piling them on, create a separate constructor specifically for PromiseWrap since it's the only class that uses the "silent" argument. PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

Allow the user to pass in an execution_async_id instead of always generating one. This way the JS API can be used to pre-allocate the execution_async_id when the JS object is instantiated, before the native resource is created. Also allow the new execution_async_id to be passed via asyncReset(). PR-URL: #14208 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

trevnorris added async_hooks Issues and PRs related to the async hooks subsystem. async_wrap labels Jul 12, 2017

trevnorris requested review from refack, AndreasMadsen and addaleax July 12, 2017 22:52

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. labels Jul 12, 2017

trevnorris changed the title ~~allow user to pass custom async_id to node::AsyncWrap::AsyncWrap~~ allow user to pass custom async_id to node::AsyncWrap::AsyncWrap Jul 12, 2017

trevnorris changed the title ~~allow user to pass custom async_id to node::AsyncWrap::AsyncWrap~~ allow passing custom async_id to node::AsyncWrap::AsyncWrap Jul 12, 2017

trevnorris mentioned this pull request Jul 12, 2017

tracking issue: passing custom async_id's to node::AsyncWrap::AsyncWrap #14209

Closed

AndreasMadsen reviewed Jul 13, 2017

View reviewed changes

AndreasMadsen mentioned this pull request Jul 13, 2017

Report async tasks to V8 Inspector #13870

Closed

4 tasks

trevnorris force-pushed the aw-accept-id branch from 8c77e4c to c32af01 Compare July 17, 2017 22:34

AndreasMadsen added the dont-land-on-v6.x label Jul 18, 2017

trevnorris mentioned this pull request Jul 20, 2017

http: set async_id_symbol to any socket set #14389

Closed

3 tasks

trevnorris force-pushed the aw-accept-id branch from c32af01 to c4796a3 Compare July 21, 2017 20:50

trevnorris force-pushed the aw-accept-id branch from c4796a3 to b2865ba Compare September 14, 2017 19:54

jasnell approved these changes Sep 14, 2017

View reviewed changes

refack approved these changes Sep 15, 2017

View reviewed changes

trevnorris force-pushed the aw-accept-id branch from b2865ba to e6cdef9 Compare September 26, 2017 21:28

refack approved these changes Sep 26, 2017

View reviewed changes

trevnorris added 4 commits September 27, 2017 04:15

trevnorris force-pushed the aw-accept-id branch from e6cdef9 to 2b9b46c Compare September 27, 2017 10:24

trevnorris merged commit 2b9b46c into nodejs:master Sep 27, 2017

trevnorris deleted the aw-accept-id branch September 27, 2017 10:41

MylesBorins mentioned this pull request Oct 3, 2017

v8.7.0 proposal #15762

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

allow passing custom async_id to node::AsyncWrap::AsyncWrap #14208

allow passing custom async_id to node::AsyncWrap::AsyncWrap #14208

trevnorris commented Jul 12, 2017 •

edited

Loading

AndreasMadsen Jul 13, 2017 •

edited

Loading

trevnorris Jul 13, 2017

AndreasMadsen Jul 13, 2017 •

edited

Loading

trevnorris Jul 13, 2017

AndreasMadsen Jul 14, 2017

trevnorris Jul 17, 2017

AndreasMadsen Jul 17, 2017

trevnorris Jul 17, 2017

refack Sep 15, 2017

AndreasMadsen Jul 13, 2017

trevnorris Jul 13, 2017 •

edited

Loading

AndreasMadsen commented Jul 13, 2017 •

edited

Loading

trevnorris commented Jul 13, 2017

refack commented Jul 14, 2017

BridgeAR commented Sep 2, 2017

trevnorris commented Sep 14, 2017

trevnorris commented Sep 14, 2017

refack Sep 15, 2017

refack Sep 15, 2017

refack Sep 15, 2017

trevnorris Sep 21, 2017

refack Sep 21, 2017

addaleax Sep 21, 2017

refack Sep 15, 2017

trevnorris Sep 21, 2017

refack Sep 21, 2017

trevnorris Sep 26, 2017

trevnorris commented Sep 26, 2017

		@@ -434,6 +436,14 @@ test-timers-clean:
		test-async-hooks:
		$(PYTHON) tools/test.py --mode=release async-hooks

allow passing custom async_id to node::AsyncWrap::AsyncWrap #14208

allow passing custom async_id to node::AsyncWrap::AsyncWrap #14208

Conversation

trevnorris commented Jul 12, 2017 • edited Loading

Checklist

Affected core subsystem(s)

AndreasMadsen Jul 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndreasMadsen Jul 13, 2017 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trevnorris Jul 13, 2017 • edited Loading

Choose a reason for hiding this comment

AndreasMadsen commented Jul 13, 2017 • edited Loading

trevnorris commented Jul 13, 2017

refack commented Jul 14, 2017

BridgeAR commented Sep 2, 2017

trevnorris commented Sep 14, 2017

trevnorris commented Sep 14, 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

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

trevnorris commented Sep 26, 2017

trevnorris commented Jul 12, 2017 •

edited

Loading

AndreasMadsen Jul 13, 2017 •

edited

Loading

AndreasMadsen Jul 13, 2017 •

edited

Loading

trevnorris Jul 13, 2017 •

edited

Loading

AndreasMadsen commented Jul 13, 2017 •

edited

Loading