-import EventEmitter from 'node:events'
+import { EventEmitter } from 'node:events'
import type {
ErrorHandler,
ExitHandler,
IWorker,
+ IWorkerNode,
MessageHandler,
OnlineHandler,
- WorkerNode
+ WorkerType
} from './worker'
import type {
WorkerChoiceStrategy,
} from './selection-strategies/selection-strategies-types'
/**
- * Pool types.
- *
- * @enum
- * @internal
+ * Enumeration of pool types.
*/
-export enum PoolType {
+export const PoolTypes = Object.freeze({
/**
* Fixed pool type.
*/
- FIXED = 'fixed',
+ fixed: 'fixed',
/**
* Dynamic pool type.
*/
- DYNAMIC = 'dynamic'
-}
+ dynamic: 'dynamic'
+} as const)
+
+/**
+ * Pool type.
+ */
+export type PoolType = keyof typeof PoolTypes
/**
* Pool events emitter.
*/
export const PoolEvents = Object.freeze({
full: 'full',
- busy: 'busy'
+ ready: 'ready',
+ busy: 'busy',
+ error: 'error',
+ taskError: 'taskError'
} as const)
/**
*/
export type PoolEvent = keyof typeof PoolEvents
+/**
+ * Pool information.
+ */
+export interface PoolInfo {
+ readonly version: string
+ readonly type: PoolType
+ readonly worker: WorkerType
+ readonly ready: boolean
+ readonly strategy: WorkerChoiceStrategy
+ readonly minSize: number
+ readonly maxSize: number
+ /** Pool utilization ratio. */
+ readonly utilization?: number
+ /** Pool total worker nodes */
+ readonly workerNodes: number
+ /** Pool idle worker nodes */
+ readonly idleWorkerNodes: number
+ /** Pool busy worker nodes */
+ readonly busyWorkerNodes: number
+ readonly executedTasks: number
+ readonly executingTasks: number
+ readonly queuedTasks: number
+ readonly maxQueuedTasks: number
+ readonly failedTasks: number
+ readonly runTime?: {
+ readonly minimum: number
+ readonly maximum: number
+ readonly average: number
+ readonly median?: number
+ }
+ readonly waitTime?: {
+ readonly minimum: number
+ readonly maximum: number
+ readonly average: number
+ readonly median?: number
+ }
+}
+
/**
* Worker tasks queue options.
*/
*
* @defaultValue 1
*/
- concurrency?: number
+ readonly concurrency?: number
}
/**
* The worker choice strategy options.
*/
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+ /**
+ * Restart worker on error.
+ */
+ restartWorkerOnError?: boolean
/**
* Pool events emission.
*
* Contract definition for a poolifier pool.
*
* @typeParam Worker - Type of worker which manages this pool.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
*/
export interface IPool<
Worker extends IWorker,
Response = unknown
> {
/**
- * Pool type.
- *
- * If it is `'dynamic'`, it provides the `max` property.
+ * Pool information.
*/
- readonly type: PoolType
+ readonly info: PoolInfo
/**
* Pool worker nodes.
*/
- readonly workerNodes: Array<WorkerNode<Worker, Data>>
+ readonly workerNodes: Array<IWorkerNode<Worker, Data>>
/**
* Emitter on which events can be listened to.
*
* Events that can currently be listened to:
*
- * - `'full'`: Emitted when the pool is dynamic and full.
- * - `'busy'`: Emitted when the pool is busy.
+ * - `'full'`: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
+ * - `'ready'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are ready.
+ * - `'busy'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
+ * - `'error'`: Emitted when an uncaught error occurs.
+ * - `'taskError'`: Emitted when an error occurs while executing a task.
*/
readonly emitter?: PoolEmitter
/**
- * Executes the function specified in the worker constructor with the task data input parameter.
+ * Executes the specified function in the worker constructor with the task data input parameter.
*
- * @param data - The task input data for the specified worker function. This can only be serializable data.
+ * @param data - The task input data for the specified worker function. This can only be structured-cloneable data.
* @param name - The name of the worker function to execute. If not specified, the default worker function will be executed.
* @returns Promise that will be fulfilled when the task is completed.
*/
- execute: (data?: Data, name?: string) => Promise<Response>
+ readonly execute: (data?: Data, name?: string) => Promise<Response>
/**
- * Shutdowns every current worker in this pool.
+ * Terminates every current worker in this pool.
*/
- destroy: () => Promise<void>
+ readonly destroy: () => Promise<void>
/**
* Sets the worker choice strategy in this pool.
*
* @param workerChoiceStrategy - The worker choice strategy.
* @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
- setWorkerChoiceStrategy: (
+ readonly setWorkerChoiceStrategy: (
workerChoiceStrategy: WorkerChoiceStrategy,
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
) => void
*
* @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
- setWorkerChoiceStrategyOptions: (
+ readonly setWorkerChoiceStrategyOptions: (
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
) => void
/**
* @param enable - Whether to enable or disable the worker tasks queue.
* @param tasksQueueOptions - The worker tasks queue options.
*/
- enableTasksQueue: (
+ readonly enableTasksQueue: (
enable: boolean,
tasksQueueOptions?: TasksQueueOptions
) => void
*
* @param tasksQueueOptions - The worker tasks queue options.
*/
- setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
+ readonly setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
}
repositories / poolifier.git / blobdiff