refactor: encapsulate worker node handling logic into its own class
[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 */
14a2e530 63 protected destroyWorker (worker: Worker): void {
cefac5ba 64 this.sendToWorker(worker, { kill: 1 })
5b59d53e
JB
65 worker.on('disconnect', () => {
66 worker.kill()
67 })
68 worker.disconnect()
4ade5f1f
S
69 }
70
afc003b2 71 /** @inheritDoc */
c97c7edb
S
72 protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
73 worker.send(message)
4ade5f1f
S
74 }
75
afc003b2 76 /** @inheritDoc */
280c2a77 77 protected createWorker (): Worker {
7e0d447f 78 return cluster.fork(this.opts.env)
4ade5f1f
S
79 }
80
afc003b2 81 /** @inheritDoc */
8881ae32 82 protected get type (): PoolType {
6b27d407 83 return PoolTypes.fixed
7c0ba920
JB
84 }
85
184855e6
JB
86 /** @inheritDoc */
87 protected get worker (): WorkerType {
88 return WorkerTypes.cluster
89 }
90
08f3f44c 91 /** @inheritDoc */
6b27d407
JB
92 protected get minSize (): number {
93 return this.numberOfWorkers
94 }
95
96 /** @inheritDoc */
97 protected get maxSize (): number {
08f3f44c
JB
98 return this.numberOfWorkers
99 }
100
afc003b2 101 /** @inheritDoc */
c319c66b 102 protected get busy (): boolean {
c2ade475 103 return this.internalBusy()
7c0ba920 104 }
4ade5f1f 105}