fixup! Update doc/api/worker_threads.md

nodejs · Jan 5, 2025 · c933aaa · c933aaa
1 parent 110da20
commit c933aaa
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 33 deletions.
diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md
@@ -100,7 +100,7 @@ if (isMainThread) {
 }
 ```
 
-## `worker.isInternalWorker`
+## `worker.isInternalThread`
 
 <!-- YAML
 added: REPLACEME
@@ -112,9 +112,9 @@ Is `true` if this code is running inside of an internal [`Worker`][] thread (e.g
 
 ```js
 // loader.js
-const { isInternalWorker } = require('node:worker_threads');
+const { isInternalThread } = require('node:worker_threads');
 
-console.log(isInternalWorker);  // Prints 'true'.
+console.log(isInternalThread);  // Prints 'true'.
 ```
 
 ```bash

diff --git a/lib/internal/worker.js b/lib/internal/worker.js
@@ -67,7 +67,7 @@ const {
 const {
   ownsProcessState,
   isMainThread,
-  isInternalWorker,
+  isInternalThread,
   resourceLimits: resourceLimitsRaw,
   threadId,
   Worker: WorkerImpl,
@@ -539,7 +539,7 @@ module.exports = {
   ownsProcessState,
   kIsOnline,
   isMainThread,
-  isInternalWorker,
+  isInternalThread,
   SHARE_ENV,
   resourceLimits:
     !isMainThread ? makeResourceLimits(resourceLimitsRaw) : {},

diff --git a/lib/worker_threads.js b/lib/worker_threads.js
@@ -2,7 +2,7 @@
 
 const {
   isMainThread,
-  isInternalWorker,
+  isInternalThread,
   SHARE_ENV,
   resourceLimits,
   setEnvironmentData,
@@ -31,7 +31,7 @@ const {
 
 module.exports = {
   isMainThread,
-  isInternalWorker,
+  isInternalThread,
   MessagePort,
   MessageChannel,
   markAsUncloneable,

diff --git a/src/node_worker.cc b/src/node_worker.cc
@@ -1039,7 +1039,7 @@ void CreateWorkerPerContextProperties(Local<Object> target,
   // Set the is_internal property
   target
       ->Set(env->context(),
-            FIXED_ONE_BYTE_STRING(isolate, "isInternalWorker"),
+            FIXED_ONE_BYTE_STRING(isolate, "isInternalThread"),
             Boolean::New(isolate, is_internal))
       .Check();
 

diff --git a/test/es-module/test-loaders-is-internal-thread.mjs b/test/es-module/test-loaders-is-internal-thread.mjs
diff --git a/test/fixtures/loader-is-internal-thread.js b/test/fixtures/loader-is-internal-thread.js
@@ -0,0 +1,3 @@
+const { isInternalThread } = require('node:worker_threads');
+
+console.log(isInternalThread);
diff --git a/test/fixtures/loader-is-internal-worker.js b/test/fixtures/loader-is-internal-worker.js
diff --git a/test/fixtures/worker-is-internal-thread.js b/test/fixtures/worker-is-internal-thread.js
@@ -0,0 +1,3 @@
+const { isInternalThread, parentPort } = require('node:worker_threads');
+
+parentPort.postMessage(isInternalThread);
diff --git a/test/parallel/test-is-internal-thread.mjs b/test/parallel/test-is-internal-thread.mjs
@@ -0,0 +1,36 @@
+import { spawnPromisified } from '../common/index.mjs';
+import * as fixtures from '../common/fixtures.mjs';
+import assert from 'node:assert';
+import { execPath } from 'node:process';
+import { describe, it } from 'node:test';
+import { isInternalThread, Worker } from 'node:worker_threads';
+import * as common from '../common/index.mjs';
+
+describe('isInternalThread is only true on InternalWorker', { concurrency: !process.env.TEST_PARALLEL }, () => {
+  it('should be true inside the loader thread', async () => {
+    const { code, signal, stdout, stderr } = await spawnPromisified(execPath, [
+      '--no-warnings',
+      '--experimental-loader',
+      fixtures.fileURL('loader-is-internal-thread.js'),
+      '--eval',
+      'setTimeout(() => {},99)',
+    ]);
+
+    assert.strictEqual(stderr, '');
+    assert.match(stdout, /^true\r?\n$/);
+    assert.strictEqual(code, 0);
+    assert.strictEqual(signal, null);
+  });
+
+  it('should be false inside the main thread', async () => {
+    assert.ok(!isInternalThread);
+  });
+
+  it('should be false inside a regular worker thread', async () => {
+    const worker = new Worker(fixtures.path('worker-is-internal-thread.js'));
+
+    worker.on('message', common.mustCall((isInternalThread) => {
+      assert.ok(!isInternalThread);
+    }));
+  });
+});
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		const { isInternalThread } = require('node:worker_threads');

		console.log(isInternalThread);
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		const { isInternalThread, parentPort } = require('node:worker_threads');

		parentPort.postMessage(isInternalThread);