X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=e1fb311e45b4eb8ed0e5d33cda3b3806d7526f5b;hb=4e6ddcbc38e0374e33505f5e363d2e7ec8a21c79;hp=d7f9d6a20e68d4c3da8481727714d51a04a4aef0;hpb=afd20c11f44e34385623a4b86834f69bcf660606;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index d7f9d6a2..e1fb311e 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,56 +1,162 @@
-import type { Worker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
+import type { EventLoopUtilization } from 'node:perf_hooks'
+import type { MessagePort, TransferListItem } from 'node:worker_threads'
+import type { KillBehavior } from './worker/worker-options'
 
 /**
- * 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
+}
 
 /**
- * Serializable primitive JSON value.
+ * Task performance.
+ *
+ * @internal
  */
-export type JSONPrimitive = number | boolean | string | null
-/**
- * Serializable JSON value.
- */
-// eslint-disable-next-line no-use-before-define
-export type JSONValue = JSONPrimitive | JSONArray | JSONObject
-/**
- * Serializable JSON object.
- */
-export type JSONObject = { [k: string]: JSONValue }
+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
+}
+
 /**
- * Serializable JSON array.
+ * Worker task performance statistics computation settings.
+ *
+ * @internal
  */
-export type JSONArray = Array<JSONValue>
+export interface WorkerStatistics {
+  /**
+   * Whether the worker computes the task runtime or not.
+   */
+  readonly runTime: boolean
+  /**
+   * Whether the worker computes the task event loop utilization (ELU) or not.
+   */
+  readonly elu: boolean
+}
 
 /**
- * Message object that is passed between worker and main worker.
+ * 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 MessageValue<
-  Data = unknown,
-  MainWorker extends Worker | MessagePort | unknown = unknown
-> {
+export interface Task<Data = unknown> {
+  /**
+   * Worker id.
+   */
+  readonly workerId: number
+  /**
+   * Task name.
+   */
+  readonly name?: string
   /**
-   * Input data that will be passed to the worker.
+   * Task input data that will be passed to the worker.
    */
   readonly data?: Data
   /**
-   * ID of the message.
+   * Array of transferable objects.
+   */
+  readonly transferList?: TransferListItem[]
+  /**
+   * Timestamp.
    */
-  readonly id?: number
+  readonly timestamp?: number
+  /**
+   * Task UUID.
+   */
+  readonly taskId?: 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?: string | number
+  readonly kill?: KillBehavior | true | 'success' | 'failure'
+  /**
+   * Task error.
+   */
+  readonly taskError?: TaskError<ErrorData>
+  /**
+   * Task performance.
+   */
+  readonly taskPerformance?: TaskPerformance
+  /**
+   * Task function names.
+   */
+  readonly taskFunctions?: string[]
   /**
-   * Error.
+   * Whether the worker computes the given statistics or not.
    */
-  readonly error?: string
+  readonly statistics?: WorkerStatistics
   /**
-   * Reference to main worker.
-   *
-   * _Only for internal use_
+   * Whether the worker is ready or not.
    */
-  readonly parent?: MainWorker
+  readonly ready?: boolean
+  /**
+   * Whether the worker starts or stops its activity check.
+   */
+  readonly checkActive?: boolean
+  /**
+   * Message port.
+   */
+  readonly port?: MessagePort
 }
+
+/**
+ * An object holding the task execution response promise resolve/reject callbacks.
+ *
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @internal
+ */
+export interface PromiseResponseWrapper<Response = unknown> {
+  /**
+   * Resolve callback to fulfill the promise.
+   */
+  readonly resolve: (value: Response | PromiseLike<Response>) => void
+  /**
+   * Reject callback to reject the promise.
+   */
+  readonly reject: (reason?: unknown) => void
+  /**
+   * The worker node key executing the task.
+   */
+  readonly workerNodeKey: number
+}
+
+export type Writable<T> = { -readonly [P in keyof T]: T[P] }