X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Ffixed.ts;h=c7c95c4b3dad537b39dfd44d37481178035fcb4c;hb=8735b4e51c0cfabc9612d57417834d42042cab4e;hp=b2724426a02111108b33debcaa3c116fe9e2b0c5;hpb=b8818d59f9e410ce2e3b0103b8372b3fa1badf8f;p=poolifier.git diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts index b2724426..c7c95c4b 100644 --- a/src/pools/cluster/fixed.ts +++ b/src/pools/cluster/fixed.ts @@ -1,7 +1,8 @@ -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. @@ -12,81 +13,111 @@ export interface ClusterPoolOptions extends PoolOptions { * * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env */ - // eslint-disable-next-line @typescript-eslint/no-explicit-any - env?: any + env?: Record + /** + * 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 Data Type of data sent to the worker. - * @template Response Type of response of execution. - * + * @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 { /** * 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. Default: `{ maxTasks: 1000 }` + * @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 = { maxTasks: 1000 } + protected readonly opts: ClusterPoolOptions = {} ) { 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 } - protected destroyWorker (worker: Worker): void { - worker.kill() + /** @inheritDoc */ + protected async destroyWorkerNode (workerNodeKey: number): Promise { + this.flushTasksQueue(workerNodeKey) + // FIXME: wait for tasks to be finished + const worker = this.workerNodes[workerNodeKey].worker + const waitWorkerExit = new Promise((resolve) => { + worker.on('exit', () => { + resolve() + }) + }) + worker.on('disconnect', () => { + worker.kill() + }) + await this.sendKillMessageToWorker(workerNodeKey, worker.id) + worker.disconnect() + await waitWorkerExit } - protected sendToWorker (worker: Worker, message: MessageValue): void { - worker.send(message) + /** @inheritDoc */ + protected sendToWorker ( + workerNodeKey: number, + message: MessageValue + ): void { + this.workerNodes[workerNodeKey].worker.send(message) } - protected registerWorkerMessageListener ( - worker: Worker, - listener: (message: MessageValue) => void - ): void { - worker.on('message', listener) + /** @inheritDoc */ + protected sendStartupMessageToWorker (workerNodeKey: number): void { + this.sendToWorker(workerNodeKey, { + ready: false, + workerId: this.workerNodes[workerNodeKey].worker.id + }) } - protected unregisterWorkerMessageListener ( - worker: Worker, + /** @inheritDoc */ + protected registerWorkerMessageListener( + workerNodeKey: number, listener: (message: MessageValue) => void ): void { - worker.removeListener('message', listener) + this.workerNodes[workerNodeKey].worker.on('message', listener) } + /** @inheritDoc */ protected createWorker (): Worker { - return fork(this.opts.env) + return cluster.fork(this.opts.env) + } + + /** @inheritDoc */ + protected get type (): PoolType { + return PoolTypes.fixed + } + + /** @inheritDoc */ + protected get worker (): WorkerType { + return WorkerTypes.cluster } - protected afterWorkerSetup (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() } }