refactor: cleanup worker usage properties namespace

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

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 3bb0ac9d66ef550f254b8535d3fd23d4f369a4f6..86f5121dd1d73239c925c51319b6ff8bdc9b2a03 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,11 +1,12 @@
 import type { CircularArray } from '../circular-array'
+import type { Queue } from '../queue'
 
 /**
  * Callback invoked if the worker has received a message.
  */
 export type MessageHandler<Worker extends IWorker> = (
   this: Worker,
-  m: unknown
+  message: unknown
 ) => void
 
 /**
@@ -13,7 +14,7 @@ export type MessageHandler<Worker extends IWorker> = (
  */
 export type ErrorHandler<Worker extends IWorker> = (
   this: Worker,
-  e: Error
+  error: Error
 ) => void
 
 /**
@@ -26,37 +27,119 @@ export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
  */
 export type ExitHandler<Worker extends IWorker> = (
   this: Worker,
-  code: number
+  exitCode: 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.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 export interface Task<Data = unknown> {
   /**
-   * Worker task data.
+   * Task name.
    */
-  data: Data
+  readonly name?: string
   /**
-   * Task UUID.
+   * Task input data that will be passed to the worker.
    */
-  id: string
+  readonly data?: Data
+  /**
+   * Timestamp.
+   */
+  readonly timestamp?: number
+  /**
+   * Message UUID.
+   */
+  readonly id?: string
+}
+
+/**
+ * Measurement statistics.
+ *
+ * @internal
+ */
+export interface MeasurementStatistics {
+  /**
+   * Measurement aggregate.
+   */
+  aggregate: number
+  /**
+   * Measurement average.
+   */
+  average: number
+  /**
+   * Measurement median.
+   */
+  median: number
+  /**
+   * Measurement history.
+   */
+  history: CircularArray<number>
+}
+
+/**
+ * Event loop utilization measurement statistics.
+ *
+ * @internal
+ */
+export interface EventLoopUtilizationMeasurementStatistics {
+  idle: MeasurementStatistics
+  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 failed tasks.
+   */
+  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
+  /**
+   * Tasks event loop utilization statistics.
+   */
+  elu: EventLoopUtilizationMeasurementStatistics
 }
 
 /**
@@ -67,14 +150,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.
@@ -86,20 +169,20 @@ 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.
+ * @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 node worker.
    */
-  worker: Worker
+  readonly worker: Worker
   /**
-   * Worker node tasks usage statistics.
+   * Worker node worker usage statistics.
    */
-  tasksUsage: TasksUsage
+  usage: WorkerUsage
   /**
    * Worker node tasks queue.
    */
-  tasksQueue: Array<Task<Data>>
+  readonly tasksQueue: Queue<Task<Data>>
 }