X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=35d9f755bc3f9d4d321c8ac7b999261a3e1d613a;hb=0de45de915a4d9feb7e1cb3b37bb416926a40b4b;hp=2db5f630fefa5a1e81161ca75362e7c73fc450a1;hpb=70a4f5ea122d3ddb2d2e0b245598ad241562e7f7;p=poolifier.git

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 2db5f630..35d9f755 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,133 +1,386 @@
-import type { CircularArray } from '../circular-array'
-import type { Queue } from '../queue'
+import type { EventEmitter } from 'node:events'
+import type { MessageChannel, WorkerOptions } from 'node:worker_threads'
+
+import type { CircularArray } from '../circular-array.js'
+import type { Task, TaskFunctionProperties } from '../utility-types.js'
+
+/**
+ * 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,
-  m: unknown
+  message: unknown
 ) => void
 
 /**
  * Callback invoked if the worker raised an error.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export type ErrorHandler<Worker extends IWorker> = (
   this: Worker,
-  e: Error
+  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,
-  code: number
+  exitCode: number
 ) => void
 
 /**
- * Message object that is passed as a task between main worker and worker.
+ * Worker event handler.
+ *
+ * @typeParam Worker - Type of worker.
+ */
+export type EventHandler<Worker extends IWorker> =
+  | OnlineHandler<Worker>
+  | MessageHandler<Worker>
+  | ErrorHandler<Worker>
+  | ExitHandler<Worker>
+
+/**
+ * Measurement statistics.
+ *
+ * @internal
+ */
+export interface MeasurementStatistics {
+  /**
+   * Measurement aggregate.
+   */
+  aggregate?: number
+  /**
+   * Measurement minimum.
+   */
+  minimum?: number
+  /**
+   * Measurement maximum.
+   */
+  maximum?: number
+  /**
+   * Measurement average.
+   */
+  average?: number
+  /**
+   * Measurement median.
+   */
+  median?: number
+  /**
+   * Measurement history.
+   */
+  readonly history: CircularArray<number>
+}
+
+/**
+ * Event loop utilization measurement statistics.
+ *
+ * @internal
+ */
+export interface EventLoopUtilizationMeasurementStatistics {
+  readonly idle: MeasurementStatistics
+  readonly active: MeasurementStatistics
+  utilization?: number
+}
+
+/**
+ * Task statistics.
  *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  * @internal
  */
-export interface Task<Data = unknown> {
+export interface TaskStatistics {
+  /**
+   * Number of executed tasks.
+   */
+  executed: number
+  /**
+   * Number of executing tasks.
+   */
+  executing: number
+  /**
+   * Number of queued tasks.
+   */
+  readonly queued: number
   /**
-   * Task name.
+   * Maximum number of queued tasks.
    */
-  readonly name?: string
+  readonly maxQueued?: number
   /**
-   * Task input data that will be passed to the worker.
+   * Number of sequentially stolen tasks.
    */
-  readonly data?: Data
+  sequentiallyStolen: number
   /**
-   * Message UUID.
+   * Number of stolen tasks.
    */
-  readonly id?: string
+  stolen: number
+  /**
+   * Number of failed tasks.
+   */
+  failed: number
 }
 
 /**
- * Worker tasks usage statistics.
+ * Enumeration of worker types.
+ */
+export const WorkerTypes: Readonly<{ thread: 'thread', cluster: 'cluster' }> =
+  Object.freeze({
+    thread: 'thread',
+    cluster: 'cluster'
+  } as const)
+
+/**
+ * Worker type.
+ */
+export type WorkerType = keyof typeof WorkerTypes
+
+/**
+ * Worker information.
  *
  * @internal
  */
-export interface TasksUsage {
+export interface WorkerInfo {
+  /**
+   * Worker id.
+   */
+  readonly id: number | undefined
+  /**
+   * Worker type.
+   */
+  readonly type: WorkerType
+  /**
+   * Dynamic flag.
+   */
+  dynamic: boolean
   /**
-   * Number of tasks executed.
+   * Ready flag.
    */
-  run: number
+  ready: boolean
   /**
-   * Number of tasks running.
+   * Stealing flag.
+   * This flag is set to `true` when worker node is stealing tasks from another worker node.
    */
-  running: number
+  stealing: boolean
   /**
-   * Tasks runtime.
+   * Task functions properties.
    */
-  runTime: number
+  taskFunctionsProperties?: TaskFunctionProperties[]
+}
+
+/**
+ * Worker usage statistics.
+ *
+ * @internal
+ */
+export interface WorkerUsage {
   /**
-   * Tasks runtime history.
+   * Tasks statistics.
    */
-  runTimeHistory: CircularArray<number>
+  readonly tasks: TaskStatistics
   /**
-   * Average tasks runtime.
+   * Tasks runtime statistics.
    */
-  avgRunTime: number
+  readonly runTime: MeasurementStatistics
   /**
-   * Median tasks runtime.
+   * Tasks wait time statistics.
    */
-  medRunTime: number
+  readonly waitTime: MeasurementStatistics
   /**
-   * Number of tasks errored.
+   * Tasks event loop utilization statistics.
    */
-  error: number
+  readonly elu: EventLoopUtilizationMeasurementStatistics
+}
+
+/**
+ * Worker choice strategy data.
+ *
+ * @internal
+ */
+export interface StrategyData {
+  virtualTaskEndTimestamp?: number
 }
 
 /**
  * Worker interface.
  */
-export interface IWorker {
+export interface IWorker extends EventEmitter {
+  /**
+   * Cluster worker id.
+   */
+  readonly id?: number
+  /**
+   * Worker thread worker id.
+   */
+  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: EventHandler<this>) => this
   /**
-   * 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.
+   */
+  readonly once: (event: string, handler: EventHandler<this>) => this
+  /**
+   * Calling `unref()` on a worker allows the thread to exit if this is the only
+   * active handle in the event system. If the worker is already `unref()`ed calling`unref()` again has no effect.
+   * @since v10.5.0
+   */
+  readonly unref?: () => 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.
    */
-  once: (event: 'exit', handler: ExitHandler<this>) => void
+  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 | undefined
+  tasksQueueBucketSize: number | undefined
 }
 
 /**
  * Worker node interface.
  *
  * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @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 tasks usage statistics.
+   * 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.
+   */
+  strategyData?: StrategyData
+  /**
+   * Message channel (worker thread only).
+   */
+  readonly messageChannel?: MessageChannel
+  /**
+   * Tasks queue back pressure size.
+   * This is the number of tasks that can be enqueued before the worker node has back pressure.
    */
-  tasksUsage: TasksUsage
+  tasksQueueBackPressureSize: number
   /**
-   * Worker node tasks queue.
+   * 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
+  /**
+   * Dequeue task.
+   *
+   * @param bucket - The prioritized bucket to dequeue from. @defaultValue 0
+   * @returns The dequeued task.
+   */
+  readonly dequeueTask: (bucket?: number) => 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
+  /**
+   * 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: EventHandler<Worker>
+  ) => void
+  /**
+   * Registers once a worker event handler.
+   *
+   * @param event - The event.
+   * @param handler - The event handler.
+   */
+  readonly registerOnceWorkerEventHandler: (
+    event: string,
+    handler: EventHandler<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 tasksQueue: Queue<Task<Data>>
+  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
 }