refactor: use task performance data structure in messages

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

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index 8b461f7d3bad7d462c0f4bcea900f0a3bff295dd..7805514a7b3b083385b96ac4d26218840b625b31 100644 (file)
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -1,16 +1,24 @@
 import { AsyncResource } from 'node:async_hooks'
 import type { Worker } from 'node:cluster'
 import type { MessagePort } from 'node:worker_threads'
+import { performance } from 'node:perf_hooks'
 import type {
   MessageValue,
+  TaskPerformance,
+  WorkerStatistics
+} from '../utility-types'
+import { EMPTY_FUNCTION, isPlainObject } from '../utils'
+import {
+  type KillBehavior,
+  KillBehaviors,
+  type WorkerOptions
+} from './worker-options'
+import type {
   TaskFunctions,
   WorkerAsyncFunction,
   WorkerFunction,
   WorkerSyncFunction
-} from '../utility-types'
-import { EMPTY_FUNCTION } 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
@@ -36,6 +44,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 +91,6 @@ export abstract class AbstractWorker<
       )
       this.checkAlive.bind(this)()
     }
-
     this.mainWorker?.on('message', this.messageListener.bind(this))
   }
 
@@ -87,7 +98,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,25 +114,14 @@ export abstract class AbstractWorker<
     if (taskFunctions == null) {
       throw new Error('taskFunctions parameter is mandatory')
     }
-    if (
-      typeof taskFunctions !== 'function' &&
-      typeof taskFunctions !== 'object'
-    ) {
-      throw new Error('taskFunctions parameter is not a function or an object')
-    }
-    if (
-      typeof taskFunctions === 'object' &&
-      taskFunctions.constructor !== Object &&
-      Object.prototype.toString.call(taskFunctions) !== '[object Object]'
-    ) {
-      throw new Error('taskFunctions parameter is not an object literal')
-    }
     this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
-    if (typeof taskFunctions !== 'function') {
+    if (typeof taskFunctions === 'function') {
+      this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
+    } else if (isPlainObject(taskFunctions)) {
       let firstEntry = true
       for (const [name, fn] of Object.entries(taskFunctions)) {
         if (typeof fn !== 'function') {
-          throw new Error(
+          throw new TypeError(
             'A taskFunctions parameter object value is not a function'
           )
         }
@@ -135,7 +135,9 @@ export abstract class AbstractWorker<
         throw new Error('taskFunctions parameter object is empty')
       }
     } else {
-      this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
+      throw new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     }
   }
 
@@ -160,6 +162,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
     }
   }
 
@@ -215,17 +220,21 @@ export abstract class AbstractWorker<
     message: MessageValue<Data>
   ): void {
     try {
-      const startTimestamp = performance.now()
+      let taskPerformance = this.beginTaskPerformance(message)
       const res = fn(message.data)
-      const runTime = performance.now() - startTimestamp
+      taskPerformance = this.endTaskPerformance(taskPerformance)
       this.sendToMainWorker({
         data: res,
-        id: message.id,
-        runTime
+        taskPerformance,
+        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())
     }
@@ -241,20 +250,24 @@ export abstract class AbstractWorker<
     fn: WorkerAsyncFunction<Data, Response>,
     message: MessageValue<Data>
   ): void {
-    const startTimestamp = performance.now()
+    let taskPerformance = this.beginTaskPerformance(message)
     fn(message.data)
       .then(res => {
-        const runTime = performance.now() - startTimestamp
+        taskPerformance = this.endTaskPerformance(taskPerformance)
         this.sendToMainWorker({
           data: res,
-          id: message.id,
-          runTime
+          taskPerformance,
+          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())
@@ -271,8 +284,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)
+      })
+    }
+  }
 }