-import type { Worker as ClusterWorker } from 'node:cluster'
-import type { MessagePort } from 'node:worker_threads'
+import type { AsyncResource } from 'node:async_hooks'
import type { EventLoopUtilization } from 'node:perf_hooks'
-import type { KillBehavior } from './worker/worker-options'
-import type { IWorker, Task } from './pools/worker'
+import type { MessagePort, TransferListItem } from 'node:worker_threads'
-/**
- * Make all properties in T non-readonly.
- *
- * @typeParam T - Type in which properties will be non-readonly.
- */
-export type Draft<T> = { -readonly [P in keyof T]?: T[P] }
+import type { WorkerChoiceStrategy } from './pools/selection-strategies/selection-strategies-types.js'
+import type { KillBehavior } from './worker/worker-options.js'
/**
- * Task error.
+ * Worker error.
*
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
*/
-export interface TaskError<Data = unknown> {
+export interface WorkerError<Data = unknown> {
+ /**
+ * Task function name triggering the error.
+ */
+ readonly name: string
/**
* Error message.
*/
- message: string
+ readonly message: string
/**
- * Data passed to the worker triggering the error.
+ * Data triggering the error.
*/
- data?: Data
+ readonly data?: Data
}
/**
* Task performance.
+ *
+ * @internal
*/
export interface TaskPerformance {
/**
- * Task performance timestamp.
+ * Task name.
*/
- timestamp: number
+ readonly name: string
/**
- * Task runtime.
+ * Task performance timestamp.
*/
- runTime?: number
+ readonly timestamp: number
/**
- * Task wait time.
+ * Task runtime.
*/
- waitTime?: number
+ readonly runTime?: number
/**
* Task event loop utilization.
*/
- elu?: EventLoopUtilization
+ readonly elu?: EventLoopUtilization
}
/**
- * Performance statistics computation.
+ * Worker task performance statistics computation settings.
+ *
+ * @internal
*/
export interface WorkerStatistics {
- runTime: boolean
- waitTime: boolean
- elu: boolean
+ /**
+ * Whether the worker computes the task runtime or not.
+ */
+ readonly runTime: boolean
+ /**
+ * Whether the worker computes the task event loop utilization (ELU) or not.
+ */
+ readonly elu: boolean
+}
+
+/**
+ * Task function properties.
+ *
+ * @internal
+ */
+export interface TaskFunctionProperties {
+ /**
+ * Task function name.
+ */
+ name: string
+ /**
+ * Task function priority. Lower values have higher priority.
+ */
+ priority?: number
+ /**
+ * Task function worker choice strategy.
+ */
+ strategy?: WorkerChoiceStrategy
+}
+
+/**
+ * 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<Data = unknown> {
+ /**
+ * Task name.
+ */
+ readonly name?: string
+ /**
+ * Task input data that will be passed to the worker.
+ */
+ readonly data?: Data
+ /**
+ * Array of transferable objects.
+ */
+ readonly transferList?: readonly TransferListItem[]
+ /**
+ * Timestamp.
+ */
+ readonly timestamp?: number
+ /**
+ * Task UUID.
+ */
+ readonly taskId?: string
}
/**
* 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.
+ * @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<
- MessageData = unknown,
- Data = unknown,
- MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
-> extends Task<MessageData> {
+export interface MessageValue<Data = unknown, ErrorData = unknown>
+ extends Task<Data> {
+ /**
+ * Worker id.
+ */
+ readonly workerId?: number
/**
* Kill code.
*/
- readonly kill?: KillBehavior | 1
+ readonly kill?: KillBehavior | true | 'success' | 'failure'
/**
- * Task error.
+ * Worker error.
*/
- readonly taskError?: TaskError<Data>
+ readonly workerError?: WorkerError<ErrorData>
/**
* Task performance.
*/
readonly taskPerformance?: TaskPerformance
/**
- * Reference to main worker.
+ * Task function operation:
+ * - `'add'` - Add a task function.
+ * - `'remove'` - Remove a task function.
+ * - `'default'` - Set a task function as default.
+ */
+ readonly taskFunctionOperation?: 'add' | 'remove' | 'default'
+ /**
+ * Whether the task function operation is successful or not.
+ */
+ readonly taskFunctionOperationStatus?: boolean
+ /**
+ * Task function properties.
+ */
+ readonly taskFunctionProperties?: TaskFunctionProperties
+ /**
+ * Task function serialized to string.
+ */
+ readonly taskFunction?: string
+ /**
+ * Task functions properties.
*/
- readonly parent?: MainWorker
+ readonly taskFunctionsProperties?: TaskFunctionProperties[]
/**
- * Whether to compute the given statistics or not.
+ * 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 execution response promise resolve/reject callbacks.
+ * An object holding the task 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<
- Worker extends IWorker,
- Response = unknown
-> {
+export interface PromiseResponseWrapper<Response = unknown> {
/**
* Resolve callback to fulfill the promise.
*/
- readonly resolve: (value: Response) => void
+ readonly resolve: (value: Response | PromiseLike<Response>) => void
/**
* Reject callback to reject the promise.
*/
- readonly reject: (reason?: string) => void
+ readonly reject: (reason?: unknown) => void
+ /**
+ * The worker node key executing the task.
+ */
+ readonly workerNodeKey: number
/**
- * The worker handling the execution.
+ * The asynchronous resource used to track the task execution.
*/
- readonly worker: Worker
+ readonly asyncResource?: AsyncResource
}
+
+export type Writable<T> = { -readonly [P in keyof T]: T[P] }
repositories / poolifier.git / blobdiff