-import cluster, { Worker } from 'cluster'
+import cluster, { type ClusterSettings, type Worker } from 'node:cluster'
import type { MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
import { AbstractPool } from '../abstract-pool'
-import { PoolType } from '../pool-internal'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
+import { type WorkerType, WorkerTypes } from '../worker'
/**
* Options for a poolifier cluster pool.
*
* @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
*/
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- env?: any
+ env?: Record<string, unknown>
+ /**
+ * Cluster settings.
+ *
+ * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
+ */
+ settings?: ClusterSettings
}
/**
* A cluster pool with a fixed number of workers.
*
- * It is possible to perform tasks in sync or asynchronous mode as you prefer.
- *
- * This pool selects the workers in a round robin fashion.
- *
- * @template DataType of data sent to the worker. This can only be serializable data.
- * @template ResponseType of response of execution. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
* @author [Christopher Quadflieg](https://github.com/Shinigami92)
* @since 2.0.0
*/
/**
* Constructs a new poolifier fixed cluster pool.
*
- * @param numberOfWorkers Number of workers for this pool.
- * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
- * @param [opts={}] Options for this fixed cluster pool.
+ * @param numberOfWorkers - Number of workers for this pool.
+ * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
+ * @param opts - Options for this fixed cluster pool.
*/
public constructor (
numberOfWorkers: number,
filePath: string,
- public readonly opts: ClusterPoolOptions = {}
+ protected readonly opts: ClusterPoolOptions = {}
) {
super(numberOfWorkers, filePath, opts)
}
- /** @inheritdoc */
+ /** @inheritDoc */
protected setupHook (): void {
- cluster.setupPrimary({
- exec: this.filePath
- })
+ cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath })
}
- /** @inheritdoc */
+ /** @inheritDoc */
protected isMain (): boolean {
return cluster.isPrimary
}
- /** @inheritdoc */
- public destroyWorker (worker: Worker): void {
- this.sendToWorker(worker, { kill: 1 })
- worker.kill()
+ /** @inheritDoc */
+ protected async destroyWorkerNode (workerNodeKey: number): Promise<void> {
+ this.flagWorkerNodeAsNotReady(workerNodeKey)
+ this.flushTasksQueue(workerNodeKey)
+ // FIXME: wait for tasks to be finished
+ const workerNode = this.workerNodes[workerNodeKey]
+ const worker = workerNode.worker
+ const waitWorkerExit = new Promise<void>(resolve => {
+ worker.once('exit', () => {
+ resolve()
+ })
+ })
+ worker.once('disconnect', () => {
+ worker.kill()
+ })
+ await this.sendKillMessageToWorker(workerNodeKey)
+ worker.disconnect()
+ await waitWorkerExit
}
- /** @inheritdoc */
- protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
- worker.send(message)
+ /** @inheritDoc */
+ protected sendToWorker (
+ workerNodeKey: number,
+ message: MessageValue<Data>
+ ): void {
+ this.workerNodes[workerNodeKey].worker.send({
+ ...message,
+ workerId: this.getWorkerInfo(workerNodeKey).id as number
+ })
+ }
+
+ /** @inheritDoc */
+ protected sendStartupMessageToWorker (workerNodeKey: number): void {
+ this.sendToWorker(workerNodeKey, {
+ ready: false
+ })
+ }
+
+ /** @inheritDoc */
+ protected registerWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
+ ): void {
+ this.workerNodes[workerNodeKey].worker.on('message', listener)
+ }
+
+ /** @inheritDoc */
+ protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
+ ): void {
+ this.workerNodes[workerNodeKey].worker.once('message', listener)
}
- /** @inheritdoc */
- public registerWorkerMessageListener<Message extends Data | Response> (
- worker: Worker,
+ /** @inheritDoc */
+ protected deregisterWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
listener: (message: MessageValue<Message>) => void
): void {
- worker.on('message', listener)
+ this.workerNodes[workerNodeKey].worker.off('message', listener)
}
- /** @inheritdoc */
+ /** @inheritDoc */
protected createWorker (): Worker {
return cluster.fork(this.opts.env)
}
- /** @inheritdoc */
- protected afterWorkerSetup (worker: Worker): void {
- // Listen worker messages.
- this.registerWorkerMessageListener(worker, super.workerListener())
+ /** @inheritDoc */
+ protected get type (): PoolType {
+ return PoolTypes.fixed
}
- /** @inheritdoc */
- public get type (): PoolType {
- return PoolType.FIXED
+ /** @inheritDoc */
+ protected get worker (): WorkerType {
+ return WorkerTypes.cluster
}
- /** @inheritdoc */
- public get busy (): boolean {
- return this.internalGetBusyStatus()
+ /** @inheritDoc */
+ protected get busy (): boolean {
+ return this.internalBusy()
}
}