X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=033ed2a5e663fbcd7c88b4317adc240e20b2d298;hb=9d2d0da193405976471817f6b0d048006bd01418;hp=1b8a673c2a78d461288bc6c4f30fa8eb5a942285;hpb=2a69b8c50a10229de607013f867d685ee594dba9;p=poolifier.git

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index 1b8a673c..033ed2a5 100644
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -14,20 +14,30 @@ import {
   isAsyncFunction,
   isPlainObject
 } from '../utils'
-import {
-  type KillBehavior,
-  KillBehaviors,
-  type WorkerOptions
-} from './worker-options'
+import { KillBehaviors, type WorkerOptions } from './worker-options'
 import type {
+  TaskAsyncFunction,
+  TaskFunction,
   TaskFunctions,
-  WorkerAsyncFunction,
-  WorkerFunction,
-  WorkerSyncFunction
-} from './worker-functions'
+  TaskSyncFunction
+} from './task-functions'
 
 const DEFAULT_MAX_INACTIVE_TIME = 60000
-const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
+const DEFAULT_WORKER_OPTIONS: WorkerOptions = {
+  /**
+   * The kill behavior option on this worker or its default value.
+   */
+  killBehavior: KillBehaviors.SOFT,
+  /**
+   * The maximum time to keep this worker active while idle.
+   * The pool automatically checks and terminates this worker when the time expires.
+   */
+  maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME,
+  /**
+   * The function to call when the worker is killed.
+   */
+  killHandler: EMPTY_FUNCTION
+}
 
 /**
  * Base class that implements some shared logic for all poolifier workers.
@@ -48,7 +58,7 @@ export abstract class AbstractWorker<
   /**
    * Task function(s) processed by the worker when the pool's `execution` function is invoked.
    */
-  protected taskFunctions!: Map<string, WorkerFunction<Data, Response>>
+  protected taskFunctions!: Map<string, TaskFunction<Data, Response>>
   /**
    * Timestamp of the last task processed by this worker.
    */
@@ -66,41 +76,30 @@ export abstract class AbstractWorker<
    *
    * @param type - The type of async event.
    * @param isMain - Whether this is the main worker or not.
-   * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function.
    * @param mainWorker - Reference to main worker.
+   * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function.
    * @param opts - Options for the worker.
    */
   public constructor (
     type: string,
     protected readonly isMain: boolean,
-    taskFunctions:
-    | WorkerFunction<Data, Response>
-    | TaskFunctions<Data, Response>,
-    protected readonly mainWorker: MainWorker,
-    protected readonly opts: WorkerOptions = {
-      /**
-       * The kill behavior option on this worker or its default value.
-       */
-      killBehavior: DEFAULT_KILL_BEHAVIOR,
-      /**
-       * The maximum time to keep this worker active while idle.
-       * The pool automatically checks and terminates this worker when the time expires.
-       */
-      maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME
-    }
+    private readonly mainWorker: MainWorker,
+    taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
+    protected opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
   ) {
     super(type)
-    this.checkWorkerOptions(this.opts)
+    if (this.isMain == null) {
+      throw new Error('isMain parameter is mandatory')
+    }
     this.checkTaskFunctions(taskFunctions)
+    this.checkWorkerOptions(this.opts)
     if (!this.isMain) {
-      this.mainWorker?.on('message', this.messageListener.bind(this))
+      this.getMainWorker().on('message', this.handleReadyMessage.bind(this))
     }
   }
 
   private checkWorkerOptions (opts: WorkerOptions): void {
-    this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
-    this.opts.maxInactiveTime =
-      opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
+    this.opts = { ...DEFAULT_WORKER_OPTIONS, ...opts }
     delete this.opts.async
   }
 
@@ -110,20 +109,18 @@ export abstract class AbstractWorker<
    * @param taskFunctions - The task function(s) parameter that should be checked.
    */
   private checkTaskFunctions (
-    taskFunctions:
-    | WorkerFunction<Data, Response>
-    | TaskFunctions<Data, Response>
+    taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
   ): void {
     if (taskFunctions == null) {
       throw new Error('taskFunctions parameter is mandatory')
     }
-    this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
+    this.taskFunctions = new Map<string, TaskFunction<Data, Response>>()
     if (typeof taskFunctions === 'function') {
       const boundFn = taskFunctions.bind(this)
       this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
       this.taskFunctions.set(
         typeof taskFunctions.name === 'string' &&
-          taskFunctions.name.trim().length > 0
+        taskFunctions.name.trim().length > 0
           ? taskFunctions.name
           : 'fn1',
         boundFn
@@ -136,17 +133,22 @@ export abstract class AbstractWorker<
             'A taskFunctions parameter object key is not a string'
           )
         }
+        if (typeof name === 'string' && name.trim().length === 0) {
+          throw new TypeError(
+            'A taskFunctions parameter object key an empty string'
+          )
+        }
         if (typeof fn !== 'function') {
           throw new TypeError(
             'A taskFunctions parameter object value is not a function'
           )
         }
         const boundFn = fn.bind(this)
-        this.taskFunctions.set(name, boundFn)
         if (firstEntry) {
           this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
           firstEntry = false
         }
+        this.taskFunctions.set(name, boundFn)
       }
       if (firstEntry) {
         throw new Error('taskFunctions parameter object is empty')
@@ -163,12 +165,10 @@ export abstract class AbstractWorker<
    *
    * @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 https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
+   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
    */
   public hasTaskFunction (name: string): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
+    this.checkTaskFunctionName(name)
     return this.taskFunctions.has(name)
   }
 
@@ -179,17 +179,15 @@ export abstract class AbstractWorker<
    * @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 https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
+   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
    * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function.
    */
   public addTaskFunction (
     name: string,
-    fn: WorkerFunction<Data, Response>
+    fn: TaskFunction<Data, Response>
   ): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
+    this.checkTaskFunctionName(name)
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot add a task function with the default reserved name'
@@ -198,8 +196,8 @@ export abstract class AbstractWorker<
     if (typeof fn !== 'function') {
       throw new TypeError('fn parameter is not a function')
     }
-    const boundFn = fn.bind(this)
     try {
+      const boundFn = fn.bind(this)
       if (
         this.taskFunctions.get(name) ===
         this.taskFunctions.get(DEFAULT_TASK_NAME)
@@ -207,6 +205,7 @@ export abstract class AbstractWorker<
         this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
       }
       this.taskFunctions.set(name, boundFn)
+      this.sendTaskFunctionsListToMainWorker()
       return true
     } catch {
       return false
@@ -218,14 +217,12 @@ export abstract class AbstractWorker<
    *
    * @param name - The name of the task function to remove.
    * @returns Whether the task function existed and was removed or not.
-   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
+   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the task function used as default task function.
    */
   public removeTaskFunction (name: string): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
+    this.checkTaskFunctionName(name)
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot remove the task function with the default reserved name'
@@ -238,22 +235,48 @@ export abstract class AbstractWorker<
         'Cannot remove the task function used as the default task function'
       )
     }
-    return this.taskFunctions.delete(name)
+    const deleteStatus = this.taskFunctions.delete(name)
+    this.sendTaskFunctionsListToMainWorker()
+    return deleteStatus
+  }
+
+  /**
+   * Lists the names of the worker's task functions.
+   *
+   * @returns The names of the worker's task functions.
+   */
+  public listTaskFunctions (): string[] {
+    const names: string[] = [...this.taskFunctions.keys()]
+    let defaultTaskFunctionName: string = DEFAULT_TASK_NAME
+    for (const [name, fn] of this.taskFunctions) {
+      if (
+        name !== DEFAULT_TASK_NAME &&
+        fn === this.taskFunctions.get(DEFAULT_TASK_NAME)
+      ) {
+        defaultTaskFunctionName = name
+        break
+      }
+    }
+    return [
+      names[names.indexOf(DEFAULT_TASK_NAME)],
+      defaultTaskFunctionName,
+      ...names.filter(
+        (name) => name !== DEFAULT_TASK_NAME && name !== defaultTaskFunctionName
+      )
+    ]
   }
 
   /**
-   * Sets the default task function to use when no task function name is specified.
+   * Sets the default task function to use in the worker.
    *
    * @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 https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string.
+   * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
    * @throws {@link https://nodejs.org/api/errors.html#class-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')
-    }
+    this.checkTaskFunctionName(name)
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot set the default task function reserved name as the default task function'
@@ -267,7 +290,7 @@ export abstract class AbstractWorker<
     try {
       this.taskFunctions.set(
         DEFAULT_TASK_NAME,
-        this.taskFunctions.get(name) as WorkerFunction<Data, Response>
+        this.taskFunctions.get(name) as TaskFunction<Data, Response>
       )
       return true
     } catch {
@@ -275,38 +298,91 @@ export abstract class AbstractWorker<
     }
   }
 
+  private checkTaskFunctionName (name: string): void {
+    if (typeof name !== 'string') {
+      throw new TypeError('name parameter is not a string')
+    }
+    if (typeof name === 'string' && name.trim().length === 0) {
+      throw new TypeError('name parameter is an empty string')
+    }
+  }
+
+  /**
+   * Handles the ready message sent by the main worker.
+   *
+   * @param message - The ready message.
+   */
+  protected abstract handleReadyMessage (message: MessageValue<Data>): void
+
   /**
    * Worker message listener.
    *
    * @param message - The received message.
    */
-  protected messageListener (message: MessageValue<Data, Data>): void {
-    if (message.workerId === this.id) {
-      if (message.ready != null) {
-        // Startup message received
-        this.sendReadyResponse()
-      } else if (message.statistics != null) {
-        // Statistics message received
-        this.statistics = message.statistics
-      } else if (message.checkActive != null) {
-        // Check active message received
-        message.checkActive ? this.startCheckActive() : this.stopCheckActive()
-      } else if (message.id != null && message.data != null) {
-        // Task message received
-        this.run(message)
-      } else if (message.kill === true) {
-        // Kill message received
-        this.stopCheckActive()
+  protected messageListener (message: MessageValue<Data>): void {
+    this.checkMessageWorkerId(message)
+    if (message.statistics != null) {
+      // Statistics message received
+      this.statistics = message.statistics
+    } else if (message.checkActive != null) {
+      // Check active message received
+      message.checkActive ? this.startCheckActive() : this.stopCheckActive()
+    } else if (message.taskId != null && message.data != null) {
+      // Task message received
+      this.run(message)
+    } else if (message.kill === true) {
+      // Kill message received
+      this.handleKillMessage(message)
+    }
+  }
+
+  /**
+   * Handles a kill message sent by the main worker.
+   *
+   * @param message - The kill message.
+   */
+  protected handleKillMessage (message: MessageValue<Data>): void {
+    this.stopCheckActive()
+    if (isAsyncFunction(this.opts.killHandler)) {
+      (this.opts.killHandler?.() as Promise<void>)
+        .then(() => {
+          this.sendToMainWorker({ kill: 'success', workerId: this.id })
+          return null
+        })
+        .catch(() => {
+          this.sendToMainWorker({ kill: 'failure', workerId: this.id })
+        })
+        .finally(() => {
+          this.emitDestroy()
+        })
+        .catch(EMPTY_FUNCTION)
+    } else {
+      try {
+        // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+        this.opts.killHandler?.() as void
+        this.sendToMainWorker({ kill: 'success', workerId: this.id })
+      } catch {
+        this.sendToMainWorker({ kill: 'failure', workerId: this.id })
+      } finally {
         this.emitDestroy()
       }
     }
   }
 
   /**
-   * Sends the ready response to the main worker.
+   * Check if the message worker id is set and matches the worker id.
+   *
+   * @param message - The message to check.
+   * @throws {@link https://nodejs.org/api/errors.html#class-error} If the message worker id is not set or does not match the worker id.
    */
-  protected sendReadyResponse (): void {
-    !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
+  private checkMessageWorkerId (message: MessageValue<Data>): void {
+    if (message.workerId == null) {
+      throw new Error('Message worker id is not set')
+    } else if (message.workerId != null && message.workerId !== this.id) {
+      throw new Error(
+        `Message worker id ${message.workerId} does not match the worker id ${this.id}`
+      )
+    }
   }
 
   /**
@@ -324,7 +400,10 @@ export abstract class AbstractWorker<
    * Stops the worker check active interval.
    */
   private stopCheckActive (): void {
-    this.activeInterval != null && clearInterval(this.activeInterval)
+    if (this.activeInterval != null) {
+      clearInterval(this.activeInterval)
+      delete this.activeInterval
+    }
   }
 
   /**
@@ -352,7 +431,7 @@ export abstract class AbstractWorker<
   }
 
   /**
-   * Sends a message to the main worker.
+   * Sends a message to main worker.
    *
    * @param message - The response message.
    */
@@ -360,6 +439,16 @@ export abstract class AbstractWorker<
     message: MessageValue<Response, Data>
   ): void
 
+  /**
+   * Sends the list of task function names to the main worker.
+   */
+  protected sendTaskFunctionsListToMainWorker (): void {
+    this.sendToMainWorker({
+      taskFunctions: this.listTaskFunctions(),
+      workerId: this.id
+    })
+  }
+
   /**
    * Handles an error and convert it to a string so it can be sent back to the main worker.
    *
@@ -377,7 +466,20 @@ export abstract class AbstractWorker<
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
    */
   protected run (task: Task<Data>): void {
-    const fn = this.getTaskFunction(task.name)
+    const { name, taskId, data } = task
+    const fn = this.taskFunctions.get(name ?? DEFAULT_TASK_NAME)
+    if (fn == null) {
+      this.sendToMainWorker({
+        taskError: {
+          name: name as string,
+          message: `Task function '${name as string}' not found`,
+          data
+        },
+        workerId: this.id,
+        taskId
+      })
+      return
+    }
     if (isAsyncFunction(fn)) {
       this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
     } else {
@@ -392,34 +494,33 @@ export abstract class AbstractWorker<
    * @param task - Input data for the task function.
    */
   protected runSync (
-    fn: WorkerSyncFunction<Data, Response>,
+    fn: TaskSyncFunction<Data, Response>,
     task: Task<Data>
   ): void {
+    const { name, taskId, data } = task
     try {
-      let taskPerformance = this.beginTaskPerformance(task.name)
-      const res = fn(task.data)
+      let taskPerformance = this.beginTaskPerformance(name)
+      const res = fn(data)
       taskPerformance = this.endTaskPerformance(taskPerformance)
       this.sendToMainWorker({
         data: res,
         taskPerformance,
         workerId: this.id,
-        id: task.id
+        taskId
       })
     } catch (e) {
       const errorMessage = this.handleError(e as Error | string)
       this.sendToMainWorker({
         taskError: {
-          name: task.name ?? DEFAULT_TASK_NAME,
+          name: name as string,
           message: errorMessage,
-          data: task.data
+          data
         },
         workerId: this.id,
-        id: task.id
+        taskId
       })
     } finally {
-      if (!this.isMain && this.activeInterval != null) {
-        this.lastTaskTimestamp = performance.now()
-      }
+      this.updateLastTaskTimestamp()
     }
   }
 
@@ -430,57 +531,40 @@ export abstract class AbstractWorker<
    * @param task - Input data for the task function.
    */
   protected runAsync (
-    fn: WorkerAsyncFunction<Data, Response>,
+    fn: TaskAsyncFunction<Data, Response>,
     task: Task<Data>
   ): void {
-    let taskPerformance = this.beginTaskPerformance(task.name)
-    fn(task.data)
-      .then(res => {
+    const { name, taskId, data } = task
+    let taskPerformance = this.beginTaskPerformance(name)
+    fn(data)
+      .then((res) => {
         taskPerformance = this.endTaskPerformance(taskPerformance)
         this.sendToMainWorker({
           data: res,
           taskPerformance,
           workerId: this.id,
-          id: task.id
+          taskId
         })
         return null
       })
-      .catch(e => {
+      .catch((e) => {
         const errorMessage = this.handleError(e as Error | string)
         this.sendToMainWorker({
           taskError: {
-            name: task.name ?? DEFAULT_TASK_NAME,
+            name: name as string,
             message: errorMessage,
-            data: task.data
+            data
           },
           workerId: this.id,
-          id: task.id
+          taskId
         })
       })
       .finally(() => {
-        if (!this.isMain && this.activeInterval != null) {
-          this.lastTaskTimestamp = performance.now()
-        }
+        this.updateLastTaskTimestamp()
       })
       .catch(EMPTY_FUNCTION)
   }
 
-  /**
-   * Gets the task function with the given name.
-   *
-   * @param name - Name of the task function that will be returned.
-   * @returns The task function.
-   * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
-   */
-  private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
-    name = name ?? DEFAULT_TASK_NAME
-    const fn = this.taskFunctions.get(name)
-    if (fn == null) {
-      throw new Error(`Task function '${name}' not found`)
-    }
-    return fn
-  }
-
   private beginTaskPerformance (name?: string): TaskPerformance {
     this.checkStatistics()
     return {
@@ -510,4 +594,10 @@ export abstract class AbstractWorker<
       throw new Error('Performance statistics computation requirements not set')
     }
   }
+
+  private updateLastTaskTimestamp (): void {
+    if (this.activeInterval != null) {
+      this.lastTaskTimestamp = performance.now()
+    }
+  }
 }