fix: fix async task statistics accounting
[poolifier.git] / src / worker / abstract-worker.ts
index 6e17c9ed92f53a3612d214f782d38019875ed46c..23739270b3a9863c20ea1a212004b2a94e982335 100644 (file)
@@ -7,7 +7,12 @@ import type {
   TaskPerformance,
   WorkerStatistics
 } from '../utility-types'
-import { EMPTY_FUNCTION, isPlainObject } from '../utils'
+import {
+  DEFAULT_TASK_NAME,
+  EMPTY_FUNCTION,
+  isAsyncFunction,
+  isPlainObject
+} from '../utils'
 import {
   type KillBehavior,
   KillBehaviors,
@@ -20,7 +25,6 @@ import type {
   WorkerSyncFunction
 } from './worker-functions'
 
-const DEFAULT_FUNCTION_NAME = 'default'
 const DEFAULT_MAX_INACTIVE_TIME = 60000
 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
 
@@ -55,7 +59,7 @@ export abstract class AbstractWorker<
   /**
    * Handler id of the `aliveInterval` worker alive check.
    */
-  protected readonly aliveInterval?: NodeJS.Timeout
+  protected aliveInterval?: NodeJS.Timeout
   /**
    * Constructs a new poolifier worker.
    *
@@ -88,12 +92,6 @@ export abstract class AbstractWorker<
     this.checkWorkerOptions(this.opts)
     this.checkTaskFunctions(taskFunctions)
     if (!this.isMain) {
-      this.lastTaskTimestamp = performance.now()
-      this.aliveInterval = setInterval(
-        this.checkAlive.bind(this),
-        (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
-      )
-      this.checkAlive.bind(this)()
       this.mainWorker?.on('message', this.messageListener.bind(this))
     }
   }
@@ -120,7 +118,7 @@ export abstract class AbstractWorker<
     }
     this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
     if (typeof taskFunctions === 'function') {
-      this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
+      this.taskFunctions.set(DEFAULT_TASK_NAME, taskFunctions.bind(this))
     } else if (isPlainObject(taskFunctions)) {
       let firstEntry = true
       for (const [name, fn] of Object.entries(taskFunctions)) {
@@ -131,7 +129,7 @@ export abstract class AbstractWorker<
         }
         this.taskFunctions.set(name, fn.bind(this))
         if (firstEntry) {
-          this.taskFunctions.set(DEFAULT_FUNCTION_NAME, fn.bind(this))
+          this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this))
           firstEntry = false
         }
       }
@@ -151,21 +149,67 @@ export abstract class AbstractWorker<
    * @param message - Message received.
    */
   protected messageListener (message: MessageValue<Data, Data>): void {
-    if (message.id != null && message.data != null) {
-      // Task message received
-      const fn = this.getTaskFunction(message.name)
-      if (fn?.constructor.name === 'AsyncFunction') {
-        this.runInAsyncScope(this.runAsync.bind(this), this, fn, message)
-      } else {
-        this.runInAsyncScope(this.runSync.bind(this), this, fn, message)
+    if (message.workerId === this.id) {
+      if (message.ready != null) {
+        // Startup message received
+        this.workerReady()
+      } else if (message.statistics != null) {
+        // Statistics message received
+        this.statistics = message.statistics
+      } else if (message.checkAlive != null) {
+        // Check alive message received
+        message.checkAlive ? this.startCheckAlive() : this.stopCheckAlive()
+      } else if (message.id != null && message.data != null) {
+        // Task message received
+        const fn = this.getTaskFunction(message.name)
+        if (isAsyncFunction(fn)) {
+          this.runInAsyncScope(this.runAsync.bind(this), this, fn, message)
+        } else {
+          this.runInAsyncScope(this.runSync.bind(this), this, fn, message)
+        }
+      } else if (message.kill === true) {
+        // Kill message received
+        this.stopCheckAlive()
+        this.emitDestroy()
       }
-    } else if (message.statistics != null) {
-      // Statistics message received
-      this.statistics = message.statistics
-    } else if (message.kill != null) {
-      // Kill message received
-      this.aliveInterval != null && clearInterval(this.aliveInterval)
-      this.emitDestroy()
+    }
+  }
+
+  /**
+   * Notifies the main worker that this worker is ready to process tasks.
+   */
+  protected workerReady (): void {
+    !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
+  }
+
+  /**
+   * Starts the worker alive check interval.
+   */
+  private startCheckAlive (): void {
+    this.lastTaskTimestamp = performance.now()
+    this.aliveInterval = setInterval(
+      this.checkAlive.bind(this),
+      (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
+    )
+    this.checkAlive.bind(this)()
+  }
+
+  /**
+   * Stops the worker alive check interval.
+   */
+  private stopCheckAlive (): void {
+    this.aliveInterval != null && clearInterval(this.aliveInterval)
+  }
+
+  /**
+   * Checks if the worker should be terminated, because its living too long.
+   */
+  private checkAlive (): void {
+    if (
+      performance.now() - this.lastTaskTimestamp >
+      (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
+    ) {
+      this.sendToMainWorker({ kill: this.opts.killBehavior, workerId: this.id })
     }
   }
 
@@ -190,18 +234,6 @@ export abstract class AbstractWorker<
     message: MessageValue<Response, Data>
   ): void
 
-  /**
-   * Checks if the worker should be terminated, because its living too long.
-   */
-  protected checkAlive (): void {
-    if (
-      performance.now() - this.lastTaskTimestamp >
-      (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
-    ) {
-      this.sendToMainWorker({ kill: this.opts.killBehavior })
-    }
-  }
-
   /**
    * Handles an error and convert it to a string so it can be sent back to the main worker.
    *
@@ -209,7 +241,7 @@ export abstract class AbstractWorker<
    * @returns The error message.
    */
   protected handleError (e: Error | string): string {
-    return e as string
+    return e instanceof Error ? e.message : e
   }
 
   /**
@@ -223,7 +255,7 @@ export abstract class AbstractWorker<
     message: MessageValue<Data>
   ): void {
     try {
-      let taskPerformance = this.beginTaskPerformance()
+      let taskPerformance = this.beginTaskPerformance(message.name)
       const res = fn(message.data)
       taskPerformance = this.endTaskPerformance(taskPerformance)
       this.sendToMainWorker({
@@ -233,17 +265,20 @@ export abstract class AbstractWorker<
         id: message.id
       })
     } catch (e) {
-      const err = this.handleError(e as Error)
+      const errorMessage = this.handleError(e as Error | string)
       this.sendToMainWorker({
         taskError: {
-          message: err,
+          name: message.name ?? DEFAULT_TASK_NAME,
+          message: errorMessage,
           data: message.data
         },
         workerId: this.id,
         id: message.id
       })
     } finally {
-      !this.isMain && (this.lastTaskTimestamp = performance.now())
+      if (!this.isMain && this.aliveInterval != null) {
+        this.lastTaskTimestamp = performance.now()
+      }
     }
   }
 
@@ -257,7 +292,7 @@ export abstract class AbstractWorker<
     fn: WorkerAsyncFunction<Data, Response>,
     message: MessageValue<Data>
   ): void {
-    let taskPerformance = this.beginTaskPerformance()
+    let taskPerformance = this.beginTaskPerformance(message.name)
     fn(message.data)
       .then(res => {
         taskPerformance = this.endTaskPerformance(taskPerformance)
@@ -270,10 +305,11 @@ export abstract class AbstractWorker<
         return null
       })
       .catch(e => {
-        const err = this.handleError(e as Error)
+        const errorMessage = this.handleError(e as Error | string)
         this.sendToMainWorker({
           taskError: {
-            message: err,
+            name: message.name ?? DEFAULT_TASK_NAME,
+            message: errorMessage,
             data: message.data
           },
           workerId: this.id,
@@ -281,7 +317,9 @@ export abstract class AbstractWorker<
         })
       })
       .finally(() => {
-        !this.isMain && (this.lastTaskTimestamp = performance.now())
+        if (!this.isMain && this.aliveInterval != null) {
+          this.lastTaskTimestamp = performance.now()
+        }
       })
       .catch(EMPTY_FUNCTION)
   }
@@ -289,10 +327,10 @@ export abstract class AbstractWorker<
   /**
    * Gets the task function in the given scope.
    *
-   * @param name - Name of the function that will be returned.
+   * @param name - Name of the task function that will be returned.
    */
   private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
-    name = name ?? DEFAULT_FUNCTION_NAME
+    name = name ?? DEFAULT_TASK_NAME
     const fn = this.taskFunctions.get(name)
     if (fn == null) {
       throw new Error(`Task function '${name}' not found`)
@@ -300,9 +338,10 @@ export abstract class AbstractWorker<
     return fn
   }
 
-  private beginTaskPerformance (): TaskPerformance {
+  private beginTaskPerformance (name?: string): TaskPerformance {
     this.checkStatistics()
     return {
+      name: name ?? DEFAULT_TASK_NAME,
       timestamp: performance.now(),
       ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
     }