Skip to content

Commit 1f761a4

Browse files
RaisinTentargos
authored andcommitted
worker: add hasRef() to the handle object
This should help projects like https://github.com/mafintosh/why-is-node-running and https://github.com/facebook/jest to detect if Worker instances are keeping the event loop active correctly. Fixes: #42091 Refs: mafintosh/why-is-node-running#59 Signed-off-by: Darshan Sen <[email protected]> PR-URL: #42756 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
1 parent ccfae8c commit 1f761a4

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

src/node_worker.cc

+8
Original file line numberDiff line numberDiff line change
@@ -676,6 +676,12 @@ void Worker::Ref(const FunctionCallbackInfo<Value>& args) {
676676
}
677677
}
678678

679+
void Worker::HasRef(const FunctionCallbackInfo<Value>& args) {
680+
Worker* w;
681+
ASSIGN_OR_RETURN_UNWRAP(&w, args.This());
682+
args.GetReturnValue().Set(w->has_ref_);
683+
}
684+
679685
void Worker::Unref(const FunctionCallbackInfo<Value>& args) {
680686
Worker* w;
681687
ASSIGN_OR_RETURN_UNWRAP(&w, args.This());
@@ -838,6 +844,7 @@ void InitWorker(Local<Object> target,
838844

839845
env->SetProtoMethod(w, "startThread", Worker::StartThread);
840846
env->SetProtoMethod(w, "stopThread", Worker::StopThread);
847+
env->SetProtoMethod(w, "hasRef", Worker::HasRef);
841848
env->SetProtoMethod(w, "ref", Worker::Ref);
842849
env->SetProtoMethod(w, "unref", Worker::Unref);
843850
env->SetProtoMethod(w, "getResourceLimits", Worker::GetResourceLimits);
@@ -901,6 +908,7 @@ void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
901908
registry->Register(Worker::New);
902909
registry->Register(Worker::StartThread);
903910
registry->Register(Worker::StopThread);
911+
registry->Register(Worker::HasRef);
904912
registry->Register(Worker::Ref);
905913
registry->Register(Worker::Unref);
906914
registry->Register(Worker::GetResourceLimits);

src/node_worker.h

+1
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ class Worker : public AsyncWrap {
6060
static void SetEnvVars(const v8::FunctionCallbackInfo<v8::Value>& args);
6161
static void StartThread(const v8::FunctionCallbackInfo<v8::Value>& args);
6262
static void StopThread(const v8::FunctionCallbackInfo<v8::Value>& args);
63+
static void HasRef(const v8::FunctionCallbackInfo<v8::Value>& args);
6364
static void Ref(const v8::FunctionCallbackInfo<v8::Value>& args);
6465
static void Unref(const v8::FunctionCallbackInfo<v8::Value>& args);
6566
static void GetResourceLimits(

test/parallel/test-worker-hasref.js

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
'use strict';
2+
const common = require('../common');
3+
4+
const { Worker } = require('worker_threads');
5+
const { createHook } = require('async_hooks');
6+
const { strictEqual } = require('assert');
7+
8+
let handle;
9+
10+
createHook({
11+
init(asyncId, type, triggerAsyncId, resource) {
12+
if (type === 'WORKER') {
13+
handle = resource;
14+
this.disable();
15+
}
16+
}
17+
}).enable();
18+
19+
const w = new Worker('', { eval: true });
20+
21+
strictEqual(handle.hasRef(), true);
22+
w.unref();
23+
strictEqual(handle.hasRef(), false);
24+
w.ref();
25+
strictEqual(handle.hasRef(), true);
26+
27+
w.on('exit', common.mustCall((exitCode) => {
28+
strictEqual(exitCode, 0);
29+
strictEqual(handle.hasRef(), true);
30+
setTimeout(common.mustCall(() => {
31+
strictEqual(handle.hasRef(), undefined);
32+
}), 0);
33+
}));

0 commit comments

Comments
 (0)