X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=950738b26f0a47f16f0f1eadd93be5f759a8024d;hb=310de0aa5d5b3887a4de4ef6a0b42e7b7a560987;hp=b7c542aa469f40bf4feb50aa99599b52bb7bc44e;hpb=0ea4c06708c761b6b4bd2f33336df61993672a0c;p=poolifier.git

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index b7c542aa..950738b2 100644
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -1,109 +1,109 @@
 import { AsyncResource } from 'node:async_hooks'
 import type { Worker } from 'node:cluster'
 import type { MessagePort } from 'node:worker_threads'
-import { type EventLoopUtilization, performance } from 'node:perf_hooks'
-import type { MessageValue, WorkerStatistics } from '../utility-types'
-import { EMPTY_FUNCTION, isPlainObject } from '../utils'
+import { performance } from 'node:perf_hooks'
+import type {
+  MessageValue,
+  Task,
+  TaskPerformance,
+  WorkerStatistics
+} from '../utility-types'
+import {
+  DEFAULT_TASK_NAME,
+  EMPTY_FUNCTION,
+  isAsyncFunction,
+  isPlainObject
+} from '../utils'
 import {
   type KillBehavior,
   KillBehaviors,
   type WorkerOptions
 } from './worker-options'
 import type {
+  TaskAsyncFunction,
+  TaskFunction,
   TaskFunctions,
-  WorkerAsyncFunction,
-  WorkerFunction,
-  WorkerSyncFunction
-} from './worker-functions'
+  TaskSyncFunction
+} from './task-functions'
 
-const DEFAULT_FUNCTION_NAME = 'default'
 const DEFAULT_MAX_INACTIVE_TIME = 60000
 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
 
-/**
- * Task performance.
- */
-export interface TaskPerformance {
-  timestamp: number
-  waitTime?: number
-  runTime?: number
-  elu?: EventLoopUtilization
-}
-
 /**
  * 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.
    */
-  protected taskFunctions!: Map<string, WorkerFunction<Data, Response>>
+  protected taskFunctions!: Map<string, TaskFunction<Data, Response>>
   /**
    * Timestamp of the last task processed by this worker.
    */
   protected lastTaskTimestamp!: number
   /**
-   * Performance statistics computation.
+   * Performance statistics computation requirements.
    */
   protected statistics!: WorkerStatistics
   /**
-   * Handler id of the `aliveInterval` worker alive check.
+   * Handler id of the `activeInterval` worker activity check.
    */
-  protected readonly aliveInterval?: NodeJS.Timeout
+  protected activeInterval?: NodeJS.Timeout
   /**
    * Constructs a new poolifier worker.
    *
    * @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 mainWorker: MainWorker | undefined | null,
+    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.
        */
       killBehavior: DEFAULT_KILL_BEHAVIOR,
       /**
-       * The maximum time to keep this worker alive while idle.
+       * 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.lastTaskTimestamp = performance.now()
-      this.aliveInterval = setInterval(
-        this.checkAlive.bind(this),
-        (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
-      )
-      this.checkAlive.bind(this)()
+      this.getMainWorker()?.on('message', this.handleReadyMessage.bind(this))
     }
-    this.mainWorker?.on('message', this.messageListener.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.killHandler = opts.killHandler ?? EMPTY_FUNCTION
     delete this.opts.async
   }
 
@@ -113,29 +113,46 @@ 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') {
-      this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
+      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
+          : 'fn1',
+        boundFn
+      )
     } else if (isPlainObject(taskFunctions)) {
       let firstEntry = true
       for (const [name, fn] of Object.entries(taskFunctions)) {
+        if (typeof name !== 'string') {
+          throw new TypeError(
+            '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'
           )
         }
-        this.taskFunctions.set(name, fn.bind(this))
+        const boundFn = fn.bind(this)
         if (firstEntry) {
-          this.taskFunctions.set(DEFAULT_FUNCTION_NAME, fn.bind(this))
+          this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
           firstEntry = false
         }
+        this.taskFunctions.set(name, boundFn)
       }
       if (firstEntry) {
         throw new Error('taskFunctions parameter object is empty')
@@ -148,29 +165,246 @@ 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 https://nodejs.org/api/errors.html#class-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')
+    }
+    if (typeof name === 'string' && name.trim().length === 0) {
+      throw new TypeError('name parameter is an empty 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 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-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: 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'
+      )
+    }
+    if (typeof fn !== 'function') {
+      throw new TypeError('fn parameter is not a function')
+    }
+    try {
+      const boundFn = fn.bind(this)
+      if (
+        this.taskFunctions.get(name) ===
+        this.taskFunctions.get(DEFAULT_TASK_NAME)
+      ) {
+        this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
       }
-    } 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) {
+      this.taskFunctions.set(name, boundFn)
+      this.sendTaskFunctionsListToMainWorker()
+      return true
+    } catch {
+      return false
+    }
+  }
+
+  /**
+   * Removes a task function from the worker.
+   *
+   * @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-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')
+    }
+    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'
+      )
+    }
+    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'
+      )
+    }
+    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[] {
+    return [...this.taskFunctions.keys()]
+  }
+
+  /**
+   * 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-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')
+    }
+    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'
+      )
+    }
+    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) as TaskFunction<Data, Response>
+      )
+      return true
+    } catch {
+      return false
+    }
+  }
+
+  /**
+   * 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>): void {
+    if (this.isMain) {
+      throw new Error('Cannot handle message to worker in main worker')
+    } else 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}`
+      )
+    }
+    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()
+      }
+    }
+  }
+
+  /**
+   * Starts the worker check active interval.
+   */
+  private startCheckActive (): void {
+    this.lastTaskTimestamp = performance.now()
+    this.activeInterval = setInterval(
+      this.checkActive.bind(this),
+      (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
+    )
+  }
+
+  /**
+   * Stops the worker check active interval.
+   */
+  private stopCheckActive (): void {
+    if (this.activeInterval != null) {
+      clearInterval(this.activeInterval)
+      delete this.activeInterval
+    }
+  }
+
+  /**
+   * Checks if the worker should be terminated, because its living too long.
+   */
+  private checkActive (): void {
+    if (
+      performance.now() - this.lastTaskTimestamp >
+      (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
+    ) {
+      this.sendToMainWorker({ kill: this.opts.killBehavior, workerId: this.id })
     }
   }
 
@@ -181,119 +415,142 @@ export abstract class AbstractWorker<
    */
   protected getMainWorker (): MainWorker {
     if (this.mainWorker == null) {
-      throw new Error('Main worker was not set')
+      throw new Error('Main worker not set')
     }
     return this.mainWorker
   }
 
   /**
-   * Sends a message to the main worker.
+   * Sends a message to main worker.
    *
    * @param message - The response message.
    */
-  protected abstract sendToMainWorker (message: MessageValue<Response>): void
+  protected abstract sendToMainWorker (
+    message: MessageValue<Response, Data>
+  ): void
 
   /**
-   * Checks if the worker should be terminated, because its living too long.
+   * Sends the list of task function names to the main worker.
    */
-  protected checkAlive (): void {
-    if (
-      performance.now() - this.lastTaskTimestamp >
-      (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
-    ) {
-      this.sendToMainWorker({ kill: this.opts.killBehavior })
-    }
+  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.
    *
    * @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
+  }
+
+  /**
+   * Runs the given task.
+   *
+   * @param task - The task to execute.
+   * @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)
+    if (isAsyncFunction(fn)) {
+      this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
+    } else {
+      this.runInAsyncScope(this.runSync.bind(this), this, fn, task)
+    }
   }
 
   /**
-   * Runs the given function synchronously.
+   * Runs the given task function synchronously.
    *
-   * @param fn - Function that will be executed.
-   * @param message - Input data for the given function.
+   * @param fn - Task function that will be executed.
+   * @param task - Input data for the task function.
    */
   protected runSync (
-    fn: WorkerSyncFunction<Data, Response>,
-    message: MessageValue<Data>
+    fn: TaskSyncFunction<Data, Response>,
+    task: Task<Data>
   ): void {
+    const { name, taskId, data } = task
     try {
-      const taskPerformance = this.beginTaskPerformance(message)
-      const res = fn(message.data)
-      const { runTime, waitTime, elu } =
-        this.endTaskPerformance(taskPerformance)
+      let taskPerformance = this.beginTaskPerformance(name)
+      const res = fn(data)
+      taskPerformance = this.endTaskPerformance(taskPerformance)
       this.sendToMainWorker({
         data: res,
-        runTime,
-        waitTime,
-        elu,
-        id: message.id
+        taskPerformance,
+        workerId: this.id,
+        taskId
       })
     } catch (e) {
-      const err = this.handleError(e as Error)
+      const errorMessage = this.handleError(e as Error | string)
       this.sendToMainWorker({
-        error: err,
-        errorData: message.data,
-        id: message.id
+        taskError: {
+          name: name ?? DEFAULT_TASK_NAME,
+          message: errorMessage,
+          data
+        },
+        workerId: this.id,
+        taskId
       })
     } finally {
-      !this.isMain && (this.lastTaskTimestamp = performance.now())
+      this.updateLastTaskTimestamp()
     }
   }
 
   /**
-   * Runs the given function asynchronously.
+   * Runs the given task function asynchronously.
    *
-   * @param fn - Function that will be executed.
-   * @param message - Input data for the given function.
+   * @param fn - Task function that will be executed.
+   * @param task - Input data for the task function.
    */
   protected runAsync (
-    fn: WorkerAsyncFunction<Data, Response>,
-    message: MessageValue<Data>
+    fn: TaskAsyncFunction<Data, Response>,
+    task: Task<Data>
   ): void {
-    const taskPerformance = this.beginTaskPerformance(message)
-    fn(message.data)
-      .then(res => {
-        const { runTime, waitTime, elu } =
-          this.endTaskPerformance(taskPerformance)
+    const { name, taskId, data } = task
+    let taskPerformance = this.beginTaskPerformance(name)
+    fn(data)
+      .then((res) => {
+        taskPerformance = this.endTaskPerformance(taskPerformance)
         this.sendToMainWorker({
           data: res,
-          runTime,
-          waitTime,
-          elu,
-          id: message.id
+          taskPerformance,
+          workerId: this.id,
+          taskId
         })
         return null
       })
-      .catch(e => {
-        const err = this.handleError(e as Error)
+      .catch((e) => {
+        const errorMessage = this.handleError(e as Error | string)
         this.sendToMainWorker({
-          error: err,
-          errorData: message.data,
-          id: message.id
+          taskError: {
+            name: name ?? DEFAULT_TASK_NAME,
+            message: errorMessage,
+            data
+          },
+          workerId: this.id,
+          taskId
         })
       })
       .finally(() => {
-        !this.isMain && (this.lastTaskTimestamp = performance.now())
+        this.updateLastTaskTimestamp()
       })
       .catch(EMPTY_FUNCTION)
   }
 
   /**
-   * Gets the task function in the given scope.
+   * Gets the task function with the given name.
    *
-   * @param name - Name of the function that will be returned.
+   * @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_FUNCTION_NAME
+  private getTaskFunction (name?: string): TaskFunction<Data, Response> {
+    name = name ?? DEFAULT_TASK_NAME
     const fn = this.taskFunctions.get(name)
     if (fn == null) {
       throw new Error(`Task function '${name}' not found`)
@@ -301,13 +558,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() })
     }
   }
@@ -315,6 +570,7 @@ export abstract class AbstractWorker<
   private endTaskPerformance (
     taskPerformance: TaskPerformance
   ): TaskPerformance {
+    this.checkStatistics()
     return {
       ...taskPerformance,
       ...(this.statistics.runTime && {
@@ -325,4 +581,16 @@ export abstract class AbstractWorker<
       })
     }
   }
+
+  private checkStatistics (): void {
+    if (this.statistics == null) {
+      throw new Error('Performance statistics computation requirements not set')
+    }
+  }
+
+  private updateLastTaskTimestamp (): void {
+    if (this.activeInterval != null) {
+      this.lastTaskTimestamp = performance.now()
+    }
+  }
 }