-import cluster, { type ClusterSettings, type Worker } from 'node:cluster'
-import type { MessageValue } from '../../utility-types'
-import { AbstractPool } from '../abstract-pool'
-import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
-import { type WorkerType, WorkerTypes } from '../worker'
+import cluster, { type Worker } from 'node:cluster'
+
+import type { MessageValue } from '../../utility-types.js'
+import { AbstractPool } from '../abstract-pool.js'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool.js'
+import { type WorkerType, WorkerTypes } from '../worker.js'
/**
* Options for a poolifier cluster pool.
*/
-export interface ClusterPoolOptions extends PoolOptions<Worker> {
- /**
- * Key/value pairs to add to worker process environment.
- *
- * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
- */
- env?: Record<string, unknown>
- /**
- * Cluster settings.
- *
- * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
- */
- settings?: ClusterSettings
-}
+export type ClusterPoolOptions = PoolOptions<Worker>
/**
* A cluster pool with a fixed number of workers.
public constructor (
numberOfWorkers: number,
filePath: string,
- protected readonly opts: ClusterPoolOptions = {}
+ opts: ClusterPoolOptions = {},
+ maximumNumberOfWorkers?: number
) {
- super(numberOfWorkers, filePath, opts)
+ super(numberOfWorkers, filePath, opts, maximumNumberOfWorkers)
}
/** @inheritDoc */
return cluster.isPrimary
}
- /** @inheritDoc */
- protected async destroyWorkerNode (workerNodeKey: number): Promise<void> {
- this.flushTasksQueue(workerNodeKey)
- // FIXME: wait for tasks to be finished
- const worker = this.workerNodes[workerNodeKey].worker
- const workerExitPromise = new Promise<void>(resolve => {
- worker.on('exit', () => {
- resolve()
- })
- })
- worker.on('disconnect', () => {
- worker.kill()
- })
- this.sendToWorker(workerNodeKey, { kill: true, workerId: worker.id })
- worker.disconnect()
- await workerExitPromise
- }
-
/** @inheritDoc */
protected sendToWorker (
workerNodeKey: number,
message: MessageValue<Data>
): void {
- this.workerNodes[workerNodeKey].worker.send(message)
+ this.workerNodes[workerNodeKey]?.worker.send({
+ ...message,
+ workerId: this.getWorkerInfo(workerNodeKey)?.id
+ } satisfies MessageValue<Data>)
}
/** @inheritDoc */
protected sendStartupMessageToWorker (workerNodeKey: number): void {
this.sendToWorker(workerNodeKey, {
- ready: false,
- workerId: this.workerNodes[workerNodeKey].worker.id
+ ready: false
})
}
}
/** @inheritDoc */
- protected createWorker (): Worker {
- return cluster.fork(this.opts.env)
+ protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
+ ): void {
+ this.workerNodes[workerNodeKey].worker.once('message', listener)
+ }
+
+ /** @inheritDoc */
+ protected deregisterWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
+ ): void {
+ this.workerNodes[workerNodeKey].worker.off('message', listener)
}
/** @inheritDoc */
- protected get type (): PoolType {
- return PoolTypes.fixed
+ protected shallCreateDynamicWorker (): boolean {
+ return false
}
/** @inheritDoc */
- protected get worker (): WorkerType {
- return WorkerTypes.cluster
+ protected checkAndEmitDynamicWorkerCreationEvents (): void {
+ /* noop */
}
/** @inheritDoc */
- protected get minSize (): number {
- return this.numberOfWorkers
+ protected get type (): PoolType {
+ return PoolTypes.fixed
}
/** @inheritDoc */
- protected get maxSize (): number {
- return this.numberOfWorkers
+ protected get worker (): WorkerType {
+ return WorkerTypes.cluster
}
/** @inheritDoc */