inspector: expose inspector.close on workers

Workers can open their own inspector agent with `inspector.open`. They should be able to close their own inspector agent too with `inspector.close`. PR-URL: #44489 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
nodejs · Sep 26, 2022 · 8b256a3 · 8b256a3
1 parent 353cd84
commit 8b256a3
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 6 deletions.
diff --git a/doc/api/inspector.md b/doc/api/inspector.md
@@ -19,8 +19,6 @@ const inspector = require('node:inspector');
 
 Deactivate the inspector. Blocks until there are no active connections.
 
-This function is not available in [worker threads][].
-
 ## `inspector.console`
 
 * {Object} An object to send messages to the remote inspector console.
@@ -262,4 +260,3 @@ session.post('HeapProfiler.takeHeapSnapshot', null, (err, r) => {
 [`'Debugger.paused'`]: https://chromedevtools.github.io/devtools-protocol/v8/Debugger#event-paused
 [`session.connect()`]: #sessionconnect
 [security warning]: cli.md#warning-binding-inspector-to-a-public-ipport-combination-is-insecure
-[worker threads]: worker_threads.md
diff --git a/lib/inspector.js b/lib/inspector.js
@@ -32,6 +32,7 @@ const {
   validateString,
 } = require('internal/validators');
 const { isMainThread } = require('worker_threads');
+const { _debugEnd } = internalBinding('process_methods');
 
 const {
   Connection,
@@ -195,7 +196,7 @@ function inspectorWaitForDebugger() {
 
 module.exports = {
   open: inspectorOpen,
-  close: process._debugEnd,
+  close: _debugEnd,
   url,
   waitForDebugger: inspectorWaitForDebugger,
   console,

diff --git a/src/node_process_methods.cc b/src/node_process_methods.cc
@@ -562,24 +562,24 @@ static void Initialize(Local<Object> target,
   // define various internal methods
   if (env->owns_process_state()) {
     SetMethod(context, target, "_debugProcess", DebugProcess);
-    SetMethod(context, target, "_debugEnd", DebugEnd);
     SetMethod(context, target, "abort", Abort);
     SetMethod(context, target, "causeSegfault", CauseSegfault);
     SetMethod(context, target, "chdir", Chdir);
   }
 
   SetMethod(context, target, "umask", Umask);
-  SetMethod(context, target, "_rawDebug", RawDebug);
   SetMethod(context, target, "memoryUsage", MemoryUsage);
   SetMethod(context, target, "rss", Rss);
   SetMethod(context, target, "cpuUsage", CPUUsage);
   SetMethod(context, target, "resourceUsage", ResourceUsage);
 
+  SetMethod(context, target, "_debugEnd", DebugEnd);
   SetMethod(context, target, "_getActiveRequestsInfo", GetActiveRequestsInfo);
   SetMethod(context, target, "_getActiveRequests", GetActiveRequests);
   SetMethod(context, target, "_getActiveHandles", GetActiveHandles);
   SetMethod(context, target, "_getActiveHandlesInfo", GetActiveHandlesInfo);
   SetMethod(context, target, "_kill", Kill);
+  SetMethod(context, target, "_rawDebug", RawDebug);
 
   SetMethodNoSideEffect(context, target, "cwd", Cwd);
   SetMethod(context, target, "dlopen", binding::DLOpen);

diff --git a/test/parallel/test-inspector-close-worker.js b/test/parallel/test-inspector-close-worker.js
@@ -0,0 +1,34 @@
+'use strict';
+
+const common = require('../common');
+common.skipIfInspectorDisabled();
+const { isMainThread, Worker } = require('worker_threads');
+const assert = require('assert');
+const inspector = require('inspector');
+
+if (!isMainThread) {
+  // Verify the inspector api on the worker thread.
+  assert.strictEqual(inspector.url(), undefined);
+
+  inspector.open(0, undefined, false);
+  const wsUrl = inspector.url();
+  assert(wsUrl.startsWith('ws://'));
+  inspector.close();
+  assert.strictEqual(inspector.url(), undefined);
+  return;
+}
+
+// Open inspector on the main thread first.
+inspector.open(0, undefined, false);
+const wsUrl = inspector.url();
+assert(wsUrl.startsWith('ws://'));
+
+const worker = new Worker(__filename);
+worker.on('exit', common.mustCall((code) => {
+  assert.strictEqual(code, 0);
+
+  // Verify inspector on the main thread is still active.
+  assert.strictEqual(inspector.url(), wsUrl);
+  inspector.close();
+  assert.strictEqual(inspector.url(), undefined);
+}));