X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=f330d192296dcc62a5b86a4209126d21798acff6;hb=448ad5810fdecae4747d35d64b3f6e016ed264f1;hp=54e66e1bbe9432c1c23c2851ca0466486d5efed5;hpb=c7c046988e2b4d93ce7998ebf39e5ad5ab92fec1;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 54e66e1b..f330d192 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,92 +1,81 @@ -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 { + /** + * 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 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 | unknown = unknown -> extends Task { +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. + * Whether to compute the given statistics or not. */ - readonly parent?: MainWorker + 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 object. - * 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. * * @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<