X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=c7663606cf86afe67f84d6f25d831d567b5bab3f;hb=ecde6ea8c439bbdd9dc2ca118731b5006a1a9884;hp=cc29801f9afc81e23d25ce6f9e91e49ed60ae831;hpb=a3ae469eebfcc990a251133beb01378599313233;p=poolifier.git

diff --git a/src/utility-types.ts b/src/utility-types.ts
index cc29801f..c7663606 100644
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,124 +1,187 @@
-import type { Worker as ClusterWorker } from 'node:cluster'
-import type { MessagePort } from 'node:worker_threads'
+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'
 
-/**
- * Make all properties in T non-readonly.
- *
- * @typeParam T - Type in which properties will be non-readonly.
- */
-export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
+import type { KillBehavior } from './worker/worker-options.js'
 
 /**
- * Message object that is passed between main worker and worker.
+ * Worker error.
  *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam MainWorker - Type of main worker.
- * @internal
+ * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
  */
-export interface MessageValue<
-  Data = unknown,
-  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
-> extends Task<Data> {
+export interface WorkerError<Data = unknown> {
   /**
-   * Kill code.
+   * Task function name triggering the error.
    */
-  readonly kill?: KillBehavior | 1
+  readonly name: string
   /**
-   * Task error.
+   * Error message.
    */
-  readonly error?: string
+  readonly message: string
   /**
-   * Task data triggering task error.
+   * Data triggering the error.
    */
-  readonly errorData?: unknown
+  readonly data?: Data
+}
+
+/**
+ * Task performance.
+ *
+ * @internal
+ */
+export interface TaskPerformance {
   /**
-   * Runtime.
+   * Task name.
    */
-  readonly runTime?: number
+  readonly name: string
   /**
-   * Wait time.
+   * Task performance timestamp.
    */
-  readonly waitTime?: number
+  readonly timestamp: number
   /**
-   * Event loop utilization.
+   * Task runtime.
    */
-  readonly elu?: EventLoopUtilization
+  readonly runTime?: number
   /**
-   * Reference to main worker.
+   * Task event loop utilization.
    */
-  readonly parent?: MainWorker
+  readonly elu?: EventLoopUtilization
 }
 
 /**
- * Worker synchronous function that can be executed.
- *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
- */
-export type WorkerSyncFunction<Data = unknown, Response = unknown> = (
-  data?: Data
-) => Response
-
-/**
- * Worker asynchronous function that can be executed.
- * This function must return a promise.
+ * Worker task performance statistics computation settings.
  *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
  */
-export type WorkerAsyncFunction<Data = unknown, Response = unknown> = (
-  data?: Data
-) => Promise<Response>
+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
+}
 
 /**
- * Worker function that can be executed.
- * This function can be synchronous or asynchronous.
+ * 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 serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @internal
  */
-export type WorkerFunction<Data = unknown, Response = unknown> =
-  | WorkerSyncFunction<Data, Response>
-  | WorkerAsyncFunction<Data, Response>
+export interface Task<Data = unknown> {
+  /**
+   * Task name.
+   */
+  readonly name?: string
+  /**
+   * Task input data that will be passed to the worker.
+   */
+  readonly data?: Data
+  /**
+   * Array of transferable objects.
+   */
+  readonly transferList?: TransferListItem[]
+  /**
+   * Timestamp.
+   */
+  readonly timestamp?: number
+  /**
+   * Task UUID.
+   */
+  readonly taskId?: string
+}
 
 /**
- * Worker functions that can be executed.
- * This object can contain synchronous or asynchronous functions.
- * The key is the name of the function.
- * The value is the function itself.
+ * Message object that is passed between main worker and worker.
  *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @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 type TaskFunctions<Data = unknown, Response = unknown> = Record<
-string,
-WorkerFunction<Data, Response>
->
+export interface MessageValue<Data = unknown, ErrorData = unknown>
+  extends Task<Data> {
+  /**
+   * Worker id.
+   */
+  readonly workerId?: number
+  /**
+   * Kill code.
+   */
+  readonly kill?: KillBehavior | true | 'success' | 'failure'
+  /**
+   * Worker error.
+   */
+  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 serialized to string.
+   */
+  readonly taskFunction?: string
+  /**
+   * Task function name.
+   */
+  readonly taskFunctionName?: string
+  /**
+   * Task function names.
+   */
+  readonly taskFunctionNames?: string[]
+  /**
+   * 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 checkActive?: boolean
+  /**
+   * Message port.
+   */
+  readonly port?: MessagePort
+}
 
 /**
- * An object holding the execution response promise resolve/reject callbacks.
+ * An object holding the task execution response promise resolve/reject callbacks.
  *
- * @typeParam Worker - Type of worker.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @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.
    */
-  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 node key executing the task.
+   */
+  readonly workerNodeKey: number
   /**
-   * The worker handling the execution.
+   * The asynchronous resource used to track the task execution.
    */
-  readonly worker: Worker
+  readonly asyncResource?: AsyncResource
 }
+
+export type Writable<T> = { -readonly [P in keyof T]: T[P] }