X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=87f4a8fa03f781aab2a17926fd98ab088387bf1b;hb=64383951fbf11fdf6a804fc6d081635fb925e403;hp=992aaaf1099c7e341daf3bd1c6a937597018b5ea;hpb=557991e8ddb66a72a47d62606e142e8be86677f2;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 992aaaf1..87f4a8fa 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,4 +1,4 @@ -import EventEmitter from 'node:events' +import EventEmitterAsyncResource from 'node:events' import type { ErrorHandler, ExitHandler, @@ -13,33 +13,50 @@ import type { } 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) /** @@ -47,6 +64,29 @@ export const PoolEvents = Object.freeze({ */ 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. */ @@ -91,6 +131,10 @@ export interface PoolOptions { * The worker choice strategy options. */ workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions + /** + * Restart worker on error. + */ + restartWorkerOnError?: boolean /** * Pool events emission. * @@ -113,8 +157,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,11 +166,9 @@ 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. */ @@ -138,18 +180,20 @@ export interface IPool< * * - `'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 /** - * 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 /** - * Shutdowns every current worker in this pool. + * Terminates every current worker in this pool. */ destroy: () => Promise /**