X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Futility-types.ts;h=f13cce6a70d9f60ed7417b9d2a45675c5179fb72;hb=HEAD;hp=0443b4ceef2374e28ba8201bf5d1d6a61ebbce93;hpb=d33d2d2fed43d102479c38cc28b496872665a90d;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 0443b4ce..8ccb1a74 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,52 +1,124 @@
+import type { AsyncResource } from 'node:async_hooks'
 import type { EventLoopUtilization } from 'node:perf_hooks'
-import type { KillBehavior } from './worker/worker-options'
-import type { IWorker, Task } from './pools/worker'
+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'
 
 /**
- * Task error.
- *
+ * Worker error.
  * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  */
-export interface TaskError<Data = unknown> {
+export interface WorkerError<Data = unknown> {
+  /**
+   * Data triggering the error.
+   */
+  readonly data?: Data
   /**
    * Error message.
    */
-  message: string
+  readonly message: string
   /**
-   * Data passed to the worker triggering the error.
+   * Task function name triggering the error.
    */
-  data?: Data
+  readonly name: string
 }
 
 /**
  * Task performance.
+ * @internal
  */
 export interface TaskPerformance {
   /**
-   * Task performance timestamp.
+   * Task event loop utilization.
+   */
+  readonly elu?: EventLoopUtilization
+  /**
+   * Task name.
    */
-  timestamp: number
+  readonly name: string
   /**
    * Task runtime.
    */
-  runTime?: number
+  readonly runTime?: number
   /**
-   * Task event loop utilization.
+   * Task performance timestamp.
    */
-  elu?: EventLoopUtilization
+  readonly timestamp: number
 }
 
 /**
- * Performance statistics computation.
+ * Worker task performance statistics computation settings.
+ * @internal
  */
 export interface WorkerStatistics {
-  runTime: boolean
-  elu: boolean
+  /**
+   * Whether the worker computes the task event loop utilization (ELU) or not.
+   */
+  readonly elu: boolean
+  /**
+   * Whether the worker computes the task runtime or not.
+   */
+  readonly runTime: boolean
+}
+
+/**
+ * Task function properties.
+ */
+export interface TaskFunctionProperties {
+  /**
+   * Task function name.
+   */
+  readonly name: string
+  /**
+   * Task function priority. Lower values have higher priority.
+   */
+  readonly priority?: number
+  /**
+   * 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 input data that will be passed to the worker.
+   */
+  readonly data?: Data
+  /**
+   * Task name.
+   */
+  readonly name?: string
+  /**
+   * Task priority. Lower values have higher priority.
+   * @defaultValue 0
+   */
+  readonly priority?: number
+  /**
+   * Task worker choice strategy.
+   */
+  readonly strategy?: WorkerChoiceStrategy
+  /**
+   * Task UUID.
+   */
+  readonly taskId?: `${string}-${string}-${string}-${string}-${string}`
+  /**
+   * Timestamp.
+   */
+  readonly timestamp?: number
+  /**
+   * Array of transferable objects.
+   */
+  readonly transferList?: readonly TransferListItem[]
 }
 
 /**
  * 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
@@ -54,52 +126,89 @@ export interface WorkerStatistics {
 export interface MessageValue<Data = unknown, ErrorData = unknown>
   extends Task<Data> {
   /**
-   * Worker id.
+   * Whether the worker starts or stops its activity check.
    */
-  readonly workerId?: number
+  readonly checkActive?: boolean
   /**
    * Kill code.
    */
-  readonly kill?: KillBehavior | 1
+  readonly kill?: 'failure' | 'success' | KillBehavior | true
   /**
-   * Task error.
+   * Message port.
    */
-  readonly taskError?: TaskError<ErrorData>
+  readonly port?: MessagePort
   /**
-   * Task performance.
+   * Whether the worker is ready or not.
    */
-  readonly taskPerformance?: TaskPerformance
+  readonly ready?: boolean
   /**
    * Whether the worker computes the given statistics or not.
    */
   readonly statistics?: WorkerStatistics
   /**
-   * Whether the worker has started or not.
+   * Task function serialized to string.
+   */
+  readonly taskFunction?: string
+  /**
+   * Task function operation:
+   * - `'add'` - Add a task function.
+   * - `'remove'` - Remove a task function.
+   * - `'default'` - Set a task function as default.
+   */
+  readonly taskFunctionOperation?: 'add' | 'default' | 'remove'
+  /**
+   * Whether the task function operation is successful or not.
+   */
+  readonly taskFunctionOperationStatus?: boolean
+  /**
+   * Task function properties.
+   */
+  readonly taskFunctionProperties?: TaskFunctionProperties
+  /**
+   * Task functions properties.
    */
-  readonly started?: boolean
+  readonly taskFunctionsProperties?: TaskFunctionProperties[]
+  /**
+   * Task performance.
+   */
+  readonly taskPerformance?: TaskPerformance
+  /**
+   * Worker error.
+   */
+  readonly workerError?: WorkerError<ErrorData>
+  /**
+   * Worker id.
+   */
+  readonly workerId?: number
 }
 
 /**
- * An object holding the execution response promise resolve/reject callbacks.
- *
- * @typeParam Worker - Type of worker.
+ * 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<
-  Worker extends IWorker,
-  Response = unknown
-> {
+export interface PromiseResponseWrapper<Response = unknown> {
   /**
-   * Resolve callback to fulfill the promise.
+   * The asynchronous resource used to track the task execution.
    */
-  readonly resolve: (value: Response) => void
+  readonly asyncResource?: AsyncResource
   /**
    * Reject callback to reject the promise.
    */
-  readonly reject: (reason?: string) => void
+  readonly reject: (reason?: unknown) => void
+  /**
+   * Resolve callback to fulfill the promise.
+   */
+  readonly resolve: (value: PromiseLike<Response> | Response) => void
   /**
-   * The worker handling the execution.
+   * The worker node key executing the task.
    */
-  readonly worker: Worker
+  readonly workerNodeKey: number
 }
+
+/**
+ * Remove readonly modifier from all properties of T.
+ * @typeParam T - Type to remove readonly modifier.
+ * @internal
+ */
+export type Writable<T> = { -readonly [P in keyof T]: T[P] }