refactor: cleanup and type task error messages

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 2d142f860e4b19893a131e7cbc872abda5f8270a..3917ad2042b920f7509749605d86f073208c71cb 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,56 +1,101 @@
-import type { Worker as ClusterWorker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
-import type { IPoolWorker } from './pools/pool-worker'
+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] }
 
+export interface TaskError<Data = unknown> {
+  /**
+   * Error message.
+   */
+  message: string
+  /**
+   * Data passed to the worker triggering the error.
+   */
+  data?: Data
+}
+
 /**
- * Message object that is passed between worker and main worker.
+ * Task performance.
  */
-export interface MessageValue<
-  Data = unknown,
-  MainWorker extends ClusterWorker | 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,
+  ErrorData = unknown,
+  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
+> extends Task<Data> {
   /**
    * Kill code.
    */
   readonly kill?: KillBehavior | 1
   /**
-   * Error.
+   * Task error.
    */
-  readonly error?: string
+  readonly taskError?: TaskError<ErrorData>
   /**
-   * Task runtime.
+   * Task performance.
    */
-  readonly taskRunTime?: 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
 }
 
 /**
- * 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.
  *
  * @typeParam Worker - Type of worker.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
  */
-export interface PromiseWorkerResponseWrapper<
-  Worker extends IPoolWorker,
+export interface PromiseResponseWrapper<
+  Worker extends IWorker,
   Response = unknown
 > {
   /**
@@ -62,7 +107,7 @@ export interface PromiseWorkerResponseWrapper<
    */
   readonly reject: (reason?: string) => void
   /**
-   * The worker that has the assigned task.
+   * The worker handling the execution.
    */
   readonly worker: Worker
 }