X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=93a36bad382fe5781f35d73b71a8169510b818ac;hb=8e5ca0401467b0a5c40b20a40ef08db6c05b9561;hp=475595eccf5f2e2c85b4eac8ba251f306f472c5d;hpb=d99ba5a8a292772965b5027272a8dc677a6ad008;p=poolifier.git

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index 475595ec..93a36bad 100644
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -1,10 +1,30 @@
 import { AsyncResource } from 'node:async_hooks'
 import type { Worker } from 'node:cluster'
 import type { MessagePort } from 'node:worker_threads'
-import type { MessageValue } from '../utility-types'
-import { EMPTY_FUNCTION } from '../utils'
-import type { KillBehavior, WorkerOptions } from './worker-options'
-import { KillBehaviors } from './worker-options'
+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 {
+  TaskFunctions,
+  WorkerAsyncFunction,
+  WorkerFunction,
+  WorkerSyncFunction
+} from './worker-functions'
 
 const DEFAULT_MAX_INACTIVE_TIME = 60000
 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
@@ -13,39 +33,53 @@ 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.
+   */
+  protected taskFunctions!: Map<string, WorkerFunction<Data, Response>>
   /**
    * Timestamp of the last task processed by this worker.
    */
   protected lastTaskTimestamp!: number
   /**
-   * Handler Id of the `aliveInterval` worker alive check.
+   * Performance statistics computation requirements.
    */
-  protected readonly aliveInterval?: NodeJS.Timeout
+  protected statistics!: WorkerStatistics
+  /**
+   * Handler id of the `aliveInterval` worker alive check.
+   */
+  protected aliveInterval?: 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 fn - Function processed by the worker when the pool's `execution` function is invoked.
+   * @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 opts - Options for the worker.
    */
   public constructor (
     type: string,
     protected readonly isMain: boolean,
-    fn: (data: Data) => Response,
-    protected mainWorker: MainWorker | undefined | null,
+    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.
+       * The kill behavior option on this worker or its default value.
        */
       killBehavior: DEFAULT_KILL_BEHAVIOR,
       /**
@@ -56,151 +90,418 @@ export abstract class AbstractWorker<
     }
   ) {
     super(type)
-    this.checkFunctionInput(fn)
     this.checkWorkerOptions(this.opts)
+    this.checkTaskFunctions(taskFunctions)
     if (!this.isMain) {
-      this.lastTaskTimestamp = Date.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', (value: MessageValue<Data, MainWorker>) => {
-      this.messageListener(value, fn)
-    })
+  private checkWorkerOptions (opts: WorkerOptions): void {
+    this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
+    this.opts.maxInactiveTime =
+      opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
+    delete this.opts.async
   }
 
-  protected messageListener (
-    value: MessageValue<Data, MainWorker>,
-    fn: (data: Data) => Response
+  /**
+   * Checks if the `taskFunctions` parameter is passed to the constructor.
+   *
+   * @param taskFunctions - The task function(s) parameter that should be checked.
+   */
+  private checkTaskFunctions (
+    taskFunctions:
+    | WorkerFunction<Data, Response>
+    | TaskFunctions<Data, Response>
   ): void {
-    if (value.data != null && value.id != null) {
-      // Here you will receive messages
-      if (this.opts.async === true) {
-        this.runInAsyncScope(this.runAsync.bind(this), this, fn, value)
-      } else {
-        this.runInAsyncScope(this.run.bind(this), this, fn, value)
+    if (taskFunctions == null) {
+      throw new Error('taskFunctions parameter is mandatory')
+    }
+    this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
+    if (typeof taskFunctions === 'function') {
+      this.taskFunctions.set(DEFAULT_TASK_NAME, taskFunctions.bind(this))
+    } 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 fn !== 'function') {
+          throw new TypeError(
+            'A taskFunctions parameter object value is not a function'
+          )
+        }
+        this.taskFunctions.set(name, fn.bind(this))
+        if (firstEntry) {
+          this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this))
+          firstEntry = false
+        }
+      }
+      if (firstEntry) {
+        throw new Error('taskFunctions parameter object is empty')
       }
-    } else if (value.parent != null) {
-      // Save a reference of the main worker to communicate with it
-      // This will be received once
-      this.mainWorker = value.parent
-    } else if (value.kill != null) {
-      // Here is time to kill this worker, just clearing the interval
-      this.aliveInterval != null && clearInterval(this.aliveInterval)
-      this.emitDestroy()
+    } else {
+      throw new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     }
   }
 
-  private checkWorkerOptions (opts: WorkerOptions): void {
-    this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
-    this.opts.maxInactiveTime =
-      opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
-    this.opts.async = opts.async ?? false
+  /**
+   * Checks if the worker has a task function with the given name.
+   *
+   * @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.
+   */
+  public hasTaskFunction (name: string): boolean {
+    if (typeof name !== 'string') {
+      throw new TypeError('name parameter is not a string')
+    }
+    return this.taskFunctions.has(name)
   }
 
   /**
-   * Checks if the `fn` parameter is passed to the constructor.
+   * Adds a task function to the worker.
+   * If a task function with the same name already exists, it is replaced.
    *
-   * @param fn - The function that should be defined.
+   * @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.
    */
-  private checkFunctionInput (fn: (data: Data) => Response): void {
-    if (fn == null) throw new Error('fn parameter is mandatory')
+  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))
+      }
+      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 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.
    */
-  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 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.
    */
-  protected abstract sendToMainWorker (message: MessageValue<Response>): void
+  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 - The received message.
+   */
+  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
+        this.run(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 aliveness 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 aliveness 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 (
-      Date.now() - this.lastTaskTimestamp >
+      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
+  }
+
+  /**
+   * 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 value - Input data for the given function.
+   * @param fn - Task function that will be executed.
+   * @param task - Input data for the task function.
    */
-  protected run (
-    fn: (data?: Data) => Response,
-    value: MessageValue<Data>
+  protected runSync (
+    fn: WorkerSyncFunction<Data, Response>,
+    task: Task<Data>
   ): void {
     try {
-      const startTaskTimestamp = Date.now()
-      const res = fn(value.data)
-      const taskRunTime = Date.now() - startTaskTimestamp
-      this.sendToMainWorker({ data: res, id: value.id, taskRunTime })
+      let taskPerformance = this.beginTaskPerformance(task.name)
+      const res = fn(task.data)
+      taskPerformance = this.endTaskPerformance(taskPerformance)
+      this.sendToMainWorker({
+        data: res,
+        taskPerformance,
+        workerId: this.id,
+        id: task.id
+      })
     } catch (e) {
-      const err = this.handleError(e as Error)
-      this.sendToMainWorker({ error: err, id: value.id })
+      const errorMessage = this.handleError(e as Error | string)
+      this.sendToMainWorker({
+        taskError: {
+          name: task.name ?? DEFAULT_TASK_NAME,
+          message: errorMessage,
+          data: task.data
+        },
+        workerId: this.id,
+        id: task.id
+      })
     } finally {
-      !this.isMain && (this.lastTaskTimestamp = Date.now())
+      if (!this.isMain && this.aliveInterval != null) {
+        this.lastTaskTimestamp = performance.now()
+      }
     }
   }
 
   /**
-   * Runs the given function asynchronously.
+   * Runs the given task function asynchronously.
    *
-   * @param fn - Function that will be executed.
-   * @param value - 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: (data?: Data) => Promise<Response>,
-    value: MessageValue<Data>
+    fn: WorkerAsyncFunction<Data, Response>,
+    task: Task<Data>
   ): void {
-    const startTaskTimestamp = Date.now()
-    fn(value.data)
+    let taskPerformance = this.beginTaskPerformance(task.name)
+    fn(task.data)
       .then(res => {
-        const taskRunTime = Date.now() - startTaskTimestamp
-        this.sendToMainWorker({ data: res, id: value.id, taskRunTime })
+        taskPerformance = this.endTaskPerformance(taskPerformance)
+        this.sendToMainWorker({
+          data: res,
+          taskPerformance,
+          workerId: this.id,
+          id: task.id
+        })
         return null
       })
       .catch(e => {
-        const err = this.handleError(e as Error)
-        this.sendToMainWorker({ error: err, id: value.id })
+        const errorMessage = this.handleError(e as Error | string)
+        this.sendToMainWorker({
+          taskError: {
+            name: task.name ?? DEFAULT_TASK_NAME,
+            message: errorMessage,
+            data: task.data
+          },
+          workerId: this.id,
+          id: task.id
+        })
       })
       .finally(() => {
-        !this.isMain && (this.lastTaskTimestamp = Date.now())
+        if (!this.isMain && this.aliveInterval != null) {
+          this.lastTaskTimestamp = performance.now()
+        }
       })
       .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 {
+      name: name ?? DEFAULT_TASK_NAME,
+      timestamp: performance.now(),
+      ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
+    }
+  }
+
+  private endTaskPerformance (
+    taskPerformance: TaskPerformance
+  ): TaskPerformance {
+    this.checkStatistics()
+    return {
+      ...taskPerformance,
+      ...(this.statistics.runTime && {
+        runTime: performance.now() - taskPerformance.timestamp
+      }),
+      ...(this.statistics.elu && {
+        elu: performance.eventLoopUtilization(taskPerformance.elu)
+      })
+    }
+  }
+
+  private checkStatistics (): void {
+    if (this.statistics == null) {
+      throw new Error('Performance statistics computation requirements not set')
+    }
+  }
 }