X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Futility-types.ts;h=9ecf56577f999f4d56a5474917d522f644993749;hb=f0376671beab5dcccfe496375c30153875a38f90;hp=9cdf6b0a7e82f9d1e3da5fb434537ca8e2d943f9;hpb=b6b3245344bd453ea91fa3d74acd5145f70d84fd;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 9cdf6b0a..9ecf5657 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,36 +1,70 @@ -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. + * Task error. * - * @typeParam T - Type in which properties will be non-readonly. + * @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 { + /** + * Worker id. + */ + readonly workerId: number + /** + * Error message. + */ + readonly message: string + /** + * Data passed to the worker triggering the error. + */ + readonly data?: Data +} + +/** + * Task performance. + * + * @internal + */ +export interface TaskPerformance { + /** + * Task performance timestamp. + */ + readonly timestamp: number + /** + * Task runtime. + */ + readonly runTime?: number + /** + * Task event loop utilization. + */ + readonly elu?: EventLoopUtilization +} /** * Performance statistics computation. + * + * @internal */ 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. + * @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, - MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort -> extends Task { +export interface MessageValue + extends Task { + /** + * Worker id. + */ + readonly workerId?: number /** * Kill code. */ @@ -38,38 +72,26 @@ export interface MessageValue< /** * Task error. */ - readonly error?: string + readonly taskError?: TaskError /** - * Task data triggering task error. + * Task performance. */ - readonly errorData?: unknown + readonly taskPerformance?: TaskPerformance /** - * Runtime. + * Whether the worker computes the given statistics or not. */ - readonly runTime?: number - /** - * Wait time. - */ - readonly waitTime?: number - /** - * Event loop utilization. - */ - readonly elu?: EventLoopUtilization - /** - * Reference to main worker. - */ - readonly parent?: MainWorker + readonly statistics?: WorkerStatistics /** - * Whether to compute the given statistics or not. + * Whether the worker has started or not. */ - readonly statistics?: WorkerStatistics + readonly started?: boolean } /** * 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<