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 1f8efbc66e429bc65f58aa8ecbcf5b9807f88f6d..d10a27c9171c978ce44e7b9f6a1d2a9fb66131db 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,30 +32,84 @@ 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> {
   /**
-   * 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
+  /**
+   * Submission timestamp.
+   */
+  readonly submissionTimestamp?: number
+  /**
+   * Message UUID.
+   */
+  readonly id?: string
 }
 
 /**
  * Worker tasks usage statistics.
+ *
+ * @internal
  */
 export interface TasksUsage {
-  run: number
+  /**
+   * Number of tasks executed.
+   */
+  ran: number
+  /**
+   * Number of tasks running.
+   */
   running: number
+  /**
+   * Tasks runtime.
+   */
   runTime: number
+  /**
+   * Tasks runtime history.
+   */
   runTimeHistory: CircularArray<number>
+  /**
+   * Average tasks runtime.
+   */
   avgRunTime: number
+  /**
+   * Median tasks runtime.
+   */
   medRunTime: number
+  /**
+   * Tasks wait time.
+   */
+  waitTime: number
+  /**
+   * Tasks wait time history.
+   */
+  waitTimeHistory: CircularArray<number>
+  /**
+   * Average tasks wait time.
+   */
+  avgWaitTime: number
+  /**
+   * Median tasks wait time.
+   */
+  medWaitTime: number
+  /**
+   * Number of tasks errored.
+   */
   error: number
+  /**
+   * Event loop utilization.
+   */
+  elu: EventLoopUtilization | undefined
 }
 
 /**
@@ -64,14 +120,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.
@@ -81,9 +137,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
+  /**
+   * Worker node worker.
+   */
+  readonly worker: Worker
+  /**
+   * Worker node tasks usage statistics.
+   */
   tasksUsage: TasksUsage
-  tasksQueue: Array<Task<Data>>
+  /**
+   * Worker node tasks queue.
+   */
+  readonly tasksQueue: Queue<Task<Data>>
 }