src/pools/utils.ts

   1 import cluster, { Worker as ClusterWorker } from 'node:cluster'
   2 import { existsSync } from 'node:fs'
   3 import { env } from 'node:process'
   4 import {
   5   SHARE_ENV,
   6   Worker as ThreadWorker,
   7   type WorkerOptions
   8 } from 'node:worker_threads'
   9
  10 import type { MessageValue, Task } from '../utility-types.js'
  11 import { average, isPlainObject, max, median, min } from '../utils.js'
  12 import type { TasksQueueOptions } from './pool.js'
  13 import {
  14   type MeasurementStatisticsRequirements,
  15   WorkerChoiceStrategies,
  16   type WorkerChoiceStrategy
  17 } from './selection-strategies/selection-strategies-types.js'
  18 import type { WorkerChoiceStrategiesContext } from './selection-strategies/worker-choice-strategies-context.js'
  19 import {
  20   type IWorker,
  21   type IWorkerNode,
  22   type MeasurementStatistics,
  23   type WorkerNodeOptions,
  24   type WorkerType,
  25   WorkerTypes,
  26   type WorkerUsage
  27 } from './worker.js'
  28
  29 /**
  30  * Default measurement statistics requirements.
  31  */
  32 export const DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS: MeasurementStatisticsRequirements =
  33   {
  34     aggregate: false,
  35     average: false,
  36     median: false
  37   }
  38
  39 export const getDefaultTasksQueueOptions = (
  40   poolMaxSize: number
  41 ): Required<TasksQueueOptions> => {
  42   return {
  43     size: Math.pow(poolMaxSize, 2),
  44     concurrency: 1,
  45     taskStealing: true,
  46     tasksStealingOnBackPressure: false,
  47     tasksFinishedTimeout: 2000
  48   }
  49 }
  50
  51 export const checkFilePath = (filePath: string | undefined): void => {
  52   if (filePath == null) {
  53     throw new TypeError('The worker file path must be specified')
  54   }
  55   if (typeof filePath !== 'string') {
  56     throw new TypeError('The worker file path must be a string')
  57   }
  58   if (!existsSync(filePath)) {
  59     throw new Error(`Cannot find the worker file '${filePath}'`)
  60   }
  61 }
  62
  63 export const checkDynamicPoolSize = (
  64   min: number,
  65   max: number | undefined
  66 ): void => {
  67   if (max == null) {
  68     throw new TypeError(
  69       'Cannot instantiate a dynamic pool without specifying the maximum pool size'
  70     )
  71   } else if (!Number.isSafeInteger(max)) {
  72     throw new TypeError(
  73       'Cannot instantiate a dynamic pool with a non safe integer maximum pool size'
  74     )
  75   } else if (min > max) {
  76     throw new RangeError(
  77       'Cannot instantiate a dynamic pool with a maximum pool size inferior to the minimum pool size'
  78     )
  79   } else if (max === 0) {
  80     throw new RangeError(
  81       'Cannot instantiate a dynamic pool with a maximum pool size equal to zero'
  82     )
  83   } else if (min === max) {
  84     throw new RangeError(
  85       'Cannot instantiate a dynamic pool with a minimum pool size equal to the maximum pool size. Use a fixed pool instead'
  86     )
  87   }
  88 }
  89
  90 export const checkValidPriority = (priority: number | undefined): void => {
  91   if (priority != null && !Number.isSafeInteger(priority)) {
  92     throw new TypeError(`Invalid property 'priority': '${priority}'`)
  93   }
  94   if (
  95     priority != null &&
  96     Number.isSafeInteger(priority) &&
  97     (priority < -20 || priority > 19)
  98   ) {
  99     throw new RangeError("Property 'priority' must be between -20 and 19")
 100   }
 101 }
 102
 103 export const checkValidWorkerChoiceStrategy = (
 104   workerChoiceStrategy: WorkerChoiceStrategy | undefined
 105 ): void => {
 106   if (
 107     workerChoiceStrategy != null &&
 108     !Object.values(WorkerChoiceStrategies).includes(workerChoiceStrategy)
 109   ) {
 110     throw new Error(`Invalid worker choice strategy '${workerChoiceStrategy}'`)
 111   }
 112 }
 113
 114 export const checkValidTasksQueueOptions = (
 115   tasksQueueOptions: TasksQueueOptions | undefined
 116 ): void => {
 117   if (tasksQueueOptions != null && !isPlainObject(tasksQueueOptions)) {
 118     throw new TypeError('Invalid tasks queue options: must be a plain object')
 119   }
 120   if (
 121     tasksQueueOptions?.concurrency != null &&
 122     !Number.isSafeInteger(tasksQueueOptions.concurrency)
 123   ) {
 124     throw new TypeError(
 125       'Invalid worker node tasks concurrency: must be an integer'
 126     )
 127   }
 128   if (
 129     tasksQueueOptions?.concurrency != null &&
 130     tasksQueueOptions.concurrency <= 0
 131   ) {
 132     throw new RangeError(
 133       `Invalid worker node tasks concurrency: ${tasksQueueOptions.concurrency} is a negative integer or zero`
 134     )
 135   }
 136   if (
 137     tasksQueueOptions?.size != null &&
 138     !Number.isSafeInteger(tasksQueueOptions.size)
 139   ) {
 140     throw new TypeError(
 141       'Invalid worker node tasks queue size: must be an integer'
 142     )
 143   }
 144   if (tasksQueueOptions?.size != null && tasksQueueOptions.size <= 0) {
 145     throw new RangeError(
 146       `Invalid worker node tasks queue size: ${tasksQueueOptions.size} is a negative integer or zero`
 147     )
 148   }
 149 }
 150
 151 export const checkWorkerNodeArguments = (
 152   type: WorkerType | undefined,
 153   filePath: string | undefined,
 154   opts: WorkerNodeOptions | undefined
 155 ): void => {
 156   if (type == null) {
 157     throw new TypeError('Cannot construct a worker node without a worker type')
 158   }
 159   if (!Object.values(WorkerTypes).includes(type)) {
 160     throw new TypeError(
 161       `Cannot construct a worker node with an invalid worker type '${type}'`
 162     )
 163   }
 164   checkFilePath(filePath)
 165   if (opts == null) {
 166     throw new TypeError(
 167       'Cannot construct a worker node without worker node options'
 168     )
 169   }
 170   if (!isPlainObject(opts)) {
 171     throw new TypeError(
 172       'Cannot construct a worker node with invalid options: must be a plain object'
 173     )
 174   }
 175   if (opts.tasksQueueBackPressureSize == null) {
 176     throw new TypeError(
 177       'Cannot construct a worker node without a tasks queue back pressure size option'
 178     )
 179   }
 180   if (!Number.isSafeInteger(opts.tasksQueueBackPressureSize)) {
 181     throw new TypeError(
 182       'Cannot construct a worker node with a tasks queue back pressure size option that is not an integer'
 183     )
 184   }
 185   if (opts.tasksQueueBackPressureSize <= 0) {
 186     throw new RangeError(
 187       'Cannot construct a worker node with a tasks queue back pressure size option that is not a positive integer'
 188     )
 189   }
 190   if (opts.tasksQueueBucketSize == null) {
 191     throw new TypeError(
 192       'Cannot construct a worker node without a tasks queue bucket size option'
 193     )
 194   }
 195   if (!Number.isSafeInteger(opts.tasksQueueBucketSize)) {
 196     throw new TypeError(
 197       'Cannot construct a worker node with a tasks queue bucket size option that is not an integer'
 198     )
 199   }
 200   if (opts.tasksQueueBucketSize <= 0) {
 201     throw new RangeError(
 202       'Cannot construct a worker node with a tasks queue bucket size option that is not a positive integer'
 203     )
 204   }
 205 }
 206
 207 /**
 208  * Updates the given measurement statistics.
 209  *
 210  * @param measurementStatistics - The measurement statistics to update.
 211  * @param measurementRequirements - The measurement statistics requirements.
 212  * @param measurementValue - The measurement value.
 213  * @internal
 214  */
 215 const updateMeasurementStatistics = (
 216   measurementStatistics: MeasurementStatistics,
 217   measurementRequirements: MeasurementStatisticsRequirements | undefined,
 218   measurementValue: number | undefined
 219 ): void => {
 220   if (
 221     measurementRequirements != null &&
 222     measurementValue != null &&
 223     measurementRequirements.aggregate
 224   ) {
 225     measurementStatistics.aggregate =
 226       (measurementStatistics.aggregate ?? 0) + measurementValue
 227     measurementStatistics.minimum = min(
 228       measurementValue,
 229       measurementStatistics.minimum ?? Number.POSITIVE_INFINITY
 230     )
 231     measurementStatistics.maximum = max(
 232       measurementValue,
 233       measurementStatistics.maximum ?? Number.NEGATIVE_INFINITY
 234     )
 235     if (measurementRequirements.average || measurementRequirements.median) {
 236       measurementStatistics.history.put(measurementValue)
 237       if (measurementRequirements.average) {
 238         measurementStatistics.average = average(
 239           measurementStatistics.history.toArray()
 240         )
 241       } else if (measurementStatistics.average != null) {
 242         delete measurementStatistics.average
 243       }
 244       if (measurementRequirements.median) {
 245         measurementStatistics.median = median(
 246           measurementStatistics.history.toArray()
 247         )
 248       } else if (measurementStatistics.median != null) {
 249         delete measurementStatistics.median
 250       }
 251     }
 252   }
 253 }
 254 if (env.NODE_ENV === 'test') {
 255   // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 256   exports.updateMeasurementStatistics = updateMeasurementStatistics
 257 }
 258
 259 export const updateWaitTimeWorkerUsage = <
 260   Worker extends IWorker,
 261   Data = unknown,
 262   Response = unknown
 263 >(
 264     workerChoiceStrategiesContext:
 265     | WorkerChoiceStrategiesContext<Worker, Data, Response>
 266     | undefined,
 267     workerUsage: WorkerUsage,
 268     task: Task<Data>
 269   ): void => {
 270   const timestamp = performance.now()
 271   const taskWaitTime = timestamp - (task.timestamp ?? timestamp)
 272   updateMeasurementStatistics(
 273     workerUsage.waitTime,
 274     workerChoiceStrategiesContext?.getTaskStatisticsRequirements().waitTime,
 275     taskWaitTime
 276   )
 277 }
 278
 279 export const updateTaskStatisticsWorkerUsage = <Response = unknown>(
 280   workerUsage: WorkerUsage,
 281   message: MessageValue<Response>
 282 ): void => {
 283   const workerTaskStatistics = workerUsage.tasks
 284   if (
 285     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 286     workerTaskStatistics.executing != null &&
 287     workerTaskStatistics.executing > 0
 288   ) {
 289     --workerTaskStatistics.executing
 290   }
 291   if (message.workerError == null) {
 292     ++workerTaskStatistics.executed
 293   } else {
 294     ++workerTaskStatistics.failed
 295   }
 296 }
 297
 298 export const updateRunTimeWorkerUsage = <
 299   Worker extends IWorker,
 300   Data = unknown,
 301   Response = unknown
 302 >(
 303     workerChoiceStrategiesContext:
 304     | WorkerChoiceStrategiesContext<Worker, Data, Response>
 305     | undefined,
 306     workerUsage: WorkerUsage,
 307     message: MessageValue<Response>
 308   ): void => {
 309   if (message.workerError != null) {
 310     return
 311   }
 312   updateMeasurementStatistics(
 313     workerUsage.runTime,
 314     workerChoiceStrategiesContext?.getTaskStatisticsRequirements().runTime,
 315     message.taskPerformance?.runTime ?? 0
 316   )
 317 }
 318
 319 export const updateEluWorkerUsage = <
 320   Worker extends IWorker,
 321   Data = unknown,
 322   Response = unknown
 323 >(
 324     workerChoiceStrategiesContext:
 325     | WorkerChoiceStrategiesContext<Worker, Data, Response>
 326     | undefined,
 327     workerUsage: WorkerUsage,
 328     message: MessageValue<Response>
 329   ): void => {
 330   if (message.workerError != null) {
 331     return
 332   }
 333   const eluTaskStatisticsRequirements =
 334     workerChoiceStrategiesContext?.getTaskStatisticsRequirements().elu
 335   updateMeasurementStatistics(
 336     workerUsage.elu.active,
 337     eluTaskStatisticsRequirements,
 338     message.taskPerformance?.elu?.active ?? 0
 339   )
 340   updateMeasurementStatistics(
 341     workerUsage.elu.idle,
 342     eluTaskStatisticsRequirements,
 343     message.taskPerformance?.elu?.idle ?? 0
 344   )
 345   if (eluTaskStatisticsRequirements?.aggregate === true) {
 346     if (message.taskPerformance?.elu != null) {
 347       if (workerUsage.elu.utilization != null) {
 348         workerUsage.elu.utilization =
 349           (workerUsage.elu.utilization +
 350             message.taskPerformance.elu.utilization) /
 351           2
 352       } else {
 353         workerUsage.elu.utilization = message.taskPerformance.elu.utilization
 354       }
 355     }
 356   }
 357 }
 358
 359 export const createWorker = <Worker extends IWorker>(
 360   type: WorkerType,
 361   filePath: string,
 362   opts: { env?: Record<string, unknown>, workerOptions?: WorkerOptions }
 363 ): Worker => {
 364   switch (type) {
 365     case WorkerTypes.thread:
 366       return new ThreadWorker(filePath, {
 367         env: SHARE_ENV,
 368         ...opts.workerOptions
 369       }) as unknown as Worker
 370     case WorkerTypes.cluster:
 371       return cluster.fork(opts.env) as unknown as Worker
 372     default:
 373       // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
 374       throw new Error(`Unknown worker type '${type}'`)
 375   }
 376 }
 377
 378 /**
 379  * Returns the worker type of the given worker.
 380  *
 381  * @param worker - The worker to get the type of.
 382  * @returns The worker type of the given worker.
 383  * @internal
 384  */
 385 export const getWorkerType = (worker: IWorker): WorkerType | undefined => {
 386   if (worker instanceof ThreadWorker) {
 387     return WorkerTypes.thread
 388   } else if (worker instanceof ClusterWorker) {
 389     return WorkerTypes.cluster
 390   }
 391 }
 392
 393 /**
 394  * Returns the worker id of the given worker.
 395  *
 396  * @param worker - The worker to get the id of.
 397  * @returns The worker id of the given worker.
 398  * @internal
 399  */
 400 export const getWorkerId = (worker: IWorker): number | undefined => {
 401   if (worker instanceof ThreadWorker) {
 402     return worker.threadId
 403   } else if (worker instanceof ClusterWorker) {
 404     return worker.id
 405   }
 406 }
 407
 408 export const waitWorkerNodeEvents = async <
 409   Worker extends IWorker,
 410   Data = unknown
 411 >(
 412   workerNode: IWorkerNode<Worker, Data>,
 413   workerNodeEvent: string,
 414   numberOfEventsToWait: number,
 415   timeout: number
 416 ): Promise<number> => {
 417   return await new Promise<number>(resolve => {
 418     let events = 0
 419     if (numberOfEventsToWait === 0) {
 420       resolve(events)
 421       return
 422     }
 423     switch (workerNodeEvent) {
 424       case 'idle':
 425       case 'backPressure':
 426       case 'taskFinished':
 427         workerNode.on(workerNodeEvent, () => {
 428           ++events
 429           if (events === numberOfEventsToWait) {
 430             resolve(events)
 431           }
 432         })
 433         break
 434       default:
 435         throw new Error('Invalid worker node event')
 436     }
 437     if (timeout >= 0) {
 438       setTimeout(() => {
 439         resolve(events)
 440       }, timeout)
 441     }
 442   })
 443 }