-import type { MessageChannel } from 'node:worker_threads'
-import type { CircularArray } from '../circular-array'
-import type { Task } from '../utility-types'
+import type { EventEmitter } from 'node:events'
+import type { MessageChannel, WorkerOptions } from 'node:worker_threads'
+
+import type { CircularBuffer } from '../circular-buffer.js'
+import type { Task, TaskFunctionProperties } 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,
/**
* Callback invoked if the worker raised an error.
+ * @typeParam Worker - Type of worker.
*/
export type ErrorHandler<Worker extends IWorker> = (
this: Worker,
/**
* Callback invoked when the worker exits successfully.
+ * @typeParam Worker - Type of worker.
*/
export type ExitHandler<Worker extends IWorker> = (
this: Worker,
exitCode: number
) => void
+/**
+ * Worker event handler.
+ * @typeParam Worker - Type of worker.
+ */
+export type EventHandler<Worker extends IWorker> =
+ | OnlineHandler<Worker>
+ | MessageHandler<Worker>
+ | ErrorHandler<Worker>
+ | ExitHandler<Worker>
+
+/**
+ * Measurement history size.
+ */
+export const MeasurementHistorySize = 386
+
/**
* Measurement statistics.
- *
* @internal
*/
export interface MeasurementStatistics {
/**
* Measurement history.
*/
- readonly history: CircularArray<number>
+ readonly history: CircularBuffer
}
/**
* Event loop utilization measurement statistics.
- *
* @internal
*/
export interface EventLoopUtilizationMeasurementStatistics {
/**
* Task statistics.
- *
* @internal
*/
export interface TaskStatistics {
* Maximum number of queued tasks.
*/
readonly maxQueued?: number
+ /**
+ * Number of sequentially stolen tasks.
+ */
+ sequentiallyStolen: number
/**
* Number of stolen tasks.
*/
/**
* Enumeration of worker types.
*/
-export const WorkerTypes = Object.freeze({
- thread: 'thread',
- cluster: 'cluster'
-} as const)
+export const WorkerTypes: Readonly<{ thread: 'thread'; cluster: 'cluster' }> =
+ Object.freeze({
+ thread: 'thread',
+ cluster: 'cluster',
+ } as const)
/**
* Worker type.
/**
* Worker information.
- *
* @internal
*/
export interface WorkerInfo {
*/
ready: boolean
/**
- * Task function names.
+ * Stealing flag.
+ * This flag is set to `true` when worker node is stealing tasks from another worker node.
*/
- taskFunctions?: string[]
+ stealing: boolean
+ /**
+ * Back pressure flag.
+ * This flag is set to `true` when worker node tasks queue has back pressure.
+ */
+ backPressure: boolean
+ /**
+ * Task functions properties.
+ */
+ taskFunctionsProperties?: TaskFunctionProperties[]
}
/**
* Worker usage statistics.
- *
* @internal
*/
export interface WorkerUsage {
/**
* Worker choice strategy data.
+ * @internal
*/
export interface StrategyData {
virtualTaskEndTimestamp?: number
/**
* Worker interface.
*/
-export interface IWorker {
+export interface IWorker extends EventEmitter {
/**
- * Worker id.
+ * Cluster worker id.
*/
readonly id?: number
+ /**
+ * Worker thread worker id.
+ */
readonly threadId?: number
/**
- * Registers an event listener.
- *
+ * Registers an event handler.
+ * @param event - The event.
+ * @param handler - The event handler.
+ */
+ readonly on: (event: string, handler: EventHandler<this>) => this
+ /**
+ * Registers once an event handler.
* @param event - The event.
* @param handler - The event handler.
*/
- readonly on: ((event: 'online', handler: OnlineHandler<this>) => void) &
- ((event: 'message', handler: MessageHandler<this>) => void) &
- ((event: 'error', handler: ErrorHandler<this>) => void) &
- ((event: 'exit', handler: ExitHandler<this>) => void)
+ readonly once: (event: string, handler: EventHandler<this>) => this
/**
- * Registers a listener to the exit event that will only be performed once.
- *
- * @param event - The `'exit'` event.
- * @param handler - The exit handler.
+ * 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 once: (event: 'exit', handler: ExitHandler<this>) => void
+ 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.
+ */
+ readonly kill?: (signal?: string) => void
}
/**
- * Worker node event callback.
- *
- * @param workerId - The worker id.
+ * Worker node options.
* @internal
*/
-export type WorkerNodeEventCallback = (workerId: number) => void
+export interface WorkerNodeOptions {
+ workerOptions?: WorkerOptions
+ env?: Record<string, unknown>
+ tasksQueueBackPressureSize: number | undefined
+ tasksQueueBucketSize: number | undefined
+ tasksQueuePriority: boolean | undefined
+}
/**
* Worker node interface.
- *
* @typeParam Worker - Type of worker.
* @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
* @internal
*/
-export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
+export interface IWorkerNode<Worker extends IWorker, Data = unknown>
+ extends EventEmitter {
/**
* Worker.
*/
readonly usage: WorkerUsage
/**
* Worker choice strategy data.
- * This is used to store data that is specific to the worker choice strategy.
+ * This is used to store data that are specific to the worker choice strategy.
*/
strategyData?: StrategyData
/**
- * Message channel (worker_threads only).
+ * Message channel (worker thread only).
*/
readonly messageChannel?: MessageChannel
/**
*/
tasksQueueBackPressureSize: number
/**
- * Callback invoked when worker node tasks queue is back pressured.
+ * Sets tasks queue priority.
+ * @param enablePriority - Whether to enable tasks queue priority.
*/
- onBackPressure?: WorkerNodeEventCallback
- /**
- * Callback invoked when worker node tasks queue is empty.
- */
- onEmptyQueue?: WorkerNodeEventCallback
+ readonly setTasksQueuePriority: (enablePriority: boolean) => void
/**
* 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.
- *
+ * @param bucket - The prioritized bucket to dequeue from. @defaultValue 0
* @returns The dequeued task.
*/
- readonly dequeueTask: () => Task<Data> | undefined
+ readonly dequeueTask: (bucket?: number) => Task<Data> | undefined
/**
- * Pops a task from the tasks queue.
- *
- * @returns The popped task.
+ * Dequeue last prioritized task.
+ * @returns The dequeued task.
*/
- readonly popTask: () => Task<Data> | undefined
+ readonly dequeueLastPrioritizedTask: () => 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.
+ * Terminates the worker node.
+ */
+ readonly terminate: () => Promise<void>
+ /**
+ * Registers a worker event handler.
+ * @param event - The event.
+ * @param handler - The event handler.
*/
- readonly resetUsage: () => void
+ readonly registerWorkerEventHandler: (
+ event: string,
+ handler: EventHandler<Worker>
+ ) => void
/**
- * Closes communication channel.
+ * Registers once a worker event handler.
+ * @param event - The event.
+ * @param handler - The event handler.
*/
- readonly closeChannel: () => void
+ 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