X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=faeda0a5a4e4048ed9c16b5e48d8bdecd4b8c690;hb=d715b7bc2973eed82edebb1f7d233d451ad3c97b;hp=544b4cd0a07e85f407a192466601167392167a41;hpb=ffe8ca52bf1a05f68a0c939d16f15b6b54028be9;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 544b4cd0..faeda0a5 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,47 +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. + * + * @typeParam T - Type in which properties will be non-readonly. */ export type Draft = { -readonly [P in keyof T]?: T[P] } /** - * 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 wait time. */ - readonly id?: string + waitTime?: number + /** + * Task event loop utilization. + */ + elu?: EventLoopUtilization +} + +/** + * 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 { /** * Kill code. */ readonly kill?: KillBehavior | 1 /** - * Error. + * Task error. */ readonly error?: string /** - * Runtime. + * Task data triggering task error. + */ + readonly errorData?: unknown + /** + * Task performance. */ - readonly runTime?: number + readonly taskPerformance?: TaskPerformance /** * Reference to main worker. - * - * Only for internal use. - * @internal */ readonly parent?: MainWorker + /** + * Whether to compute the given statistics or not. + */ + readonly statistics?: WorkerStatistics } /** @@ -49,6 +84,7 @@ export interface MessageValue< * * @typeParam Worker - Type of worker. * @typeParam Response - Type of execution response. This can only be serializable data. + * @internal */ export interface PromiseResponseWrapper< Worker extends IWorker,