X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Fdynamic.ts;h=b84a80ce2b31b7fc807bceae6b29e1a7eb2af5bd;hb=d2097c13847f906e289a80638248343948b7f18a;hp=d4bf30f39b3a58f7572064ca9627f434a6a77308;hpb=325f50bc1777ea44abc9736ce9d780ec0c8f90e2;p=poolifier.git diff --git a/src/pools/cluster/dynamic.ts b/src/pools/cluster/dynamic.ts index d4bf30f3..b84a80ce 100644 --- a/src/pools/cluster/dynamic.ts +++ b/src/pools/cluster/dynamic.ts @@ -1,75 +1,51 @@ -import { EventEmitter } from 'events' -import type { FixedClusterPoolOptions, WorkerWithMessageChannel } from './fixed' +import { PoolType } from '../pool-internal' +import type { ClusterPoolOptions } from './fixed' import { FixedClusterPool } from './fixed' -class MyEmitter extends EventEmitter {} - -export type DynamicClusterPoolOptions = FixedClusterPoolOptions - /** - * 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 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 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, + min: number, public readonly max: number, - public readonly filename: string, - public readonly opts: DynamicClusterPoolOptions = { maxTasks: 1000 } + filePath: string, + opts: ClusterPoolOptions = {} ) { - super(min, filename, opts) + super(min, filePath, opts) + } - this.emitter = new MyEmitter() + /** @inheritDoc */ + public get type (): PoolType { + return PoolType.DYNAMIC } - protected chooseWorker (): WorkerWithMessageChannel { - let worker: WorkerWithMessageChannel | undefined - for (const entry of this.tasks) { - if (entry[1] === 0) { - worker = entry[0] - break - } - } + /** @inheritDoc */ + public get full (): boolean { + return this.workers.length === this.max + } - 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 */ + public get busy (): boolean { + return this.full && this.findFreeWorkerKey() === -1 } }