X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Fdynamic.ts;h=08ebc75c76a66ba5ca311c2e269988d741ad5aff;hb=d087803425ae5b3577028029dd1d2dae67d7f63b;hp=d4bf30f39b3a58f7572064ca9627f434a6a77308;hpb=325f50bc1777ea44abc9736ce9d780ec0c8f90e2;p=poolifier.git diff --git a/src/pools/cluster/dynamic.ts b/src/pools/cluster/dynamic.ts index d4bf30f3..08ebc75c 100644 --- a/src/pools/cluster/dynamic.ts +++ b/src/pools/cluster/dynamic.ts @@ -1,75 +1,62 @@ -import { EventEmitter } from 'events' -import type { FixedClusterPoolOptions, WorkerWithMessageChannel } from './fixed' -import { FixedClusterPool } from './fixed' - -class MyEmitter extends EventEmitter {} - -export type DynamicClusterPoolOptions = FixedClusterPoolOptions +import { checkDynamicPoolSize } from '../utils' +import { PoolEvents, type PoolType, PoolTypes } from '../pool' +import { type ClusterPoolOptions, FixedClusterPool } from './fixed' /** - * A cluster pool with a min/max number of workers, is possible to execute tasks in sync or async mode as you prefer. + * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers. * - * This cluster pool will create new workers when the other ones are busy, until the max number of workers, - * when the max number of workers is reached, an event will be emitted, if you want to listen this event use the emitter method. + * 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 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< - // eslint-disable-next-line @typescript-eslint/no-explicit-any - Data = any, - // eslint-disable-next-line @typescript-eslint/no-explicit-any - Response = any + Data = unknown, + Response = unknown > extends FixedClusterPool { - public readonly emitter: MyEmitter - /** - * @param min Min number of workers that will be always active - * @param max Max number of workers that will be active - * @param filename 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 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 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 ( - public readonly min: number, - public readonly max: number, - public readonly filename: string, - public readonly opts: DynamicClusterPoolOptions = { maxTasks: 1000 } + min: number, + max: number, + filePath: string, + opts: ClusterPoolOptions = {} ) { - super(min, filename, opts) + super(min, filePath, opts, max) + checkDynamicPoolSize( + this.minimumNumberOfWorkers, + this.maximumNumberOfWorkers as number + ) + } - this.emitter = new MyEmitter() + /** @inheritDoc */ + protected shallCreateDynamicWorker (): boolean { + return !this.full && this.internalBusy() } - protected chooseWorker (): WorkerWithMessageChannel { - let worker: WorkerWithMessageChannel | undefined - for (const entry of this.tasks) { - if (entry[1] === 0) { - worker = entry[0] - break - } + /** @inheritDoc */ + protected checkAndEmitDynamicWorkerCreationEvents (): void { + if (this.full) { + this.emitter?.emit(PoolEvents.full, this.info) } + } - 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.newWorker() - worker.on('message', (message: { kill?: number }) => { - if (message.kill) { - worker.send({ kill: 1 }) - worker.kill() - // clean workers from data structures - const workerIndex = this.workers.indexOf(worker) - this.workers.splice(workerIndex, 1) - this.tasks.delete(worker) - } - }) - return worker - } + /** @inheritDoc */ + protected get type (): PoolType { + return PoolTypes.dynamic + } + + /** @inheritDoc */ + protected get busy (): boolean { + return this.full && this.internalBusy() } }