refactor: use task performance data structure in messages

[poolifier.git] / src / utility-types.ts

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 9441fec4e420292905a23150d73580e73b3411cd..faeda0a5a4e4048ed9c16b5e48d8bdecd4b8c690 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,51 +1,92 @@
-import type { Worker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
-import type { IWorker } from './pools/abstract-pool'
+import type { Worker as ClusterWorker } from 'node:cluster'
+import type { MessagePort } from 'node:worker_threads'
+import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { KillBehavior } from './worker/worker-options'
+import type { IWorker, Task } from './pools/worker'
 
 /**
  * Make all properties in T non-readonly.
+ *
+ * @typeParam T - Type in which properties will be non-readonly.
  */
 export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
 
 /**
- * Message object that is passed between worker and main worker.
+ * Task performance.
  */
-export interface MessageValue<
-  Data = unknown,
-  MainWorker extends Worker | MessagePort | unknown = unknown
-> {
+export interface TaskPerformance {
   /**
-   * Input data that will be passed to the worker.
+   * Task performance timestamp.
    */
-  readonly data?: Data
+  timestamp: number
   /**
-   * ID of the message.
+   * Task runtime.
    */
-  readonly id?: number
+  runTime?: number
+  /**
+   * Task wait time.
+   */
+  waitTime?: number
+  /**
+   * Task event loop utilization.
+   */
+  elu?: EventLoopUtilization
+}
+
+/**
+ * Performance statistics computation.
+ */
+export interface WorkerStatistics {
+  runTime: boolean
+  waitTime: boolean
+  elu: boolean
+}
+
+/**
+ * Message object that is passed between main worker and worker.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam MainWorker - Type of main worker.
+ * @internal
+ */
+export interface MessageValue<
+  Data = unknown,
+  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
+> extends Task<Data> {
   /**
    * Kill code.
    */
   readonly kill?: KillBehavior | 1
   /**
-   * Error.
+   * Task error.
    */
   readonly error?: string
+  /**
+   * Task data triggering task error.
+   */
+  readonly errorData?: unknown
+  /**
+   * Task performance.
+   */
+  readonly taskPerformance?: TaskPerformance
   /**
    * Reference to main worker.
-   *
-   * _Only for internal use_
    */
   readonly parent?: MainWorker
+  /**
+   * Whether to compute the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
 }
 
 /**
- * An object holding the worker that will be used to resolve/rejects the promise later on.
+ * An object holding the execution response promise resolve/reject callbacks.
  *
- * @template Worker Type of worker.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @typeParam Worker - Type of worker.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
  */
-export interface PromiseWorkerResponseWrapper<
+export interface PromiseResponseWrapper<
   Worker extends IWorker,
   Response = unknown
 > {
@@ -58,7 +99,7 @@ export interface PromiseWorkerResponseWrapper<
    */
   readonly reject: (reason?: string) => void
   /**
-   * The worker that has the assigned task.
+   * The worker handling the execution.
    */
   readonly worker: Worker
 }