X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=bfbc2a84e376ac1db341614f6427943d5405285f;hb=520c8c68ceeccd6b9f4cd363241fdd2c4d628234;hp=21a442538d4988eba011f7904b2467cc895c3593;hpb=91ee39ed9280daa760f898e84b4e7dc68debe5ba;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 21a44253..bfbc2a84 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,5 +1,6 @@ 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' @@ -10,17 +11,61 @@ import type { IWorker, Task } from './pools/worker' */ export type Draft = { -readonly [P in keyof T]?: T[P] } +/** + * Task error. + * + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + */ +export interface TaskError { + /** + * Error message. + */ + message: string + /** + * Data passed to the worker triggering the error. + */ + data?: Data +} + +/** + * Task performance. + */ +export interface TaskPerformance { + /** + * Task performance timestamp. + */ + timestamp: number + /** + * Task runtime. + */ + 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 MessageData - Type of data sent to and/or from the worker. This can only be serializable data. * @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< + MessageData = unknown, Data = unknown, MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort -> extends Task { +> extends Task { /** * Kill code. */ @@ -28,71 +73,21 @@ export interface MessageValue< /** * Task error. */ - readonly error?: string - /** - * Task data triggering task error. - */ - readonly errorData?: unknown - /** - * Runtime. - */ - readonly runTime?: number + readonly taskError?: TaskError /** - * Wait time. + * Task performance. */ - readonly waitTime?: number + readonly taskPerformance?: TaskPerformance /** * Reference to main worker. */ readonly parent?: MainWorker + /** + * Whether to compute the given statistics or not. + */ + readonly statistics?: WorkerStatistics } -/** - * Worker synchronous function that can be executed. - * - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam Response - Type of execution response. This can only be serializable data. - */ -export type WorkerSyncFunction = ( - data?: Data -) => Response - -/** - * Worker asynchronous function that can be executed. - * This function must return a promise. - * - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam Response - Type of execution response. This can only be serializable data. - */ -export type WorkerAsyncFunction = ( - data?: Data -) => Promise - -/** - * Worker function that can be executed. - * This function can be synchronous or asynchronous. - * - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam Response - Type of execution response. This can only be serializable data. - */ -export type WorkerFunction = - | WorkerSyncFunction - | WorkerAsyncFunction - -/** - * Worker functions that can be executed. - * This object can contain synchronous or asynchronous functions. - * The key is the name of the function. - * The value is the function itself. - * - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam Response - Type of execution response. This can only be serializable data. - */ -export type TaskFunctions = Record< -string, -WorkerFunction -> - /** * An object holding the execution response promise resolve/reject callbacks. *