-import EventEmitter from 'node:events'
+import EventEmitterAsyncResource from 'node:events'
import type {
ErrorHandler,
ExitHandler,
} 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
+
+/**
+ * Enumeration of worker types.
+ */
+export const WorkerTypes = Object.freeze({
+ cluster: 'cluster',
+ thread: 'thread'
+} as const)
+
+/**
+ * Worker type.
+ */
+export type WorkerType = keyof typeof WorkerTypes
/**
* Pool events emitter.
*/
-export class PoolEmitter extends EventEmitter {}
+export class PoolEmitter extends EventEmitterAsyncResource {}
/**
* Enumeration of pool events.
*/
export const PoolEvents = Object.freeze({
full: 'full',
- busy: 'busy'
+ busy: 'busy',
+ error: 'error',
+ taskError: 'taskError'
} as const)
/**
*/
export type PoolEvent = keyof typeof PoolEvents
+/**
+ * Pool information.
+ */
+export interface PoolInfo {
+ type: PoolType
+ worker: WorkerType
+ minSize: number
+ maxSize: number
+ /** Pool utilization ratio. */
+ utilization: number
+ /** Pool total worker nodes */
+ workerNodes: number
+ /** Pool idle worker nodes */
+ idleWorkerNodes: number
+ /** Pool busy worker nodes */
+ busyWorkerNodes: number
+ executedTasks: number
+ executingTasks: number
+ queuedTasks: number
+ maxQueuedTasks: number
+ failedTasks: number
+}
+
/**
* Worker tasks queue options.
*/
exitHandler?: ExitHandler<Worker>
/**
* The worker choice strategy to use in this pool.
+ *
+ * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
*/
workerChoiceStrategy?: WorkerChoiceStrategy
/**
* The worker choice strategy options.
*/
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+ /**
+ * Restart worker on error.
+ */
+ restartWorkerOnError?: boolean
/**
* Pool events emission.
*
/**
* Pool worker tasks queue.
*
- * @experimental
* @defaultValue false
*/
enableTasksQueue?: boolean
/**
* Pool worker tasks queue options.
- *
- * @experimental
*/
tasksQueueOptions?: TasksQueueOptions
}
* 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.
*/
*
* - `'full'`: Emitted when the pool is dynamic and full.
* - `'busy'`: Emitted when the pool is busy.
+ * - `'error'`: Emitted when an uncaught error occurs.
+ * - `'taskError'`: Emitted when an error occurs while executing a task.
*/
readonly emitter?: PoolEmitter
/**
- * Finds a free worker node key based on the number of tasks the worker has applied.
+ * Executes the specified function in the worker constructor with the task data input parameter.
*
- * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
- *
- * If no free worker is found, `-1` is returned.
+ * @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>
+ /**
+ * Terminates every current worker in this pool.
+ */
+ destroy: () => Promise<void>
+ /**
+ * Sets the worker choice strategy in this pool.
*
- * @returns A worker node key if there is one, `-1` otherwise.
+ * @param workerChoiceStrategy - The worker choice strategy.
+ * @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
- findFreeWorkerNodeKey: () => number
+ setWorkerChoiceStrategy: (
+ workerChoiceStrategy: WorkerChoiceStrategy,
+ workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+ ) => void
/**
- * Executes the function specified in the constructor with the task data parameter.
+ * Sets the worker choice strategy options in this pool.
*
- * @param data - The input for the specified task. This can only be serializable data.
- * @returns Promise that will be resolved when the task is successfully completed.
+ * @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
- execute: (data: Data) => Promise<Response>
+ setWorkerChoiceStrategyOptions: (
+ workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+ ) => void
/**
- * Shutdowns every current worker in this pool.
+ * Enables/disables the worker tasks queue in this pool.
+ *
+ * @param enable - Whether to enable or disable the worker tasks queue.
+ * @param tasksQueueOptions - The worker tasks queue options.
*/
- destroy: () => Promise<void>
+ enableTasksQueue: (
+ enable: boolean,
+ tasksQueueOptions?: TasksQueueOptions
+ ) => void
/**
- * Sets the worker choice strategy in this pool.
+ * Sets the worker tasks queue options in this pool.
*
- * @param workerChoiceStrategy - The worker choice strategy.
+ * @param tasksQueueOptions - The worker tasks queue options.
*/
- setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
+ setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
}
repositories / poolifier.git / blobdiff