X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=5439606d420f0abd165b84c49157808de230aee6;hb=fa548cda5120ac0708d82f37cd0ce1260d7f96c1;hp=4ff2c494664b571927f9d44e04fe3acbe3ec72e7;hpb=f06e48d8e14dcfe3277bd16b1bd2463136af13e6;p=poolifier.git

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 4ff2c494..5439606d 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,44 +1,196 @@
+import type { MessageChannel } from 'node:worker_threads'
+import type { EventEmitter } from 'node:events'
 import type { CircularArray } from '../circular-array'
+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> = (this: Worker, m: unknown) => void
+export type MessageHandler<Worker extends IWorker> = (
+  this: Worker,
+  message: unknown
+) => void
 
 /**
  * Callback invoked if the worker raised an error.
+ *
+ * @typeParam Worker - Type of worker.
  */
-export type ErrorHandler<Worker> = (this: Worker, e: Error) => void
+export type ErrorHandler<Worker extends IWorker> = (
+  this: Worker,
+  error: Error
+) => void
 
 /**
- * Callback invoked when the worker has started successfully.
+ * Callback invoked when the worker exits successfully.
+ *
+ * @typeParam Worker - Type of worker.
  */
-export type OnlineHandler<Worker> = (this: Worker) => void
+export type ExitHandler<Worker extends IWorker> = (
+  this: Worker,
+  exitCode: number
+) => void
 
 /**
- * Callback invoked when the worker exits successfully.
+ * 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 type ExitHandler<Worker> = (this: Worker, code: number) => void
+export interface EventLoopUtilizationMeasurementStatistics {
+  readonly idle: MeasurementStatistics
+  readonly active: MeasurementStatistics
+  utilization?: number
+}
+
+/**
+ * Task statistics.
+ *
+ * @internal
+ */
+export interface TaskStatistics {
+  /**
+   * Number of executed tasks.
+   */
+  executed: number
+  /**
+   * Number of executing tasks.
+   */
+  executing: number
+  /**
+   * Number of queued tasks.
+   */
+  readonly queued: number
+  /**
+   * Maximum number of queued tasks.
+   */
+  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.
+ *
+ * @internal
+ */
+export interface WorkerInfo {
+  /**
+   * Worker id.
+   */
+  readonly id: number | undefined
+  /**
+   * Worker type.
+   */
+  readonly type: WorkerType
+  /**
+   * Dynamic flag.
+   */
+  dynamic: boolean
+  /**
+   * Ready flag.
+   */
+  ready: boolean
+  /**
+   * Task function names.
+   */
+  taskFunctionNames?: string[]
+}
 
 /**
- * Worker task interface.
+ * Worker usage statistics.
+ *
+ * @internal
  */
-export interface Task<Data = unknown> {
-  data: Data
-  id: string
+export interface WorkerUsage {
+  /**
+   * Tasks statistics.
+   */
+  readonly tasks: TaskStatistics
+  /**
+   * Tasks runtime statistics.
+   */
+  readonly runTime: MeasurementStatistics
+  /**
+   * Tasks wait time statistics.
+   */
+  readonly waitTime: MeasurementStatistics
+  /**
+   * Tasks event loop utilization statistics.
+   */
+  readonly elu: EventLoopUtilizationMeasurementStatistics
 }
 
 /**
- * Worker tasks usage statistics.
+ * Worker choice strategy data.
+ *
+ * @internal
  */
-export interface TasksUsage {
-  run: number
-  running: number
-  runTime: number
-  runTimeHistory: CircularArray<number>
-  avgRunTime: number
-  medRunTime: number
-  error: number
+export interface StrategyData {
+  virtualTaskEndTimestamp?: number
 }
 
 /**
@@ -46,29 +198,136 @@ export interface TasksUsage {
  */
 export interface IWorker {
   /**
-   * Register an event listener.
+   * Worker id.
+   */
+  readonly id?: number
+  readonly threadId?: number
+  /**
+   * Registers an event listener.
    *
    * @param event - The event.
-   * @param handler - The event listener.
+   * @param handler - The event handler.
    */
-  on: ((event: 'message', handler: MessageHandler<this>) => void) &
+  readonly on: ((event: 'online', handler: OnlineHandler<this>) => void) &
+  ((event: 'message', handler: MessageHandler<this>) => void) &
   ((event: 'error', handler: ErrorHandler<this>) => void) &
-  ((event: 'online', handler: OnlineHandler<this>) => void) &
   ((event: 'exit', handler: ExitHandler<this>) => void)
   /**
-   * Register a listener to the exit event that will only performed once.
+   * Registers a listener to the exit event that will only be performed once.
    *
-   * @param event - `'exit'`.
+   * @param event - The `'exit'` event.
    * @param handler - The exit handler.
    */
-  once: (event: 'exit', handler: ExitHandler<this>) => void
+  readonly once: (event: 'exit', handler: ExitHandler<this>) => void
+}
+
+/**
+ * Worker node event detail.
+ *
+ * @internal
+ */
+export interface WorkerNodeEventDetail {
+  workerId: number
+  workerNodeKey?: number
 }
 
 /**
  * Worker node interface.
+ *
+ * @typeParam Worker - Type of worker.
+ * @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> {
-  worker: Worker
-  tasksUsage: TasksUsage
-  tasksQueue: Array<Task<Data>>
+export interface IWorkerNode<Worker extends IWorker, Data = unknown>
+  extends EventEmitter {
+  /**
+   * Worker.
+   */
+  readonly worker: Worker
+  /**
+   * 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_threads 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.
+   */
+  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
+  /**
+   * Closes communication channel.
+   */
+  readonly closeChannel: () => 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
 }