Merge pull request #770 from poolifier/elu-strategy

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

diff --git a/src/utility-types.ts b/src/utility-types.ts
index 5a3ef4c565f184e5712d2f47f755848a62f3cb42..9cdf6b0a7e82f9d1e3da5fb434537ca8e2d943f9 100644 (file)
--- a/src/utility-types.ts
+++ b/src/utility-types.ts
@@ -1,9 +1,91 @@
+import type { Worker as ClusterWorker } from 'node:cluster'
+import type { MessagePort } from 'node:worker_threads'
+import type { EventLoopUtilization } from 'node:perf_hooks'
+import type { KillBehavior } from './worker/worker-options'
+import type { IWorker, Task } from './pools/worker'
+
+/**
+ * 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] }
 
-export interface MessageValue<Data> {
-  readonly data?: Data
-  readonly id?: number
-  readonly kill?: number
+/**
+ * Performance statistics computation.
+ */
+export interface WorkerStatistics {
+  runTime: boolean
+  waitTime: boolean
+  elu: boolean
+}
+
+/**
+ * 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 MainWorker - Type of main worker.
+ * @internal
+ */
+export interface MessageValue<
+  Data = unknown,
+  MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
+> extends Task<Data> {
+  /**
+   * Kill code.
+   */
+  readonly kill?: KillBehavior | 1
+  /**
+   * Task error.
+   */
   readonly error?: string
-  readonly parent?: MessagePort
+  /**
+   * Task data triggering task error.
+   */
+  readonly errorData?: unknown
+  /**
+   * Runtime.
+   */
+  readonly runTime?: number
+  /**
+   * Wait time.
+   */
+  readonly waitTime?: number
+  /**
+   * Event loop utilization.
+   */
+  readonly elu?: EventLoopUtilization
+  /**
+   * Reference to main worker.
+   */
+  readonly parent?: MainWorker
+  /**
+   * Whether to compute the given statistics or not.
+   */
+  readonly statistics?: WorkerStatistics
+}
+
+/**
+ * An object holding the execution response promise resolve/reject callbacks.
+ *
+ * @typeParam Worker - Type of worker.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @internal
+ */
+export interface PromiseResponseWrapper<
+  Worker extends IWorker,
+  Response = unknown
+> {
+  /**
+   * Resolve callback to fulfill the promise.
+   */
+  readonly resolve: (value: Response) => void
+  /**
+   * Reject callback to reject the promise.
+   */
+  readonly reject: (reason?: string) => void
+  /**
+   * The worker handling the execution.
+   */
+  readonly worker: Worker
 }