-import { fork, isMaster, setupMaster, Worker } from 'cluster'
-import type { JSONValue, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
+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'
+/**
+ * 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
*/
- // 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 static number of workers, is possible to execute tasks in sync or async mode as you prefer.
- *
- * This pool will select the worker in a round robin fashion.
+ * A cluster pool with a fixed number of workers.
*
+ * @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
*/
export class FixedClusterPool<
- Data extends JSONValue = JSONValue,
- Response extends JSONValue = JSONValue
+ Data = unknown,
+ Response = unknown
> extends AbstractPool<Worker, Data, Response> {
/**
- * @param numWorkers Number of workers for this pool.
- * @param filePath A file path with implementation of `ClusterWorker` class, relative path is fine.
- * @param opts An object with possible options for example `errorHandler`, `onlineHandler`. Default: `{ maxTasks: 1000 }`
+ * 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.
*/
public constructor (
- numWorkers: number,
+ numberOfWorkers: number,
filePath: string,
- public readonly opts: ClusterPoolOptions = { maxTasks: 1000 }
+ protected readonly opts: ClusterPoolOptions = {}
) {
- super(numWorkers, filePath, opts)
+ super(numberOfWorkers, filePath, opts)
}
+ /** @inheritDoc */
protected setupHook (): void {
- setupMaster({
- exec: this.filePath
- })
+ cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath })
}
+ /** @inheritDoc */
protected isMain (): boolean {
- return isMaster
+ return cluster.isPrimary
+ }
+
+ /** @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
}
- protected destroyWorker (worker: Worker): void {
- worker.kill()
- // FIXME: The tests are currently failing, so these must be changed first
+ /** @inheritDoc */
+ protected sendToWorker (
+ workerNodeKey: number,
+ message: MessageValue<Data>
+ ): void {
+ this.workerNodes[workerNodeKey].worker.send({
+ ...message,
+ workerId: this.getWorkerInfo(workerNodeKey).id as number
+ })
}
- protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
- worker.send(message)
+ /** @inheritDoc */
+ protected sendStartupMessageToWorker (workerNodeKey: number): void {
+ this.sendToWorker(workerNodeKey, {
+ ready: false
+ })
}
- protected registerWorkerMessageListener (
- port: Worker,
- listener: (message: MessageValue<Response>) => void
+ /** @inheritDoc */
+ protected registerWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
): void {
- port.on('message', listener)
+ this.workerNodes[workerNodeKey].worker.on('message', listener)
}
- protected unregisterWorkerMessageListener (
- port: Worker,
- listener: (message: MessageValue<Response>) => void
+ /** @inheritDoc */
+ protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
): void {
- port.removeListener('message', listener)
+ 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 createWorker (): Worker {
+ return cluster.fork(this.opts.env)
+ }
+
+ /** @inheritDoc */
+ protected get type (): PoolType {
+ return PoolTypes.fixed
}
- protected newWorker (): Worker {
- return fork(this.opts.env)
+ /** @inheritDoc */
+ protected get worker (): WorkerType {
+ return WorkerTypes.cluster
}
- protected afterNewWorkerPushed (worker: Worker): void {
- // we will attach a listener for every task,
- // when task is completed the listener will be removed but to avoid warnings we are increasing the max listeners size
- worker.setMaxListeners(this.opts.maxTasks ?? 1000)
+ /** @inheritDoc */
+ protected get busy (): boolean {
+ return this.internalBusy()
}
}