chore: v2.5.4

[poolifier.git] / src / worker / abstract-worker.ts

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index 12fb67af32934383a9498e541fadc031e85cbafe..b7c542aa469f40bf4feb50aa99599b52bb7bc44e 100644 (file)
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -1,21 +1,35 @@
 import { AsyncResource } from 'node:async_hooks'
 import type { Worker } from 'node:cluster'
 import type { MessagePort } from 'node:worker_threads'
+import { type EventLoopUtilization, performance } from 'node:perf_hooks'
+import type { MessageValue, WorkerStatistics } from '../utility-types'
+import { EMPTY_FUNCTION, isPlainObject } from '../utils'
+import {
+  type KillBehavior,
+  KillBehaviors,
+  type WorkerOptions
+} from './worker-options'
 import type {
-  MessageValue,
   TaskFunctions,
   WorkerAsyncFunction,
   WorkerFunction,
   WorkerSyncFunction
-} from '../utility-types'
-import { EMPTY_FUNCTION, isPlainObject } from '../utils'
-import type { KillBehavior, WorkerOptions } from './worker-options'
-import { KillBehaviors } from './worker-options'
+} from './worker-functions'
 
 const DEFAULT_FUNCTION_NAME = 'default'
 const DEFAULT_MAX_INACTIVE_TIME = 60000
 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
 
+/**
+ * Task performance.
+ */
+export interface TaskPerformance {
+  timestamp: number
+  waitTime?: number
+  runTime?: number
+  elu?: EventLoopUtilization
+}
+
 /**
  * Base class that implements some shared logic for all poolifier workers.
  *
@@ -36,6 +50,10 @@ export abstract class AbstractWorker<
    * Timestamp of the last task processed by this worker.
    */
   protected lastTaskTimestamp!: number
+  /**
+   * Performance statistics computation.
+   */
+  protected statistics!: WorkerStatistics
   /**
    * Handler id of the `aliveInterval` worker alive check.
    */
@@ -79,7 +97,6 @@ export abstract class AbstractWorker<
       )
       this.checkAlive.bind(this)()
     }
-
     this.mainWorker?.on('message', this.messageListener.bind(this))
   }
 
@@ -87,7 +104,7 @@ export abstract class AbstractWorker<
     this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
     this.opts.maxInactiveTime =
       opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
-    this.opts.async = opts.async ?? false
+    delete this.opts.async
   }
 
   /**
@@ -103,14 +120,6 @@ export abstract class AbstractWorker<
     if (taskFunctions == null) {
       throw new Error('taskFunctions parameter is mandatory')
     }
-    if (
-      typeof taskFunctions !== 'function' &&
-      typeof taskFunctions !== 'object'
-    ) {
-      throw new TypeError(
-        'taskFunctions parameter is not a function or an object'
-      )
-    }
     this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
     if (typeof taskFunctions === 'function') {
       this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
@@ -132,7 +141,9 @@ export abstract class AbstractWorker<
         throw new Error('taskFunctions parameter object is empty')
       }
     } else {
-      throw new TypeError('taskFunctions parameter is not an object literal')
+      throw new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     }
   }
 
@@ -157,6 +168,9 @@ export abstract class AbstractWorker<
       // Kill message received
       this.aliveInterval != null && clearInterval(this.aliveInterval)
       this.emitDestroy()
+    } else if (message.statistics != null) {
+      // Statistics message received
+      this.statistics = message.statistics
     }
   }
 
@@ -212,17 +226,24 @@ export abstract class AbstractWorker<
     message: MessageValue<Data>
   ): void {
     try {
-      const startTimestamp = performance.now()
+      const taskPerformance = this.beginTaskPerformance(message)
       const res = fn(message.data)
-      const runTime = performance.now() - startTimestamp
+      const { runTime, waitTime, elu } =
+        this.endTaskPerformance(taskPerformance)
       this.sendToMainWorker({
         data: res,
-        id: message.id,
-        runTime
+        runTime,
+        waitTime,
+        elu,
+        id: message.id
       })
     } catch (e) {
       const err = this.handleError(e as Error)
-      this.sendToMainWorker({ error: err, id: message.id })
+      this.sendToMainWorker({
+        error: err,
+        errorData: message.data,
+        id: message.id
+      })
     } finally {
       !this.isMain && (this.lastTaskTimestamp = performance.now())
     }
@@ -238,20 +259,27 @@ export abstract class AbstractWorker<
     fn: WorkerAsyncFunction<Data, Response>,
     message: MessageValue<Data>
   ): void {
-    const startTimestamp = performance.now()
+    const taskPerformance = this.beginTaskPerformance(message)
     fn(message.data)
       .then(res => {
-        const runTime = performance.now() - startTimestamp
+        const { runTime, waitTime, elu } =
+          this.endTaskPerformance(taskPerformance)
         this.sendToMainWorker({
           data: res,
-          id: message.id,
-          runTime
+          runTime,
+          waitTime,
+          elu,
+          id: message.id
         })
         return null
       })
       .catch(e => {
         const err = this.handleError(e as Error)
-        this.sendToMainWorker({ error: err, id: message.id })
+        this.sendToMainWorker({
+          error: err,
+          errorData: message.data,
+          id: message.id
+        })
       })
       .finally(() => {
         !this.isMain && (this.lastTaskTimestamp = performance.now())
@@ -268,8 +296,33 @@ export abstract class AbstractWorker<
     name = name ?? DEFAULT_FUNCTION_NAME
     const fn = this.taskFunctions.get(name)
     if (fn == null) {
-      throw new Error(`Task function "${name}" not found`)
+      throw new Error(`Task function '${name}' not found`)
     }
     return fn
   }
+
+  private beginTaskPerformance (message: MessageValue<Data>): TaskPerformance {
+    const timestamp = performance.now()
+    return {
+      timestamp,
+      ...(this.statistics.waitTime && {
+        waitTime: timestamp - (message.timestamp ?? timestamp)
+      }),
+      ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
+    }
+  }
+
+  private endTaskPerformance (
+    taskPerformance: TaskPerformance
+  ): TaskPerformance {
+    return {
+      ...taskPerformance,
+      ...(this.statistics.runTime && {
+        runTime: performance.now() - taskPerformance.timestamp
+      }),
+      ...(this.statistics.elu && {
+        elu: performance.eventLoopUtilization(taskPerformance.elu)
+      })
+    }
+  }
 }