X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=a3552e486ed348fe8c0a35041a9ede5e3b028e92;hb=010f158c374ba75715130189cc1c53d8f6ca275f;hp=cc028fecf45d7e3106b09cd0028a55e977e284b9;hpb=e458035a3f34d2fe43a9c24cb9717709805e4d9c;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index cc028fec..a3552e48 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,5 +1,16 @@ -import { EventEmitter } from 'node:events' -import { type TransferListItem } from 'node:worker_threads' +import type { ClusterSettings } from 'node:cluster' +import type { EventEmitterAsyncResource } from 'node:events' +import type { TransferListItem, WorkerOptions } from 'node:worker_threads' + +import type { TaskFunctionProperties } from '../utility-types.js' +import type { + TaskFunction, + TaskFunctionObject +} from '../worker/task-functions.js' +import type { + WorkerChoiceStrategy, + WorkerChoiceStrategyOptions +} from './selection-strategies/selection-strategies-types.js' import type { ErrorHandler, ExitHandler, @@ -8,16 +19,15 @@ import type { MessageHandler, OnlineHandler, WorkerType -} from './worker' -import type { - WorkerChoiceStrategy, - WorkerChoiceStrategyOptions -} from './selection-strategies/selection-strategies-types' +} from './worker.js' /** * Enumeration of pool types. */ -export const PoolTypes = Object.freeze({ +export const PoolTypes: Readonly<{ + fixed: 'fixed' + dynamic: 'dynamic' +}> = Object.freeze({ /** * Fixed pool type. */ @@ -33,18 +43,23 @@ export const PoolTypes = Object.freeze({ */ export type PoolType = keyof typeof PoolTypes -/** - * Pool events emitter. - */ -export class PoolEmitter extends EventEmitter {} - /** * Enumeration of pool events. */ -export const PoolEvents = Object.freeze({ +export const PoolEvents: Readonly<{ + ready: 'ready' + busy: 'busy' + full: 'full' + empty: 'empty' + destroy: 'destroy' + error: 'error' + taskError: 'taskError' + backPressure: 'backPressure' +}> = Object.freeze({ ready: 'ready', busy: 'busy', full: 'full', + empty: 'empty', destroy: 'destroy', error: 'error', taskError: 'taskError', @@ -63,14 +78,18 @@ export interface PoolInfo { readonly version: string readonly type: PoolType readonly worker: WorkerType + readonly started: boolean readonly ready: boolean - readonly strategy: WorkerChoiceStrategy + readonly defaultStrategy: WorkerChoiceStrategy + readonly strategyRetries: number readonly minSize: number readonly maxSize: number /** Pool utilization. */ readonly utilization?: number /** Pool total worker nodes. */ readonly workerNodes: number + /** Pool stealing worker nodes. */ + readonly stealingWorkerNodes?: number /** Pool idle worker nodes. */ readonly idleWorkerNodes: number /** Pool busy worker nodes. */ @@ -80,6 +99,7 @@ export interface PoolInfo { readonly queuedTasks?: number readonly maxQueuedTasks?: number readonly backPressure?: boolean + readonly stolenTasks?: number readonly failedTasks: number readonly runTime?: { readonly minimum: number @@ -93,6 +113,20 @@ export interface PoolInfo { readonly average?: number readonly median?: number } + readonly elu?: { + idle: { + readonly minimum: number + readonly maximum: number + readonly average?: number + readonly median?: number + } + active: { + readonly minimum: number + readonly maximum: number + readonly average?: number + readonly median?: number + } + } } /** @@ -105,16 +139,30 @@ export interface TasksQueueOptions { * @defaultValue (pool maximum size)^2 */ readonly size?: number - /** - * @deprecated Use `size` instead. - */ - readonly queueMaxSize?: number /** * Maximum number of tasks that can be executed concurrently on a worker node. * * @defaultValue 1 */ readonly concurrency?: number + /** + * Whether to enable task stealing on idle. + * + * @defaultValue true + */ + readonly taskStealing?: boolean + /** + * Whether to enable tasks stealing under back pressure. + * + * @defaultValue false + */ + readonly tasksStealingOnBackPressure?: boolean + /** + * Queued tasks finished timeout in milliseconds at worker node termination. + * + * @defaultValue 2000 + */ + readonly tasksFinishedTimeout?: number } /** @@ -125,22 +173,36 @@ export interface TasksQueueOptions { export interface PoolOptions { /** * A function that will listen for online event on each worker. + * + * @defaultValue `() => {}` */ onlineHandler?: OnlineHandler /** * A function that will listen for message event on each worker. + * + * @defaultValue `() => {}` */ messageHandler?: MessageHandler /** * A function that will listen for error event on each worker. + * + * @defaultValue `() => {}` */ errorHandler?: ErrorHandler /** * A function that will listen for exit event on each worker. + * + * @defaultValue `() => {}` */ exitHandler?: ExitHandler /** - * The worker choice strategy to use in this pool. + * Whether to start the minimum number of workers at pool initialization. + * + * @defaultValue true + */ + startWorkers?: boolean + /** + * The default worker choice strategy to use in this pool. * * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN */ @@ -154,7 +216,7 @@ export interface PoolOptions { */ restartWorkerOnError?: boolean /** - * Pool events emission. + * Pool events integrated with async resource emission. * * @defaultValue true */ @@ -169,6 +231,24 @@ export interface PoolOptions { * Pool worker node tasks queue options. */ tasksQueueOptions?: TasksQueueOptions + /** + * Worker options. + * + * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options + */ + workerOptions?: WorkerOptions + /** + * Key/value pairs to add to worker process environment. + * + * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env + */ + env?: Record + /** + * Cluster settings. + * + * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings + */ + settings?: ClusterSettings } /** @@ -194,54 +274,87 @@ export interface IPool< */ readonly workerNodes: Array> /** - * Whether the worker node has back pressure (i.e. its tasks queue is full). - * - * @param workerNodeKey - The worker node key. - * @returns `true` if the worker node has back pressure, `false` otherwise. - * @internal - */ - readonly hasWorkerNodeBackPressure: (workerNodeKey: number) => boolean - /** - * Emitter on which events can be listened to. + * Pool event emitter integrated with async resource. + * The async tracking tooling identifier is `poolifier:--pool`. * * Events that can currently be listened to: * - * - `'ready'`: Emitted when the number of workers created in the pool has reached the minimum 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. + * - `'ready'`: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready. + * - `'busy'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota. * - `'full'`: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected. + * - `'empty'`: Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected. * - `'destroy'`: Emitted when the pool is destroyed. * - `'error'`: Emitted when an uncaught error occurs. * - `'taskError'`: Emitted when an error occurs while executing a task. * - `'backPressure'`: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size \>= maximum queue size). */ - readonly emitter?: PoolEmitter + readonly emitter?: EventEmitterAsyncResource /** * Executes the specified function in the worker constructor with the task data input parameter. * * @param data - The optional task input data for the specified task function. This can only be structured-cloneable data. * @param name - The optional name of the task function to execute. If not specified, the default task function will be executed. - * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards. + * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards. * @returns Promise that will be fulfilled when the task is completed. */ readonly execute: ( data?: Data, name?: string, - transferList?: TransferListItem[] + transferList?: readonly TransferListItem[] ) => Promise + /** + * Starts the minimum number of workers in this pool. + */ + readonly start: () => void /** * Terminates all workers in this pool. */ readonly destroy: () => Promise /** - * Lists the names of task function available in this pool. + * Whether the specified task function exists in this pool. + * + * @param name - The name of the task function. + * @returns `true` if the task function exists, `false` otherwise. + */ + readonly hasTaskFunction: (name: string) => boolean + /** + * Adds a task function to this pool. + * If a task function with the same name already exists, it will be overwritten. + * + * @param name - The name of the task function. + * @param fn - The task function. + * @returns `true` if the task function was added, `false` otherwise. + * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string. + * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function or task function object. + */ + readonly addTaskFunction: ( + name: string, + fn: TaskFunction | TaskFunctionObject + ) => Promise + /** + * Removes a task function from this pool. * - * @returns The names of task function available in this pool. + * @param name - The name of the task function. + * @returns `true` if the task function was removed, `false` otherwise. */ - readonly listTaskFunctions: () => string[] + readonly removeTaskFunction: (name: string) => Promise /** - * Sets the worker choice strategy in this pool. + * Lists the properties of task functions available in this pool. * - * @param workerChoiceStrategy - The worker choice strategy. + * @returns The properties of task functions available in this pool. + */ + readonly listTaskFunctionsProperties: () => TaskFunctionProperties[] + /** + * Sets the default task function in this pool. + * + * @param name - The name of the task function. + * @returns `true` if the default task function was set, `false` otherwise. + */ + readonly setDefaultTaskFunction: (name: string) => Promise + /** + * Sets the default worker choice strategy in this pool. + * + * @param workerChoiceStrategy - The default worker choice strategy. * @param workerChoiceStrategyOptions - The worker choice strategy options. */ readonly setWorkerChoiceStrategy: ( @@ -252,10 +365,11 @@ export interface IPool< * Sets the worker choice strategy options in this pool. * * @param workerChoiceStrategyOptions - The worker choice strategy options. + * @returns `true` if the worker choice strategy options were set, `false` otherwise. */ readonly setWorkerChoiceStrategyOptions: ( workerChoiceStrategyOptions: WorkerChoiceStrategyOptions - ) => void + ) => boolean /** * Enables/disables the worker node tasks queue in this pool. *