X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=f330d192296dcc62a5b86a4209126d21798acff6;hb=25f5b5de1c522d29f7a16597245a2f7c9434b124;hp=544b4cd0a07e85f407a192466601167392167a41;hpb=50e66724ecb17b83dfb87b1128ca9674f9b14e03;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 544b4cd0..f330d192 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,54 +1,82 @@ -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 } from './pools/worker' +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 = { -readonly [P in keyof T]?: T[P] } +export interface TaskError { + /** + * 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 { + /** + * Task performance timestamp. + */ + timestamp: number /** - * Input data that will be passed to the worker. + * Task runtime. */ - readonly data?: Data + runTime?: number /** - * Id of the message. + * Task event loop utilization. */ - readonly id?: string + 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 + extends Task { /** * Kill code. */ readonly kill?: KillBehavior | 1 /** - * Error. + * Task error. */ - readonly error?: string + readonly taskError?: TaskError /** - * Runtime. + * Task performance. */ - readonly runTime?: number + readonly taskPerformance?: TaskPerformance /** - * Reference to main worker. - * - * Only for internal use. - * @internal + * Whether to compute the given statistics or not. */ - readonly parent?: MainWorker + 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. + * @typeParam Response - Type of execution response. This can only be structured-cloneable data. + * @internal */ export interface PromiseResponseWrapper< Worker extends IWorker,