X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=fcdd1bf283971955b8cdb9cc6482856b73516a48;hb=968a2e8ca7bfc81d61b5ffc820a6a76bf44b202f;hp=7805514a7b3b083385b96ac4d26218840b625b31;hpb=d715b7bc2973eed82edebb1f7d233d451ad3c97b;p=poolifier.git

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index 7805514a..fcdd1bf2 100644
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -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
 
@@ -28,14 +32,18 @@ const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
  * Base class that implements some shared logic for all poolifier workers.
  *
  * @typeParam MainWorker - Type of main worker.
- * @typeParam Data - Type of data this worker receives from pool's execution. This can only be serializable data.
- * @typeParam Response - Type of response the worker sends back to the main worker. This can only be serializable data.
+ * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
+ * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
  */
 export abstract class AbstractWorker<
   MainWorker extends Worker | MessagePort,
   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.
    */
@@ -45,13 +53,13 @@ export abstract class AbstractWorker<
    */
   protected lastTaskTimestamp!: number
   /**
-   * Performance statistics computation.
+   * Performance statistics computation requirements.
    */
   protected statistics!: WorkerStatistics
   /**
    * Handler id of the `aliveInterval` worker alive check.
    */
-  protected readonly aliveInterval?: NodeJS.Timeout
+  protected aliveInterval?: NodeJS.Timeout
   /**
    * Constructs a new poolifier worker.
    *
@@ -67,7 +75,7 @@ export abstract class AbstractWorker<
     taskFunctions:
     | WorkerFunction<Data, Response>
     | TaskFunctions<Data, Response>,
-    protected mainWorker: MainWorker | undefined | null,
+    protected readonly mainWorker: MainWorker,
     protected readonly opts: WorkerOptions = {
       /**
        * The kill behavior option on this worker or its default value.
@@ -84,14 +92,8 @@ 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))
     }
-    this.mainWorker?.on('message', this.messageListener.bind(this))
   }
 
   private checkWorkerOptions (opts: WorkerOptions): void {
@@ -116,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)) {
@@ -127,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
         }
       }
@@ -142,71 +144,223 @@ export abstract class AbstractWorker<
   }
 
   /**
-   * Worker message listener.
+   * Checks if the worker has a task function with the given name.
    *
-   * @param message - Message received.
+   * @param name - The name of the task function to check.
+   * @returns Whether the worker has a task function with the given name or not.
+   * @throws {@link TypeError} If the `name` parameter is not a string.
    */
-  protected messageListener (message: MessageValue<Data, MainWorker>): 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)
+  public hasTaskFunction (name: string): boolean {
+    if (typeof name !== 'string') {
+      throw new TypeError('name parameter is not a string')
+    }
+    return this.taskFunctions.has(name)
+  }
+
+  /**
+   * Adds a task function to the worker.
+   * If a task function with the same name already exists, it is replaced.
+   *
+   * @param name - The name of the task function to add.
+   * @param fn - The task function to add.
+   * @returns Whether the task function was added or not.
+   * @throws {@link TypeError} If the `name` parameter is not a string.
+   * @throws {@link Error} If the `name` parameter is the default task function reserved name.
+   * @throws {@link TypeError} If the `fn` parameter is not a function.
+   */
+  public addTaskFunction (
+    name: string,
+    fn: WorkerFunction<Data, Response>
+  ): boolean {
+    if (typeof name !== 'string') {
+      throw new TypeError('name parameter is not a string')
+    }
+    if (name === DEFAULT_TASK_NAME) {
+      throw new Error(
+        'Cannot add a task function with the default reserved name'
+      )
+    }
+    if (typeof fn !== 'function') {
+      throw new TypeError('fn parameter is not a function')
+    }
+    try {
+      if (
+        this.taskFunctions.get(name) ===
+        this.taskFunctions.get(DEFAULT_TASK_NAME)
+      ) {
+        this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this))
       }
-    } else if (message.parent != null) {
-      // Main worker reference message received
-      this.mainWorker = message.parent
-    } else if (message.kill != null) {
-      // Kill message received
-      this.aliveInterval != null && clearInterval(this.aliveInterval)
-      this.emitDestroy()
-    } else if (message.statistics != null) {
-      // Statistics message received
-      this.statistics = message.statistics
+      this.taskFunctions.set(name, fn.bind(this))
+      return true
+    } catch {
+      return false
     }
   }
 
   /**
-   * Returns the main worker.
+   * Removes a task function from the worker.
    *
-   * @returns Reference to the main worker.
+   * @param name - The name of the task function to remove.
+   * @returns Whether the task function existed and was removed or not.
+   * @throws {@link TypeError} If the `name` parameter is not a string.
+   * @throws {@link Error} If the `name` parameter is the default task function reserved name.
+   * @throws {@link Error} If the `name` parameter is the task function used as default task function.
    */
-  protected getMainWorker (): MainWorker {
-    if (this.mainWorker == null) {
-      throw new Error('Main worker was not set')
+  public removeTaskFunction (name: string): boolean {
+    if (typeof name !== 'string') {
+      throw new TypeError('name parameter is not a string')
     }
-    return this.mainWorker
+    if (name === DEFAULT_TASK_NAME) {
+      throw new Error(
+        'Cannot remove the task function with the default reserved name'
+      )
+    }
+    if (
+      this.taskFunctions.get(name) === this.taskFunctions.get(DEFAULT_TASK_NAME)
+    ) {
+      throw new Error(
+        'Cannot remove the task function used as the default task function'
+      )
+    }
+    return this.taskFunctions.delete(name)
   }
 
   /**
-   * Sends a message to the main worker.
+   * Sets the default task function to use when no task function name is specified.
    *
-   * @param message - The response message.
+   * @param name - The name of the task function to use as default task function.
+   * @returns Whether the default task function was set or not.
+   * @throws {@link TypeError} If the `name` parameter is not a string.
+   * @throws {@link Error} If the `name` parameter is the default task function reserved name.
+   * @throws {@link Error} If the `name` parameter is a non-existing task function.
+   */
+  public setDefaultTaskFunction (name: string): boolean {
+    if (typeof name !== 'string') {
+      throw new TypeError('name parameter is not a string')
+    }
+    if (name === DEFAULT_TASK_NAME) {
+      throw new Error(
+        'Cannot set the default task function reserved name as the default task function'
+      )
+    }
+    if (!this.taskFunctions.has(name)) {
+      throw new Error(
+        'Cannot set the default task function to a non-existing task function'
+      )
+    }
+    try {
+      this.taskFunctions.set(
+        DEFAULT_TASK_NAME,
+        this.taskFunctions.get(name)?.bind(this) as WorkerFunction<
+        Data,
+        Response
+        >
+      )
+      return true
+    } catch {
+      return false
+    }
+  }
+
+  /**
+   * Worker message listener.
+   *
+   * @param message - Message received.
    */
-  protected abstract sendToMainWorker (message: MessageValue<Response>): void
+  protected messageListener (message: MessageValue<Data, Data>): void {
+    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()
+      }
+    }
+  }
+
+  /**
+   * 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.
    */
-  protected checkAlive (): void {
+  private checkAlive (): void {
     if (
       performance.now() - this.lastTaskTimestamp >
       (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
     ) {
-      this.sendToMainWorker({ kill: this.opts.killBehavior })
+      this.sendToMainWorker({ kill: this.opts.killBehavior, workerId: this.id })
+    }
+  }
+
+  /**
+   * Returns the main worker.
+   *
+   * @returns Reference to the main worker.
+   */
+  protected getMainWorker (): MainWorker {
+    if (this.mainWorker == null) {
+      throw new Error('Main worker not set')
     }
+    return this.mainWorker
   }
 
+  /**
+   * Sends a message to the main worker.
+   *
+   * @param message - The response message.
+   */
+  protected abstract sendToMainWorker (
+    message: MessageValue<Response, Data>
+  ): void
+
   /**
    * Handles an error and convert it to a string so it can be sent back to the main worker.
    *
    * @param e - The error raised by the worker.
-   * @returns Message of the error.
+   * @returns The error message.
    */
   protected handleError (e: Error | string): string {
-    return e as string
+    return e instanceof Error ? e.message : e
   }
 
   /**
@@ -220,23 +374,30 @@ export abstract class AbstractWorker<
     message: MessageValue<Data>
   ): void {
     try {
-      let taskPerformance = this.beginTaskPerformance(message)
+      let taskPerformance = this.beginTaskPerformance(message.name)
       const res = fn(message.data)
       taskPerformance = this.endTaskPerformance(taskPerformance)
       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({
-        error: err,
-        errorData: message.data,
+        taskError: {
+          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()
+      }
     }
   }
 
@@ -250,27 +411,34 @@ export abstract class AbstractWorker<
     fn: WorkerAsyncFunction<Data, Response>,
     message: MessageValue<Data>
   ): void {
-    let taskPerformance = this.beginTaskPerformance(message)
+    let taskPerformance = this.beginTaskPerformance(message.name)
     fn(message.data)
       .then(res => {
         taskPerformance = this.endTaskPerformance(taskPerformance)
         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({
-          error: err,
-          errorData: message.data,
+          taskError: {
+            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()
+        }
       })
       .catch(EMPTY_FUNCTION)
   }
@@ -278,10 +446,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`)
@@ -289,13 +457,11 @@ export abstract class AbstractWorker<
     return fn
   }
 
-  private beginTaskPerformance (message: MessageValue<Data>): TaskPerformance {
-    const timestamp = performance.now()
+  private beginTaskPerformance (name?: string): TaskPerformance {
+    this.checkStatistics()
     return {
-      timestamp,
-      ...(this.statistics.waitTime && {
-        waitTime: timestamp - (message.timestamp ?? timestamp)
-      }),
+      name: name ?? DEFAULT_TASK_NAME,
+      timestamp: performance.now(),
       ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
     }
   }
@@ -303,6 +469,7 @@ export abstract class AbstractWorker<
   private endTaskPerformance (
     taskPerformance: TaskPerformance
   ): TaskPerformance {
+    this.checkStatistics()
     return {
       ...taskPerformance,
       ...(this.statistics.runTime && {
@@ -313,4 +480,10 @@ export abstract class AbstractWorker<
       })
     }
   }
+
+  private checkStatistics (): void {
+    if (this.statistics == null) {
+      throw new Error('Performance statistics computation requirements not set')
+    }
+  }
 }