X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=ff31fc7cb1879e19435c7942ca34c80b1a5a2051;hb=30369cc0f200d553cfc72fce6e8685c66fa1e344;hp=a431f5a7fb0e9e72771dc848c0245fb775078854;hpb=209d7d1586c12f0c0e6faf58eb51b262464ecc60;p=poolifier.git

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index a431f5a7..ff31fc7c 100644
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -20,11 +20,11 @@ import {
   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
@@ -48,7 +48,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,17 +66,15 @@ 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,
+    private readonly mainWorker: MainWorker,
+    taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
     protected readonly opts: WorkerOptions = {
       /**
        * The kill behavior option on this worker or its default value.
@@ -86,14 +84,18 @@ export abstract class AbstractWorker<
        * 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
+      maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME,
+      /**
+       * The function to call when the worker is killed.
+       */
+      killHandler: EMPTY_FUNCTION
     }
   ) {
     super(type)
     this.checkWorkerOptions(this.opts)
     this.checkTaskFunctions(taskFunctions)
     if (!this.isMain) {
-      this.mainWorker?.on('message', this.messageListener.bind(this))
+      this.getMainWorker()?.on('message', this.handleReadyMessage.bind(this))
     }
   }
 
@@ -101,6 +103,7 @@ export abstract class AbstractWorker<
     this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
     this.opts.maxInactiveTime =
       opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
+    this.opts.killHandler = opts.killHandler ?? EMPTY_FUNCTION
     delete this.opts.async
   }
 
@@ -110,20 +113,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,6 +137,11 @@ 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'
@@ -169,6 +175,9 @@ export abstract class AbstractWorker<
     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')
+    }
     return this.taskFunctions.has(name)
   }
 
@@ -185,11 +194,14 @@ export abstract class AbstractWorker<
    */
   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')
     }
+    if (typeof name === 'string' && name.trim().length === 0) {
+      throw new TypeError('name parameter is an empty string')
+    }
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot add a task function with the default reserved name'
@@ -207,6 +219,7 @@ export abstract class AbstractWorker<
         this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
       }
       this.taskFunctions.set(name, boundFn)
+      this.sendTaskFunctionsListToMainWorker()
       return true
     } catch {
       return false
@@ -226,6 +239,9 @@ export abstract class AbstractWorker<
     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')
+    }
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot remove the task function with the default reserved name'
@@ -238,7 +254,9 @@ 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
   }
 
   /**
@@ -247,7 +265,7 @@ export abstract class AbstractWorker<
    * @returns The names of the worker's task functions.
    */
   public listTaskFunctions (): string[] {
-    return Array.from(this.taskFunctions.keys())
+    return [...this.taskFunctions.keys()]
   }
 
   /**
@@ -263,6 +281,9 @@ export abstract class AbstractWorker<
     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')
+    }
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot set the default task function reserved name as the default task function'
@@ -276,7 +297,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 {
@@ -284,40 +305,73 @@ export abstract class AbstractWorker<
     }
   }
 
+  /**
+   * 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) {
+  protected messageListener (message: MessageValue<Data>): void {
+    if (this.isMain) {
+      throw new Error('Cannot handle message to worker in main worker')
+    } 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}`
+      )
+    } else if (message.workerId === this.id) {
+      if (message.statistics != null) {
         // Statistics message received
         this.statistics = message.statistics
       } else if (message.checkActive != null) {
         // Check active message received
-        !this.isMain && message.checkActive
-          ? this.startCheckActive()
-          : this.stopCheckActive()
-      } else if (message.id != null && message.data != null) {
+        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.isMain && this.stopCheckActive()
-        this.emitDestroy()
+        this.handleKillMessage(message)
       }
     }
   }
 
   /**
-   * Sends the ready response to the main worker.
+   * Handles a kill message sent by the main worker.
+   *
+   * @param message - The kill message.
    */
-  protected sendReadyResponse (): void {
-    !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
+  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()
+      }
+    }
   }
 
   /**
@@ -328,7 +382,7 @@ export abstract class AbstractWorker<
     this.activeInterval = setInterval(
       this.checkActive.bind(this),
       (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
-    ).unref()
+    )
   }
 
   /**
@@ -366,7 +420,7 @@ export abstract class AbstractWorker<
   }
 
   /**
-   * Sends a message to the main worker.
+   * Sends a message to main worker.
    *
    * @param message - The response message.
    */
@@ -374,6 +428,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.
    *
@@ -391,9 +455,6 @@ 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 {
-    if (this.isMain) {
-      throw new Error('Cannot run a task in the main worker')
-    }
     const fn = this.getTaskFunction(task.name)
     if (isAsyncFunction(fn)) {
       this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
@@ -409,7 +470,7 @@ 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 {
     try {
@@ -420,7 +481,7 @@ export abstract class AbstractWorker<
         data: res,
         taskPerformance,
         workerId: this.id,
-        id: task.id
+        taskId: task.taskId
       })
     } catch (e) {
       const errorMessage = this.handleError(e as Error | string)
@@ -431,7 +492,7 @@ export abstract class AbstractWorker<
           data: task.data
         },
         workerId: this.id,
-        id: task.id
+        taskId: task.taskId
       })
     } finally {
       this.updateLastTaskTimestamp()
@@ -445,22 +506,22 @@ 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 => {
+      .then((res) => {
         taskPerformance = this.endTaskPerformance(taskPerformance)
         this.sendToMainWorker({
           data: res,
           taskPerformance,
           workerId: this.id,
-          id: task.id
+          taskId: task.taskId
         })
         return null
       })
-      .catch(e => {
+      .catch((e) => {
         const errorMessage = this.handleError(e as Error | string)
         this.sendToMainWorker({
           taskError: {
@@ -469,7 +530,7 @@ export abstract class AbstractWorker<
             data: task.data
           },
           workerId: this.id,
-          id: task.id
+          taskId: task.taskId
         })
       })
       .finally(() => {
@@ -485,7 +546,7 @@ export abstract class AbstractWorker<
    * @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> {
+  private getTaskFunction (name?: string): TaskFunction<Data, Response> {
     name = name ?? DEFAULT_TASK_NAME
     const fn = this.taskFunctions.get(name)
     if (fn == null) {
@@ -525,7 +586,7 @@ export abstract class AbstractWorker<
   }
 
   private updateLastTaskTimestamp (): void {
-    if (!this.isMain && this.activeInterval != null) {
+    if (this.activeInterval != null) {
       this.lastTaskTimestamp = performance.now()
     }
   }