X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Ffixed.ts;h=81e7b3b7d08b4bb5624d993a15f7850d9d3bf2ba;hb=c319c66bad0611acf6087950a1f8a20f8124167b;hp=b2724426a02111108b33debcaa3c116fe9e2b0c5;hpb=b8818d59f9e410ce2e3b0103b8372b3fa1badf8f;p=poolifier.git diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts index b2724426..81e7b3b7 100644 --- a/src/pools/cluster/fixed.ts +++ b/src/pools/cluster/fixed.ts @@ -1,7 +1,9 @@ -import { fork, isMaster, setupMaster, Worker } from 'cluster' -import type { JSONValue, MessageValue } from '../../utility-types' -import type { PoolOptions } from '../abstract-pool' +import type { ClusterSettings, Worker } from 'node:cluster' +import cluster from 'node:cluster' +import type { MessageValue } from '../../utility-types' import { AbstractPool } from '../abstract-pool' +import type { PoolOptions } from '../pool' +import { PoolType } from '../pool' /** * Options for a poolifier cluster pool. @@ -14,6 +16,12 @@ export interface ClusterPoolOptions extends PoolOptions { */ // 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 } /** @@ -23,70 +31,82 @@ export interface ClusterPoolOptions extends PoolOptions { * * 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 serializable data. + * @typeParam Response - Type of response of execution. This can only be serializable 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 } + public 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 { + /** @inheritDoc */ + public destroyWorker (worker: Worker): void { + this.sendToWorker(worker, { kill: 1 }) worker.kill() } + /** @inheritDoc */ protected sendToWorker (worker: Worker, message: MessageValue): void { worker.send(message) } - protected registerWorkerMessageListener ( + /** @inheritDoc */ + protected registerWorkerMessageListener( worker: Worker, listener: (message: MessageValue) => void ): void { worker.on('message', listener) } - protected unregisterWorkerMessageListener ( - worker: Worker, - listener: (message: MessageValue) => void - ): void { - worker.removeListener('message', listener) - } - + /** @inheritDoc */ protected createWorker (): Worker { - return fork(this.opts.env) + return cluster.fork(this.opts.env) } + /** @inheritDoc */ 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) + // Listen to worker messages. + this.registerWorkerMessageListener(worker, super.workerListener()) + } + + /** @inheritDoc */ + public get type (): PoolType { + return PoolType.FIXED + } + + /** @inheritDoc */ + protected get full (): boolean { + return this.workerNodes.length === this.numberOfWorkers + } + + /** @inheritDoc */ + protected get busy (): boolean { + return this.internalBusy() } }