X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=bfbc2a84e376ac1db341614f6427943d5405285f;hb=520c8c68ceeccd6b9f4cd363241fdd2c4d628234;hp=b5611f9ea18c2a90403998245173693525f45b2c;hpb=a34454964733f585af19a04f21f9e35eb18c77b1;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index b5611f9e..bfbc2a84 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,46 +1,91 @@
 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 } from './pools/worker'
+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 error.
+ *
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  */
-export interface MessageValue<
-  Data = unknown,
-  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
-> {
+export interface TaskError<Data = unknown> {
+  /**
+   * Error message.
+   */
+  message: string
+  /**
+   * Data passed to the worker triggering the error.
+   */
+  data?: Data
+}
+
+/**
+ * Task performance.
+ */
+export interface TaskPerformance {
+  /**
+   * Task performance timestamp.
+   */
+  timestamp: number
   /**
-   * Input data that will be passed to the worker.
+   * Task runtime.
    */
-  readonly data?: Data
+  runTime?: number
   /**
-   * Id of the message.
+   * Task event loop utilization.
    */
-  readonly id?: string
+  elu?: EventLoopUtilization
+}
+
+/**
+ * Performance statistics computation.
+ */
+export interface WorkerStatistics {
+  runTime: boolean
+  elu: boolean
+}
+
+/**
+ * Message object that is passed between main worker and worker.
+ *
+ * @typeParam MessageData - Type of data sent to and/or from the worker. This can only be serializable data.
+ * @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<
+  MessageData = unknown,
+  Data = unknown,
+  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
+> extends Task<MessageData> {
   /**
    * Kill code.
    */
   readonly kill?: KillBehavior | 1
   /**
-   * Error.
+   * Task error.
    */
-  readonly error?: string
+  readonly taskError?: TaskError<Data>
   /**
-   * Runtime.
+   * Task performance.
    */
-  readonly runTime?: number
+  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
 }
 
 /**
@@ -48,6 +93,7 @@ export interface MessageValue<
  *
  * @typeParam Worker - Type of worker.
  * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
  */
 export interface PromiseResponseWrapper<
   Worker extends IWorker,