src/pools/cluster/dynamic.ts

   1 import type { Worker } from 'cluster'
   2 import type { JSONValue, MessageValue } from '../../utility-types'
   3 import type { ClusterPoolOptions } from './fixed'
   4 import { FixedClusterPool } from './fixed'
   5
   6 /**
   7  * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
   8  *
   9  * This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
  10  * 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`.
  11  *
  12  * @template Data Type of data sent to the worker.
  13  * @template Response Type of response of execution.
  14  *
  15  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  16  * @since 2.0.0
  17  */
  18 export class DynamicClusterPool<
  19   Data extends JSONValue = JSONValue,
  20   Response extends JSONValue = JSONValue
  21 > extends FixedClusterPool<Data, Response> {
  22   /**
  23    * Constructs a new poolifier dynamic cluster pool.
  24    *
  25    * @param min Minimum number of workers which are always active.
  26    * @param max Maximum number of workers that can be created by this pool.
  27    * @param filename Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
  28    * @param opts Options for this fixed cluster pool. Default: `{ maxTasks: 1000 }`
  29    */
  30   public constructor (
  31     min: number,
  32     public readonly max: number,
  33     filename: string,
  34     opts: ClusterPoolOptions = { maxTasks: 1000 }
  35   ) {
  36     super(min, filename, opts)
  37   }
  38
  39   /**
  40    * Choose a worker for the next task.
  41    *
  42    * It will first check for and return an idle worker.
  43    * If all workers are busy, then it will try to create a new one up to the `max` worker count.
  44    * 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.
  45    *
  46    * @returns Cluster worker.
  47    */
  48   protected chooseWorker (): Worker {
  49     let worker: Worker | undefined
  50     for (const entry of this.tasks) {
  51       if (entry[1] === 0) {
  52         worker = entry[0]
  53         break
  54       }
  55     }
  56
  57     if (worker) {
  58       // A worker is free, use it
  59       return worker
  60     } else {
  61       if (this.workers.length === this.max) {
  62         this.emitter.emit('FullPool')
  63         return super.chooseWorker()
  64       }
  65       // All workers are busy, create a new worker
  66       const worker = this.internalNewWorker()
  67       worker.on('message', (message: MessageValue<Data>) => {
  68         if (message.kill) {
  69           this.sendToWorker(worker, { kill: 1 })
  70           void this.destroyWorker(worker)
  71           this.removeWorker(worker)
  72         }
  73       })
  74       return worker
  75     }
  76   }
  77 }