src/pools/cluster/dynamic.ts

   1 import { PoolEvents, type PoolType, PoolTypes } from '../pool.js'
   2 import { checkDynamicPoolSize } from '../utils.js'
   3 import { type ClusterPoolOptions, FixedClusterPool } from './fixed.js'
   4
   5 /**
   6  * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
   7  *
   8  * This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
   9  * 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`.
  10  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  11  * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  12  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  13  * @since 2.0.0
  14  */
  15 export class DynamicClusterPool<
  16   Data = unknown,
  17   Response = unknown
  18 > extends FixedClusterPool<Data, Response> {
  19   /**
  20    * Constructs a new poolifier dynamic cluster pool.
  21    * @param min - Minimum number of workers which are always active.
  22    * @param max - Maximum number of workers that can be created by this pool.
  23    * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
  24    * @param opts - Options for this dynamic cluster pool.
  25    */
  26   public constructor (
  27     min: number,
  28     max: number,
  29     filePath: string,
  30     opts: ClusterPoolOptions = {}
  31   ) {
  32     super(min, filePath, opts, max)
  33     checkDynamicPoolSize(
  34       this.minimumNumberOfWorkers,
  35       this.maximumNumberOfWorkers
  36     )
  37   }
  38
  39   /** @inheritDoc */
  40   protected shallCreateDynamicWorker (): boolean {
  41     return (!this.full && this.internalBusy()) || this.empty
  42   }
  43
  44   /** @inheritDoc */
  45   protected checkAndEmitDynamicWorkerCreationEvents (): void {
  46     if (this.full) {
  47       this.emitter?.emit(PoolEvents.full, this.info)
  48     }
  49   }
  50
  51   /** @inheritDoc */
  52   protected get type (): PoolType {
  53     return PoolTypes.dynamic
  54   }
  55
  56   /** @inheritDoc */
  57   protected get busy (): boolean {
  58     return this.full && this.internalBusy()
  59   }
  60 }