Repository navigation
worker: add diagnostic channel 'worker_threads.main.registry' #67311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ShogunPanda
wants to merge
4
commits into
nodejs:main
Choose a base branch
from
ShogunPanda:threads-registry
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+113
−0
Open
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| 'use strict'; | ||
|
|
||
| const { | ||
| ArrayFrom, | ||
| AtomicsNotify, | ||
| AtomicsStore, | ||
| AtomicsWaitAsync, | ||
|
|
@@ -30,6 +31,8 @@ const { MessageChannel } = require('internal/worker/io'); | |
|
|
||
| const { validateNumber } = require('internal/validators'); | ||
|
|
||
| const registryChannel = require('diagnostics_channel').channel('worker_threads.main.registry'); | ||
|
|
||
| const messageTypes = { | ||
| REGISTER_MAIN_THREAD_PORT: 'registerMainThreadPort', | ||
| UNREGISTER_MAIN_THREAD_PORT: 'unregisterMainThreadPort', | ||
|
|
@@ -72,12 +75,20 @@ function handleMessageFromThread(message) { | |
|
|
||
| // Never block the thread on this port | ||
| port.unref(); | ||
|
|
||
| if (registryChannel.hasSubscribers) { | ||
| registryChannel.publish({ threadIds: ArrayFrom(threadsPorts.keys()) }); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: I haven't checked the convention for other things, but I suspect we should be using |
||
| } | ||
| } | ||
|
|
||
| break; | ||
| case messageTypes.UNREGISTER_MAIN_THREAD_PORT: | ||
| threadsPorts.get(message.threadId).close(); | ||
| threadsPorts.delete(message.threadId); | ||
|
|
||
| if (registryChannel.hasSubscribers) { | ||
| registryChannel.publish({ threadIds: ArrayFrom(threadsPorts.keys()) }); | ||
| } | ||
| break; | ||
| case messageTypes.SEND_MESSAGE_TO_WORKER: | ||
| { | ||
|
|
||
81 changes: 81 additions & 0 deletions
81
test/parallel/test-diagnostics-channel-worker-threads-registry.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| 'use strict'; | ||
| const common = require('../common'); | ||
| const assert = require('assert'); | ||
| const { once } = require('events'); | ||
| const dc = require('diagnostics_channel'); | ||
| const { Worker, isMainThread, parentPort, workerData } = require('worker_threads'); | ||
|
|
||
| const channelName = 'worker_threads.main.registry'; | ||
|
|
||
| if (isMainThread) { | ||
| // Expect one snapshot for each registration and removal in the worker tree. | ||
| const snapshots = []; | ||
| const childRegistered = Promise.withResolvers(); | ||
| const childRemoved = Promise.withResolvers(); | ||
|
|
||
| dc.subscribe(channelName, common.mustCall((message) => { | ||
| assert.deepStrictEqual(Object.keys(message), ['threadIds']); | ||
| snapshots.push(message.threadIds); | ||
|
|
||
| if (snapshots.length === 2) { | ||
| childRegistered.resolve(); | ||
| } | ||
| if (snapshots.length === 3) { | ||
| childRemoved.resolve(); | ||
| } | ||
| }, 4)); | ||
|
|
||
| async function test() { | ||
| const worker = new Worker(__filename); | ||
| const threadId = worker.threadId; | ||
|
|
||
| // The child ID and its registry update arrive on independent channels. | ||
| const [[childId]] = await Promise.all([ | ||
| once(worker, 'message'), | ||
| once(worker, 'online'), | ||
| childRegistered.promise, | ||
| ]); | ||
|
|
||
| assert.deepStrictEqual(snapshots, [[threadId], [threadId, childId]]); | ||
|
|
||
| // Remove the nested worker first, keeping its parent alive for the update. | ||
| worker.postMessage('stop'); | ||
| await childRemoved.promise; | ||
|
|
||
| assert.deepStrictEqual(snapshots, [[threadId], [threadId, childId], [threadId]]); | ||
|
|
||
| // Let the parent exit naturally, then check that earlier snapshots are intact. | ||
| const exited = once(worker, 'exit'); | ||
| worker.postMessage('finish'); | ||
| const [code] = await exited; | ||
|
|
||
| assert.strictEqual(code, 0); | ||
| assert.deepStrictEqual(snapshots, [[threadId], [threadId, childId], [threadId], []]); | ||
| } | ||
|
|
||
| test().then(common.mustCall()); | ||
| } else { | ||
| // Neither the parent worker nor its child should publish this channel locally. | ||
| dc.subscribe(channelName, common.mustNotCall()); | ||
|
|
||
| if (workerData === 'child') { | ||
| // Keep the child alive until its parent explicitly terminates it. | ||
| parentPort.on('message', common.mustNotCall()); | ||
| } else { | ||
| async function run() { | ||
| const worker = new Worker(__filename, { workerData: 'child' }); | ||
| await once(worker, 'online'); | ||
| parentPort.postMessage(worker.threadId); | ||
|
|
||
| // The main thread requests termination after observing both registrations. | ||
| await once(parentPort, 'message'); | ||
| assert.strictEqual(await worker.terminate(), 1); | ||
|
|
||
| // Wait until the main thread observes the child's removal before exiting. | ||
| await once(parentPort, 'message'); | ||
| parentPort.close(); | ||
| } | ||
|
|
||
| run().then(common.mustCall()); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The name's connection with "messaging port" here is a bit unclear and confusing. Specifically, unless you know how the implementation works, "main registry" and "messaging port" are not obviously connected.