-import type { Worker as ClusterWorker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
-import type { AbstractPoolWorker } from './pools/abstract-pool-worker'
+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.
+ * Task error.
+ *
+ * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
*/
-export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
+export interface TaskError<Data = unknown> {
+ /**
+ * Error message.
+ */
+ message: string
+ /**
+ * Data passed to the worker triggering the error.
+ */
+ data?: Data
+}
/**
- * Message object that is passed between worker and main worker.
+ * Task performance.
*/
-export interface MessageValue<
- Data = unknown,
- MainWorker extends ClusterWorker | MessagePort | unknown = unknown
-> {
+export interface TaskPerformance {
/**
- * Input data that will be passed to the worker.
+ * Task performance timestamp.
*/
- readonly data?: Data
+ timestamp: number
/**
- * Id of the message.
+ * Task runtime.
*/
- readonly id?: number
+ runTime?: number
+ /**
+ * Task event loop utilization.
+ */
+ elu?: EventLoopUtilization
+}
+
+/**
+ * Performance statistics computation.
+ */
+export interface WorkerStatistics {
+ runTime: boolean
+ elu: boolean
+}
+
+/**
+ * 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> {
/**
* Kill code.
*/
readonly kill?: KillBehavior | 1
/**
- * Error.
+ * Task error.
+ */
+ readonly taskError?: TaskError<ErrorData>
+ /**
+ * Task performance.
*/
- readonly error?: string
+ readonly taskPerformance?: TaskPerformance
/**
- * Reference to main worker.
- *
- * Only for internal use.
+ * Whether the worker computes the given statistics or not.
*/
- readonly parent?: MainWorker
+ readonly statistics?: WorkerStatistics
}
/**
- * An object holding the worker that will be used to resolve/rejects the promise later on.
+ * An object holding the execution response promise resolve/reject callbacks.
*
- * @template Worker Type of worker.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @typeParam Worker - Type of worker.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
+ * @internal
*/
-export interface PromiseWorkerResponseWrapper<
- Worker extends AbstractPoolWorker,
+export interface PromiseResponseWrapper<
+ Worker extends IWorker,
Response = unknown
> {
/**
*/
readonly reject: (reason?: string) => void
/**
- * The worker that has the assigned task.
+ * The worker handling the execution.
*/
readonly worker: Worker
}