X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=a418ee885f903d3bb9838c0c34be0e6bbce43524;hb=251d6ac2d29d7361d671a8df17af51b414ea3b83;hp=769949e0f76c29ce5cc76e49bf3e0b162c89f63c;hpb=cc9b8d300c91ae6346ddd5904ff9bc932d0d3346;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 769949e0..a418ee88 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,64 +1,154 @@ -import type { Worker as ClusterWorker } from 'cluster' -import type { MessagePort } from 'worker_threads' -import type { IWorker } from './pools/abstract-pool' +import type { EventLoopUtilization } from 'node:perf_hooks' +import type { MessagePort, TransferListItem } from 'node:worker_threads' import type { KillBehavior } from './worker/worker-options' /** - * 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 { + /** + * Task name triggering the error. + */ + readonly name: string + /** + * Error message. + */ + readonly message: string + /** + * Data triggering the error. + */ + readonly data?: Data +} /** - * Message object that is passed between worker and main worker. + * Task performance. + * + * @internal */ -export interface MessageValue< - Data = unknown, - MainWorker extends ClusterWorker | MessagePort | unknown = unknown -> { +export interface TaskPerformance { + /** + * Task name. + */ + readonly name: string + /** + * Task performance timestamp. + */ + readonly timestamp: number + /** + * Task runtime. + */ + readonly runTime?: number /** - * Input data that will be passed to the worker. + * Task event loop utilization. + */ + readonly elu?: EventLoopUtilization +} + +/** + * Performance statistics computation. + * + * @internal + */ +export interface WorkerStatistics { + runTime: boolean + elu: boolean +} + +/** + * Message object that is passed as a task between main worker and worker. + * + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. + * @internal + */ +export interface Task { + /** + * Worker id. + */ + readonly workerId: number + /** + * Task name. + */ + readonly name?: string + /** + * Task input data that will be passed to the worker. */ readonly data?: Data /** - * Id of the message. + * Array of transferable objects. */ - readonly id?: number + readonly transferList?: TransferListItem[] + /** + * Timestamp. + */ + readonly timestamp?: number + /** + * Task UUID. + */ + readonly taskId?: string +} + +/** + * 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 + readonly kill?: KillBehavior | true | 'success' | 'failure' + /** + * Task error. + */ + readonly taskError?: TaskError + /** + * Task performance. + */ + readonly taskPerformance?: TaskPerformance + /** + * Task function names. + */ + readonly taskFunctions?: string[] + /** + * Whether the worker computes the given statistics or not. + */ + readonly statistics?: WorkerStatistics + /** + * Whether the worker is ready or not. + */ + readonly ready?: boolean /** - * Error. + * Whether the worker starts or stops its activity check. */ - readonly error?: string + readonly checkActive?: boolean /** - * Reference to main worker. - * - * _Only for internal use_ + * Message port. */ - readonly parent?: MainWorker + readonly port?: MessagePort } /** - * An object holding the worker that will be used to resolve/rejects the promise later on. + * An object holding the task execution response promise resolve/reject callbacks. * - * @template Worker Type of worker. - * @template Response Type of response of execution. This can only be serializable data. + * @typeParam Response - Type of execution response. This can only be structured-cloneable data. + * @internal */ -export interface PromiseWorkerResponseWrapper< - Worker extends IWorker, - Response = unknown -> { +export interface PromiseResponseWrapper { /** * Resolve callback to fulfill the promise. */ - readonly resolve: (value: Response) => void + readonly resolve: (value: Response | PromiseLike) => void /** * Reject callback to reject the promise. */ - readonly reject: (reason?: string) => void + readonly reject: (reason?: unknown) => void /** - * The worker that has the assigned task. + * The worker node key executing the task. */ - readonly worker: Worker + readonly workerNodeKey: number }