src/pools/abstract-pool.ts

   1 import crypto from 'node:crypto'
   2 import type {
   3   MessageValue,
   4   PromiseWorkerResponseWrapper
   5 } from '../utility-types'
   6 import { EMPTY_FUNCTION } from '../utils'
   7 import { KillBehaviors, isKillBehavior } from '../worker/worker-options'
   8 import type { PoolOptions } from './pool'
   9 import { PoolEmitter } from './pool'
  10 import type { IPoolInternal, TasksUsage, WorkerType } from './pool-internal'
  11 import { PoolType } from './pool-internal'
  12 import type { IPoolWorker } from './pool-worker'
  13 import {
  14   WorkerChoiceStrategies,
  15   type WorkerChoiceStrategy
  16 } from './selection-strategies/selection-strategies-types'
  17 import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context'
  18
  19 /**
  20  * Base class that implements some shared logic for all poolifier pools.
  21  *
  22  * @typeParam Worker - Type of worker which manages this pool.
  23  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  24  * @typeParam Response - Type of response of execution. This can only be serializable data.
  25  */
  26 export abstract class AbstractPool<
  27   Worker extends IPoolWorker,
  28   Data = unknown,
  29   Response = unknown
  30 > implements IPoolInternal<Worker, Data, Response> {
  31   /** {@inheritDoc} */
  32   public readonly workers: Map<number, WorkerType<Worker>> = new Map<
  33   number,
  34   WorkerType<Worker>
  35   >()
  36
  37   /** {@inheritDoc} */
  38   public readonly emitter?: PoolEmitter
  39
  40   /**
  41    * Id of the next worker.
  42    */
  43   protected nextWorkerId: number = 0
  44
  45   /**
  46    * The promise map.
  47    *
  48    * - `key`: This is the message id of each submitted task.
  49    * - `value`: An object that contains the worker, the resolve function and the reject function.
  50    *
  51    * When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.
  52    */
  53   protected promiseMap: Map<
  54   string,
  55   PromiseWorkerResponseWrapper<Worker, Response>
  56   > = new Map<string, PromiseWorkerResponseWrapper<Worker, Response>>()
  57
  58   /**
  59    * Worker choice strategy instance implementing the worker choice algorithm.
  60    *
  61    * Default to a strategy implementing a round robin algorithm.
  62    */
  63   protected workerChoiceStrategyContext: WorkerChoiceStrategyContext<
  64   Worker,
  65   Data,
  66   Response
  67   >
  68
  69   /**
  70    * Constructs a new poolifier pool.
  71    *
  72    * @param numberOfWorkers - Number of workers that this pool should manage.
  73    * @param filePath - Path to the worker-file.
  74    * @param opts - Options for the pool.
  75    */
  76   public constructor (
  77     public readonly numberOfWorkers: number,
  78     public readonly filePath: string,
  79     public readonly opts: PoolOptions<Worker>
  80   ) {
  81     if (!this.isMain()) {
  82       throw new Error('Cannot start a pool from a worker!')
  83     }
  84     this.checkNumberOfWorkers(this.numberOfWorkers)
  85     this.checkFilePath(this.filePath)
  86     this.checkPoolOptions(this.opts)
  87     this.setupHook()
  88
  89     for (let i = 1; i <= this.numberOfWorkers; i++) {
  90       this.createAndSetupWorker()
  91     }
  92
  93     if (this.opts.enableEvents === true) {
  94       this.emitter = new PoolEmitter()
  95     }
  96     this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext(
  97       this,
  98       () => {
  99         const workerCreated = this.createAndSetupWorker()
 100         this.registerWorkerMessageListener(workerCreated, message => {
 101           if (
 102             isKillBehavior(KillBehaviors.HARD, message.kill) ||
 103             this.getWorkerRunningTasks(workerCreated) === 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(workerCreated)
 107           }
 108         })
 109         return workerCreated
 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     this.opts.enableEvents = opts.enableEvents ?? true
 146   }
 147
 148   /** {@inheritDoc} */
 149   public abstract get type (): PoolType
 150
 151   /** {@inheritDoc} */
 152   public get numberOfRunningTasks (): number {
 153     return this.promiseMap.size
 154   }
 155
 156   /**
 157    * Gets the given worker key.
 158    *
 159    * @param worker - The worker.
 160    * @returns The worker key.
 161    */
 162   private getWorkerKey (worker: Worker): number | undefined {
 163     return [...this.workers].find(([, value]) => value.worker === worker)?.[0]
 164   }
 165
 166   /** {@inheritDoc} */
 167   public getWorkerRunningTasks (worker: Worker): number | undefined {
 168     return this.workers.get(this.getWorkerKey(worker) as number)?.tasksUsage
 169       ?.running
 170   }
 171
 172   /** {@inheritDoc} */
 173   public getWorkerAverageTasksRunTime (worker: Worker): number | undefined {
 174     return this.workers.get(this.getWorkerKey(worker) as number)?.tasksUsage
 175       ?.avgRunTime
 176   }
 177
 178   /** {@inheritDoc} */
 179   public setWorkerChoiceStrategy (
 180     workerChoiceStrategy: WorkerChoiceStrategy
 181   ): void {
 182     this.opts.workerChoiceStrategy = workerChoiceStrategy
 183     for (const [key, value] of this.workers) {
 184       this.setWorker(key, value.worker, {
 185         run: 0,
 186         running: 0,
 187         runTime: 0,
 188         avgRunTime: 0
 189       })
 190     }
 191     this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
 192       workerChoiceStrategy
 193     )
 194   }
 195
 196   /** {@inheritDoc} */
 197   public abstract get busy (): boolean
 198
 199   protected internalGetBusyStatus (): boolean {
 200     return (
 201       this.numberOfRunningTasks >= this.numberOfWorkers &&
 202       this.findFreeWorker() === false
 203     )
 204   }
 205
 206   /** {@inheritDoc} */
 207   public findFreeWorker (): Worker | false {
 208     for (const value of this.workers.values()) {
 209       if (value.tasksUsage.running === 0) {
 210         // A worker is free, return the matching worker
 211         return value.worker
 212       }
 213     }
 214     return false
 215   }
 216
 217   /** {@inheritDoc} */
 218   public async execute (data: Data): Promise<Response> {
 219     const worker = this.chooseWorker()
 220     const messageId = crypto.randomUUID()
 221     const res = this.internalExecute(worker, messageId)
 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 ([, value]) => {
 236         await this.destroyWorker(value.worker)
 237       })
 238     )
 239   }
 240
 241   /**
 242    * Shutdowns given worker.
 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   protected setupHook (): void {
 253     // Can be overridden
 254   }
 255
 256   /**
 257    * Should return whether the worker is the main worker or not.
 258    */
 259   protected abstract isMain (): boolean
 260
 261   /**
 262    * Hook executed before the worker task promise resolution.
 263    * Can be overridden.
 264    *
 265    * @param worker - The worker.
 266    */
 267   protected beforePromiseWorkerResponseHook (worker: Worker): void {
 268     this.increaseWorkerRunningTasks(worker)
 269   }
 270
 271   /**
 272    * Hook executed after the worker task promise resolution.
 273    * Can be overridden.
 274    *
 275    * @param message - The received message.
 276    * @param promise - The Promise response.
 277    */
 278   protected afterPromiseWorkerResponseHook (
 279     message: MessageValue<Response>,
 280     promise: PromiseWorkerResponseWrapper<Worker, Response>
 281   ): void {
 282     this.decreaseWorkerRunningTasks(promise.worker)
 283     this.stepWorkerRunTasks(promise.worker, 1)
 284     this.updateWorkerTasksRunTime(promise.worker, message.taskRunTime)
 285   }
 286
 287   /**
 288    * Removes the given worker from the pool.
 289    *
 290    * @param worker - The worker that will be removed.
 291    */
 292   protected removeWorker (worker: Worker): void {
 293     this.workers.delete(this.getWorkerKey(worker) as number)
 294     --this.nextWorkerId
 295   }
 296
 297   /**
 298    * Chooses a worker for the next task.
 299    *
 300    * The default implementation uses a round robin algorithm to distribute the load.
 301    *
 302    * @returns Worker.
 303    */
 304   protected chooseWorker (): Worker {
 305     return this.workerChoiceStrategyContext.execute()
 306   }
 307
 308   /**
 309    * Sends a message to the given worker.
 310    *
 311    * @param worker - The worker which should receive the message.
 312    * @param message - The message.
 313    */
 314   protected abstract sendToWorker (
 315     worker: Worker,
 316     message: MessageValue<Data>
 317   ): void
 318
 319   /**
 320    * Registers a listener callback on a given worker.
 321    *
 322    * @param worker - The worker which should register a listener.
 323    * @param listener - The message listener callback.
 324    */
 325   protected abstract registerWorkerMessageListener<
 326     Message extends Data | Response
 327   >(worker: Worker, listener: (message: MessageValue<Message>) => void): void
 328
 329   /**
 330    * Returns a newly created worker.
 331    */
 332   protected abstract createWorker (): Worker
 333
 334   /**
 335    * Function that can be hooked up when a worker has been newly created and moved to the workers registry.
 336    *
 337    * Can be used to update the `maxListeners` or binding the `main-worker`\<-\>`worker` connection if not bind by default.
 338    *
 339    * @param worker - The newly created worker.
 340    */
 341   protected abstract afterWorkerSetup (worker: Worker): void
 342
 343   /**
 344    * Creates a new worker for this pool and sets it up completely.
 345    *
 346    * @returns New, completely set up worker.
 347    */
 348   protected createAndSetupWorker (): Worker {
 349     const worker = this.createWorker()
 350
 351     worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION)
 352     worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION)
 353     worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION)
 354     worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION)
 355     worker.once('exit', () => {
 356       this.removeWorker(worker)
 357     })
 358
 359     this.setWorker(this.nextWorkerId, worker, {
 360       run: 0,
 361       running: 0,
 362       runTime: 0,
 363       avgRunTime: 0
 364     })
 365     ++this.nextWorkerId
 366
 367     this.afterWorkerSetup(worker)
 368
 369     return worker
 370   }
 371
 372   /**
 373    * This function is the listener registered for each worker.
 374    *
 375    * @returns The listener function to execute when a message is received from a worker.
 376    */
 377   protected workerListener (): (message: MessageValue<Response>) => void {
 378     return message => {
 379       if (message.id !== undefined) {
 380         const promise = this.promiseMap.get(message.id)
 381         if (promise !== undefined) {
 382           if (message.error != null) {
 383             promise.reject(message.error)
 384           } else {
 385             promise.resolve(message.data as Response)
 386           }
 387           this.afterPromiseWorkerResponseHook(message, promise)
 388           this.promiseMap.delete(message.id)
 389         }
 390       }
 391     }
 392   }
 393
 394   private async internalExecute (
 395     worker: Worker,
 396     messageId: string
 397   ): Promise<Response> {
 398     this.beforePromiseWorkerResponseHook(worker)
 399     return await new Promise<Response>((resolve, reject) => {
 400       this.promiseMap.set(messageId, { resolve, reject, worker })
 401     })
 402   }
 403
 404   private checkAndEmitBusy (): void {
 405     if (this.opts.enableEvents === true && this.busy) {
 406       this.emitter?.emit('busy')
 407     }
 408   }
 409
 410   /**
 411    * Increases the number of tasks that the given worker has applied.
 412    *
 413    * @param worker - Worker which running tasks is increased.
 414    */
 415   private increaseWorkerRunningTasks (worker: Worker): void {
 416     this.stepWorkerRunningTasks(worker, 1)
 417   }
 418
 419   /**
 420    * Decreases the number of tasks that the given worker has applied.
 421    *
 422    * @param worker - Worker which running tasks is decreased.
 423    */
 424   private decreaseWorkerRunningTasks (worker: Worker): void {
 425     this.stepWorkerRunningTasks(worker, -1)
 426   }
 427
 428   /**
 429    * Gets tasks usage of the given worker.
 430    *
 431    * @param worker - Worker which tasks usage is returned.
 432    */
 433   private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined {
 434     if (this.checkWorker(worker)) {
 435       const workerKey = this.getWorkerKey(worker) as number
 436       const workerEntry = this.workers.get(workerKey) as WorkerType<Worker>
 437       return workerEntry.tasksUsage
 438     }
 439   }
 440
 441   /**
 442    * Steps the number of tasks that the given worker has applied.
 443    *
 444    * @param worker - Worker which running tasks are stepped.
 445    * @param step - Number of running tasks step.
 446    */
 447   private stepWorkerRunningTasks (worker: Worker, step: number): void {
 448     // prettier-ignore
 449     (this.getWorkerTasksUsage(worker) as TasksUsage).running += step
 450   }
 451
 452   /**
 453    * Steps the number of tasks that the given worker has run.
 454    *
 455    * @param worker - Worker which has run tasks.
 456    * @param step - Number of run tasks step.
 457    */
 458   private stepWorkerRunTasks (worker: Worker, step: number): void {
 459     // prettier-ignore
 460     (this.getWorkerTasksUsage(worker) as TasksUsage).run += step
 461   }
 462
 463   /**
 464    * Updates tasks runtime for the given worker.
 465    *
 466    * @param worker - Worker which run the task.
 467    * @param taskRunTime - Worker task runtime.
 468    */
 469   private updateWorkerTasksRunTime (
 470     worker: Worker,
 471     taskRunTime: number | undefined
 472   ): void {
 473     if (
 474       this.workerChoiceStrategyContext.getWorkerChoiceStrategy()
 475         .requiredStatistics.runTime
 476     ) {
 477       const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage
 478       workerTasksUsage.runTime += taskRunTime ?? 0
 479       if (workerTasksUsage.run !== 0) {
 480         workerTasksUsage.avgRunTime =
 481           workerTasksUsage.runTime / workerTasksUsage.run
 482       }
 483     }
 484   }
 485
 486   /**
 487    * Sets the given worker.
 488    *
 489    * @param workerKey - The worker key.
 490    * @param worker - The worker.
 491    * @param tasksUsage - The worker tasks usage.
 492    */
 493   private setWorker (
 494     workerKey: number,
 495     worker: Worker,
 496     tasksUsage: TasksUsage
 497   ): void {
 498     this.workers.set(workerKey, {
 499       worker,
 500       tasksUsage
 501     })
 502   }
 503
 504   /**
 505    * Checks if the given worker is registered in the pool.
 506    *
 507    * @param worker - Worker to check.
 508    * @returns `true` if the worker is registered in the pool.
 509    */
 510   private checkWorker (worker: Worker): boolean {
 511     if (this.getWorkerKey(worker) == null) {
 512       throw new Error('Worker could not be found in the pool')
 513     }
 514     return true
 515   }
 516 }