X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=3aa9feb70b04d8ea3b321777dd053d9823d994b0;hb=7f0e133432b540753bcdd06160d1363e9fe65437;hp=e6388b03fc8544f1a5ee3b6eac62d862b51d323e;hpb=b560403426309944ad775794161773a745263190;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index e6388b03..3aa9feb7 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,6 +1,7 @@ -import { EventEmitterAsyncResource } from 'node:events' -import type { TransferListItem } from 'node:worker_threads' -import type { TaskFunction } from '../worker/task-functions' +import type { TransferListItem, WorkerOptions } from 'node:worker_threads' +import type { EventEmitterAsyncResource } from 'node:events' +import type { ClusterSettings } from 'node:cluster' +import type { TaskFunction } from '../worker/task-functions.js' import type { ErrorHandler, ExitHandler, @@ -9,11 +10,11 @@ import type { MessageHandler, OnlineHandler, WorkerType -} from './worker' +} from './worker.js' import type { WorkerChoiceStrategy, WorkerChoiceStrategyOptions -} from './selection-strategies/selection-strategies-types' +} from './selection-strategies/selection-strategies-types.js' /** * Enumeration of pool types. @@ -34,11 +35,6 @@ export const PoolTypes = Object.freeze({ */ export type PoolType = keyof typeof PoolTypes -/** - * Pool event emitter integrated with async resource. - */ -export class PoolEmitter extends EventEmitterAsyncResource {} - /** * Enumeration of pool events. */ @@ -73,6 +69,8 @@ export interface PoolInfo { 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. */ @@ -115,17 +113,23 @@ export interface TasksQueueOptions { */ readonly concurrency?: number /** - * Whether to enable task stealing. + * Whether to enable task stealing on idle. * * @defaultValue true */ readonly taskStealing?: boolean /** - * Whether to enable tasks stealing on back pressure. + * Whether to enable tasks stealing under back pressure. * * @defaultValue true */ readonly tasksStealingOnBackPressure?: boolean + /** + * Queued tasks finished timeout in milliseconds at worker node termination. + * + * @defaultValue 2000 + */ + readonly tasksFinishedTimeout?: number } /** @@ -194,6 +198,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 } /** @@ -219,15 +241,7 @@ 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 - /** - * Event emitter integrated with `AsyncResource` on which events can be listened to. + * Event emitter integrated with async resource on which events can be listened to. * The async tracking tooling identifier is `poolifier:--pool`. * * Events that can currently be listened to: @@ -240,13 +254,13 @@ export interface IPool< * - `'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: (