-import type { CircularArray } from '../circular-array'
+import type { EventEmitter } from 'node:events'
+import type { MessageChannel, WorkerOptions } from 'node:worker_threads'
+
+import type { CircularArray } from '../circular-array.js'
+import type { Task } from '../utility-types.js'
+
+/**
+ * Callback invoked when the worker has started successfully.
+ *
+ * @typeParam Worker - Type of worker.
+ */
+export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
/**
* Callback invoked if the worker has received a message.
+ *
+ * @typeParam Worker - Type of worker.
*/
export type MessageHandler<Worker extends IWorker> = (
this: Worker,
- m: unknown
+ message: unknown
) => void
/**
* Callback invoked if the worker raised an error.
+ *
+ * @typeParam Worker - Type of worker.
*/
export type ErrorHandler<Worker extends IWorker> = (
this: Worker,
- e: Error
+ error: Error
) => void
-/**
- * Callback invoked when the worker has started successfully.
- */
-export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
-
/**
* Callback invoked when the worker exits successfully.
+ *
+ * @typeParam Worker - Type of worker.
*/
export type ExitHandler<Worker extends IWorker> = (
this: Worker,
- code: number
+ exitCode: number
) => void
/**
- * Message object that is passed as a task between main worker and worker.
+ * Worker event handler.
+ *
+ * @typeParam Worker - Type of worker.
+ */
+export type EventHandler<Worker extends IWorker> =
+ | OnlineHandler<Worker>
+ | MessageHandler<Worker>
+ | ErrorHandler<Worker>
+ | ExitHandler<Worker>
+
+/**
+ * Measurement statistics.
+ *
+ * @internal
+ */
+export interface MeasurementStatistics {
+ /**
+ * Measurement aggregate.
+ */
+ aggregate?: number
+ /**
+ * Measurement minimum.
+ */
+ minimum?: number
+ /**
+ * Measurement maximum.
+ */
+ maximum?: number
+ /**
+ * Measurement average.
+ */
+ average?: number
+ /**
+ * Measurement median.
+ */
+ median?: number
+ /**
+ * Measurement history.
+ */
+ readonly history: CircularArray<number>
+}
+
+/**
+ * Event loop utilization measurement statistics.
+ *
+ * @internal
+ */
+export interface EventLoopUtilizationMeasurementStatistics {
+ readonly idle: MeasurementStatistics
+ readonly active: MeasurementStatistics
+ utilization?: number
+}
+
+/**
+ * Task statistics.
*
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
* @internal
*/
-export interface Task<Data = unknown> {
+export interface TaskStatistics {
+ /**
+ * Number of executed tasks.
+ */
+ executed: number
+ /**
+ * Number of executing tasks.
+ */
+ executing: number
+ /**
+ * Number of queued tasks.
+ */
+ readonly queued: number
+ /**
+ * Maximum number of queued tasks.
+ */
+ readonly maxQueued?: number
+ /**
+ * Number of sequentially stolen tasks.
+ */
+ sequentiallyStolen: number
/**
- * Input data that will be passed to the worker.
+ * Number of stolen tasks.
*/
- readonly data?: Data
+ stolen: number
/**
- * UUID of the message.
+ * Number of failed tasks.
*/
- readonly id?: string
+ failed: number
}
/**
- * Worker tasks usage statistics.
+ * Enumeration of worker types.
+ */
+export const WorkerTypes: Readonly<{ thread: 'thread', cluster: 'cluster' }> =
+ Object.freeze({
+ thread: 'thread',
+ cluster: 'cluster'
+ } as const)
+
+/**
+ * Worker type.
+ */
+export type WorkerType = keyof typeof WorkerTypes
+
+/**
+ * Worker information.
*
* @internal
*/
-export interface TasksUsage {
+export interface WorkerInfo {
/**
- * Number of tasks executed.
+ * Worker id.
*/
- run: number
+ readonly id: number | undefined
/**
- * Number of tasks running.
+ * Worker type.
*/
- running: number
+ readonly type: WorkerType
/**
- * Tasks runtime.
+ * Dynamic flag.
*/
- runTime: number
+ dynamic: boolean
+ /**
+ * Ready flag.
+ */
+ ready: boolean
+ /**
+ * Stealing flag.
+ * This flag is set to `true` when worker node is stealing tasks from another worker node.
+ */
+ stealing: boolean
+ /**
+ * Task function names.
+ */
+ taskFunctionNames?: string[]
+}
+
+/**
+ * Worker usage statistics.
+ *
+ * @internal
+ */
+export interface WorkerUsage {
/**
- * Tasks runtime history.
+ * Tasks statistics.
*/
- runTimeHistory: CircularArray<number>
+ readonly tasks: TaskStatistics
/**
- * Average tasks runtime.
+ * Tasks runtime statistics.
*/
- avgRunTime: number
+ readonly runTime: MeasurementStatistics
/**
- * Median tasks runtime.
+ * Tasks wait time statistics.
*/
- medRunTime: number
+ readonly waitTime: MeasurementStatistics
/**
- * Number of tasks errored.
+ * Tasks event loop utilization statistics.
*/
- error: number
+ readonly elu: EventLoopUtilizationMeasurementStatistics
+}
+
+/**
+ * Worker choice strategy data.
+ *
+ * @internal
+ */
+export interface StrategyData {
+ virtualTaskEndTimestamp?: number
}
/**
* Worker interface.
*/
-export interface IWorker {
+export interface IWorker extends EventEmitter {
+ /**
+ * Cluster worker id.
+ */
+ readonly id?: number
+ /**
+ * Worker thread worker id.
+ */
+ readonly threadId?: number
/**
- * Register an event listener.
+ * Registers an event handler.
*
* @param event - The event.
- * @param handler - The event listener.
+ * @param handler - The event handler.
*/
- on: ((event: 'message', handler: MessageHandler<this>) => void) &
- ((event: 'error', handler: ErrorHandler<this>) => void) &
- ((event: 'online', handler: OnlineHandler<this>) => void) &
- ((event: 'exit', handler: ExitHandler<this>) => void)
+ readonly on: (event: string, handler: EventHandler<this>) => this
/**
- * Register a listener to the exit event that will only performed once.
+ * Registers once an event handler.
*
- * @param event - `'exit'`.
- * @param handler - The exit handler.
+ * @param event - The event.
+ * @param handler - The event handler.
+ */
+ readonly once: (event: string, handler: EventHandler<this>) => this
+ /**
+ * Calling `unref()` on a worker allows the thread to exit if this is the only
+ * active handle in the event system. If the worker is already `unref()`ed calling`unref()` again has no effect.
+ * @since v10.5.0
+ */
+ readonly unref?: () => void
+ /**
+ * Stop all JavaScript execution in the worker thread as soon as possible.
+ * Returns a Promise for the exit code that is fulfilled when the `'exit' event` is emitted.
+ */
+ readonly terminate?: () => Promise<number>
+ /**
+ * Cluster worker disconnect.
+ */
+ readonly disconnect?: () => void
+ /**
+ * Cluster worker kill.
*/
- once: (event: 'exit', handler: ExitHandler<this>) => void
+ readonly kill?: (signal?: string) => void
+}
+
+/**
+ * Worker node options.
+ *
+ * @internal
+ */
+export interface WorkerNodeOptions {
+ workerOptions?: WorkerOptions
+ env?: Record<string, unknown>
+ tasksQueueBackPressureSize: number | undefined
}
/**
* Worker node interface.
*
* @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
* @internal
*/
-export interface WorkerNode<Worker extends IWorker, Data = unknown> {
+export interface IWorkerNode<Worker extends IWorker, Data = unknown>
+ extends EventEmitter {
/**
- * Worker node worker.
+ * Worker.
*/
readonly worker: Worker
/**
- * Worker node tasks usage statistics.
+ * Worker info.
+ */
+ readonly info: WorkerInfo
+ /**
+ * Worker usage statistics.
+ */
+ readonly usage: WorkerUsage
+ /**
+ * Worker choice strategy data.
+ * This is used to store data that are specific to the worker choice strategy.
*/
- tasksUsage: TasksUsage
+ strategyData?: StrategyData
/**
- * Worker node tasks queue.
+ * Message channel (worker thread only).
*/
- readonly tasksQueue: Array<Task<Data>>
+ readonly messageChannel?: MessageChannel
+ /**
+ * Tasks queue back pressure size.
+ * This is the number of tasks that can be enqueued before the worker node has back pressure.
+ */
+ tasksQueueBackPressureSize: number
+ /**
+ * Tasks queue size.
+ *
+ * @returns The tasks queue size.
+ */
+ readonly tasksQueueSize: () => number
+ /**
+ * Enqueue task.
+ *
+ * @param task - The task to queue.
+ * @returns The tasks queue size.
+ */
+ readonly enqueueTask: (task: Task<Data>) => number
+ /**
+ * Prepends a task to the tasks queue.
+ *
+ * @param task - The task to prepend.
+ * @returns The tasks queue size.
+ */
+ readonly unshiftTask: (task: Task<Data>) => number
+ /**
+ * Dequeue task.
+ *
+ * @returns The dequeued task.
+ */
+ readonly dequeueTask: () => Task<Data> | undefined
+ /**
+ * Pops a task from the tasks queue.
+ *
+ * @returns The popped task.
+ */
+ readonly popTask: () => Task<Data> | undefined
+ /**
+ * Clears tasks queue.
+ */
+ readonly clearTasksQueue: () => void
+ /**
+ * Whether the worker node has back pressure (i.e. its tasks queue is full).
+ *
+ * @returns `true` if the worker node has back pressure, `false` otherwise.
+ */
+ readonly hasBackPressure: () => boolean
+ /**
+ * Resets usage statistics.
+ */
+ readonly resetUsage: () => void
+ /**
+ * Terminates the worker node.
+ */
+ readonly terminate: () => Promise<void>
+ /**
+ * Registers a worker event handler.
+ *
+ * @param event - The event.
+ * @param handler - The event handler.
+ */
+ readonly registerWorkerEventHandler: (
+ event: string,
+ handler: EventHandler<Worker>
+ ) => void
+ /**
+ * Registers once a worker event handler.
+ *
+ * @param event - The event.
+ * @param handler - The event handler.
+ */
+ readonly registerOnceWorkerEventHandler: (
+ event: string,
+ handler: EventHandler<Worker>
+ ) => void
+ /**
+ * Gets task function worker usage statistics.
+ *
+ * @param name - The task function name.
+ * @returns The task function worker usage statistics if the task function worker usage statistics are initialized, `undefined` otherwise.
+ */
+ readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined
+ /**
+ * Deletes task function worker usage statistics.
+ *
+ * @param name - The task function name.
+ * @returns `true` if the task function worker usage statistics were deleted, `false` otherwise.
+ */
+ readonly deleteTaskFunctionWorkerUsage: (name: string) => boolean
+}
+
+/**
+ * Worker node event detail.
+ *
+ * @internal
+ */
+export interface WorkerNodeEventDetail {
+ workerId?: number
+ workerNodeKey?: number
}
repositories / poolifier.git / blobdiff