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: true,
  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 }
 191
 192 /**
 193  * Updates the given measurement statistics.
 194  *
 195  * @param measurementStatistics - The measurement statistics to update.
 196  * @param measurementRequirements - The measurement statistics requirements.
 197  * @param measurementValue - The measurement value.
 198  * @internal
 199  */
 200 const updateMeasurementStatistics = (
 201   measurementStatistics: MeasurementStatistics,
 202   measurementRequirements: MeasurementStatisticsRequirements | undefined,
 203   measurementValue: number | undefined
 204 ): void => {
 205   if (
 206     measurementRequirements != null &&
 207     measurementValue != null &&
 208     measurementRequirements.aggregate
 209   ) {
 210     measurementStatistics.aggregate =
 211       (measurementStatistics.aggregate ?? 0) + measurementValue
 212     measurementStatistics.minimum = min(
 213       measurementValue,
 214       measurementStatistics.minimum ?? Infinity
 215     )
 216     measurementStatistics.maximum = max(
 217       measurementValue,
 218       measurementStatistics.maximum ?? -Infinity
 219     )
 220     if (measurementRequirements.average || measurementRequirements.median) {
 221       measurementStatistics.history.push(measurementValue)
 222       if (measurementRequirements.average) {
 223         measurementStatistics.average = average(measurementStatistics.history)
 224       } else if (measurementStatistics.average != null) {
 225         delete measurementStatistics.average
 226       }
 227       if (measurementRequirements.median) {
 228         measurementStatistics.median = median(measurementStatistics.history)
 229       } else if (measurementStatistics.median != null) {
 230         delete measurementStatistics.median
 231       }
 232     }
 233   }
 234 }
 235 if (env.NODE_ENV === 'test') {
 236   // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
 237   exports.updateMeasurementStatistics = updateMeasurementStatistics
 238 }
 239
 240 export const updateWaitTimeWorkerUsage = <
 241   Worker extends IWorker,
 242   Data = unknown,
 243   Response = unknown
 244 >(
 245     workerChoiceStrategiesContext:
 246     | WorkerChoiceStrategiesContext<Worker, Data, Response>
 247     | undefined,
 248     workerUsage: WorkerUsage,
 249     task: Task<Data>
 250   ): void => {
 251   const timestamp = performance.now()
 252   const taskWaitTime = timestamp - (task.timestamp ?? timestamp)
 253   updateMeasurementStatistics(
 254     workerUsage.waitTime,
 255     workerChoiceStrategiesContext?.getTaskStatisticsRequirements().waitTime,
 256     taskWaitTime
 257   )
 258 }
 259
 260 export const updateTaskStatisticsWorkerUsage = <Response = unknown>(
 261   workerUsage: WorkerUsage,
 262   message: MessageValue<Response>
 263 ): void => {
 264   const workerTaskStatistics = workerUsage.tasks
 265   if (
 266     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 267     workerTaskStatistics.executing != null &&
 268     workerTaskStatistics.executing > 0
 269   ) {
 270     --workerTaskStatistics.executing
 271   }
 272   if (message.workerError == null) {
 273     ++workerTaskStatistics.executed
 274   } else {
 275     ++workerTaskStatistics.failed
 276   }
 277 }
 278
 279 export const updateRunTimeWorkerUsage = <
 280   Worker extends IWorker,
 281   Data = unknown,
 282   Response = unknown
 283 >(
 284     workerChoiceStrategiesContext:
 285     | WorkerChoiceStrategiesContext<Worker, Data, Response>
 286     | undefined,
 287     workerUsage: WorkerUsage,
 288     message: MessageValue<Response>
 289   ): void => {
 290   if (message.workerError != null) {
 291     return
 292   }
 293   updateMeasurementStatistics(
 294     workerUsage.runTime,
 295     workerChoiceStrategiesContext?.getTaskStatisticsRequirements().runTime,
 296     message.taskPerformance?.runTime ?? 0
 297   )
 298 }
 299
 300 export const updateEluWorkerUsage = <
 301   Worker extends IWorker,
 302   Data = unknown,
 303   Response = unknown
 304 >(
 305     workerChoiceStrategiesContext:
 306     | WorkerChoiceStrategiesContext<Worker, Data, Response>
 307     | undefined,
 308     workerUsage: WorkerUsage,
 309     message: MessageValue<Response>
 310   ): void => {
 311   if (message.workerError != null) {
 312     return
 313   }
 314   const eluTaskStatisticsRequirements =
 315     workerChoiceStrategiesContext?.getTaskStatisticsRequirements().elu
 316   updateMeasurementStatistics(
 317     workerUsage.elu.active,
 318     eluTaskStatisticsRequirements,
 319     message.taskPerformance?.elu?.active ?? 0
 320   )
 321   updateMeasurementStatistics(
 322     workerUsage.elu.idle,
 323     eluTaskStatisticsRequirements,
 324     message.taskPerformance?.elu?.idle ?? 0
 325   )
 326   if (eluTaskStatisticsRequirements?.aggregate === true) {
 327     if (message.taskPerformance?.elu != null) {
 328       if (workerUsage.elu.utilization != null) {
 329         workerUsage.elu.utilization =
 330           (workerUsage.elu.utilization +
 331             message.taskPerformance.elu.utilization) /
 332           2
 333       } else {
 334         workerUsage.elu.utilization = message.taskPerformance.elu.utilization
 335       }
 336     }
 337   }
 338 }
 339
 340 export const createWorker = <Worker extends IWorker>(
 341   type: WorkerType,
 342   filePath: string,
 343   opts: { env?: Record<string, unknown>, workerOptions?: WorkerOptions }
 344 ): Worker => {
 345   switch (type) {
 346     case WorkerTypes.thread:
 347       return new ThreadWorker(filePath, {
 348         env: SHARE_ENV,
 349         ...opts.workerOptions
 350       }) as unknown as Worker
 351     case WorkerTypes.cluster:
 352       return cluster.fork(opts.env) as unknown as Worker
 353     default:
 354       // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
 355       throw new Error(`Unknown worker type '${type}'`)
 356   }
 357 }
 358
 359 /**
 360  * Returns the worker type of the given worker.
 361  *
 362  * @param worker - The worker to get the type of.
 363  * @returns The worker type of the given worker.
 364  * @internal
 365  */
 366 export const getWorkerType = (worker: IWorker): WorkerType | undefined => {
 367   if (worker instanceof ThreadWorker) {
 368     return WorkerTypes.thread
 369   } else if (worker instanceof ClusterWorker) {
 370     return WorkerTypes.cluster
 371   }
 372 }
 373
 374 /**
 375  * Returns the worker id of the given worker.
 376  *
 377  * @param worker - The worker to get the id of.
 378  * @returns The worker id of the given worker.
 379  * @internal
 380  */
 381 export const getWorkerId = (worker: IWorker): number | undefined => {
 382   if (worker instanceof ThreadWorker) {
 383     return worker.threadId
 384   } else if (worker instanceof ClusterWorker) {
 385     return worker.id
 386   }
 387 }
 388
 389 export const waitWorkerNodeEvents = async <
 390   Worker extends IWorker,
 391   Data = unknown
 392 >(
 393   workerNode: IWorkerNode<Worker, Data>,
 394   workerNodeEvent: string,
 395   numberOfEventsToWait: number,
 396   timeout: number
 397 ): Promise<number> => {
 398   return await new Promise<number>(resolve => {
 399     let events = 0
 400     if (numberOfEventsToWait === 0) {
 401       resolve(events)
 402       return
 403     }
 404     workerNode.on(workerNodeEvent, () => {
 405       ++events
 406       if (events === numberOfEventsToWait) {
 407         resolve(events)
 408       }
 409     })
 410     if (timeout >= 0) {
 411       setTimeout(() => {
 412         resolve(events)
 413       }, timeout)
 414     }
 415   })
 416 }