feat: internal messaging strict worker id checking

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

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index 2a027269f990375f2a1556372a463e5b9f726655..8122f909af89d93e76d5a0c1730e19323b3391da 100644 (file)
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -7,7 +7,7 @@ import type {
   TaskPerformance,
   WorkerStatistics
 } from '../utility-types'
-import { EMPTY_FUNCTION, isPlainObject } from '../utils'
+import { EMPTY_FUNCTION, isAsyncFunction, isPlainObject } from '../utils'
 import {
   type KillBehavior,
   KillBehaviors,
@@ -36,6 +36,10 @@ export abstract class AbstractWorker<
   Data = unknown,
   Response = unknown
 > extends AsyncResource {
+  /**
+   * Worker id.
+   */
+  protected abstract id: number
   /**
    * Task function(s) processed by the worker when the pool's `execution` function is invoked.
    */
@@ -51,7 +55,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.
    *
@@ -84,12 +88,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))
     }
   }
@@ -147,24 +145,72 @@ export abstract class AbstractWorker<
    * @param message - Message received.
    */
   protected messageListener (message: MessageValue<Data, Data>): void {
-    if (message.id != null && message.data != null) {
+    if (message.ready != null && message.workerId === this.id) {
+      // Startup message received
+      this.workerReady()
+    } else if (message.statistics != null && message.workerId === this.id) {
+      // Statistics message received
+      this.statistics = message.statistics
+    } else if (message.checkAlive != null && message.workerId === this.id) {
+      // Check alive message received
+      message.checkAlive ? this.startCheckAlive() : this.stopCheckAlive()
+    } else if (
+      message.id != null &&
+      message.data != null &&
+      message.workerId === this.id
+    ) {
       // Task message received
       const fn = this.getTaskFunction(message.name)
-      if (fn?.constructor.name === 'AsyncFunction') {
+      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.statistics != null) {
-      // Statistics message received
-      this.statistics = message.statistics
-    } else if (message.kill != null) {
+    } else if (message.kill === true && message.workerId === this.id) {
       // Kill message received
-      this.aliveInterval != null && clearInterval(this.aliveInterval)
+      this.stopCheckAlive()
       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 })
+    }
+  }
+
   /**
    * Returns the main worker.
    *
@@ -186,18 +232,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.
    *
@@ -205,7 +239,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
   }
 
   /**
@@ -225,19 +259,23 @@ export abstract class AbstractWorker<
       this.sendToMainWorker({
         data: res,
         taskPerformance,
+        workerId: this.id,
         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,
+          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()
+      }
     }
   }
 
@@ -258,22 +296,26 @@ export abstract class AbstractWorker<
         this.sendToMainWorker({
           data: res,
           taskPerformance,
+          workerId: this.id,
           id: message.id
         })
         return null
       })
       .catch(e => {
-        const err = this.handleError(e as Error)
+        const errorMessage = this.handleError(e as Error | string)
         this.sendToMainWorker({
           taskError: {
-            message: err,
+            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()
+        }
       })
       .catch(EMPTY_FUNCTION)
   }