Merge branch 'master' of github.com:poolifier/poolifier

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

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index ec75c819cfe9be8a5e56dac0e0c2bdad4cfe7d66..93e4eda4c8e80aabfc1b13503e87ef4b0dc7173b 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -6,7 +6,7 @@ import type { Queue } from '../queue'
  */
 export type MessageHandler<Worker extends IWorker> = (
   this: Worker,
-  m: unknown
+  message: unknown
 ) => void
 
 /**
@@ -14,7 +14,7 @@ export type MessageHandler<Worker extends IWorker> = (
  */
 export type ErrorHandler<Worker extends IWorker> = (
   this: Worker,
-  e: Error
+  error: Error
 ) => void
 
 /**
@@ -27,13 +27,13 @@ export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
  */
 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.
  *
- * @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> {
@@ -46,9 +46,9 @@ export interface Task<Data = unknown> {
    */
   readonly data?: Data
   /**
-   * Submission timestamp.
+   * Timestamp.
    */
-  readonly submissionTimestamp?: number
+  readonly timestamp?: number
   /**
    * Message UUID.
    */
@@ -56,55 +56,110 @@ export interface Task<Data = unknown> {
 }
 
 /**
- * Worker tasks usage statistics.
+ * Measurement statistics.
  *
  * @internal
  */
-export interface TasksUsage {
+export interface MeasurementStatistics {
   /**
-   * Number of tasks executed.
+   * Measurement aggregate.
    */
-  ran: number
+  aggregate: number
   /**
-   * Number of tasks running.
+   * Measurement average.
    */
-  running: number
+  average: number
   /**
-   * Tasks runtime.
+   * Measurement median.
    */
-  runTime: number
+  median: number
   /**
-   * Tasks runtime history.
+   * Measurement history.
    */
-  runTimeHistory: CircularArray<number>
+  readonly history: CircularArray<number>
+}
+
+/**
+ * Event loop utilization measurement statistics.
+ *
+ * @internal
+ */
+export interface EventLoopUtilizationMeasurementStatistics {
+  readonly idle: MeasurementStatistics
+  readonly 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
   /**
-   * Average tasks runtime.
+   * Number of failed tasks.
    */
-  avgRunTime: number
+  failed: number
+}
+
+/**
+ * Worker information.
+ *
+ * @internal
+ */
+export interface WorkerInfo {
   /**
-   * Median tasks runtime.
+   * Worker id.
    */
-  medRunTime: number
+  readonly id: number | undefined
   /**
-   * Tasks wait time.
+   * Started flag.
    */
-  waitTime: number
+  started: boolean
   /**
-   * Tasks wait time history.
+   * Shared buffer.
    */
-  waitTimeHistory: CircularArray<number>
+  readonly sharedBuffer?: Int32Array
+}
+
+/**
+ * Worker usage statistics.
+ *
+ * @internal
+ */
+export interface WorkerUsage {
+  /**
+   * Tasks statistics.
+   */
+  readonly tasks: TaskStatistics
   /**
-   * Average tasks wait time.
+   * Tasks runtime statistics.
    */
-  avgWaitTime: number
+  readonly runTime: MeasurementStatistics
   /**
-   * Median tasks wait time.
+   * Tasks wait time statistics.
    */
-  medWaitTime: number
+  readonly waitTime: MeasurementStatistics
   /**
-   * Number of tasks errored.
+   * Tasks event loop utilization statistics.
    */
-  error: number
+  readonly elu: EventLoopUtilizationMeasurementStatistics
 }
 
 /**
@@ -112,7 +167,12 @@ 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.
@@ -122,7 +182,7 @@ export interface IWorker {
   ((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.
@@ -134,7 +194,7 @@ 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> {
@@ -143,9 +203,13 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
    */
   readonly worker: Worker
   /**
-   * Worker node tasks usage statistics.
+   * Worker node worker info.
+   */
+  readonly info: WorkerInfo
+  /**
+   * Worker node worker usage statistics.
    */
-  tasksUsage: TasksUsage
+  usage: WorkerUsage
   /**
    * Worker node tasks queue.
    */