src/pools/abstract-pool.ts

   1 import crypto from 'node:crypto'
   2 import type { MessageValue, PromiseResponseWrapper } from '../utility-types'
   3 import { EMPTY_FUNCTION } from '../utils'
   4 import { KillBehaviors, isKillBehavior } from '../worker/worker-options'
   5 import type { PoolOptions } from './pool'
   6 import { PoolEmitter } from './pool'
   7 import type { IPoolInternal, TasksUsage, WorkerType } from './pool-internal'
   8 import { PoolType } from './pool-internal'
   9 import type { IPoolWorker } from './pool-worker'
  10 import {
  11   WorkerChoiceStrategies,
  12   type WorkerChoiceStrategy
  13 } from './selection-strategies/selection-strategies-types'
  14 import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context'
  15
  16 /**
  17  * Base class that implements some shared logic for all poolifier pools.
  18  *
  19  * @typeParam Worker - Type of worker which manages this pool.
  20  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  21  * @typeParam Response - Type of response of execution. This can only be serializable data.
  22  */
  23 export abstract class AbstractPool<
  24   Worker extends IPoolWorker,
  25   Data = unknown,
  26   Response = unknown
  27 > implements IPoolInternal<Worker, Data, Response> {
  28   /** @inheritDoc */
  29   public readonly workers: Array<WorkerType<Worker>> = []
  30
  31   /** @inheritDoc */
  32   public readonly emitter?: PoolEmitter
  33
  34   /**
  35    * The promise response map.
  36    *
  37    * - `key`: The message id of each submitted task.
  38    * - `value`: An object that contains the worker, the promise resolve and reject callbacks.
  39    *
  40    * When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.
  41    */
  42   protected promiseResponseMap: Map<
  43   string,
  44   PromiseResponseWrapper<Worker, Response>
  45   > = new Map<string, PromiseResponseWrapper<Worker, Response>>()
  46
  47   /**
  48    * Worker choice strategy context referencing a worker choice algorithm implementation.
  49    *
  50    * Default to a round robin algorithm.
  51    */
  52   protected workerChoiceStrategyContext: WorkerChoiceStrategyContext<
  53   Worker,
  54   Data,
  55   Response
  56   >
  57
  58   /**
  59    * Constructs a new poolifier pool.
  60    *
  61    * @param numberOfWorkers - Number of workers that this pool should manage.
  62    * @param filePath - Path to the worker-file.
  63    * @param opts - Options for the pool.
  64    */
  65   public constructor (
  66     public readonly numberOfWorkers: number,
  67     public readonly filePath: string,
  68     public readonly opts: PoolOptions<Worker>
  69   ) {
  70     if (!this.isMain()) {
  71       throw new Error('Cannot start a pool from a worker!')
  72     }
  73     this.checkNumberOfWorkers(this.numberOfWorkers)
  74     this.checkFilePath(this.filePath)
  75     this.checkPoolOptions(this.opts)
  76
  77     this.chooseWorker.bind(this)
  78     this.internalExecute.bind(this)
  79     this.checkAndEmitFull.bind(this)
  80     this.checkAndEmitBusy.bind(this)
  81     this.sendToWorker.bind(this)
  82
  83     this.setupHook()
  84
  85     for (let i = 1; i <= this.numberOfWorkers; i++) {
  86       this.createAndSetupWorker()
  87     }
  88
  89     if (this.opts.enableEvents === true) {
  90       this.emitter = new PoolEmitter()
  91     }
  92     this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext<
  93     Worker,
  94     Data,
  95     Response
  96     >(
  97       this,
  98       () => {
  99         const createdWorker = this.createAndSetupWorker()
 100         this.registerWorkerMessageListener(createdWorker, message => {
 101           if (
 102             isKillBehavior(KillBehaviors.HARD, message.kill) ||
 103             this.getWorkerTasksUsage(createdWorker)?.running === 0
 104           ) {
 105             // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime)
 106             void this.destroyWorker(createdWorker)
 107           }
 108         })
 109         return this.getWorkerKey(createdWorker)
 110       },
 111       this.opts.workerChoiceStrategy
 112     )
 113   }
 114
 115   private checkFilePath (filePath: string): void {
 116     if (
 117       filePath == null ||
 118       (typeof filePath === 'string' && filePath.trim().length === 0)
 119     ) {
 120       throw new Error('Please specify a file with a worker implementation')
 121     }
 122   }
 123
 124   private checkNumberOfWorkers (numberOfWorkers: number): void {
 125     if (numberOfWorkers == null) {
 126       throw new Error(
 127         'Cannot instantiate a pool without specifying the number of workers'
 128       )
 129     } else if (!Number.isSafeInteger(numberOfWorkers)) {
 130       throw new TypeError(
 131         'Cannot instantiate a pool with a non integer number of workers'
 132       )
 133     } else if (numberOfWorkers < 0) {
 134       throw new RangeError(
 135         'Cannot instantiate a pool with a negative number of workers'
 136       )
 137     } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) {
 138       throw new Error('Cannot instantiate a fixed pool with no worker')
 139     }
 140   }
 141
 142   private checkPoolOptions (opts: PoolOptions<Worker>): void {
 143     this.opts.workerChoiceStrategy =
 144       opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
 145     if (
 146       !Object.values(WorkerChoiceStrategies).includes(
 147         this.opts.workerChoiceStrategy
 148       )
 149     ) {
 150       throw new Error(
 151         `Invalid worker choice strategy '${this.opts.workerChoiceStrategy}'`
 152       )
 153     }
 154     this.opts.enableEvents = opts.enableEvents ?? true
 155   }
 156
 157   /** @inheritDoc */
 158   public abstract get type (): PoolType
 159
 160   /**
 161    * Number of tasks concurrently running in the pool.
 162    */
 163   private get numberOfRunningTasks (): number {
 164     return this.promiseResponseMap.size
 165   }
 166
 167   /**
 168    * Gets the given worker key.
 169    *
 170    * @param worker - The worker.
 171    * @returns The worker key if the worker is found in the pool, `-1` otherwise.
 172    */
 173   private getWorkerKey (worker: Worker): number {
 174     return this.workers.findIndex(workerItem => workerItem.worker === worker)
 175   }
 176
 177   /** @inheritDoc */
 178   public setWorkerChoiceStrategy (
 179     workerChoiceStrategy: WorkerChoiceStrategy
 180   ): void {
 181     this.opts.workerChoiceStrategy = workerChoiceStrategy
 182     for (const [index, workerItem] of this.workers.entries()) {
 183       this.setWorker(index, workerItem.worker, {
 184         run: 0,
 185         running: 0,
 186         runTime: 0,
 187         avgRunTime: 0,
 188         error: 0
 189       })
 190     }
 191     this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
 192       workerChoiceStrategy
 193     )
 194   }
 195
 196   /** @inheritDoc */
 197   public abstract get full (): boolean
 198
 199   /** @inheritDoc */
 200   public abstract get busy (): boolean
 201
 202   protected internalBusy (): boolean {
 203     return (
 204       this.numberOfRunningTasks >= this.numberOfWorkers &&
 205       this.findFreeWorkerKey() === -1
 206     )
 207   }
 208
 209   /** @inheritDoc */
 210   public findFreeWorkerKey (): number {
 211     return this.workers.findIndex(workerItem => {
 212       return workerItem.tasksUsage.running === 0
 213     })
 214   }
 215
 216   /** @inheritDoc */
 217   public async execute (data: Data): Promise<Response> {
 218     const [workerKey, worker] = this.chooseWorker()
 219     const messageId = crypto.randomUUID()
 220     const res = this.internalExecute(workerKey, worker, messageId)
 221     this.checkAndEmitFull()
 222     this.checkAndEmitBusy()
 223     this.sendToWorker(worker, {
 224       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
 225       data: data ?? ({} as Data),
 226       id: messageId
 227     })
 228     // eslint-disable-next-line @typescript-eslint/return-await
 229     return res
 230   }
 231
 232   /** @inheritDoc */
 233   public async destroy (): Promise<void> {
 234     await Promise.all(
 235       this.workers.map(async workerItem => {
 236         await this.destroyWorker(workerItem.worker)
 237       })
 238     )
 239   }
 240
 241   /**
 242    * Shutdowns given worker in the pool.
 243    *
 244    * @param worker - A worker within `workers`.
 245    */
 246   protected abstract destroyWorker (worker: Worker): void | Promise<void>
 247
 248   /**
 249    * Setup hook that can be overridden by a Poolifier pool implementation
 250    * to run code before workers are created in the abstract constructor.
 251    *
 252    * @virtual
 253    */
 254   protected setupHook (): void {
 255     // Can be overridden
 256   }
 257
 258   /**
 259    * Should return whether the worker is the main worker or not.
 260    */
 261   protected abstract isMain (): boolean
 262
 263   /**
 264    * Hook executed before the worker task promise resolution.
 265    * Can be overridden.
 266    *
 267    * @param workerKey - The worker key.
 268    */
 269   protected beforePromiseResponseHook (workerKey: number): void {
 270     ++this.workers[workerKey].tasksUsage.running
 271   }
 272
 273   /**
 274    * Hook executed after the worker task promise resolution.
 275    * Can be overridden.
 276    *
 277    * @param worker - The worker.
 278    * @param message - The received message.
 279    */
 280   protected afterPromiseResponseHook (
 281     worker: Worker,
 282     message: MessageValue<Response>
 283   ): void {
 284     const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage
 285     --workerTasksUsage.running
 286     ++workerTasksUsage.run
 287     if (message.error != null) {
 288       ++workerTasksUsage.error
 289     }
 290     if (this.workerChoiceStrategyContext.getRequiredStatistics().runTime) {
 291       workerTasksUsage.runTime += message.taskRunTime ?? 0
 292       if (
 293         this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime &&
 294         workerTasksUsage.run !== 0
 295       ) {
 296         workerTasksUsage.avgRunTime =
 297           workerTasksUsage.runTime / workerTasksUsage.run
 298       }
 299     }
 300   }
 301
 302   /**
 303    * Chooses a worker for the next task.
 304    *
 305    * The default uses a round robin algorithm to distribute the load.
 306    *
 307    * @returns [worker key, worker].
 308    */
 309   protected chooseWorker (): [number, Worker] {
 310     const workerKey = this.workerChoiceStrategyContext.execute()
 311     return [workerKey, this.workers[workerKey].worker]
 312   }
 313
 314   /**
 315    * Sends a message to the given worker.
 316    *
 317    * @param worker - The worker which should receive the message.
 318    * @param message - The message.
 319    */
 320   protected abstract sendToWorker (
 321     worker: Worker,
 322     message: MessageValue<Data>
 323   ): void
 324
 325   /**
 326    * Registers a listener callback on a given worker.
 327    *
 328    * @param worker - The worker which should register a listener.
 329    * @param listener - The message listener callback.
 330    */
 331   protected abstract registerWorkerMessageListener<
 332     Message extends Data | Response
 333   >(worker: Worker, listener: (message: MessageValue<Message>) => void): void
 334
 335   /**
 336    * Returns a newly created worker.
 337    */
 338   protected abstract createWorker (): Worker
 339
 340   /**
 341    * Function that can be hooked up when a worker has been newly created and moved to the workers registry.
 342    *
 343    * Can be used to update the `maxListeners` or binding the `main-worker`\<-\>`worker` connection if not bind by default.
 344    *
 345    * @param worker - The newly created worker.
 346    * @virtual
 347    */
 348   protected abstract afterWorkerSetup (worker: Worker): void
 349
 350   /**
 351    * Creates a new worker for this pool and sets it up completely.
 352    *
 353    * @returns New, completely set up worker.
 354    */
 355   protected createAndSetupWorker (): Worker {
 356     const worker = this.createWorker()
 357
 358     worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION)
 359     worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION)
 360     worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION)
 361     worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION)
 362     worker.once('exit', () => {
 363       this.removeWorker(worker)
 364     })
 365
 366     this.pushWorker(worker, {
 367       run: 0,
 368       running: 0,
 369       runTime: 0,
 370       avgRunTime: 0,
 371       error: 0
 372     })
 373
 374     this.afterWorkerSetup(worker)
 375
 376     return worker
 377   }
 378
 379   /**
 380    * This function is the listener registered for each worker.
 381    *
 382    * @returns The listener function to execute when a message is received from a worker.
 383    */
 384   protected workerListener (): (message: MessageValue<Response>) => void {
 385     return message => {
 386       if (message.id != null) {
 387         const promiseResponse = this.promiseResponseMap.get(message.id)
 388         if (promiseResponse != null) {
 389           if (message.error != null) {
 390             promiseResponse.reject(message.error)
 391           } else {
 392             promiseResponse.resolve(message.data as Response)
 393           }
 394           this.afterPromiseResponseHook(promiseResponse.worker, message)
 395           this.promiseResponseMap.delete(message.id)
 396         }
 397       }
 398     }
 399   }
 400
 401   private async internalExecute (
 402     workerKey: number,
 403     worker: Worker,
 404     messageId: string
 405   ): Promise<Response> {
 406     this.beforePromiseResponseHook(workerKey)
 407     return await new Promise<Response>((resolve, reject) => {
 408       this.promiseResponseMap.set(messageId, { resolve, reject, worker })
 409     })
 410   }
 411
 412   private checkAndEmitBusy (): void {
 413     if (this.opts.enableEvents === true && this.busy) {
 414       this.emitter?.emit('busy')
 415     }
 416   }
 417
 418   private checkAndEmitFull (): void {
 419     if (
 420       this.type === PoolType.DYNAMIC &&
 421       this.opts.enableEvents === true &&
 422       this.full
 423     ) {
 424       this.emitter?.emit('full')
 425     }
 426   }
 427
 428   /**
 429    * Gets the given worker tasks usage in the pool.
 430    *
 431    * @param worker - The worker.
 432    * @returns The worker tasks usage.
 433    */
 434   private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined {
 435     const workerKey = this.getWorkerKey(worker)
 436     if (workerKey !== -1) {
 437       return this.workers[workerKey].tasksUsage
 438     }
 439     throw new Error('Worker could not be found in the pool')
 440   }
 441
 442   /**
 443    * Pushes the given worker in the pool.
 444    *
 445    * @param worker - The worker.
 446    * @param tasksUsage - The worker tasks usage.
 447    */
 448   private pushWorker (worker: Worker, tasksUsage: TasksUsage): void {
 449     this.workers.push({
 450       worker,
 451       tasksUsage
 452     })
 453   }
 454
 455   /**
 456    * Sets the given worker in the pool.
 457    *
 458    * @param workerKey - The worker key.
 459    * @param worker - The worker.
 460    * @param tasksUsage - The worker tasks usage.
 461    */
 462   private setWorker (
 463     workerKey: number,
 464     worker: Worker,
 465     tasksUsage: TasksUsage
 466   ): void {
 467     this.workers[workerKey] = {
 468       worker,
 469       tasksUsage
 470     }
 471   }
 472
 473   /**
 474    * Removes the given worker from the pool.
 475    *
 476    * @param worker - The worker that will be removed.
 477    */
 478   protected removeWorker (worker: Worker): void {
 479     const workerKey = this.getWorkerKey(worker)
 480     this.workers.splice(workerKey, 1)
 481     this.workerChoiceStrategyContext.remove(workerKey)
 482   }
 483 }