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

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 4ff2c494..ba9393ab 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,44 +1,131 @@
+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.
  */
-export type MessageHandler<Worker> = (this: Worker, m: unknown) => void
+export type MessageHandler<Worker extends IWorker> = (
+  this: Worker,
+  m: unknown
+) => void
 
 /**
  * Callback invoked if the worker raised an error.
  */
-export type ErrorHandler<Worker> = (this: Worker, e: Error) => void
+export type ErrorHandler<Worker extends IWorker> = (
+  this: Worker,
+  e: Error
+) => void
 
 /**
  * Callback invoked when the worker has started successfully.
  */
-export type OnlineHandler<Worker> = (this: Worker) => void
+export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
 
 /**
  * Callback invoked when the worker exits successfully.
  */
-export type ExitHandler<Worker> = (this: Worker, code: number) => void
+export type ExitHandler<Worker extends IWorker> = (
+  this: Worker,
+  code: number
+) => 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.
+   */
+  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
 }
 
 /**
@@ -49,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.
@@ -66,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>>
 }