build(deps-dev): apply updates

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

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index a484dce12927c1cd29721e9529aa08a822c37b43..a84bb0691fc588d3a8e51b0fe1696d7c85bb7dc9 100644 (file)
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -1,13 +1,11 @@
 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 { performance } from 'node:perf_hooks'
 import type {
   MessageValue,
-  TaskFunctions,
-  WorkerAsyncFunction,
-  WorkerFunction,
-  WorkerSyncFunction
+  TaskPerformance,
+  WorkerStatistics
 } from '../utility-types'
 import { EMPTY_FUNCTION, isPlainObject } from '../utils'
 import {
@@ -15,18 +13,17 @@ import {
   KillBehaviors,
   type WorkerOptions
 } from './worker-options'
+import type {
+  TaskFunctions,
+  WorkerAsyncFunction,
+  WorkerFunction,
+  WorkerSyncFunction
+} from './worker-functions'
 
 const DEFAULT_FUNCTION_NAME = 'default'
 const DEFAULT_MAX_INACTIVE_TIME = 60000
 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
 
-interface TaskPerformance {
-  timestamp: number
-  waitTime: number
-  runTime?: number
-  elu: EventLoopUtilization
-}
-
 /**
  * Base class that implements some shared logic for all poolifier workers.
  *
@@ -47,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.
    */
@@ -90,7 +91,6 @@ export abstract class AbstractWorker<
       )
       this.checkAlive.bind(this)()
     }
-
     this.mainWorker?.on('message', this.messageListener.bind(this))
   }
 
@@ -146,7 +146,9 @@ export abstract class AbstractWorker<
    *
    * @param message - Message received.
    */
-  protected messageListener (message: MessageValue<Data, MainWorker>): void {
+  protected messageListener (
+    message: MessageValue<Data, Data, MainWorker>
+  ): void {
     if (message.id != null && message.data != null) {
       // Task message received
       const fn = this.getTaskFunction(message.name)
@@ -162,6 +164,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
     }
   }
 
@@ -182,7 +187,9 @@ export abstract class AbstractWorker<
    *
    * @param message - The response message.
    */
-  protected abstract sendToMainWorker (message: MessageValue<Response>): void
+  protected abstract sendToMainWorker (
+    message: MessageValue<Response, Data>
+  ): void
 
   /**
    * Checks if the worker should be terminated, because its living too long.
@@ -217,21 +224,21 @@ export abstract class AbstractWorker<
     message: MessageValue<Data>
   ): void {
     try {
-      const taskPerformance = this.beforeTaskRunHook(message)
+      let taskPerformance = this.beginTaskPerformance()
       const res = fn(message.data)
-      const { runTime, waitTime, elu } = this.afterTaskRunHook(taskPerformance)
+      taskPerformance = this.endTaskPerformance(taskPerformance)
       this.sendToMainWorker({
         data: res,
-        runTime,
-        waitTime,
-        elu,
+        taskPerformance,
         id: message.id
       })
     } catch (e) {
       const err = this.handleError(e as Error)
       this.sendToMainWorker({
-        error: err,
-        errorData: message.data,
+        taskError: {
+          message: err,
+          data: message.data
+        },
         id: message.id
       })
     } finally {
@@ -249,16 +256,13 @@ export abstract class AbstractWorker<
     fn: WorkerAsyncFunction<Data, Response>,
     message: MessageValue<Data>
   ): void {
-    const taskPerformance = this.beforeTaskRunHook(message)
+    let taskPerformance = this.beginTaskPerformance()
     fn(message.data)
       .then(res => {
-        const { runTime, waitTime, elu } =
-          this.afterTaskRunHook(taskPerformance)
+        taskPerformance = this.endTaskPerformance(taskPerformance)
         this.sendToMainWorker({
           data: res,
-          runTime,
-          waitTime,
-          elu,
+          taskPerformance,
           id: message.id
         })
         return null
@@ -266,8 +270,10 @@ export abstract class AbstractWorker<
       .catch(e => {
         const err = this.handleError(e as Error)
         this.sendToMainWorker({
-          error: err,
-          errorData: message.data,
+          taskError: {
+            message: err,
+            data: message.data
+          },
           id: message.id
         })
       })
@@ -291,23 +297,24 @@ export abstract class AbstractWorker<
     return fn
   }
 
-  private beforeTaskRunHook (message: MessageValue<Data>): TaskPerformance {
-    // TODO: conditional accounting
-    const timestamp = performance.now()
+  private beginTaskPerformance (): TaskPerformance {
     return {
-      timestamp,
-      waitTime: timestamp - (message.submissionTimestamp ?? 0),
-      elu: performance.eventLoopUtilization()
+      timestamp: performance.now(),
+      ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
     }
   }
 
-  private afterTaskRunHook (taskPerformance: TaskPerformance): TaskPerformance {
+  private endTaskPerformance (
+    taskPerformance: TaskPerformance
+  ): TaskPerformance {
     return {
       ...taskPerformance,
-      ...{
-        runTime: performance.now() - taskPerformance.timestamp,
+      ...(this.statistics.runTime && {
+        runTime: performance.now() - taskPerformance.timestamp
+      }),
+      ...(this.statistics.elu && {
         elu: performance.eventLoopUtilization(taskPerformance.elu)
-      }
+      })
     }
   }
 }