X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=9a27d8a5056bb7b4b222f2d210803699ab95ad0d;hb=839b98b8d7b2a142da0841e9618b14c3e4e55c71;hp=c92478d4a8436512853384f65ccce026f6528a19;hpb=f59e102739e13698f278f1d9d58ab26ed8150442;p=poolifier.git

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index c92478d4..9a27d8a5 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,8 +1,19 @@
+import type { MessageChannel, WorkerOptions } from 'node:worker_threads'
+import type { EventEmitter } from 'node:events'
 import type { CircularArray } from '../circular-array'
-import type { Queue } from '../queue'
+import type { Task } from '../utility-types'
+
+/**
+ * Callback invoked when the worker has started successfully.
+ *
+ * @typeParam Worker - Type of worker.
+ */
+export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
 
 /**
  * Callback invoked if the worker has received a message.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export type MessageHandler<Worker extends IWorker> = (
   this: Worker,
@@ -11,19 +22,18 @@ export type MessageHandler<Worker extends IWorker> = (
 
 /**
  * Callback invoked if the worker raised an error.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export type ErrorHandler<Worker extends IWorker> = (
   this: Worker,
   error: Error
 ) => void
 
-/**
- * Callback invoked when the worker has started successfully.
- */
-export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
-
 /**
  * Callback invoked when the worker exits successfully.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export type ExitHandler<Worker extends IWorker> = (
   this: Worker,
@@ -31,52 +41,35 @@ export type ExitHandler<Worker extends IWorker> = (
 ) => void
 
 /**
- * Message object that is passed as a task between main worker and worker.
+ * Measurement statistics.
  *
- * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
-export interface Task<Data = unknown> {
-  /**
-   * Task name.
-   */
-  readonly name?: string
-  /**
-   * Task input data that will be passed to the worker.
-   */
-  readonly data?: Data
+export interface MeasurementStatistics {
   /**
-   * Timestamp.
+   * Measurement aggregate.
    */
-  readonly timestamp?: number
+  aggregate?: number
   /**
-   * Message UUID.
+   * Measurement minimum.
    */
-  readonly id?: string
-}
-
-/**
- * Measurement statistics.
- *
- * @internal
- */
-export interface MeasurementStatistics {
+  minimum?: number
   /**
-   * Measurement aggregate.
+   * Measurement maximum.
    */
-  aggregate: number
+  maximum?: number
   /**
    * Measurement average.
    */
-  average: number
+  average?: number
   /**
    * Measurement median.
    */
-  median: number
+  median?: number
   /**
    * Measurement history.
    */
-  history: CircularArray<number>
+  readonly history: CircularArray<number>
 }
 
 /**
@@ -85,9 +78,9 @@ export interface MeasurementStatistics {
  * @internal
  */
 export interface EventLoopUtilizationMeasurementStatistics {
-  idle: MeasurementStatistics
-  active: MeasurementStatistics
-  utilization: number
+  readonly idle: MeasurementStatistics
+  readonly active: MeasurementStatistics
+  utilization?: number
 }
 
 /**
@@ -111,13 +104,34 @@ export interface TaskStatistics {
   /**
    * Maximum number of queued tasks.
    */
-  readonly maxQueued: number
+  readonly maxQueued?: number
+  /**
+   * Number of sequentially stolen tasks.
+   */
+  sequentiallyStolen: number
+  /**
+   * Number of stolen tasks.
+   */
+  stolen: number
   /**
    * Number of failed tasks.
    */
   failed: number
 }
 
+/**
+ * Enumeration of worker types.
+ */
+export const WorkerTypes = Object.freeze({
+  thread: 'thread',
+  cluster: 'cluster'
+} as const)
+
+/**
+ * Worker type.
+ */
+export type WorkerType = keyof typeof WorkerTypes
+
 /**
  * Worker information.
  *
@@ -125,13 +139,25 @@ export interface TaskStatistics {
  */
 export interface WorkerInfo {
   /**
-   * Worker Id.
+   * Worker id.
+   */
+  readonly id: number | undefined
+  /**
+   * Worker type.
    */
-  id: number | undefined
+  readonly type: WorkerType
   /**
-   * Started flag.
+   * Dynamic flag.
    */
-  started: boolean
+  dynamic: boolean
+  /**
+   * Ready flag.
+   */
+  ready: boolean
+  /**
+   * Task function names.
+   */
+  taskFunctionNames?: string[]
 }
 
 /**
@@ -143,19 +169,28 @@ export interface WorkerUsage {
   /**
    * Tasks statistics.
    */
-  tasks: TaskStatistics
+  readonly tasks: TaskStatistics
   /**
    * Tasks runtime statistics.
    */
-  runTime: MeasurementStatistics
+  readonly runTime: MeasurementStatistics
   /**
    * Tasks wait time statistics.
    */
-  waitTime: MeasurementStatistics
+  readonly waitTime: MeasurementStatistics
   /**
    * Tasks event loop utilization statistics.
    */
-  elu: EventLoopUtilizationMeasurementStatistics
+  readonly elu: EventLoopUtilizationMeasurementStatistics
+}
+
+/**
+ * Worker choice strategy data.
+ *
+ * @internal
+ */
+export interface StrategyData {
+  virtualTaskEndTimestamp?: number
 }
 
 /**
@@ -163,27 +198,65 @@ export interface WorkerUsage {
  */
 export interface IWorker {
   /**
-   * Worker Id.
+   * Cluster worker id.
+   */
+  readonly id?: number
+  /**
+   * Worker thread worker id.
    */
-  id?: number
-  threadId?: number
+  readonly threadId?: number
   /**
-   * Register an event listener.
+   * Registers an event handler.
    *
    * @param event - The event.
    * @param handler - The event handler.
    */
-  on: ((event: 'message', handler: MessageHandler<this>) => void) &
-  ((event: 'error', handler: ErrorHandler<this>) => void) &
-  ((event: 'online', handler: OnlineHandler<this>) => void) &
-  ((event: 'exit', handler: ExitHandler<this>) => void)
+  readonly on: (
+    event: string,
+    handler:
+    | OnlineHandler<this>
+    | MessageHandler<this>
+    | ErrorHandler<this>
+    | ExitHandler<this>
+  ) => void
   /**
-   * Register a listener to the exit event that will only be performed once.
+   * Registers once an event handler.
    *
-   * @param event - `'exit'`.
-   * @param handler - The exit handler.
+   * @param event - The event.
+   * @param handler - The event handler.
    */
-  once: (event: 'exit', handler: ExitHandler<this>) => void
+  readonly once: (
+    event: string,
+    handler:
+    | OnlineHandler<this>
+    | MessageHandler<this>
+    | ErrorHandler<this>
+    | ExitHandler<this>
+  ) => void
+  /**
+   * Stop all JavaScript execution in the worker thread as soon as possible.
+   * Returns a Promise for the exit code that is fulfilled when the `'exit' event` is emitted.
+   */
+  readonly terminate?: () => Promise<number>
+  /**
+   * Cluster worker disconnect.
+   */
+  readonly disconnect?: () => void
+  /**
+   * Cluster worker kill.
+   */
+  readonly kill?: (signal?: string) => void
+}
+
+/**
+ * Worker node options.
+ *
+ * @internal
+ */
+export interface WorkerNodeOptions {
+  workerOptions?: WorkerOptions
+  env?: Record<string, unknown>
+  tasksQueueBackPressureSize: number
 }
 
 /**
@@ -193,21 +266,134 @@ export interface IWorker {
  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
-export interface WorkerNode<Worker extends IWorker, Data = unknown> {
+export interface IWorkerNode<Worker extends IWorker, Data = unknown>
+  extends EventEmitter {
   /**
-   * Worker node worker.
+   * Worker.
    */
   readonly worker: Worker
   /**
-   * Worker node worker info.
+   * Worker info.
+   */
+  readonly info: WorkerInfo
+  /**
+   * Worker usage statistics.
+   */
+  readonly usage: WorkerUsage
+  /**
+   * Worker choice strategy data.
+   * This is used to store data that are specific to the worker choice strategy.
    */
-  info: WorkerInfo
+  strategyData?: StrategyData
   /**
-   * Worker node worker usage statistics.
+   * Message channel (worker thread only).
    */
-  usage: WorkerUsage
+  readonly messageChannel?: MessageChannel
   /**
-   * Worker node tasks queue.
+   * Tasks queue back pressure size.
+   * This is the number of tasks that can be enqueued before the worker node has back pressure.
    */
-  readonly tasksQueue: Queue<Task<Data>>
+  tasksQueueBackPressureSize: number
+  /**
+   * Tasks queue size.
+   *
+   * @returns The tasks queue size.
+   */
+  readonly tasksQueueSize: () => number
+  /**
+   * Enqueue task.
+   *
+   * @param task - The task to queue.
+   * @returns The tasks queue size.
+   */
+  readonly enqueueTask: (task: Task<Data>) => number
+  /**
+   * Prepends a task to the tasks queue.
+   *
+   * @param task - The task to prepend.
+   * @returns The tasks queue size.
+   */
+  readonly unshiftTask: (task: Task<Data>) => number
+  /**
+   * Dequeue task.
+   *
+   * @returns The dequeued task.
+   */
+  readonly dequeueTask: () => Task<Data> | undefined
+  /**
+   * Pops a task from the tasks queue.
+   *
+   * @returns The popped task.
+   */
+  readonly popTask: () => Task<Data> | undefined
+  /**
+   * Clears tasks queue.
+   */
+  readonly clearTasksQueue: () => void
+  /**
+   * Whether the worker node has back pressure (i.e. its tasks queue is full).
+   *
+   * @returns `true` if the worker node has back pressure, `false` otherwise.
+   */
+  readonly hasBackPressure: () => boolean
+  /**
+   * Resets usage statistics.
+   */
+  readonly resetUsage: () => void
+  /**
+   * Terminates the worker node.
+   */
+  readonly terminate: () => Promise<void>
+  /**
+   * Registers a worker event handler.
+   *
+   * @param event - The event.
+   * @param handler - The event handler.
+   */
+  readonly registerWorkerEventHandler: (
+    event: string,
+    handler:
+    | OnlineHandler<Worker>
+    | MessageHandler<Worker>
+    | ErrorHandler<Worker>
+    | ExitHandler<Worker>
+  ) => void
+  /**
+   * Registers once a worker event handler.
+   *
+   * @param event - The event.
+   * @param handler - The event handler.
+   */
+  readonly registerOnceWorkerEventHandler: (
+    event: string,
+    handler:
+    | OnlineHandler<Worker>
+    | MessageHandler<Worker>
+    | ErrorHandler<Worker>
+    | ExitHandler<Worker>
+  ) => void
+  /**
+   * Gets task function worker usage statistics.
+   *
+   * @param name - The task function name.
+   * @returns The task function worker usage statistics if the task function worker usage statistics are initialized, `undefined` otherwise.
+   */
+  readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined
+  /**
+   * Deletes task function worker usage statistics.
+   *
+   * @param name - The task function name.
+   * @returns `true` if the task function worker usage statistics were deleted, `false` otherwise.
+   */
+  readonly deleteTaskFunctionWorkerUsage: (name: string) => boolean
+}
+
+/**
+ * Worker node event detail.
+ *
+ * @internal
+ */
+export interface WorkerNodeEventDetail {
+  workerId: number
+  workerNodeKey?: number
 }