-
-
Notifications
You must be signed in to change notification settings - Fork 34.2k
async_wrap,src: promise hook integration #13000
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 15 commits
ef35de1
563c1b0
4aaadc0
70f9675
0afbcfc
833ad39
5717d75
34ee31f
e0c194b
e1c11e7
d47e97a
012171a
4e38bda
13313bb
9b9c310
81ff7f6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -44,6 +44,8 @@ using v8::Local; | |
| using v8::MaybeLocal; | ||
| using v8::Number; | ||
| using v8::Object; | ||
| using v8::Promise; | ||
| using v8::PromiseHookType; | ||
| using v8::RetainedObjectInfo; | ||
| using v8::Symbol; | ||
| using v8::TryCatch; | ||
|
|
@@ -177,6 +179,141 @@ static void PushBackDestroyId(Environment* env, double id) { | |
| } | ||
|
|
||
|
|
||
| bool DomainEnter(Environment* env, Local<Object> object) { | ||
| Local<Value> domain_v = object->Get(env->domain_string()); | ||
| if (domain_v->IsObject()) { | ||
| Local<Object> domain = domain_v.As<Object>(); | ||
| if (domain->Get(env->disposed_string())->IsTrue()) | ||
| return true; | ||
| Local<Value> enter_v = domain->Get(env->enter_string()); | ||
| if (enter_v->IsFunction()) { | ||
| if (enter_v.As<Function>()->Call(domain, 0, nullptr).IsEmpty()) { | ||
| FatalError("node::AsyncWrap::MakeCallback", | ||
| "domain enter callback threw, please report this"); | ||
| } | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
|
|
||
| bool DomainExit(Environment* env, v8::Local<v8::Object> object) { | ||
| Local<Value> domain_v = object->Get(env->domain_string()); | ||
| if (domain_v->IsObject()) { | ||
| Local<Object> domain = domain_v.As<Object>(); | ||
| if (domain->Get(env->disposed_string())->IsTrue()) | ||
| return true; | ||
| Local<Value> exit_v = domain->Get(env->exit_string()); | ||
| if (exit_v->IsFunction()) { | ||
| if (exit_v.As<Function>()->Call(domain, 0, nullptr).IsEmpty()) { | ||
| FatalError("node::AsyncWrap::MakeCallback", | ||
| "domain exit callback threw, please report this"); | ||
| } | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
|
|
||
| static bool PreCallbackExecution(AsyncWrap* wrap, bool run_domain_cbs) { | ||
| AsyncHooks* async_hooks = wrap->env()->async_hooks(); | ||
|
|
||
| if (wrap->env()->using_domains() && run_domain_cbs) { | ||
| bool is_disposed = DomainEnter(wrap->env(), wrap->object()); | ||
| if (is_disposed) | ||
| return false; | ||
| } | ||
|
|
||
| if (async_hooks->fields()[AsyncHooks::kBefore] > 0) { | ||
| Local<Value> uid = Number::New(wrap->env()->isolate(), wrap->get_id()); | ||
| Local<Function> fn = wrap->env()->async_hooks_before_function(); | ||
| TryCatch try_catch(wrap->env()->isolate()); | ||
| MaybeLocal<Value> ar = fn->Call( | ||
| wrap->env()->context(), Undefined(wrap->env()->isolate()), 1, &uid); | ||
| if (ar.IsEmpty()) { | ||
| ClearFatalExceptionHandlers(wrap->env()); | ||
| FatalException(wrap->env()->isolate(), try_catch); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
|
|
||
| static bool PostCallbackExecution(AsyncWrap* wrap, bool run_domain_cbs) { | ||
| AsyncHooks* async_hooks = wrap->env()->async_hooks(); | ||
|
|
||
| // If the callback failed then the after() hooks will be called at the end | ||
| // of _fatalException(). | ||
| if (async_hooks->fields()[AsyncHooks::kAfter] > 0) { | ||
| Local<Value> uid = Number::New(wrap->env()->isolate(), wrap->get_id()); | ||
| Local<Function> fn = wrap->env()->async_hooks_after_function(); | ||
| TryCatch try_catch(wrap->env()->isolate()); | ||
| MaybeLocal<Value> ar = fn->Call( | ||
| wrap->env()->context(), Undefined(wrap->env()->isolate()), 1, &uid); | ||
| if (ar.IsEmpty()) { | ||
| ClearFatalExceptionHandlers(wrap->env()); | ||
| FatalException(wrap->env()->isolate(), try_catch); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| if (wrap->env()->using_domains() && run_domain_cbs) { | ||
| bool is_disposed = DomainExit(wrap->env(), wrap->object()); | ||
| if (is_disposed) | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| class PromiseWrap : public AsyncWrap { | ||
| public: | ||
| PromiseWrap(Environment* env, Local<Object> object) | ||
| : AsyncWrap(env, object, PROVIDER_PROMISE) {} | ||
| size_t self_size() const override { return sizeof(*this); } | ||
| }; | ||
|
|
||
|
|
||
| static void PromiseHook(PromiseHookType type, Local<Promise> promise, | ||
| Local<Value> parent, void* arg) { | ||
| Local<Context> context = promise->CreationContext(); | ||
| Environment* env = Environment::GetCurrent(context); | ||
| if (type == PromiseHookType::kInit) { | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there an analogue of
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @matthewloring What Trevor has been doing elsewhere in the code is testing
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @addaleax As far as I can tell, the line above is only used to avoid invoking init hooks if none have been registered. I was hoping to avoid attaching the new async hook related properties to promises in the case where async hooks were disabled. Adding these properties causes ~30x increase in the time it takes to construct/resolve promises (adding the property causes all of V8's map checks to fail and prevent promises from ever running on fast paths). I am hoping to fix this by adding an internal field to promises (https://codereview.chromium.org/2889863002/) but it would be good to avoid modifying promises if async hooks are not in use. This slow down may also come in to play when domains are active as that also seems to modify promise shape but I haven't run any benchmarks against domains yet.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @matthewloring I think this might be enough for what you want? I didn’t try it with this PR but it passes testing on its own. diffdiff --git a/lib/async_hooks.js b/lib/async_hooks.js
index 867b5eb52da1..49f8fa5becf2 100644
--- a/lib/async_hooks.js
+++ b/lib/async_hooks.js
@@ -49,12 +49,7 @@ const before_symbol = Symbol('before');
const after_symbol = Symbol('after');
const destroy_symbol = Symbol('destroy');
-// Setup the callbacks that node::AsyncWrap will call when there are hooks to
-// process. They use the same functions as the JS embedder API.
-async_wrap.setupHooks({ init,
- before: emitBeforeN,
- after: emitAfterN,
- destroy: emitDestroyN });
+let setupHooksCalled = false;
// Used to fatally abort the process if a callback throws.
function fatalError(e) {
@@ -103,6 +98,16 @@ class AsyncHook {
if (hooks_array.includes(this))
return;
+ if (!setupHooksCalled) {
+ setupHooksCalled = true;
+ // Setup the callbacks that node::AsyncWrap will call when there are
+ // hooks to process. They use the same functions as the JS embedder API.
+ async_wrap.setupHooks({ init,
+ before: emitBeforeN,
+ after: emitAfterN,
+ destroy: emitDestroyN });
+ }
+
// createHook() has already enforced that the callbacks are all functions,
// so here simply increment the count of whether each callbacks exists or
// not.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
How much will inverting the dependencies help, as suggested in #13000 (comment)? Personally, I see no reason to add properties to the promise object.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @addaleax yes, but can a WeakMap (
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @AndreasMadsen As I’ve recently learned, no :( http://iamstef.net/n/shapeshifting.html
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I see, that is sad :(
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @matthewloring I actually had a call like this previously, but removed it b/c it wasn't needed anywhere in the initial PR. Basically if
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| // Unfortunately, promises don't have internal fields. Need a surrogate that | ||
| // async wrap can wrap. | ||
| Local<Object> obj = | ||
| env->async_hooks_promise_object()->NewInstance(context).ToLocalChecked(); | ||
| PromiseWrap* wrap = new PromiseWrap(env, obj); | ||
| v8::PropertyAttribute hidden = | ||
| static_cast<v8::PropertyAttribute>(v8::ReadOnly | v8::DontDelete | v8::DontEnum); | ||
| promise->DefineOwnProperty(context, | ||
| env->promise_wrap(), | ||
| v8::External::New(env->isolate(), wrap), | ||
| hidden).FromJust(); | ||
| // The async tag will be destroyed at the same time as the promise as the | ||
| // only reference to it is held by the promise. This allows the promise | ||
| // wrap instance to be notified when the promise is destroyed. | ||
| promise->DefineOwnProperty(context, | ||
| env->promise_async_tag(), | ||
|
||
| obj, hidden).FromJust(); | ||
| } else if (type == PromiseHookType::kResolve) { | ||
| // TODO(matthewloring): need to expose this through the async hooks api. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Yes, there is also the actual event but that information can be inferred when
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
yep :)
You’d think so, wouldn’t you? 😄 This isn’t called when the promise is resolved, it’s at the beginning of when the I’m not actually sure There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure if a promise's
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Haha, that was actually what I meant, when
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This was perhaps the most discussed thing in the I think adding the async id that called
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is an example scenario that almost captures all the possibilities that Promises and async hooks can interact: (function runner() {
const p = new Promise(function p_fn0(res) {
setImmediate(function si0() {
res('foo')
});
}).then(function then0(val) {
return Fn(val);
});
setImmediate(function si0() {
p.catch(function catch0(err) {
printLongErrorStack(err); // not defined
});
});
function Fn(val) {
if (val === 'foo') throw new Error('bam');
}
})();If each Promise executor, onFulfilled or onRejected only collect the stack when Though it would be helpful to produce the following long stack: I've had some lengthy discussions about this and, though I don't remember with whom, I recall agreeing that the logical place to execute the So for this PR the first stack above is expected, but we should also address how to produce the second. IIRC the API in in place to allow watching for
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yup, this conversation was with me and I think it captures the concern with attaching the async id to the promise resource at resolution time so that it can be read in
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @matthewloring Adding another type that fires at a different time wouldn't be a problem.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
While it is not a technical issue to add another type (I assume you mean event type and not resource type), I think it would be better to do in a future PR where we have a better chance to evaluate the needs for such event type for other cases than promises. So far the only concern mentioned in the EPS has been regarding context across async boundaries, which "attaching the async id to the promise resource" does solve, although not in a particularly nice way.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Addressing this in a follow on seems fine to me. |
||
| } | ||
| Local<v8::Value> external_wrap = | ||
| promise->Get(context, env->promise_wrap()).ToLocalChecked(); | ||
| PromiseWrap* wrap = | ||
| static_cast<PromiseWrap*>(external_wrap.As<v8::External>()->Value()); | ||
| CHECK_NE(wrap, nullptr); | ||
| if (type == PromiseHookType::kBefore) { | ||
| PreCallbackExecution(wrap, false); | ||
| } else if (type == PromiseHookType::kAfter) { | ||
| PostCallbackExecution(wrap, false); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| static void SetupHooks(const FunctionCallbackInfo<Value>& args) { | ||
| Environment* env = Environment::GetCurrent(args); | ||
|
|
||
|
|
@@ -201,6 +338,7 @@ static void SetupHooks(const FunctionCallbackInfo<Value>& args) { | |
| SET_HOOK_FN(before); | ||
| SET_HOOK_FN(after); | ||
| SET_HOOK_FN(destroy); | ||
| env->AddPromiseHook(PromiseHook, nullptr); | ||
| #undef SET_HOOK_FN | ||
| } | ||
|
|
||
|
|
@@ -262,6 +400,11 @@ void AsyncWrap::Initialize(Local<Object> target, | |
| env->SetMethod(target, "clearIdStack", ClearIdStack); | ||
| env->SetMethod(target, "addIdToDestroyList", QueueDestroyId); | ||
|
|
||
| Local<v8::ObjectTemplate> promise_object_template = | ||
| v8::ObjectTemplate::New(env->isolate()); | ||
| promise_object_template->SetInternalFieldCount(1); | ||
| env->set_async_hooks_promise_object(promise_object_template); | ||
|
|
||
| v8::PropertyAttribute ReadOnlyDontDelete = | ||
| static_cast<v8::PropertyAttribute>(v8::ReadOnly | v8::DontDelete); | ||
|
|
||
|
|
@@ -416,87 +559,30 @@ Local<Value> AsyncWrap::MakeCallback(const Local<Function> cb, | |
| Local<Value>* argv) { | ||
| CHECK(env()->context() == env()->isolate()->GetCurrentContext()); | ||
|
|
||
| AsyncHooks* async_hooks = env()->async_hooks(); | ||
| Local<Object> context = object(); | ||
| Local<Object> domain; | ||
| Local<Value> uid; | ||
| bool has_domain = false; | ||
|
|
||
| Environment::AsyncCallbackScope callback_scope(env()); | ||
|
|
||
| if (env()->using_domains()) { | ||
| Local<Value> domain_v = context->Get(env()->domain_string()); | ||
| has_domain = domain_v->IsObject(); | ||
| if (has_domain) { | ||
| domain = domain_v.As<Object>(); | ||
| if (domain->Get(env()->disposed_string())->IsTrue()) | ||
| return Local<Value>(); | ||
| } | ||
| } | ||
| Environment::AsyncHooks::ExecScope exec_scope(env(), | ||
| get_id(), | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Grabbing the
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Are you sure? We use the
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @addaleax Note sure what I was smoking. My comment makes no sense. Never mind. |
||
| get_trigger_id()); | ||
|
|
||
| if (has_domain) { | ||
| Local<Value> enter_v = domain->Get(env()->enter_string()); | ||
| if (enter_v->IsFunction()) { | ||
| if (enter_v.As<Function>()->Call(domain, 0, nullptr).IsEmpty()) { | ||
| FatalError("node::AsyncWrap::MakeCallback", | ||
| "domain enter callback threw, please report this"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Want currentId() to return the correct value from the callbacks. | ||
| AsyncHooks::ExecScope exec_scope(env(), get_id(), get_trigger_id()); | ||
|
|
||
| if (async_hooks->fields()[AsyncHooks::kBefore] > 0) { | ||
| uid = Number::New(env()->isolate(), get_id()); | ||
| Local<Function> fn = env()->async_hooks_before_function(); | ||
| TryCatch try_catch(env()->isolate()); | ||
| MaybeLocal<Value> ar = fn->Call( | ||
| env()->context(), Undefined(env()->isolate()), 1, &uid); | ||
| if (ar.IsEmpty()) { | ||
| ClearFatalExceptionHandlers(env()); | ||
| FatalException(env()->isolate(), try_catch); | ||
| return Local<Value>(); | ||
| } | ||
| if (!PreCallbackExecution(this, true)) { | ||
| return Local<Value>(); | ||
| } | ||
|
|
||
| // Finally... Get to running the user's callback. | ||
| MaybeLocal<Value> ret = cb->Call(env()->context(), context, argc, argv); | ||
| MaybeLocal<Value> ret = cb->Call(env()->context(), object(), argc, argv); | ||
|
|
||
| Local<Value> ret_v; | ||
| if (!ret.ToLocal(&ret_v)) { | ||
| return Local<Value>(); | ||
| } | ||
|
|
||
| // If the callback failed then the after() hooks will be called at the end | ||
| // of _fatalException(). | ||
| if (async_hooks->fields()[AsyncHooks::kAfter] > 0) { | ||
| if (uid.IsEmpty()) | ||
| uid = Number::New(env()->isolate(), get_id()); | ||
| Local<Function> fn = env()->async_hooks_after_function(); | ||
| TryCatch try_catch(env()->isolate()); | ||
| MaybeLocal<Value> ar = fn->Call( | ||
| env()->context(), Undefined(env()->isolate()), 1, &uid); | ||
| if (ar.IsEmpty()) { | ||
| ClearFatalExceptionHandlers(env()); | ||
| FatalException(env()->isolate(), try_catch); | ||
| return Local<Value>(); | ||
| } | ||
| if (!PostCallbackExecution(this, true)) { | ||
| return Local<Value>(); | ||
| } | ||
|
|
||
| // The execution scope of the id and trigger_id only go this far. | ||
| exec_scope.Dispose(); | ||
|
|
||
| if (has_domain) { | ||
| Local<Value> exit_v = domain->Get(env()->exit_string()); | ||
| if (exit_v->IsFunction()) { | ||
| if (exit_v.As<Function>()->Call(domain, 0, nullptr).IsEmpty()) { | ||
| FatalError("node::AsyncWrap::MakeCallback", | ||
| "domain exit callback threw, please report this"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (callback_scope.in_makecallback()) { | ||
| return ret_v; | ||
| } | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FatalException()always exits the application in this case becauseClearFatalException()removed allunhandledExceptioncallbacks. So I'll assume thisreturnis so the compiler doesn't emit a warning.I decided this would be the safest course of action when first implementing
AsyncWrapbecause it was difficult to properly clean up if an async hook threw. It was difficult enough to properly cleanup if a user's callback threw (seeprocess._fatalException()inlib/internal/bootstrap_node.js). If we can properly show it's safe to recover from an async hook throwing then I'm all for changing this behavior.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That makes sense, maybe we can look into that more in a follow on pr.