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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index b5611f9e..28bf19e2 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,53 +1,131 @@
-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'
 
 /**
- * Make all properties in T non-readonly.
+ * Task error.
+ *
+ * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  */
-export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
+export interface TaskError<Data = unknown> {
+  /**
+   * Task name triggering the error.
+   */
+  readonly name: string
+  /**
+   * Error message.
+   */
+  readonly message: string
+  /**
+   * Data triggering the error.
+   */
+  readonly data?: Data
+}
 
 /**
- * Message object that is passed between worker and main worker.
+ * Task performance.
+ *
+ * @internal
  */
-export interface MessageValue<
-  Data = unknown,
-  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
-> {
+export interface TaskPerformance {
+  /**
+   * Task name.
+   */
+  readonly name: string
+  /**
+   * Task performance timestamp.
+   */
+  readonly timestamp: number
+  /**
+   * Task runtime.
+   */
+  readonly runTime?: number
+  /**
+   * Task event loop utilization.
+   */
+  readonly elu?: EventLoopUtilization
+}
+
+/**
+ * Performance statistics computation.
+ *
+ * @internal
+ */
+export interface WorkerStatistics {
+  runTime: boolean
+  elu: boolean
+}
+
+/**
+ * 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 structured-cloneable data.
+ * @internal
+ */
+export interface Task<Data = unknown> {
+  /**
+   * Worker id.
+   */
+  readonly workerId: number
   /**
-   * Input data that will be passed to the worker.
+   * Task name.
+   */
+  readonly name?: string
+  /**
+   * Task input data that will be passed to the worker.
    */
   readonly data?: Data
   /**
-   * Id of the message.
+   * Timestamp.
+   */
+  readonly timestamp?: number
+  /**
+   * Message UUID.
    */
   readonly id?: string
+}
+
+/**
+ * Message object that is passed between main worker and worker.
+ *
+ * @typeParam Data - Type of data sent to the worker or execution response. This can only be structured-cloneable data.
+ * @typeParam ErrorData - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
+ * @internal
+ */
+export interface MessageValue<Data = unknown, ErrorData = unknown>
+  extends Task<Data> {
   /**
    * Kill code.
    */
-  readonly kill?: KillBehavior | 1
+  readonly kill?: KillBehavior | true
   /**
-   * Error.
+   * Task error.
    */
-  readonly error?: string
+  readonly taskError?: TaskError<ErrorData>
   /**
-   * Runtime.
+   * Task performance.
    */
-  readonly runTime?: number
+  readonly taskPerformance?: TaskPerformance
+  /**
+   * Whether the worker computes the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
+  /**
+   * Whether the worker is ready or not.
+   */
+  readonly ready?: boolean
   /**
-   * Reference to main worker.
-   *
-   * Only for internal use.
+   * Whether the worker starts or stops its aliveness check.
    */
-  readonly parent?: MainWorker
+  readonly checkAlive?: boolean
 }
 
 /**
  * An object holding the execution response promise resolve/reject callbacks.
  *
  * @typeParam Worker - Type of worker.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @internal
  */
 export interface PromiseResponseWrapper<
   Worker extends IWorker,