X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=1d0c4e22e47f073384bdf8c69e3c477ea9cb1d2b;hb=a1763c54c962c69b5e02a30c0909724986495fcd;hp=d2d2a56f76160d2e2618b7d92d8169919ef01cdb;hpb=a86b6df187001e7e2e5c248ddb828286f985096c;p=poolifier.git

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index d2d2a56f..1d0c4e22 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,11 +1,18 @@
+import type { MessageChannel } from 'node:worker_threads'
 import type { CircularArray } from '../circular-array'
+import type { Task } from '../utility-types'
+
+/**
+ * Callback invoked when the worker has started successfully.
+ */
+export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
 
 /**
  * Callback invoked if the worker has received a message.
  */
 export type MessageHandler<Worker extends IWorker> = (
   this: Worker,
-  m: unknown
+  message: unknown
 ) => void
 
 /**
@@ -13,77 +20,151 @@ export type MessageHandler<Worker extends IWorker> = (
  */
 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.
  */
 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.
+ * Measurement statistics.
  *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  * @internal
  */
-export interface Task<Data = unknown> {
+export interface MeasurementStatistics {
   /**
-   * Task name.
+   * Measurement aggregate.
    */
-  readonly name?: string
+  aggregate?: number
   /**
-   * Task input data that will be passed to the worker.
+   * Measurement minimum.
    */
-  readonly data?: Data
+  minimum?: number
   /**
-   * UUID of the message.
+   * Measurement maximum.
    */
-  readonly id?: string
+  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
 }
 
 /**
- * Worker tasks usage statistics.
+ * Task statistics.
  *
  * @internal
  */
-export interface TasksUsage {
+export interface TaskStatistics {
+  /**
+   * Number of executed tasks.
+   */
+  executed: number
+  /**
+   * Number of executing tasks.
+   */
+  executing: number
+  /**
+   * Number of queued tasks.
+   */
+  readonly queued: number
   /**
-   * Number of tasks executed.
+   * Maximum number of queued tasks.
    */
-  run: number
+  readonly maxQueued?: number
   /**
-   * Number of tasks running.
+   * Number of failed tasks.
    */
-  running: number
+  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 {
   /**
-   * Tasks runtime.
+   * Worker id.
    */
-  runTime: number
+  readonly id: number | undefined
   /**
-   * Tasks runtime history.
+   * Worker type.
    */
-  runTimeHistory: CircularArray<number>
+  type: WorkerType
   /**
-   * Average tasks runtime.
+   * Dynamic flag.
    */
-  avgRunTime: number
+  dynamic: boolean
   /**
-   * Median tasks runtime.
+   * Ready flag.
    */
-  medRunTime: number
+  ready: boolean
   /**
-   * Number of tasks errored.
+   * Task function names.
    */
-  error: number
+  taskFunctions?: string[]
+}
+
+/**
+ * Worker usage statistics.
+ *
+ * @internal
+ */
+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
 }
 
 /**
@@ -91,42 +172,95 @@ 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 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 be performed once.
+   * Registers a listener to the exit event that will only be performed once.
    *
    * @param event - `'exit'`.
    * @param handler - The exit handler.
    */
-  once: (event: 'exit', handler: ExitHandler<this>) => void
+  readonly once: (event: 'exit', handler: ExitHandler<this>) => void
 }
 
 /**
  * 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> {
   /**
-   * Worker node worker.
+   * Worker.
    */
   readonly worker: Worker
   /**
-   * Worker node tasks usage statistics.
+   * Worker info.
+   */
+  readonly info: WorkerInfo
+  /**
+   * Message channel.
+   */
+  readonly messageChannel?: MessageChannel
+  /**
+   * Worker usage statistics.
    */
-  tasksUsage: TasksUsage
+  usage: WorkerUsage
   /**
-   * 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.
+   *
+   * @returns The dequeued task.
+   */
+  readonly dequeueTask: () => 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 tasksQueue: Array<Task<Data>>
+  readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined
 }