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   TaskPerformance,
   8   WorkerStatistics
   9 } from '../utility-types'
  10 import { EMPTY_FUNCTION, isAsyncFunction, isPlainObject } from '../utils'
  11 import {
  12   type KillBehavior,
  13   KillBehaviors,
  14   type WorkerOptions
  15 } from './worker-options'
  16 import type {
  17   TaskFunctions,
  18   WorkerAsyncFunction,
  19   WorkerFunction,
  20   WorkerSyncFunction
  21 } from './worker-functions'
  22
  23 const DEFAULT_FUNCTION_NAME = 'default'
  24 const DEFAULT_MAX_INACTIVE_TIME = 60000
  25 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
  26
  27 /**
  28  * Base class that implements some shared logic for all poolifier workers.
  29  *
  30  * @typeParam MainWorker - Type of main worker.
  31  * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
  32  * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
  33  */
  34 export abstract class AbstractWorker<
  35   MainWorker extends Worker | MessagePort,
  36   Data = unknown,
  37   Response = unknown
  38 > extends AsyncResource {
  39   /**
  40    * Worker id.
  41    */
  42   protected abstract id: number
  43   /**
  44    * Task function(s) processed by the worker when the pool's `execution` function is invoked.
  45    */
  46   protected taskFunctions!: Map<string, WorkerFunction<Data, Response>>
  47   /**
  48    * Timestamp of the last task processed by this worker.
  49    */
  50   protected lastTaskTimestamp!: number
  51   /**
  52    * Performance statistics computation requirements.
  53    */
  54   protected statistics!: WorkerStatistics
  55   /**
  56    * Handler id of the `aliveInterval` worker alive check.
  57    */
  58   protected aliveInterval?: NodeJS.Timeout
  59   /**
  60    * Constructs a new poolifier worker.
  61    *
  62    * @param type - The type of async event.
  63    * @param isMain - Whether this is the main worker or not.
  64    * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function.
  65    * @param mainWorker - Reference to main worker.
  66    * @param opts - Options for the worker.
  67    */
  68   public constructor (
  69     type: string,
  70     protected readonly isMain: boolean,
  71     taskFunctions:
  72     | WorkerFunction<Data, Response>
  73     | TaskFunctions<Data, Response>,
  74     protected readonly mainWorker: MainWorker,
  75     protected readonly opts: WorkerOptions = {
  76       /**
  77        * The kill behavior option on this worker or its default value.
  78        */
  79       killBehavior: DEFAULT_KILL_BEHAVIOR,
  80       /**
  81        * The maximum time to keep this worker alive while idle.
  82        * The pool automatically checks and terminates this worker when the time expires.
  83        */
  84       maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME
  85     }
  86   ) {
  87     super(type)
  88     this.checkWorkerOptions(this.opts)
  89     this.checkTaskFunctions(taskFunctions)
  90     if (!this.isMain) {
  91       this.mainWorker?.on('message', this.messageListener.bind(this))
  92     }
  93   }
  94
  95   private checkWorkerOptions (opts: WorkerOptions): void {
  96     this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
  97     this.opts.maxInactiveTime =
  98       opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
  99     delete this.opts.async
 100   }
 101
 102   /**
 103    * Checks if the `taskFunctions` parameter is passed to the constructor.
 104    *
 105    * @param taskFunctions - The task function(s) parameter that should be checked.
 106    */
 107   private checkTaskFunctions (
 108     taskFunctions:
 109     | WorkerFunction<Data, Response>
 110     | TaskFunctions<Data, Response>
 111   ): void {
 112     if (taskFunctions == null) {
 113       throw new Error('taskFunctions parameter is mandatory')
 114     }
 115     this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
 116     if (typeof taskFunctions === 'function') {
 117       this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
 118     } else if (isPlainObject(taskFunctions)) {
 119       let firstEntry = true
 120       for (const [name, fn] of Object.entries(taskFunctions)) {
 121         if (typeof fn !== 'function') {
 122           throw new TypeError(
 123             'A taskFunctions parameter object value is not a function'
 124           )
 125         }
 126         this.taskFunctions.set(name, fn.bind(this))
 127         if (firstEntry) {
 128           this.taskFunctions.set(DEFAULT_FUNCTION_NAME, fn.bind(this))
 129           firstEntry = false
 130         }
 131       }
 132       if (firstEntry) {
 133         throw new Error('taskFunctions parameter object is empty')
 134       }
 135     } else {
 136       throw new TypeError(
 137         'taskFunctions parameter is not a function or a plain object'
 138       )
 139     }
 140   }
 141
 142   /**
 143    * Worker message listener.
 144    *
 145    * @param message - Message received.
 146    */
 147   protected messageListener (message: MessageValue<Data, Data>): void {
 148     if (message.ready != null && message.workerId === this.id) {
 149       // Startup message received
 150       this.workerReady()
 151     } else if (message.statistics != null) {
 152       // Statistics message received
 153       this.statistics = message.statistics
 154     } else if (message.checkAlive != null) {
 155       // Check alive message received
 156       message.checkAlive ? this.startCheckAlive() : this.stopCheckAlive()
 157     } else if (message.id != null && message.data != null) {
 158       // Task message received
 159       const fn = this.getTaskFunction(message.name)
 160       if (isAsyncFunction(fn)) {
 161         this.runInAsyncScope(this.runAsync.bind(this), this, fn, message)
 162       } else {
 163         this.runInAsyncScope(this.runSync.bind(this), this, fn, message)
 164       }
 165     } else if (message.kill === true) {
 166       // Kill message received
 167       this.stopCheckAlive()
 168       this.emitDestroy()
 169     }
 170   }
 171
 172   /**
 173    * Notifies the main worker that this worker is ready to process tasks.
 174    */
 175   protected workerReady (): void {
 176     !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
 177   }
 178
 179   /**
 180    * Starts the worker alive check interval.
 181    */
 182   private startCheckAlive (): void {
 183     this.lastTaskTimestamp = performance.now()
 184     this.aliveInterval = setInterval(
 185       this.checkAlive.bind(this),
 186       (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
 187     )
 188     this.checkAlive.bind(this)()
 189   }
 190
 191   /**
 192    * Stops the worker alive check interval.
 193    */
 194   private stopCheckAlive (): void {
 195     this.aliveInterval != null && clearInterval(this.aliveInterval)
 196   }
 197
 198   /**
 199    * Checks if the worker should be terminated, because its living too long.
 200    */
 201   private checkAlive (): void {
 202     if (
 203       performance.now() - this.lastTaskTimestamp >
 204       (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
 205     ) {
 206       this.sendToMainWorker({ kill: this.opts.killBehavior })
 207     }
 208   }
 209
 210   /**
 211    * Returns the main worker.
 212    *
 213    * @returns Reference to the main worker.
 214    */
 215   protected getMainWorker (): MainWorker {
 216     if (this.mainWorker == null) {
 217       throw new Error('Main worker not set')
 218     }
 219     return this.mainWorker
 220   }
 221
 222   /**
 223    * Sends a message to the main worker.
 224    *
 225    * @param message - The response message.
 226    */
 227   protected abstract sendToMainWorker (
 228     message: MessageValue<Response, Data>
 229   ): void
 230
 231   /**
 232    * Handles an error and convert it to a string so it can be sent back to the main worker.
 233    *
 234    * @param e - The error raised by the worker.
 235    * @returns The error message.
 236    */
 237   protected handleError (e: Error | string): string {
 238     return e instanceof Error ? e.message : e
 239   }
 240
 241   /**
 242    * Runs the given function synchronously.
 243    *
 244    * @param fn - Function that will be executed.
 245    * @param message - Input data for the given function.
 246    */
 247   protected runSync (
 248     fn: WorkerSyncFunction<Data, Response>,
 249     message: MessageValue<Data>
 250   ): void {
 251     try {
 252       let taskPerformance = this.beginTaskPerformance()
 253       const res = fn(message.data)
 254       taskPerformance = this.endTaskPerformance(taskPerformance)
 255       this.sendToMainWorker({
 256         data: res,
 257         taskPerformance,
 258         workerId: this.id,
 259         id: message.id
 260       })
 261     } catch (e) {
 262       const errorMessage = this.handleError(e as Error | string)
 263       this.sendToMainWorker({
 264         taskError: {
 265           workerId: this.id,
 266           message: errorMessage,
 267           data: message.data
 268         },
 269         id: message.id
 270       })
 271     } finally {
 272       if (!this.isMain && this.aliveInterval != null) {
 273         this.lastTaskTimestamp = performance.now()
 274       }
 275     }
 276   }
 277
 278   /**
 279    * Runs the given function asynchronously.
 280    *
 281    * @param fn - Function that will be executed.
 282    * @param message - Input data for the given function.
 283    */
 284   protected runAsync (
 285     fn: WorkerAsyncFunction<Data, Response>,
 286     message: MessageValue<Data>
 287   ): void {
 288     let taskPerformance = this.beginTaskPerformance()
 289     fn(message.data)
 290       .then(res => {
 291         taskPerformance = this.endTaskPerformance(taskPerformance)
 292         this.sendToMainWorker({
 293           data: res,
 294           taskPerformance,
 295           workerId: this.id,
 296           id: message.id
 297         })
 298         return null
 299       })
 300       .catch(e => {
 301         const errorMessage = this.handleError(e as Error | string)
 302         this.sendToMainWorker({
 303           taskError: {
 304             workerId: this.id,
 305             message: errorMessage,
 306             data: message.data
 307           },
 308           id: message.id
 309         })
 310       })
 311       .finally(() => {
 312         if (!this.isMain && this.aliveInterval != null) {
 313           this.lastTaskTimestamp = performance.now()
 314         }
 315       })
 316       .catch(EMPTY_FUNCTION)
 317   }
 318
 319   /**
 320    * Gets the task function in the given scope.
 321    *
 322    * @param name - Name of the function that will be returned.
 323    */
 324   private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
 325     name = name ?? DEFAULT_FUNCTION_NAME
 326     const fn = this.taskFunctions.get(name)
 327     if (fn == null) {
 328       throw new Error(`Task function '${name}' not found`)
 329     }
 330     return fn
 331   }
 332
 333   private beginTaskPerformance (): TaskPerformance {
 334     this.checkStatistics()
 335     return {
 336       timestamp: performance.now(),
 337       ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
 338     }
 339   }
 340
 341   private endTaskPerformance (
 342     taskPerformance: TaskPerformance
 343   ): TaskPerformance {
 344     this.checkStatistics()
 345     return {
 346       ...taskPerformance,
 347       ...(this.statistics.runTime && {
 348         runTime: performance.now() - taskPerformance.timestamp
 349       }),
 350       ...(this.statistics.elu && {
 351         elu: performance.eventLoopUtilization(taskPerformance.elu)
 352       })
 353     }
 354   }
 355
 356   private checkStatistics (): void {
 357     if (this.statistics == null) {
 358       throw new Error('Performance statistics computation requirements not set')
 359     }
 360   }
 361 }