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 mainWorker - Reference to main worker.
  70    * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function.
  71    * @param opts - Options for the worker.
  72    */
  73   public constructor (
  74     type: string,
  75     protected readonly isMain: boolean,
  76     private readonly mainWorker: MainWorker,
  77     taskFunctions:
  78     | WorkerFunction<Data, Response>
  79     | TaskFunctions<Data, Response>,
  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.getMainWorker()?.on('message', this.handleReadyMessage.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    * Handles the ready message sent by the main worker.
 289    *
 290    * @param message - The ready message.
 291    */
 292   protected abstract handleReadyMessage (message: MessageValue<Data>): void
 293
 294   /**
 295    * Worker message listener.
 296    *
 297    * @param message - The received message.
 298    */
 299   protected messageListener (message: MessageValue<Data>): void {
 300     if (message.workerId === this.id) {
 301       if (message.statistics != null) {
 302         // Statistics message received
 303         this.statistics = message.statistics
 304       } else if (message.checkActive != null) {
 305         // Check active message received
 306         !this.isMain && message.checkActive
 307           ? this.startCheckActive()
 308           : this.stopCheckActive()
 309       } else if (message.id != null && message.data != null) {
 310         // Task message received
 311         this.run(message)
 312       } else if (message.kill === true) {
 313         // Kill message received
 314         !this.isMain && this.stopCheckActive()
 315         this.emitDestroy()
 316       }
 317     }
 318   }
 319
 320   /**
 321    * Starts the worker check active interval.
 322    */
 323   private startCheckActive (): void {
 324     this.lastTaskTimestamp = performance.now()
 325     this.activeInterval = setInterval(
 326       this.checkActive.bind(this),
 327       (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
 328     ).unref()
 329   }
 330
 331   /**
 332    * Stops the worker check active interval.
 333    */
 334   private stopCheckActive (): void {
 335     if (this.activeInterval != null) {
 336       clearInterval(this.activeInterval)
 337       delete this.activeInterval
 338     }
 339   }
 340
 341   /**
 342    * Checks if the worker should be terminated, because its living too long.
 343    */
 344   private checkActive (): void {
 345     if (
 346       performance.now() - this.lastTaskTimestamp >
 347       (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
 348     ) {
 349       this.sendToMainWorker({ kill: this.opts.killBehavior, workerId: this.id })
 350     }
 351   }
 352
 353   /**
 354    * Returns the main worker.
 355    *
 356    * @returns Reference to the main worker.
 357    */
 358   protected getMainWorker (): MainWorker {
 359     if (this.mainWorker == null) {
 360       throw new Error('Main worker not set')
 361     }
 362     return this.mainWorker
 363   }
 364
 365   /**
 366    * Sends a message to the main worker.
 367    *
 368    * @param message - The response message.
 369    */
 370   protected abstract sendToMainWorker (
 371     message: MessageValue<Response, Data>
 372   ): void
 373
 374   /**
 375    * Handles an error and convert it to a string so it can be sent back to the main worker.
 376    *
 377    * @param e - The error raised by the worker.
 378    * @returns The error message.
 379    */
 380   protected handleError (e: Error | string): string {
 381     return e instanceof Error ? e.message : e
 382   }
 383
 384   /**
 385    * Runs the given task.
 386    *
 387    * @param task - The task to execute.
 388    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
 389    */
 390   protected run (task: Task<Data>): void {
 391     if (this.isMain) {
 392       throw new Error('Cannot run a task in the main worker')
 393     }
 394     const fn = this.getTaskFunction(task.name)
 395     if (isAsyncFunction(fn)) {
 396       this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
 397     } else {
 398       this.runInAsyncScope(this.runSync.bind(this), this, fn, task)
 399     }
 400   }
 401
 402   /**
 403    * Runs the given task function synchronously.
 404    *
 405    * @param fn - Task function that will be executed.
 406    * @param task - Input data for the task function.
 407    */
 408   protected runSync (
 409     fn: WorkerSyncFunction<Data, Response>,
 410     task: Task<Data>
 411   ): void {
 412     try {
 413       let taskPerformance = this.beginTaskPerformance(task.name)
 414       const res = fn(task.data)
 415       taskPerformance = this.endTaskPerformance(taskPerformance)
 416       this.sendToMainWorker({
 417         data: res,
 418         taskPerformance,
 419         workerId: this.id,
 420         id: task.id
 421       })
 422     } catch (e) {
 423       const errorMessage = this.handleError(e as Error | string)
 424       this.sendToMainWorker({
 425         taskError: {
 426           name: task.name ?? DEFAULT_TASK_NAME,
 427           message: errorMessage,
 428           data: task.data
 429         },
 430         workerId: this.id,
 431         id: task.id
 432       })
 433     } finally {
 434       this.updateLastTaskTimestamp()
 435     }
 436   }
 437
 438   /**
 439    * Runs the given task function asynchronously.
 440    *
 441    * @param fn - Task function that will be executed.
 442    * @param task - Input data for the task function.
 443    */
 444   protected runAsync (
 445     fn: WorkerAsyncFunction<Data, Response>,
 446     task: Task<Data>
 447   ): void {
 448     let taskPerformance = this.beginTaskPerformance(task.name)
 449     fn(task.data)
 450       .then(res => {
 451         taskPerformance = this.endTaskPerformance(taskPerformance)
 452         this.sendToMainWorker({
 453           data: res,
 454           taskPerformance,
 455           workerId: this.id,
 456           id: task.id
 457         })
 458         return null
 459       })
 460       .catch(e => {
 461         const errorMessage = this.handleError(e as Error | string)
 462         this.sendToMainWorker({
 463           taskError: {
 464             name: task.name ?? DEFAULT_TASK_NAME,
 465             message: errorMessage,
 466             data: task.data
 467           },
 468           workerId: this.id,
 469           id: task.id
 470         })
 471       })
 472       .finally(() => {
 473         this.updateLastTaskTimestamp()
 474       })
 475       .catch(EMPTY_FUNCTION)
 476   }
 477
 478   /**
 479    * Gets the task function with the given name.
 480    *
 481    * @param name - Name of the task function that will be returned.
 482    * @returns The task function.
 483    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
 484    */
 485   private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
 486     name = name ?? DEFAULT_TASK_NAME
 487     const fn = this.taskFunctions.get(name)
 488     if (fn == null) {
 489       throw new Error(`Task function '${name}' not found`)
 490     }
 491     return fn
 492   }
 493
 494   private beginTaskPerformance (name?: string): TaskPerformance {
 495     this.checkStatistics()
 496     return {
 497       name: name ?? DEFAULT_TASK_NAME,
 498       timestamp: performance.now(),
 499       ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
 500     }
 501   }
 502
 503   private endTaskPerformance (
 504     taskPerformance: TaskPerformance
 505   ): TaskPerformance {
 506     this.checkStatistics()
 507     return {
 508       ...taskPerformance,
 509       ...(this.statistics.runTime && {
 510         runTime: performance.now() - taskPerformance.timestamp
 511       }),
 512       ...(this.statistics.elu && {
 513         elu: performance.eventLoopUtilization(taskPerformance.elu)
 514       })
 515     }
 516   }
 517
 518   private checkStatistics (): void {
 519     if (this.statistics == null) {
 520       throw new Error('Performance statistics computation requirements not set')
 521     }
 522   }
 523
 524   private updateLastTaskTimestamp (): void {
 525     if (!this.isMain && this.activeInterval != null) {
 526       this.lastTaskTimestamp = performance.now()
 527     }
 528   }
 529 }