fix: ensure task function ops sync worker choice strategies

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 123b5d6ea4fa397982c6195de0d9ccd95ba0c1df..10d9183ca6f262cd25d475737d0e86613a55d247 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,15 +1,18 @@
+import type { AsyncResource } from 'node:async_hooks'
 import type { EventLoopUtilization } from 'node:perf_hooks'
-import type { MessagePort } from 'node:worker_threads'
-import type { KillBehavior } from './worker/worker-options'
+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> {
   /**
-   * Task name triggering the error.
+   * Task function name triggering the error.
    */
   readonly name: string
   /**
@@ -47,13 +50,39 @@ export interface TaskPerformance {
 }
 
 /**
- * Performance statistics computation.
+ * Worker task performance statistics computation settings.
  *
  * @internal
  */
 export interface WorkerStatistics {
-  runTime: boolean
-  elu: boolean
+  /**
+   * 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
+}
+
+/**
+ * Task function properties.
+ *
+ * @internal
+ */
+export interface TaskFunctionProperties {
+  /**
+   * Task function name.
+   */
+  name: string
+  /**
+   * Task function priority. Lower values have higher priority.
+   */
+  priority?: number
+  /**
+   * Task function worker choice strategy.
+   */
+  strategy?: WorkerChoiceStrategy
 }
 
 /**
@@ -63,10 +92,6 @@ export interface WorkerStatistics {
  * @internal
  */
 export interface Task<Data = unknown> {
-  /**
-   * Worker id.
-   */
-  readonly workerId: number
   /**
    * Task name.
    */
@@ -75,6 +100,10 @@ export interface Task<Data = unknown> {
    * Task input data that will be passed to the worker.
    */
   readonly data?: Data
+  /**
+   * Array of transferable objects.
+   */
+  readonly transferList?: readonly TransferListItem[]
   /**
    * Timestamp.
    */
@@ -94,18 +123,45 @@ export interface Task<Data = unknown> {
  */
 export interface MessageValue<Data = unknown, ErrorData = unknown>
   extends Task<Data> {
+  /**
+   * Worker id.
+   */
+  readonly workerId?: number
   /**
    * Kill code.
    */
-  readonly kill?: KillBehavior | true
+  readonly kill?: KillBehavior | true | 'success' | 'failure'
   /**
-   * Task error.
+   * Worker error.
    */
-  readonly taskError?: TaskError<ErrorData>
+  readonly workerError?: WorkerError<ErrorData>
   /**
    * Task performance.
    */
   readonly taskPerformance?: TaskPerformance
+  /**
+   * 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.
    */
@@ -143,4 +199,10 @@ export interface PromiseResponseWrapper<Response = unknown> {
    * The worker node key executing the task.
    */
   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] }