build(deps-dev): bump @types/node from 20.8.4 to 20.8.5
[poolifier.git] / src / worker / cluster-worker.ts
1 import cluster, { type Worker } from 'node:cluster'
2 import type { MessageValue } from '../utility-types'
3 import { AbstractWorker } from './abstract-worker'
4 import type { WorkerOptions } from './worker-options'
5 import type { TaskFunction, TaskFunctions } from './task-functions'
6
7 /**
8 * A cluster worker used by a poolifier `ClusterPool`.
9 *
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 *
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.
18 * @author [Christopher Quadflieg](https://github.com/Shinigami92)
19 * @since 2.0.0
20 */
21 export class ClusterWorker<
22 Data = unknown,
23 Response = unknown
24 > extends AbstractWorker<Worker, Data, Response> {
25 /**
26 * Constructs a new poolifier cluster worker.
27 *
28 * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked.
29 * @param opts - Options for the worker.
30 */
31 public constructor (
32 taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
33 opts: WorkerOptions = {}
34 ) {
35 super(
36 'poolifier:cluster-worker',
37 cluster.isPrimary,
38 cluster.worker as Worker,
39 taskFunctions,
40 opts
41 )
42 }
43
44 /** @inheritDoc */
45 protected handleReadyMessage (message: MessageValue<Data>): void {
46 if (message.workerId === this.id && message.ready === false) {
47 try {
48 this.getMainWorker().on('message', this.messageListener.bind(this))
49 this.sendToMainWorker({
50 ready: true,
51 taskFunctionNames: this.listTaskFunctionNames()
52 })
53 } catch {
54 this.sendToMainWorker({
55 ready: false,
56 taskFunctionNames: this.listTaskFunctionNames()
57 })
58 }
59 }
60 }
61
62 /** @inheritDoc */
63 protected get id (): number {
64 return this.getMainWorker().id
65 }
66
67 /** @inheritDoc */
68 protected sendToMainWorker (message: MessageValue<Response>): void {
69 this.getMainWorker().send({ ...message, workerId: this.id })
70 }
71 }