X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=a418ee885f903d3bb9838c0c34be0e6bbce43524;hb=251d6ac2d29d7361d671a8df17af51b414ea3b83;hp=5a3ef4c565f184e5712d2f47f755848a62f3cb42;hpb=325f50bc1777ea44abc9736ce9d780ec0c8f90e2;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 5a3ef4c5..a418ee88 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,9 +1,154 @@ -export type Draft = { -readonly [P in keyof T]?: T[P] } +import type { EventLoopUtilization } from 'node:perf_hooks' +import type { MessagePort, TransferListItem } from 'node:worker_threads' +import type { KillBehavior } from './worker/worker-options' -export interface MessageValue { +/** + * Task error. + * + * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data. + */ +export interface TaskError { + /** + * Task name triggering the error. + */ + readonly name: string + /** + * Error message. + */ + readonly message: string + /** + * Data triggering the error. + */ readonly data?: Data - readonly id?: number - readonly kill?: number - readonly error?: string - readonly parent?: MessagePort +} + +/** + * Task performance. + * + * @internal + */ +export interface TaskPerformance { + /** + * Task name. + */ + readonly name: string + /** + * 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 + 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 + /** + * Array of transferable objects. + */ + 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 | 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 + /** + * Whether the worker starts or stops its activity check. + */ + readonly checkActive?: boolean + /** + * Message port. + */ + readonly port?: MessagePort +} + +/** + * An object holding the task execution response promise resolve/reject callbacks. + * + * @typeParam Response - Type of execution response. This can only be structured-cloneable data. + * @internal + */ +export interface PromiseResponseWrapper { + /** + * Resolve callback to fulfill the promise. + */ + readonly resolve: (value: Response | PromiseLike) => void + /** + * Reject callback to reject the promise. + */ + readonly reject: (reason?: unknown) => void + /** + * The worker node key executing the task. + */ + readonly workerNodeKey: number }