refactor: cleanup task handling in worker code

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 7bcd076c291736cad1729d66a671a51b2115c1b7..28bf19e256abaef2f619051773ad55456643b842 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,56 +1,134 @@
-import type { Worker as ClusterWorker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
-import type { IPoolWorker } from './pools/pool-worker'
+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 id?: number
+  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>
   /**
-   * Task runtime.
+   * Task performance.
+   */
+  readonly taskPerformance?: TaskPerformance
+  /**
+   * Whether the worker computes the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
+  /**
+   * Whether the worker is ready or not.
    */
-  readonly taskRunTime?: number
+  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 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 structured-cloneable data.
+ * @internal
  */
-export interface PromiseWorkerResponseWrapper<
-  Worker extends IPoolWorker,
+export interface PromiseResponseWrapper<
+  Worker extends IWorker,
   Response = unknown
 > {
   /**
@@ -62,7 +140,7 @@ export interface PromiseWorkerResponseWrapper<
    */
   readonly reject: (reason?: string) => void
   /**
-   * The worker that has the assigned task.
+   * The worker handling the execution.
    */
   readonly worker: Worker
 }