Skip to content
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

AsyncWrap minor fixes #1614

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 9 additions & 23 deletions src/async-wrap-inl.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,39 +21,25 @@ inline AsyncWrap::AsyncWrap(Environment* env,
// Check user controlled flag to see if the init callback should run.
if (!env->using_asyncwrap())
return;
if (!env->call_async_init_hook() && parent == nullptr)
return;

// TODO(trevnorris): Until it's verified all passed object's are not weak,
// add a HandleScope to make sure there's no leak.
v8::HandleScope scope(env->isolate());
// If callback hooks have not been enabled, and there is no parent, return.
if (!env->async_wrap_callbacks_enabled() && parent == nullptr)
return;

v8::Local<v8::Object> parent_obj;
// If callback hooks have not been enabled and parent has no queue, return.
if (!env->async_wrap_callbacks_enabled() && !parent->has_async_queue())
return;

v8::HandleScope scope(env->isolate());
v8::TryCatch try_catch;

// If a parent value was sent then call its pre/post functions to let it know
// a conceptual "child" is being instantiated (e.g. that a server has
// received a connection).
if (parent != nullptr) {
parent_obj = parent->object();
env->async_hooks_pre_function()->Call(parent_obj, 0, nullptr);
if (try_catch.HasCaught())
FatalError("node::AsyncWrap::AsyncWrap", "parent pre hook threw");
}

env->async_hooks_init_function()->Call(object, 0, nullptr);
v8::Local<v8::Value> n = v8::Int32::New(env->isolate(), provider);
env->async_hooks_init_function()->Call(object, 1, &n);

if (try_catch.HasCaught())
FatalError("node::AsyncWrap::AsyncWrap", "init hook threw");

bits_ |= 1; // has_async_queue() is true now.

if (parent != nullptr) {
env->async_hooks_post_function()->Call(parent_obj, 0, nullptr);
if (try_catch.HasCaught())
FatalError("node::AsyncWrap::AsyncWrap", "parent post hook threw");
}
}


Expand Down
40 changes: 19 additions & 21 deletions src/async-wrap.cc
Original file line number Diff line number Diff line change
Expand Up @@ -23,32 +23,28 @@ using v8::kExternalUint32Array;

namespace node {

static void EnableHooksJS(const FunctionCallbackInfo<Value>& args) {
Environment* env = Environment::GetCurrent(args);
env->async_hooks()->set_enable_callbacks(1);
}


static void DisableHooksJS(const FunctionCallbackInfo<Value>& args) {
Environment* env = Environment::GetCurrent(args);
env->async_hooks()->set_enable_callbacks(0);
}


static void SetupHooks(const FunctionCallbackInfo<Value>& args) {
Environment* env = Environment::GetCurrent(args.GetIsolate());

CHECK(args[0]->IsObject());
CHECK(args[0]->IsFunction());
CHECK(args[1]->IsFunction());
CHECK(args[2]->IsFunction());
CHECK(args[3]->IsFunction());

// Attach Fields enum from Environment::AsyncHooks.
// Flags attached to this object are:
// - kCallInitHook (0): Tells the AsyncWrap constructor whether it should
// make a call to the init JS callback. This is disabled by default, so
// even after setting the callbacks the flag will have to be set to
// non-zero to have those callbacks called. This only affects the init
// callback. If the init callback was called, then the pre/post callbacks
// will automatically be called.
Local<Object> async_hooks_obj = args[0].As<Object>();
Environment::AsyncHooks* async_hooks = env->async_hooks();
async_hooks_obj->SetIndexedPropertiesToExternalArrayData(
async_hooks->fields(),
kExternalUint32Array,
async_hooks->fields_count());

env->set_async_hooks_init_function(args[1].As<Function>());
env->set_async_hooks_pre_function(args[2].As<Function>());
env->set_async_hooks_post_function(args[3].As<Function>());

env->set_async_hooks_init_function(args[0].As<Function>());
env->set_async_hooks_pre_function(args[1].As<Function>());
env->set_async_hooks_post_function(args[2].As<Function>());

env->set_using_asyncwrap(true);
}
Expand All @@ -62,6 +58,8 @@ static void Initialize(Handle<Object> target,
HandleScope scope(isolate);

NODE_SET_METHOD(target, "setupHooks", SetupHooks);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would do the same for SetupHooks for consistency. That can wait for another PR though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might as well. had to run before I had a chance to land this.

env->SetMethod(target, "disable", DisableHooksJS);
env->SetMethod(target, "enable", EnableHooksJS);

Local<Object> async_providers = Object::New(isolate);
#define V(PROVIDER) \
Expand Down
12 changes: 8 additions & 4 deletions src/env-inl.h
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,12 @@ inline int Environment::AsyncHooks::fields_count() const {
return kFieldsCount;
}

inline bool Environment::AsyncHooks::call_init_hook() {
return fields_[kCallInitHook] != 0;
inline bool Environment::AsyncHooks::callbacks_enabled() {
return fields_[kEnableCallbacks] != 0;
}

inline void Environment::AsyncHooks::set_enable_callbacks(uint32_t flag) {
fields_[kEnableCallbacks] = flag;
}

inline Environment::DomainFlag::DomainFlag() {
Expand Down Expand Up @@ -214,9 +218,9 @@ inline v8::Isolate* Environment::isolate() const {
return isolate_;
}

inline bool Environment::call_async_init_hook() const {
inline bool Environment::async_wrap_callbacks_enabled() const {
// The const_cast is okay, it doesn't violate conceptual const-ness.
return const_cast<Environment*>(this)->async_hooks()->call_init_hook();
return const_cast<Environment*>(this)->async_hooks()->callbacks_enabled();
}

inline bool Environment::in_domain() const {
Expand Down
7 changes: 4 additions & 3 deletions src/env.h
Original file line number Diff line number Diff line change
Expand Up @@ -269,15 +269,16 @@ class Environment {
public:
inline uint32_t* fields();
inline int fields_count() const;
inline bool call_init_hook();
inline bool callbacks_enabled();
inline void set_enable_callbacks(uint32_t flag);

private:
friend class Environment; // So we can call the constructor.
inline AsyncHooks();

enum Fields {
// Set this to not zero if the init hook should be called.
kCallInitHook,
kEnableCallbacks,
kFieldsCount
};

Expand Down Expand Up @@ -374,7 +375,7 @@ class Environment {

inline v8::Isolate* isolate() const;
inline uv_loop_t* event_loop() const;
inline bool call_async_init_hook() const;
inline bool async_wrap_callbacks_enabled() const;
inline bool in_domain() const;
inline uint32_t watched_providers() const;

Expand Down