worker: add name for worker #59213

theanarkh · 2025-07-25T16:05:28Z

In some scenarios, name is very useful(such as in the APM SDK) and easier to understand.

const { Worker } = require('worker_threads');

process.on('worker', (worker) => {
  // output: test-worker-thread-name in main thread
  console.log(worker.threadName + " in main thread");
});

new Worker(`
  const { threadName } = require('worker_threads');
  // output: test-worker-thread-name in worker thread
  console.log(threadName + " in worker thread");
`, { eval: true, name: 'test-worker-thread-name' });

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

codecov · 2025-07-25T17:38:57Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.00%. Comparing base (04c5a18) to head (6f7e498).
⚠️ Report is 56 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #59213      +/-   ##
==========================================
- Coverage   90.04%   90.00%   -0.04%     
==========================================
  Files         648      649       +1     
  Lines      191200   192219    +1019     
  Branches    37472    37659     +187     
==========================================
+ Hits       172160   173006     +846     
- Misses      11665    11826     +161     
- Partials     7375     7387      +12

Files with missing lines	Coverage Δ
lib/internal/worker.js	`98.83% <100.00%> (+0.01%)`	⬆️
lib/worker_threads.js	`100.00% <100.00%> (ø)`
src/api/environment.cc	`77.05% <100.00%> (+0.23%)`	⬆️
src/env-inl.h	`94.23% <100.00%> (+0.02%)`	⬆️
src/env.cc	`80.64% <100.00%> (-0.41%)`	⬇️
src/env.h	`98.14% <ø> (ø)`
src/node.h	`92.30% <ø> (ø)`
src/node_worker.cc	`84.57% <100.00%> (+1.37%)`	⬆️

... and 43 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

src/node.h

addaleax

LGTM!

nodejs-github-bot · 2025-07-27T03:53:25Z

CI: https://ci.nodejs.org/job/node-test-pull-request/68227/

nodejs-github-bot · 2025-07-27T06:44:23Z

CI: https://ci.nodejs.org/job/node-test-pull-request/68229/

github-actions · 2025-07-28T10:54:20Z

Failed to start CI

   ⚠  Commits were pushed since the last approving review:
   ⚠  - worker: add name for worker
   ✘  Refusing to run CI on potentially unsafe PR

https://github.com/nodejs/node/actions/runs/16567111188

theanarkh · 2025-07-29T13:10:50Z

@addaleax Hi! I modified the test example to support creating worker in worker. Could you help review again ? Thanks !

nodejs-github-bot · 2025-07-29T14:52:03Z

CI: https://ci.nodejs.org/job/node-test-pull-request/68298/

src/node_worker.cc

nodejs-github-bot · 2025-08-04T13:02:36Z

CI: https://ci.nodejs.org/job/node-test-pull-request/68402/

jasnell · 2025-08-04T13:20:22Z

test/parallel/test-worker-thread-name.js

+
+const name = 'test-worker-thread-name';
+
+if (workerData?.isWorker) {


It looks like the workerData?.isWorker is here only to determine if you're running in a worker or not. You can use isMainThread for that purpose and simplify this a bit.

const { Worker, isMainThread } = require('worker_threads'); if (!isMainThread) { // This is running in a worker } else { // This is running in the main thread }

workerData?.isWorker is designed to support the creation of worker within worker.

Is that actually necessary tho? I would just make this test as a whole not run in a worker.

We also need to support this use case, so should we support this kind of test ?

jasnell · 2025-08-04T13:21:23Z

test/parallel/test-worker-thread-name.js

+
+if (workerData?.isWorker) {
+  assert.strictEqual(threadName, name);
+  process.exit(0);


There should be no reason for process.exit(0) here.

jasnell · 2025-08-04T13:24:48Z

doc/api/worker_threads.md

@@ -721,6 +721,17 @@ An integer identifier for the current thread. On the corresponding worker object
 (if there is any), it is available as [`worker.threadId`][].
 This value is unique for each [`Worker`][] instance inside a single process.

+## `worker.threadName`


Just a nit since I see we don't do this with the other properties here so feel free to ignore, but it would be ideal if the docs were clear that this is a read-only property. (same goes for the other read-only properties here)

jasnell · 2025-08-04T13:26:34Z

lib/internal/worker.js

+    if (this[kHandle] === null) return null;
+
+    return this[kHandle].threadName;


I believe you could simplify this a bit as...

Suggested change

if (this[kHandle] === null) return null;

return this[kHandle].threadName;

return this[kHandle]?.threadName || null;

I will optimize it in another pr.Thanks.

nodejs-github-bot · 2025-08-04T15:23:31Z

CI: https://ci.nodejs.org/job/node-test-pull-request/68409/

nodejs-github-bot · 2025-08-04T16:22:56Z

CI: https://ci.nodejs.org/job/node-test-pull-request/68410/

nodejs-github-bot · 2025-08-05T13:45:43Z

Landed in 3090def

PR-URL: nodejs#59213 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: #59213 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: nodejs#59213 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: #59213 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Jul 25, 2025

theanarkh added the worker Issues and PRs related to Worker support. label Jul 25, 2025

theanarkh force-pushed the add_name_for_worker branch 3 times, most recently from 8cffc77 to db88135 Compare July 25, 2025 16:48

addaleax reviewed Jul 25, 2025

View reviewed changes

src/node.h Outdated Show resolved Hide resolved

theanarkh force-pushed the add_name_for_worker branch 3 times, most recently from c59afff to cf60597 Compare July 26, 2025 18:37

addaleax approved these changes Jul 26, 2025

View reviewed changes

theanarkh added the request-ci Add this label to start a Jenkins CI on a PR. label Jul 27, 2025

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jul 27, 2025

theanarkh force-pushed the add_name_for_worker branch from cf60597 to 854c313 Compare July 27, 2025 09:04

theanarkh added the request-ci Add this label to start a Jenkins CI on a PR. label Jul 28, 2025

github-actions bot added request-ci-failed An error occurred while starting CI via request-ci label, and manual interventon is needed. and removed request-ci Add this label to start a Jenkins CI on a PR. labels Jul 28, 2025

theanarkh force-pushed the add_name_for_worker branch from 854c313 to 42df3d9 Compare July 28, 2025 14:44

addaleax approved these changes Jul 29, 2025

View reviewed changes

theanarkh added request-ci Add this label to start a Jenkins CI on a PR. and removed request-ci-failed An error occurred while starting CI via request-ci label, and manual interventon is needed. labels Jul 29, 2025

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jul 29, 2025

jasnell reviewed Jul 29, 2025

View reviewed changes

src/node_worker.cc Show resolved Hide resolved

jasnell approved these changes Jul 29, 2025

View reviewed changes

theanarkh force-pushed the add_name_for_worker branch from 07eb563 to d1f417c Compare July 29, 2025 18:48

worker: add name for worker

6f7e498

theanarkh force-pushed the add_name_for_worker branch from d1f417c to 6f7e498 Compare July 30, 2025 05:55

theanarkh requested review from jasnell and addaleax July 31, 2025 09:56

addaleax approved these changes Aug 4, 2025

View reviewed changes

theanarkh added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 4, 2025

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 4, 2025

This comment was marked as outdated.

Sign in to view

jasnell reviewed Aug 4, 2025

View reviewed changes

jasnell approved these changes Aug 4, 2025

View reviewed changes

theanarkh added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Aug 5, 2025

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 5, 2025

nodejs-github-bot merged commit 3090def into nodejs:main Aug 5, 2025
64 checks passed

panva pushed a commit to panva/node that referenced this pull request Aug 7, 2025

worker: add name for worker

4f9b348

PR-URL: nodejs#59213 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

targos pushed a commit that referenced this pull request Aug 8, 2025

worker: add name for worker

e07d9d0

PR-URL: #59213 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

mete0rfish pushed a commit to mete0rfish/node-contribute that referenced this pull request Aug 9, 2025

worker: add name for worker

03251d3

PR-URL: nodejs#59213 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

panva pushed a commit to panva/node that referenced this pull request Aug 9, 2025

worker: add name for worker

04a14a0

PR-URL: nodejs#59213 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

github-actions bot mentioned this pull request Aug 11, 2025

2025-08-12, Version 24.6.0 (Current) #59449

Merged

RafaelGSS pushed a commit that referenced this pull request Aug 12, 2025

worker: add name for worker

eecd327

PR-URL: #59213 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>

Jul	AUG	Sep
	14
2024	2025	2026


		const name = 'test-worker-thread-name';

		if (workerData?.isWorker) {

		if (this[kHandle] === null) return null;

		return this[kHandle].threadName;

Uh oh!

worker: add name for worker #59213

worker: add name for worker #59213

Uh oh!

Conversation

theanarkh commented Jul 25, 2025

Uh oh!

codecov bot commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

addaleax left a comment

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Jul 27, 2025

Uh oh!

nodejs-github-bot commented Jul 27, 2025

Uh oh!

github-actions bot commented Jul 28, 2025

Uh oh!

theanarkh commented Jul 29, 2025

Uh oh!

nodejs-github-bot commented Jul 29, 2025

Uh oh!

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

nodejs-github-bot commented Aug 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Aug 4, 2025

Uh oh!

nodejs-github-bot commented Aug 4, 2025

Uh oh!

Uh oh!

nodejs-github-bot commented Aug 5, 2025

Uh oh!

Uh oh!

codecov bot commented Jul 25, 2025 •

edited

Loading