X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=78d298f90f20381d3cb2157d276e32ced109f4a2;hb=2431bdb4c2dc637169bf623a40fc6562f685e56e;hp=4395712f801d3f69961eb6e57bbef6e333d6c713;hpb=027063571693f211b35c8851566a063201adb9af;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 4395712f..78d298f9 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,11 +1,12 @@ -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, @@ -13,20 +14,23 @@ import type { } from './selection-strategies/selection-strategies-types' /** - * Pool types. - * - * @enum + * 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. @@ -38,7 +42,10 @@ export class PoolEmitter extends EventEmitter {} */ export const PoolEvents = Object.freeze({ full: 'full', - busy: 'busy' + ready: 'ready', + busy: 'busy', + error: 'error', + taskError: 'taskError' } as const) /** @@ -46,6 +53,44 @@ export const PoolEvents = Object.freeze({ */ 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. */ @@ -55,13 +100,13 @@ export interface TasksQueueOptions { * * @defaultValue 1 */ - concurrency?: number + readonly concurrency?: number } /** * Options for a poolifier pool. * - * @typeParam Worker - The worker type. + * @typeParam Worker - Type of worker. */ export interface PoolOptions { /** @@ -82,12 +127,18 @@ export interface PoolOptions { exitHandler?: ExitHandler /** * 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. * @@ -97,14 +148,11 @@ export interface PoolOptions { /** * Pool worker tasks queue. * - * @experimental * @defaultValue false */ enableTasksQueue?: boolean /** * Pool worker tasks queue options. - * - * @experimental */ tasksQueueOptions?: TasksQueueOptions } @@ -113,8 +161,8 @@ export interface PoolOptions { * 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, @@ -122,49 +170,69 @@ export interface IPool< 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> + readonly workerNodes: Array> /** * 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 /** - * Finds a free worker node key based on the number of tasks the worker has applied. - * - * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned. + * Executes the specified function in the worker constructor with the task data input parameter. * - * 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. + */ + readonly execute: (data?: Data, name?: string) => Promise + /** + * Terminates every current worker in this pool. + */ + readonly destroy: () => Promise + /** + * 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 + readonly setWorkerChoiceStrategy: ( + workerChoiceStrategy: WorkerChoiceStrategy, + workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions + ) => void /** - * Performs the task specified in the constructor with the 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 + readonly 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 + readonly 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 + readonly setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void }