X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Fdynamic.ts;h=08ebc75c76a66ba5ca311c2e269988d741ad5aff;hb=d087803425ae5b3577028029dd1d2dae67d7f63b;hp=99fa828d733e15f82363d373bb8fa593d383880f;hpb=729c563db85562dd7d0f7733b1a3e2d98467134b;p=poolifier.git diff --git a/src/pools/cluster/dynamic.ts b/src/pools/cluster/dynamic.ts index 99fa828d..08ebc75c 100644 --- a/src/pools/cluster/dynamic.ts +++ b/src/pools/cluster/dynamic.ts @@ -1,75 +1,62 @@ -import type { Worker } from 'cluster' -import type { JSONValue, MessageValue } from '../../utility-types' -import type { ClusterPoolOptions } from './fixed' -import { FixedClusterPool } from './fixed' +import { checkDynamicPoolSize } from '../utils' +import { PoolEvents, type PoolType, PoolTypes } from '../pool' +import { type ClusterPoolOptions, FixedClusterPool } from './fixed' /** * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers. * * This cluster pool creates new workers when the others are busy, up to the maximum number of workers. - * When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's `emitter`. - * - * @template Data Type of data sent to the worker. - * @template Response Type of response of execution. + * When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`. * + * @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 DynamicClusterPool< - Data extends JSONValue = JSONValue, - Response extends JSONValue = JSONValue + Data = unknown, + Response = unknown > extends FixedClusterPool { /** * Constructs a new poolifier dynamic cluster pool. * - * @param min Minimum number of workers which are always active. - * @param max Maximum number of workers that can be created by this pool. - * @param filename 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 min - Minimum number of workers which are always active. + * @param max - Maximum number of workers that can be created by this pool. + * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute. + * @param opts - Options for this dynamic cluster pool. */ public constructor ( min: number, - public readonly max: number, - filename: string, - opts: ClusterPoolOptions = { maxTasks: 1000 } + max: number, + filePath: string, + opts: ClusterPoolOptions = {} ) { - super(min, filename, opts) + super(min, filePath, opts, max) + checkDynamicPoolSize( + this.minimumNumberOfWorkers, + this.maximumNumberOfWorkers as number + ) } - /** - * Choose a worker for the next task. - * - * It will first check for and return an idle worker. - * If all workers are busy, then it will try to create a new one up to the `max` worker count. - * If the max worker count is reached, the emitter will emit a `FullPool` event and it will fall back to using a round robin algorithm to distribute the load. - */ - protected chooseWorker (): Worker { - let worker: Worker | undefined - for (const entry of this.tasks) { - if (entry[1] === 0) { - worker = entry[0] - break - } - } + /** @inheritDoc */ + protected shallCreateDynamicWorker (): boolean { + return !this.full && this.internalBusy() + } - if (worker) { - // A worker is free, use it - return worker - } else { - if (this.workers.length === this.max) { - this.emitter.emit('FullPool') - return super.chooseWorker() - } - // All workers are busy, create a new worker - const worker = this.internalNewWorker() - worker.on('message', (message: MessageValue) => { - if (message.kill) { - this.sendToWorker(worker, { kill: 1 }) - void this.destroyWorker(worker) - this.removeWorker(worker) - } - }) - return worker + /** @inheritDoc */ + protected checkAndEmitDynamicWorkerCreationEvents (): void { + if (this.full) { + this.emitter?.emit(PoolEvents.full, this.info) } } + + /** @inheritDoc */ + protected get type (): PoolType { + return PoolTypes.dynamic + } + + /** @inheritDoc */ + protected get busy (): boolean { + return this.full && this.internalBusy() + } }