X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=0013bf5dc20a27a9b84b63645233d2e636c9df49;hb=8a9febf5f5d99c234d1b89879ff2d6655af7d65f;hp=396c59ad987ea5c9e8294190587917d8036990b5;hpb=6709f3086622c12bae8060915be7a7f6be9d9763;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 396c59ad..0013bf5d 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,37 @@ 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 /** * 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 +51,21 @@ export const PoolEvents = Object.freeze({ */ export type PoolEvent = keyof typeof PoolEvents +/** + * Pool information. + */ +export interface PoolInfo { + type: PoolType + minSize: number + maxSize: number + workerNodes: number + idleWorkerNodes: number + busyWorkerNodes: number + runningTasks: number + queuedTasks: number + maxQueuedTasks: number +} + /** * Worker tasks queue options. */ @@ -83,12 +102,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. * @@ -125,6 +150,10 @@ export interface IPool< * If it is `'dynamic'`, it provides the `max` property. */ readonly type: PoolType + /** + * Pool information. + */ + readonly info: PoolInfo /** * Pool worker nodes. */ @@ -136,25 +165,18 @@ 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 /** - * 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. - * - * If no free worker is found, `-1` is returned. - * - * @returns A worker node key if there is one, `-1` otherwise. - */ - findFreeWorkerNodeKey: () => number - /** - * Executes the function specified in the constructor with the task data parameter. + * Executes the specified function in the worker constructor with the task data input parameter. * - * @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 data - The task input data for the specified worker function. This can only be serializable 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) => Promise + execute: (data?: Data, name?: string) => Promise /** * Shutdowns every current worker in this pool. */