Merge pull request #885 from poolifier/dependabot/npm_and_yarn/examples/typescript...
[poolifier.git] / src / pools / cluster / fixed.ts
CommitLineData
059438ff 1import cluster, { type ClusterSettings, type Worker } from 'node:cluster'
deb85c12 2import type { MessageValue } from '../../utility-types'
c97c7edb 3import { AbstractPool } from '../abstract-pool'
4b628b48
JB
4import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
5import { type WorkerType, WorkerTypes } from '../worker'
4ade5f1f 6
729c563d
S
7/**
8 * Options for a poolifier cluster pool.
9 */
c97c7edb 10export interface ClusterPoolOptions extends PoolOptions<Worker> {
325f50bc
S
11 /**
12 * Key/value pairs to add to worker process environment.
13 *
14 * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
15 */
82f36766 16 env?: Record<string, unknown>
1a76932b
JB
17 /**
18 * Cluster settings.
19 *
20 * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
21 */
22 settings?: ClusterSettings
4ade5f1f
S
23}
24
25/**
729c563d
S
26 * A cluster pool with a fixed number of workers.
27 *
e102732c
JB
28 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
29 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
325f50bc
S
30 * @author [Christopher Quadflieg](https://github.com/Shinigami92)
31 * @since 2.0.0
4ade5f1f 32 */
d3c8a1a8 33export class FixedClusterPool<
deb85c12
JB
34 Data = unknown,
35 Response = unknown
d3c8a1a8 36> extends AbstractPool<Worker, Data, Response> {
4ade5f1f 37 /**
729c563d
S
38 * Constructs a new poolifier fixed cluster pool.
39 *
38e795c1
JB
40 * @param numberOfWorkers - Number of workers for this pool.
41 * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
42 * @param opts - Options for this fixed cluster pool.
4ade5f1f
S
43 */
44 public constructor (
5c5a1fb7 45 numberOfWorkers: number,
c97c7edb 46 filePath: string,
dea903a8 47 protected readonly opts: ClusterPoolOptions = {}
4ade5f1f 48 ) {
5c5a1fb7 49 super(numberOfWorkers, filePath, opts)
c97c7edb 50 }
4ade5f1f 51
afc003b2 52 /** @inheritDoc */
c97c7edb 53 protected setupHook (): void {
1a76932b 54 cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath })
c97c7edb 55 }
325f50bc 56
afc003b2 57 /** @inheritDoc */
c97c7edb 58 protected isMain (): boolean {
7e0d447f 59 return cluster.isPrimary
4ade5f1f
S
60 }
61
afc003b2 62 /** @inheritDoc */
81c02522
JB
63 protected async destroyWorkerNode (workerNodeKey: number): Promise<void> {
64 this.flushTasksQueue(workerNodeKey)
65 // FIXME: wait for tasks to be finished
aa9eede8 66 const worker = this.workerNodes[workerNodeKey].worker
8ebe6c30 67 const waitWorkerExit = new Promise<void>((resolve) => {
81c02522
JB
68 worker.on('exit', () => {
69 resolve()
70 })
71 })
5b59d53e
JB
72 worker.on('disconnect', () => {
73 worker.kill()
74 })
1e3214b6 75 await this.sendKillMessageToWorker(workerNodeKey, worker.id)
5b59d53e 76 worker.disconnect()
c2301b8e 77 await waitWorkerExit
4ade5f1f
S
78 }
79
afc003b2 80 /** @inheritDoc */
aa9eede8
JB
81 protected sendToWorker (
82 workerNodeKey: number,
83 message: MessageValue<Data>
84 ): void {
85 this.workerNodes[workerNodeKey].worker.send(message)
4ade5f1f
S
86 }
87
85aeb3f3 88 /** @inheritDoc */
aa9eede8
JB
89 protected sendStartupMessageToWorker (workerNodeKey: number): void {
90 this.sendToWorker(workerNodeKey, {
85aeb3f3 91 ready: false,
aa9eede8 92 workerId: this.workerNodes[workerNodeKey].worker.id
85aeb3f3
JB
93 })
94 }
95
96 /** @inheritDoc */
97 protected registerWorkerMessageListener<Message extends Data | Response>(
aa9eede8 98 workerNodeKey: number,
85aeb3f3
JB
99 listener: (message: MessageValue<Message>) => void
100 ): void {
aa9eede8 101 this.workerNodes[workerNodeKey].worker.on('message', listener)
85aeb3f3
JB
102 }
103
afc003b2 104 /** @inheritDoc */
280c2a77 105 protected createWorker (): Worker {
7e0d447f 106 return cluster.fork(this.opts.env)
4ade5f1f
S
107 }
108
afc003b2 109 /** @inheritDoc */
8881ae32 110 protected get type (): PoolType {
6b27d407 111 return PoolTypes.fixed
7c0ba920
JB
112 }
113
184855e6
JB
114 /** @inheritDoc */
115 protected get worker (): WorkerType {
116 return WorkerTypes.cluster
117 }
118
afc003b2 119 /** @inheritDoc */
c319c66b 120 protected get busy (): boolean {
c2ade475 121 return this.internalBusy()
7c0ba920 122 }
4ade5f1f 123}