fix: ensure worker started message cannot be received for non existing
[poolifier.git] / src / pools / worker.ts
index 94f0ff73043d3d4eede636c9bcae5d0f21ee82e8..e0636d9920db6ddf4e5d7a20ea412cfbee612b04 100644 (file)
@@ -1,4 +1,3 @@
-import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { CircularArray } from '../circular-array'
 import type { Queue } from '../queue'
 
@@ -7,7 +6,7 @@ import type { Queue } from '../queue'
  */
 export type MessageHandler<Worker extends IWorker> = (
   this: Worker,
-  m: unknown
+  message: unknown
 ) => void
 
 /**
@@ -15,7 +14,7 @@ export type MessageHandler<Worker extends IWorker> = (
  */
 export type ErrorHandler<Worker extends IWorker> = (
   this: Worker,
-  e: Error
+  error: Error
 ) => void
 
 /**
@@ -28,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> {
@@ -63,9 +62,9 @@ export interface Task<Data = unknown> {
  */
 export interface MeasurementStatistics {
   /**
-   * Measurement aggregation.
+   * Measurement aggregate.
    */
-  aggregation: number
+  aggregate: number
   /**
    * Measurement average.
    */
@@ -80,6 +79,17 @@ export interface MeasurementStatistics {
   history: CircularArray<number>
 }
 
+/**
+ * Event loop utilization measurement statistics.
+ *
+ * @internal
+ */
+export interface EventLoopUtilizationMeasurementStatistics {
+  idle: MeasurementStatistics
+  active: MeasurementStatistics
+  utilization: number
+}
+
 /**
  * Task statistics.
  *
@@ -98,12 +108,32 @@ export interface TaskStatistics {
    * Number of queued tasks.
    */
   readonly queued: number
+  /**
+   * Maximum number of queued tasks.
+   */
+  readonly maxQueued: number
   /**
    * Number of failed tasks.
    */
   failed: number
 }
 
+/**
+ * Worker information.
+ *
+ * @internal
+ */
+export interface WorkerInfo {
+  /**
+   * Worker id.
+   */
+  id: number | undefined
+  /**
+   * Started flag.
+   */
+  started: boolean
+}
+
 /**
  * Worker usage statistics.
  *
@@ -123,15 +153,20 @@ export interface WorkerUsage {
    */
   waitTime: MeasurementStatistics
   /**
-   * Event loop utilization.
+   * Tasks event loop utilization statistics.
    */
-  elu: EventLoopUtilization | undefined
+  elu: EventLoopUtilizationMeasurementStatistics
 }
 
 /**
  * Worker interface.
  */
 export interface IWorker {
+  /**
+   * Worker id.
+   */
+  id?: number
+  threadId?: number
   /**
    * Register an event listener.
    *
@@ -155,7 +190,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> {
@@ -163,10 +198,14 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
    * Worker node worker.
    */
   readonly worker: Worker
+  /**
+   * Worker node worker info.
+   */
+  info: WorkerInfo
   /**
    * Worker node worker usage statistics.
    */
-  workerUsage: WorkerUsage
+  usage: WorkerUsage
   /**
    * Worker node tasks queue.
    */