src/worker/abstract-worker.ts

   1 import { AsyncResource } from 'node:async_hooks'
   2 import type { Worker } from 'node:cluster'
   3 import type { MessagePort } from 'node:worker_threads'
   4 import { performance } from 'node:perf_hooks'
   5 import type {
   6   MessageValue,
   7   Task,
   8   TaskPerformance,
   9   WorkerStatistics
  10 } from '../utility-types'
  11 import {
  12   DEFAULT_TASK_NAME,
  13   EMPTY_FUNCTION,
  14   isAsyncFunction,
  15   isPlainObject
  16 } from '../utils'
  17 import {
  18   type KillBehavior,
  19   KillBehaviors,
  20   type WorkerOptions
  21 } from './worker-options'
  22 import type {
  23   TaskFunctions,
  24   WorkerAsyncFunction,
  25   WorkerFunction,
  26   WorkerSyncFunction
  27 } from './worker-functions'
  28
  29 const DEFAULT_MAX_INACTIVE_TIME = 60000
  30 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
  31
  32 /**
  33  * Base class that implements some shared logic for all poolifier workers.
  34  *
  35  * @typeParam MainWorker - Type of main worker.
  36  * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
  37  * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
  38  */
  39 export abstract class AbstractWorker<
  40   MainWorker extends Worker | MessagePort,
  41   Data = unknown,
  42   Response = unknown
  43 > extends AsyncResource {
  44   /**
  45    * Worker id.
  46    */
  47   protected abstract id: number
  48   /**
  49    * Task function(s) processed by the worker when the pool's `execution` function is invoked.
  50    */
  51   protected taskFunctions!: Map<string, WorkerFunction<Data, Response>>
  52   /**
  53    * Timestamp of the last task processed by this worker.
  54    */
  55   protected lastTaskTimestamp!: number
  56   /**
  57    * Performance statistics computation requirements.
  58    */
  59   protected statistics!: WorkerStatistics
  60   /**
  61    * Handler id of the `activeInterval` worker activity check.
  62    */
  63   protected activeInterval?: NodeJS.Timeout
  64   /**
  65    * Constructs a new poolifier worker.
  66    *
  67    * @param type - The type of async event.
  68    * @param isMain - Whether this is the main worker or not.
  69    * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function.
  70    * @param mainWorker - Reference to main worker.
  71    * @param opts - Options for the worker.
  72    */
  73   public constructor (
  74     type: string,
  75     protected readonly isMain: boolean,
  76     taskFunctions:
  77     | WorkerFunction<Data, Response>
  78     | TaskFunctions<Data, Response>,
  79     protected readonly mainWorker: MainWorker,
  80     protected readonly opts: WorkerOptions = {
  81       /**
  82        * The kill behavior option on this worker or its default value.
  83        */
  84       killBehavior: DEFAULT_KILL_BEHAVIOR,
  85       /**
  86        * The maximum time to keep this worker active while idle.
  87        * The pool automatically checks and terminates this worker when the time expires.
  88        */
  89       maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME
  90     }
  91   ) {
  92     super(type)
  93     this.checkWorkerOptions(this.opts)
  94     this.checkTaskFunctions(taskFunctions)
  95     if (!this.isMain) {
  96       this.mainWorker?.on('message', this.messageListener.bind(this))
  97     }
  98   }
  99
 100   private checkWorkerOptions (opts: WorkerOptions): void {
 101     this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
 102     this.opts.maxInactiveTime =
 103       opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
 104     delete this.opts.async
 105   }
 106
 107   /**
 108    * Checks if the `taskFunctions` parameter is passed to the constructor.
 109    *
 110    * @param taskFunctions - The task function(s) parameter that should be checked.
 111    */
 112   private checkTaskFunctions (
 113     taskFunctions:
 114     | WorkerFunction<Data, Response>
 115     | TaskFunctions<Data, Response>
 116   ): void {
 117     if (taskFunctions == null) {
 118       throw new Error('taskFunctions parameter is mandatory')
 119     }
 120     this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
 121     if (typeof taskFunctions === 'function') {
 122       const boundFn = taskFunctions.bind(this)
 123       this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
 124       this.taskFunctions.set(
 125         typeof taskFunctions.name === 'string' &&
 126           taskFunctions.name.trim().length > 0
 127           ? taskFunctions.name
 128           : 'fn1',
 129         boundFn
 130       )
 131     } else if (isPlainObject(taskFunctions)) {
 132       let firstEntry = true
 133       for (const [name, fn] of Object.entries(taskFunctions)) {
 134         if (typeof name !== 'string') {
 135           throw new TypeError(
 136             'A taskFunctions parameter object key is not a string'
 137           )
 138         }
 139         if (typeof fn !== 'function') {
 140           throw new TypeError(
 141             'A taskFunctions parameter object value is not a function'
 142           )
 143         }
 144         const boundFn = fn.bind(this)
 145         if (firstEntry) {
 146           this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
 147           firstEntry = false
 148         }
 149         this.taskFunctions.set(name, boundFn)
 150       }
 151       if (firstEntry) {
 152         throw new Error('taskFunctions parameter object is empty')
 153       }
 154     } else {
 155       throw new TypeError(
 156         'taskFunctions parameter is not a function or a plain object'
 157       )
 158     }
 159   }
 160
 161   /**
 162    * Checks if the worker has a task function with the given name.
 163    *
 164    * @param name - The name of the task function to check.
 165    * @returns Whether the worker has a task function with the given name or not.
 166    * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
 167    */
 168   public hasTaskFunction (name: string): boolean {
 169     if (typeof name !== 'string') {
 170       throw new TypeError('name parameter is not a string')
 171     }
 172     return this.taskFunctions.has(name)
 173   }
 174
 175   /**
 176    * Adds a task function to the worker.
 177    * If a task function with the same name already exists, it is replaced.
 178    *
 179    * @param name - The name of the task function to add.
 180    * @param fn - The task function to add.
 181    * @returns Whether the task function was added or not.
 182    * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
 183    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
 184    * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function.
 185    */
 186   public addTaskFunction (
 187     name: string,
 188     fn: WorkerFunction<Data, Response>
 189   ): boolean {
 190     if (typeof name !== 'string') {
 191       throw new TypeError('name parameter is not a string')
 192     }
 193     if (name === DEFAULT_TASK_NAME) {
 194       throw new Error(
 195         'Cannot add a task function with the default reserved name'
 196       )
 197     }
 198     if (typeof fn !== 'function') {
 199       throw new TypeError('fn parameter is not a function')
 200     }
 201     try {
 202       const boundFn = fn.bind(this)
 203       if (
 204         this.taskFunctions.get(name) ===
 205         this.taskFunctions.get(DEFAULT_TASK_NAME)
 206       ) {
 207         this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
 208       }
 209       this.taskFunctions.set(name, boundFn)
 210       return true
 211     } catch {
 212       return false
 213     }
 214   }
 215
 216   /**
 217    * Removes a task function from the worker.
 218    *
 219    * @param name - The name of the task function to remove.
 220    * @returns Whether the task function existed and was removed or not.
 221    * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
 222    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
 223    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the task function used as default task function.
 224    */
 225   public removeTaskFunction (name: string): boolean {
 226     if (typeof name !== 'string') {
 227       throw new TypeError('name parameter is not a string')
 228     }
 229     if (name === DEFAULT_TASK_NAME) {
 230       throw new Error(
 231         'Cannot remove the task function with the default reserved name'
 232       )
 233     }
 234     if (
 235       this.taskFunctions.get(name) === this.taskFunctions.get(DEFAULT_TASK_NAME)
 236     ) {
 237       throw new Error(
 238         'Cannot remove the task function used as the default task function'
 239       )
 240     }
 241     return this.taskFunctions.delete(name)
 242   }
 243
 244   /**
 245    * Lists the names of the worker's task functions.
 246    *
 247    * @returns The names of the worker's task functions.
 248    */
 249   public listTaskFunctions (): string[] {
 250     return Array.from(this.taskFunctions.keys())
 251   }
 252
 253   /**
 254    * Sets the default task function to use in the worker.
 255    *
 256    * @param name - The name of the task function to use as default task function.
 257    * @returns Whether the default task function was set or not.
 258    * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
 259    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
 260    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is a non-existing task function.
 261    */
 262   public setDefaultTaskFunction (name: string): boolean {
 263     if (typeof name !== 'string') {
 264       throw new TypeError('name parameter is not a string')
 265     }
 266     if (name === DEFAULT_TASK_NAME) {
 267       throw new Error(
 268         'Cannot set the default task function reserved name as the default task function'
 269       )
 270     }
 271     if (!this.taskFunctions.has(name)) {
 272       throw new Error(
 273         'Cannot set the default task function to a non-existing task function'
 274       )
 275     }
 276     try {
 277       this.taskFunctions.set(
 278         DEFAULT_TASK_NAME,
 279         this.taskFunctions.get(name) as WorkerFunction<Data, Response>
 280       )
 281       return true
 282     } catch {
 283       return false
 284     }
 285   }
 286
 287   /**
 288    * Worker message listener.
 289    *
 290    * @param message - The received message.
 291    */
 292   protected messageListener (message: MessageValue<Data, Data>): void {
 293     if (message.workerId === this.id) {
 294       if (message.ready != null) {
 295         // Startup message received
 296         this.sendReadyResponse()
 297       } else if (message.statistics != null) {
 298         // Statistics message received
 299         this.statistics = message.statistics
 300       } else if (message.checkActive != null) {
 301         // Check active message received
 302         !this.isMain && message.checkActive
 303           ? this.startCheckActive()
 304           : this.stopCheckActive()
 305       } else if (message.id != null && message.data != null) {
 306         // Task message received
 307         this.run(message)
 308       } else if (message.kill === true) {
 309         // Kill message received
 310         !this.isMain && this.stopCheckActive()
 311         this.emitDestroy()
 312       }
 313     }
 314   }
 315
 316   /**
 317    * Sends the ready response to the main worker.
 318    */
 319   protected sendReadyResponse (): void {
 320     !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
 321   }
 322
 323   /**
 324    * Starts the worker check active interval.
 325    */
 326   private startCheckActive (): void {
 327     this.lastTaskTimestamp = performance.now()
 328     this.activeInterval = setInterval(
 329       this.checkActive.bind(this),
 330       (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
 331     ).unref()
 332   }
 333
 334   /**
 335    * Stops the worker check active interval.
 336    */
 337   private stopCheckActive (): void {
 338     if (this.activeInterval != null) {
 339       clearInterval(this.activeInterval)
 340       delete this.activeInterval
 341     }
 342   }
 343
 344   /**
 345    * Checks if the worker should be terminated, because its living too long.
 346    */
 347   private checkActive (): void {
 348     if (
 349       performance.now() - this.lastTaskTimestamp >
 350       (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
 351     ) {
 352       this.sendToMainWorker({ kill: this.opts.killBehavior, workerId: this.id })
 353     }
 354   }
 355
 356   /**
 357    * Returns the main worker.
 358    *
 359    * @returns Reference to the main worker.
 360    */
 361   protected getMainWorker (): MainWorker {
 362     if (this.mainWorker == null) {
 363       throw new Error('Main worker not set')
 364     }
 365     return this.mainWorker
 366   }
 367
 368   /**
 369    * Sends a message to the main worker.
 370    *
 371    * @param message - The response message.
 372    */
 373   protected abstract sendToMainWorker (
 374     message: MessageValue<Response, Data>
 375   ): void
 376
 377   /**
 378    * Handles an error and convert it to a string so it can be sent back to the main worker.
 379    *
 380    * @param e - The error raised by the worker.
 381    * @returns The error message.
 382    */
 383   protected handleError (e: Error | string): string {
 384     return e instanceof Error ? e.message : e
 385   }
 386
 387   /**
 388    * Runs the given task.
 389    *
 390    * @param task - The task to execute.
 391    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
 392    */
 393   protected run (task: Task<Data>): void {
 394     if (this.isMain) {
 395       throw new Error('Cannot run a task in the main worker')
 396     }
 397     const fn = this.getTaskFunction(task.name)
 398     if (isAsyncFunction(fn)) {
 399       this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
 400     } else {
 401       this.runInAsyncScope(this.runSync.bind(this), this, fn, task)
 402     }
 403   }
 404
 405   /**
 406    * Runs the given task function synchronously.
 407    *
 408    * @param fn - Task function that will be executed.
 409    * @param task - Input data for the task function.
 410    */
 411   protected runSync (
 412     fn: WorkerSyncFunction<Data, Response>,
 413     task: Task<Data>
 414   ): void {
 415     try {
 416       let taskPerformance = this.beginTaskPerformance(task.name)
 417       const res = fn(task.data)
 418       taskPerformance = this.endTaskPerformance(taskPerformance)
 419       this.sendToMainWorker({
 420         data: res,
 421         taskPerformance,
 422         workerId: this.id,
 423         id: task.id
 424       })
 425     } catch (e) {
 426       const errorMessage = this.handleError(e as Error | string)
 427       this.sendToMainWorker({
 428         taskError: {
 429           name: task.name ?? DEFAULT_TASK_NAME,
 430           message: errorMessage,
 431           data: task.data
 432         },
 433         workerId: this.id,
 434         id: task.id
 435       })
 436     } finally {
 437       this.updateLastTaskTimestamp()
 438     }
 439   }
 440
 441   /**
 442    * Runs the given task function asynchronously.
 443    *
 444    * @param fn - Task function that will be executed.
 445    * @param task - Input data for the task function.
 446    */
 447   protected runAsync (
 448     fn: WorkerAsyncFunction<Data, Response>,
 449     task: Task<Data>
 450   ): void {
 451     let taskPerformance = this.beginTaskPerformance(task.name)
 452     fn(task.data)
 453       .then(res => {
 454         taskPerformance = this.endTaskPerformance(taskPerformance)
 455         this.sendToMainWorker({
 456           data: res,
 457           taskPerformance,
 458           workerId: this.id,
 459           id: task.id
 460         })
 461         return null
 462       })
 463       .catch(e => {
 464         const errorMessage = this.handleError(e as Error | string)
 465         this.sendToMainWorker({
 466           taskError: {
 467             name: task.name ?? DEFAULT_TASK_NAME,
 468             message: errorMessage,
 469             data: task.data
 470           },
 471           workerId: this.id,
 472           id: task.id
 473         })
 474       })
 475       .finally(() => {
 476         this.updateLastTaskTimestamp()
 477       })
 478       .catch(EMPTY_FUNCTION)
 479   }
 480
 481   /**
 482    * Gets the task function with the given name.
 483    *
 484    * @param name - Name of the task function that will be returned.
 485    * @returns The task function.
 486    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
 487    */
 488   private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
 489     name = name ?? DEFAULT_TASK_NAME
 490     const fn = this.taskFunctions.get(name)
 491     if (fn == null) {
 492       throw new Error(`Task function '${name}' not found`)
 493     }
 494     return fn
 495   }
 496
 497   private beginTaskPerformance (name?: string): TaskPerformance {
 498     this.checkStatistics()
 499     return {
 500       name: name ?? DEFAULT_TASK_NAME,
 501       timestamp: performance.now(),
 502       ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
 503     }
 504   }
 505
 506   private endTaskPerformance (
 507     taskPerformance: TaskPerformance
 508   ): TaskPerformance {
 509     this.checkStatistics()
 510     return {
 511       ...taskPerformance,
 512       ...(this.statistics.runTime && {
 513         runTime: performance.now() - taskPerformance.timestamp
 514       }),
 515       ...(this.statistics.elu && {
 516         elu: performance.eventLoopUtilization(taskPerformance.elu)
 517       })
 518     }
 519   }
 520
 521   private checkStatistics (): void {
 522     if (this.statistics == null) {
 523       throw new Error('Performance statistics computation requirements not set')
 524     }
 525   }
 526
 527   private updateLastTaskTimestamp (): void {
 528     if (!this.isMain && this.activeInterval != null) {
 529       this.lastTaskTimestamp = performance.now()
 530     }
 531   }
 532 }