X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Ffixed.ts;h=4a8cb4f1eeeafeb59adf1e30c5d678328cb19b70;hb=ecde6ea8c439bbdd9dc2ca118731b5006a1a9884;hp=a58dfb6f5f66c3bec010f98bf06e37ae28613b4c;hpb=78cea37e264d5ca527bc42eb056f3b9579a2b2c4;p=poolifier.git diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts index a58dfb6f..4a8cb4f1 100644 --- a/src/pools/cluster/fixed.ts +++ b/src/pools/cluster/fixed.ts @@ -1,38 +1,20 @@ -import type { ClusterSettings, Worker } from 'cluster' -import cluster from 'cluster' -import type { MessageValue } from '../../utility-types' -import { AbstractPool } from '../abstract-pool' -import type { PoolOptions } from '../pool' -import { PoolType } from '../pool-internal' +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 { - /** - * 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 - /** - * Cluster settings. - * - * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings - */ - settings?: ClusterSettings -} +export type ClusterPoolOptions = PoolOptions /** * 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. This can only be serializable data. - * @template Response Type 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 */ @@ -43,16 +25,17 @@ export class FixedClusterPool< /** * 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 = {} + opts: ClusterPoolOptions = {}, + maximumNumberOfWorkers?: number ) { - super(numberOfWorkers, filePath, opts) + super(numberOfWorkers, filePath, opts, maximumNumberOfWorkers) } /** @inheritDoc */ @@ -66,42 +49,69 @@ export class FixedClusterPool< } /** @inheritDoc */ - public destroyWorker (worker: Worker): void { - this.sendToWorker(worker, { kill: 1 }) - worker.kill() + protected sendToWorker ( + workerNodeKey: number, + message: MessageValue + ): void { + this.workerNodes[workerNodeKey]?.worker.send({ + ...message, + workerId: this.getWorkerInfo(workerNodeKey)?.id + } satisfies MessageValue) + } + + /** @inheritDoc */ + protected sendStartupMessageToWorker (workerNodeKey: number): void { + this.sendToWorker(workerNodeKey, { + ready: false + }) + } + + /** @inheritDoc */ + protected registerWorkerMessageListener( + workerNodeKey: number, + listener: (message: MessageValue) => void + ): void { + this.workerNodes[workerNodeKey].worker.on('message', listener) } /** @inheritDoc */ - protected sendToWorker (worker: Worker, message: MessageValue): void { - worker.send(message) + protected registerOnceWorkerMessageListener( + workerNodeKey: number, + listener: (message: MessageValue) => void + ): void { + this.workerNodes[workerNodeKey].worker.once('message', listener) } /** @inheritDoc */ - public registerWorkerMessageListener( - worker: Worker, + protected deregisterWorkerMessageListener( + workerNodeKey: number, listener: (message: MessageValue) => void ): void { - worker.on('message', listener) + this.workerNodes[workerNodeKey].worker.off('message', listener) + } + + /** @inheritDoc */ + protected shallCreateDynamicWorker (): boolean { + return false } /** @inheritDoc */ - protected createWorker (): Worker { - return cluster.fork(this.opts.env) + protected checkAndEmitDynamicWorkerCreationEvents (): void { + /* noop */ } /** @inheritDoc */ - protected afterWorkerSetup (worker: Worker): void { - // Listen to worker messages. - this.registerWorkerMessageListener(worker, super.workerListener()) + protected get type (): PoolType { + return PoolTypes.fixed } /** @inheritDoc */ - public get type (): PoolType { - return PoolType.FIXED + protected get worker (): WorkerType { + return WorkerTypes.cluster } /** @inheritDoc */ - public get busy (): boolean { - return this.internalGetBusyStatus() + protected get busy (): boolean { + return this.internalBusy() } }