From 68380b6d6b5b5bd8ea0a66719f31649dc18845e4 Mon Sep 17 00:00:00 2001
From: Darshan Sen <raisinten@gmail.com>
Date: Sat, 16 Apr 2022 18:17:50 +0530
Subject: [PATCH] worker: add hasRef()

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: https://github.com/nodejs/node/issues/42091
Refs: https://github.com/mafintosh/why-is-node-running/issues/59
Signed-off-by: Darshan Sen <raisinten@gmail.com>
---
 doc/api/worker_threads.md           | 10 ++++++++++
 lib/internal/worker.js              |  6 ++++++
 src/node_worker.cc                  |  8 ++++++++
 src/node_worker.h                   |  1 +
 test/parallel/test-worker-hasref.js | 12 ++++++++++++
 5 files changed, 37 insertions(+)
 create mode 100644 test/parallel/test-worker-hasref.js

diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md
index 3e8158470d432f..4a35f381c3067c 100644
--- a/doc/api/worker_threads.md
+++ b/doc/api/worker_threads.md
@@ -1144,6 +1144,16 @@ Send a message to the worker that is received via
 [`require('worker_threads').parentPort.on('message')`][].
 See [`port.postMessage()`][] for more details.
 
+### `worker.hasRef()`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+If true, the `Worker` object will keep the Node.js event loop active.
+
 ### `worker.ref()`
 
 <!-- YAML
diff --git a/lib/internal/worker.js b/lib/internal/worker.js
index 1d2cd8cefd2996..c2f93fcf0b8b9d 100644
--- a/lib/internal/worker.js
+++ b/lib/internal/worker.js
@@ -367,6 +367,12 @@ class Worker extends EventEmitter {
     });
   }
 
+  hasRef() {
+    if (this[kHandle] === null) return false;
+
+    return this[kHandle].hasRef();
+  }
+
   ref() {
     if (this[kHandle] === null) return;
 
diff --git a/src/node_worker.cc b/src/node_worker.cc
index c9743fcf583a08..2f5604c5febbfc 100644
--- a/src/node_worker.cc
+++ b/src/node_worker.cc
@@ -665,6 +665,12 @@ void Worker::Ref(const FunctionCallbackInfo<Value>& args) {
   }
 }
 
+void Worker::HasRef(const FunctionCallbackInfo<Value>& args) {
+  Worker* w;
+  ASSIGN_OR_RETURN_UNWRAP(&w, args.This());
+  args.GetReturnValue().Set(w->has_ref_);
+}
+
 void Worker::Unref(const FunctionCallbackInfo<Value>& args) {
   Worker* w;
   ASSIGN_OR_RETURN_UNWRAP(&w, args.This());
@@ -827,6 +833,7 @@ void InitWorker(Local<Object> target,
 
     env->SetProtoMethod(w, "startThread", Worker::StartThread);
     env->SetProtoMethod(w, "stopThread", Worker::StopThread);
+    env->SetProtoMethod(w, "hasRef", Worker::HasRef);
     env->SetProtoMethod(w, "ref", Worker::Ref);
     env->SetProtoMethod(w, "unref", Worker::Unref);
     env->SetProtoMethod(w, "getResourceLimits", Worker::GetResourceLimits);
@@ -890,6 +897,7 @@ void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
   registry->Register(Worker::New);
   registry->Register(Worker::StartThread);
   registry->Register(Worker::StopThread);
+  registry->Register(Worker::HasRef);
   registry->Register(Worker::Ref);
   registry->Register(Worker::Unref);
   registry->Register(Worker::GetResourceLimits);
diff --git a/src/node_worker.h b/src/node_worker.h
index d400c4c991dcbc..f2a9386aeabff3 100644
--- a/src/node_worker.h
+++ b/src/node_worker.h
@@ -61,6 +61,7 @@ class Worker : public AsyncWrap {
   static void SetEnvVars(const v8::FunctionCallbackInfo<v8::Value>& args);
   static void StartThread(const v8::FunctionCallbackInfo<v8::Value>& args);
   static void StopThread(const v8::FunctionCallbackInfo<v8::Value>& args);
+  static void HasRef(const v8::FunctionCallbackInfo<v8::Value>& args);
   static void Ref(const v8::FunctionCallbackInfo<v8::Value>& args);
   static void Unref(const v8::FunctionCallbackInfo<v8::Value>& args);
   static void GetResourceLimits(
diff --git a/test/parallel/test-worker-hasref.js b/test/parallel/test-worker-hasref.js
new file mode 100644
index 00000000000000..3169a39792de84
--- /dev/null
+++ b/test/parallel/test-worker-hasref.js
@@ -0,0 +1,12 @@
+'use strict';
+require('../common');
+
+const { Worker } = require('worker_threads');
+const { strictEqual } = require('assert');
+
+const w = new Worker('', { eval: true });
+strictEqual(w.hasRef(), true);
+w.unref();
+strictEqual(w.hasRef(), false);
+w.ref();
+strictEqual(w.hasRef(), true);