X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=82f79230accb88160ae612e9d5cc5ba7da57d157;hb=055a2d42cc2d74da7abc5f0dff8844f552f8c2b5;hp=2d142f860e4b19893a131e7cbc872abda5f8270a;hpb=38e795c12f0e9daeff7b025147f36f85f486366e;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 2d142f86..82f79230 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,68 +1,216 @@
-import type { Worker as ClusterWorker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
-import type { IPoolWorker } from './pools/pool-worker'
-import type { KillBehavior } from './worker/worker-options'
+import type { AsyncResource } from 'node:async_hooks'
+import type { EventLoopUtilization } from 'node:perf_hooks'
+import type { MessagePort, TransferListItem } from 'node:worker_threads'
+
+import type { WorkerChoiceStrategy } from './pools/selection-strategies/selection-strategies-types.js'
+import type { KillBehavior } from './worker/worker-options.js'
+
+/**
+ * Worker error.
+ *
+ * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
+ */
+export interface WorkerError<Data = unknown> {
+  /**
+   * Task function name triggering the error.
+   */
+  readonly name: string
+  /**
+   * Error message.
+   */
+  readonly message: string
+  /**
+   * Data triggering the error.
+   */
+  readonly data?: Data
+}
+
+/**
+ * Task performance.
+ *
+ * @internal
+ */
+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
+}
 
 /**
- * Make all properties in T non-readonly.
+ * Worker task performance statistics computation settings.
+ *
+ * @internal
  */
-export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
+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.
+ * Task function properties.
  */
-export interface MessageValue<
-  Data = unknown,
-  MainWorker extends ClusterWorker | MessagePort | unknown = unknown
-> {
+export interface TaskFunctionProperties {
+  /**
+   * Task function name.
+   */
+  readonly name: string
+  /**
+   * Task function priority. Lower values have higher priority.
+   */
+  readonly priority?: number
   /**
-   * Input data that will be passed to the worker.
+   * Task function worker choice strategy.
+   */
+  readonly strategy?: WorkerChoiceStrategy
+}
+
+/**
+ * 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> {
+  /**
+   * Task name.
+   */
+  readonly name?: string
+  /**
+   * Task input data that will be passed to the worker.
    */
   readonly data?: Data
   /**
-   * Id of the message.
+   * Task priority. Lower values have higher priority.
+   *
+   * @defaultValue 0
+   */
+  readonly priority?: number
+  /**
+   * Task worker choice strategy.
+   */
+  readonly strategy?: WorkerChoiceStrategy
+  /**
+   * Array of transferable objects.
+   */
+  readonly transferList?: readonly TransferListItem[]
+  /**
+   * Timestamp.
    */
-  readonly id?: number
+  readonly timestamp?: number
+  /**
+   * Task UUID.
+   */
+  readonly taskId?: `${string}-${string}-${string}-${string}-${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> {
+  /**
+   * Worker id.
+   */
+  readonly workerId?: number
   /**
    * Kill code.
    */
-  readonly kill?: KillBehavior | 1
+  readonly kill?: KillBehavior | true | 'success' | 'failure'
   /**
-   * Error.
+   * Worker error.
    */
-  readonly error?: string
+  readonly workerError?: WorkerError<ErrorData>
   /**
-   * Task runtime.
+   * Task performance.
    */
-  readonly taskRunTime?: number
+  readonly taskPerformance?: TaskPerformance
   /**
-   * Reference to main worker.
-   *
-   * Only for internal use.
+   * Task function operation:
+   * - `'add'` - Add a task function.
+   * - `'remove'` - Remove a task function.
+   * - `'default'` - Set a task function as default.
+   */
+  readonly taskFunctionOperation?: 'add' | 'remove' | 'default'
+  /**
+   * Whether the task function operation is successful or not.
+   */
+  readonly taskFunctionOperationStatus?: boolean
+  /**
+   * Task function properties.
+   */
+  readonly taskFunctionProperties?: TaskFunctionProperties
+  /**
+   * Task function serialized to string.
+   */
+  readonly taskFunction?: string
+  /**
+   * Task functions properties.
+   */
+  readonly taskFunctionsProperties?: TaskFunctionProperties[]
+  /**
+   * Whether the worker computes the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
+  /**
+   * Whether the worker is ready or not.
+   */
+  readonly ready?: boolean
+  /**
+   * Whether the worker starts or stops its activity check.
    */
-  readonly parent?: MainWorker
+  readonly checkActive?: boolean
+  /**
+   * Message port.
+   */
+  readonly port?: MessagePort
 }
 
 /**
- * An object holding the worker that will be used to resolve/rejects the promise later on.
+ * An object holding the task 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 structured-cloneable data.
+ * @internal
  */
-export interface PromiseWorkerResponseWrapper<
-  Worker extends IPoolWorker,
-  Response = unknown
-> {
+export interface PromiseResponseWrapper<Response = unknown> {
   /**
    * Resolve callback to fulfill the promise.
    */
-  readonly resolve: (value: Response) => void
+  readonly resolve: (value: Response | PromiseLike<Response>) => void
   /**
    * Reject callback to reject the promise.
    */
-  readonly reject: (reason?: string) => void
+  readonly reject: (reason?: unknown) => void
   /**
-   * The worker that has the assigned task.
+   * The worker node key executing the task.
    */
-  readonly worker: Worker
+  readonly workerNodeKey: number
+  /**
+   * The asynchronous resource used to track the task execution.
+   */
+  readonly asyncResource?: AsyncResource
 }
+
+export type Writable<T> = { -readonly [P in keyof T]: T[P] }