chore: v3.0.5
[poolifier.git] / src / worker / cluster-worker.ts
CommitLineData
6677a3d3 1import cluster, { type Worker } from 'node:cluster'
b6b32453 2import type { MessageValue } from '../utility-types'
c97c7edb 3import { AbstractWorker } from './abstract-worker'
325f50bc 4import type { WorkerOptions } from './worker-options'
82ea6492 5import type { TaskFunction, TaskFunctions } from './task-functions'
325f50bc
S
6
7/**
729c563d 8 * A cluster worker used by a poolifier `ClusterPool`.
325f50bc 9 *
729c563d
S
10 * When this worker is inactive for more than the given `maxInactiveTime`,
11 * it will send a termination request to its main worker.
12 *
13 * If you use a `DynamicClusterPool` the extra workers that were created will be terminated,
14 * but the minimum number of workers will be guaranteed.
15 *
e102732c
JB
16 * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
17 * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
325f50bc
S
18 * @author [Christopher Quadflieg](https://github.com/Shinigami92)
19 * @since 2.0.0
20 */
d3c8a1a8 21export class ClusterWorker<
deb85c12
JB
22 Data = unknown,
23 Response = unknown
6677a3d3 24> extends AbstractWorker<Worker, Data, Response> {
729c563d
S
25 /**
26 * Constructs a new poolifier cluster worker.
27 *
a86b6df1 28 * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked.
38e795c1 29 * @param opts - Options for the worker.
729c563d 30 */
d4aeae5a 31 public constructor (
82ea6492 32 taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
d4aeae5a
JB
33 opts: WorkerOptions = {}
34 ) {
7e0d447f 35 super(
b5604034 36 'poolifier:cluster-worker',
7e0d447f 37 cluster.isPrimary,
6677a3d3 38 cluster.worker as Worker,
85aeb3f3 39 taskFunctions,
7e0d447f
JB
40 opts
41 )
85aeb3f3
JB
42 }
43
44 /** @inheritDoc */
45 protected handleReadyMessage (message: MessageValue<Data>): void {
f05ed93c
JB
46 if (message.workerId === this.id && message.ready === false) {
47 try {
9d2d0da1 48 this.getMainWorker().on('message', this.messageListener.bind(this))
a5d15204
JB
49 this.sendToMainWorker({
50 ready: true,
895b5341 51 taskFunctionNames: this.listTaskFunctionNames()
a5d15204 52 })
f05ed93c 53 } catch {
a5d15204
JB
54 this.sendToMainWorker({
55 ready: false,
895b5341 56 taskFunctionNames: this.listTaskFunctionNames()
a5d15204 57 })
f05ed93c 58 }
85aeb3f3 59 }
f59e1027
JB
60 }
61
62 /** @inheritDoc */
63 protected get id (): number {
64 return this.getMainWorker().id
325f50bc
S
65 }
66
afc003b2 67 /** @inheritDoc */
c97c7edb 68 protected sendToMainWorker (message: MessageValue<Response>): void {
895b5341 69 this.getMainWorker().send({ ...message, workerId: this.id })
325f50bc 70 }
325f50bc 71}