Merge branch 'master' into elu-strategy

[poolifier.git] / src / pools / worker.ts

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 1e23ee872aa0b9f1a5ae97d48c2a8c87b06e6567..b6dddd1d59ac24916dd8ab49591dc31c1edfa93a 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,4 +1,6 @@
+import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { CircularArray } from '../circular-array'
+import type { Queue } from '../queue'
 
 /**
  * Callback invoked if the worker has received a message.
@@ -30,24 +32,100 @@ export type ExitHandler<Worker extends IWorker> = (
 ) => void
 
 /**
- * Worker task interface.
+ * Message object that is passed as a task between main worker and worker.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @internal
  */
 export interface Task<Data = unknown> {
-  data: Data
-  id: string
+  /**
+   * Task name.
+   */
+  readonly name?: string
+  /**
+   * Task input data that will be passed to the worker.
+   */
+  readonly data?: Data
+  /**
+   * Timestamp.
+   */
+  readonly timestamp?: number
+  /**
+   * Message UUID.
+   */
+  readonly id?: string
+}
+
+/**
+ * Measurement statistics.
+ *
+ * @internal
+ */
+export interface MeasurementStatistics {
+  /**
+   * Measurement aggregation.
+   */
+  aggregation: number
+  /**
+   * Measurement average.
+   */
+  average: number
+  /**
+   * Measurement median.
+   */
+  median: number
+  /**
+   * Measurement history.
+   */
+  history: CircularArray<number>
+}
+
+/**
+ * Task statistics.
+ *
+ * @internal
+ */
+export interface TaskStatistics {
+  /**
+   * Number of tasks executed.
+   */
+  executed: number
+  /**
+   * Number of tasks executing.
+   */
+  executing: number
+  /**
+   * Number of tasks queued.
+   */
+  readonly queued: number
+  /**
+   * Number of tasks failed.
+   */
+  failed: number
 }
 
 /**
- * Worker tasks usage statistics.
+ * Worker usage statistics.
+ *
+ * @internal
  */
-export interface TasksUsage {
-  run: number
-  running: number
-  runTime: number
-  runTimeHistory: CircularArray<number>
-  avgRunTime: number
-  medRunTime: number
-  error: number
+export interface WorkerUsage {
+  /**
+   * Tasks statistics.
+   */
+  tasks: TaskStatistics
+  /**
+   * Tasks runtime statistics.
+   */
+  runTime: MeasurementStatistics
+  /**
+   * Tasks wait time statistics.
+   */
+  waitTime: MeasurementStatistics
+  /**
+   * Event loop utilization.
+   */
+  elu: EventLoopUtilization | undefined
 }
 
 /**
@@ -58,14 +136,14 @@ export interface IWorker {
    * Register an event listener.
    *
    * @param event - The event.
-   * @param handler - The event listener.
+   * @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)
   /**
-   * Register a listener to the exit event that will only performed once.
+   * Register a listener to the exit event that will only be performed once.
    *
    * @param event - `'exit'`.
    * @param handler - The exit handler.
@@ -75,9 +153,22 @@ export interface IWorker {
 
 /**
  * Worker node interface.
+ *
+ * @typeParam Worker - Type of worker.
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @internal
  */
 export interface WorkerNode<Worker extends IWorker, Data = unknown> {
-  worker: Worker
-  tasksUsage: TasksUsage
-  tasksQueue: Array<Task<Data>>
+  /**
+   * Worker node worker.
+   */
+  readonly worker: Worker
+  /**
+   * Worker node worker usage statistics.
+   */
+  workerUsage: WorkerUsage
+  /**
+   * Worker node tasks queue.
+   */
+  readonly tasksQueue: Queue<Task<Data>>
 }