build(deps-dev): bump rollup
[poolifier.git] / src / pools / pool.ts
CommitLineData
2845f2a5 1import { EventEmitter } from 'node:events'
7d91a8cd 2import { type TransferListItem } from 'node:worker_threads'
bdaf31cd
JB
3import type {
4 ErrorHandler,
5 ExitHandler,
50e66724 6 IWorker,
4b628b48 7 IWorkerNode,
bdaf31cd 8 MessageHandler,
c4855468 9 OnlineHandler,
4b628b48 10 WorkerType
f06e48d8 11} from './worker'
da309861
JB
12import type {
13 WorkerChoiceStrategy,
14 WorkerChoiceStrategyOptions
15} from './selection-strategies/selection-strategies-types'
bdaf31cd 16
c4855468 17/**
6b27d407 18 * Enumeration of pool types.
c4855468 19 */
6b27d407 20export const PoolTypes = Object.freeze({
c4855468
JB
21 /**
22 * Fixed pool type.
23 */
6b27d407 24 fixed: 'fixed',
c4855468
JB
25 /**
26 * Dynamic pool type.
27 */
6b27d407
JB
28 dynamic: 'dynamic'
29} as const)
30
31/**
32 * Pool type.
33 */
34export type PoolType = keyof typeof PoolTypes
c4855468 35
b4904890
JB
36/**
37 * Pool events emitter.
38 */
2845f2a5 39export class PoolEmitter extends EventEmitter {}
b4904890 40
aee46736
JB
41/**
42 * Enumeration of pool events.
43 */
44export const PoolEvents = Object.freeze({
2431bdb4 45 ready: 'ready',
1f68cede 46 busy: 'busy',
ef3891a3
JB
47 full: 'full',
48 destroy: 'destroy',
91ee39ed 49 error: 'error',
671d5154
JB
50 taskError: 'taskError',
51 backPressure: 'backPressure'
aee46736
JB
52} as const)
53
54/**
55 * Pool event.
56 */
57export type PoolEvent = keyof typeof PoolEvents
58
6b27d407
JB
59/**
60 * Pool information.
61 */
62export interface PoolInfo {
4b628b48
JB
63 readonly version: string
64 readonly type: PoolType
65 readonly worker: WorkerType
2431bdb4
JB
66 readonly ready: boolean
67 readonly strategy: WorkerChoiceStrategy
4b628b48
JB
68 readonly minSize: number
69 readonly maxSize: number
aa9eede8 70 /** Pool utilization. */
4b628b48 71 readonly utilization?: number
01a59f3c 72 /** Pool total worker nodes. */
4b628b48 73 readonly workerNodes: number
01a59f3c 74 /** Pool idle worker nodes. */
4b628b48 75 readonly idleWorkerNodes: number
01a59f3c 76 /** Pool busy worker nodes. */
4b628b48
JB
77 readonly busyWorkerNodes: number
78 readonly executedTasks: number
79 readonly executingTasks: number
daf86646
JB
80 readonly queuedTasks?: number
81 readonly maxQueuedTasks?: number
a1763c54 82 readonly backPressure?: boolean
68cbdc84 83 readonly stolenTasks?: number
4b628b48
JB
84 readonly failedTasks: number
85 readonly runTime?: {
86 readonly minimum: number
87 readonly maximum: number
3baa0837 88 readonly average?: number
4b628b48 89 readonly median?: number
1dcf8b7b 90 }
4b628b48
JB
91 readonly waitTime?: {
92 readonly minimum: number
93 readonly maximum: number
3baa0837 94 readonly average?: number
4b628b48 95 readonly median?: number
1dcf8b7b 96 }
6b27d407
JB
97}
98
7171d33f 99/**
20c6f652 100 * Worker node tasks queue options.
7171d33f
JB
101 */
102export interface TasksQueueOptions {
103 /**
20c6f652
JB
104 * Maximum tasks queue size per worker node flagging it as back pressured.
105 *
106 * @defaultValue (pool maximum size)^2
107 */
ff3f866a
JB
108 readonly size?: number
109 /**
110 * @deprecated Use `size` instead.
111 */
20c6f652
JB
112 readonly queueMaxSize?: number
113 /**
114 * Maximum number of tasks that can be executed concurrently on a worker node.
7171d33f
JB
115 *
116 * @defaultValue 1
117 */
eb7bf744 118 readonly concurrency?: number
7171d33f
JB
119}
120
bdaf31cd
JB
121/**
122 * Options for a poolifier pool.
c319c66b 123 *
d480d708 124 * @typeParam Worker - Type of worker.
bdaf31cd 125 */
50e66724 126export interface PoolOptions<Worker extends IWorker> {
fd04474e
JB
127 /**
128 * A function that will listen for online event on each worker.
129 */
130 onlineHandler?: OnlineHandler<Worker>
bdaf31cd
JB
131 /**
132 * A function that will listen for message event on each worker.
133 */
134 messageHandler?: MessageHandler<Worker>
135 /**
136 * A function that will listen for error event on each worker.
137 */
138 errorHandler?: ErrorHandler<Worker>
bdaf31cd
JB
139 /**
140 * A function that will listen for exit event on each worker.
141 */
142 exitHandler?: ExitHandler<Worker>
143 /**
46e857ca 144 * The worker choice strategy to use in this pool.
d29bce7c 145 *
95ec6006 146 * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
bdaf31cd
JB
147 */
148 workerChoiceStrategy?: WorkerChoiceStrategy
da309861
JB
149 /**
150 * The worker choice strategy options.
151 */
152 workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
1f68cede
JB
153 /**
154 * Restart worker on error.
155 */
156 restartWorkerOnError?: boolean
bdaf31cd
JB
157 /**
158 * Pool events emission.
159 *
38e795c1 160 * @defaultValue true
bdaf31cd
JB
161 */
162 enableEvents?: boolean
ff733df7 163 /**
20c6f652 164 * Pool worker node tasks queue.
ff733df7 165 *
ff733df7
JB
166 * @defaultValue false
167 */
168 enableTasksQueue?: boolean
7171d33f 169 /**
20c6f652 170 * Pool worker node tasks queue options.
7171d33f
JB
171 */
172 tasksQueueOptions?: TasksQueueOptions
bdaf31cd 173}
a35560ba 174
729c563d
S
175/**
176 * Contract definition for a poolifier pool.
177 *
c4855468 178 * @typeParam Worker - Type of worker which manages this pool.
e102732c
JB
179 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
180 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
729c563d 181 */
c4855468
JB
182export interface IPool<
183 Worker extends IWorker,
184 Data = unknown,
185 Response = unknown
186> {
08f3f44c 187 /**
6b27d407 188 * Pool information.
08f3f44c 189 */
6b27d407 190 readonly info: PoolInfo
c4855468
JB
191 /**
192 * Pool worker nodes.
9768f49f
JB
193 *
194 * @internal
c4855468 195 */
4b628b48 196 readonly workerNodes: Array<IWorkerNode<Worker, Data>>
e2b31e32
JB
197 /**
198 * Whether the worker node has back pressure (i.e. its tasks queue is full).
199 *
200 * @param workerNodeKey - The worker node key.
201 * @returns `true` if the worker node has back pressure, `false` otherwise.
9768f49f 202 * @internal
e2b31e32
JB
203 */
204 readonly hasWorkerNodeBackPressure: (workerNodeKey: number) => boolean
b4904890
JB
205 /**
206 * Emitter on which events can be listened to.
207 *
208 * Events that can currently be listened to:
209 *
d5024c00 210 * - `'ready'`: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
a9780ad2 211 * - `'busy'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
ef3891a3 212 * - `'full'`: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
033f1776 213 * - `'destroy'`: Emitted when the pool is destroyed.
91ee39ed
JB
214 * - `'error'`: Emitted when an uncaught error occurs.
215 * - `'taskError'`: Emitted when an error occurs while executing a task.
d92f3ddf 216 * - `'backPressure'`: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size \>= maximum queue size).
b4904890
JB
217 */
218 readonly emitter?: PoolEmitter
729c563d 219 /**
61aa11a6 220 * Executes the specified function in the worker constructor with the task data input parameter.
729c563d 221 *
7d91a8cd
JB
222 * @param data - The optional task input data for the specified task function. This can only be structured-cloneable data.
223 * @param name - The optional name of the task function to execute. If not specified, the default task function will be executed.
224 * @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.
ef41a6e6 225 * @returns Promise that will be fulfilled when the task is completed.
729c563d 226 */
7d91a8cd
JB
227 readonly execute: (
228 data?: Data,
229 name?: string,
230 transferList?: TransferListItem[]
231 ) => Promise<Response>
280c2a77 232 /**
aa9eede8 233 * Terminates all workers in this pool.
280c2a77 234 */
4b628b48 235 readonly destroy: () => Promise<void>
90d7d101
JB
236 /**
237 * Lists the names of task function available in this pool.
238 *
239 * @returns The names of task function available in this pool.
240 */
241 readonly listTaskFunctions: () => string[]
a35560ba 242 /**
bdede008 243 * Sets the worker choice strategy in this pool.
a35560ba 244 *
38e795c1 245 * @param workerChoiceStrategy - The worker choice strategy.
59219cbb 246 * @param workerChoiceStrategyOptions - The worker choice strategy options.
a35560ba 247 */
4b628b48 248 readonly setWorkerChoiceStrategy: (
59219cbb
JB
249 workerChoiceStrategy: WorkerChoiceStrategy,
250 workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
251 ) => void
a20f0ba5
JB
252 /**
253 * Sets the worker choice strategy options in this pool.
254 *
255 * @param workerChoiceStrategyOptions - The worker choice strategy options.
256 */
4b628b48 257 readonly setWorkerChoiceStrategyOptions: (
a20f0ba5
JB
258 workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
259 ) => void
260 /**
20c6f652 261 * Enables/disables the worker node tasks queue in this pool.
a20f0ba5 262 *
20c6f652
JB
263 * @param enable - Whether to enable or disable the worker node tasks queue.
264 * @param tasksQueueOptions - The worker node tasks queue options.
a20f0ba5 265 */
4b628b48 266 readonly enableTasksQueue: (
8f52842f
JB
267 enable: boolean,
268 tasksQueueOptions?: TasksQueueOptions
269 ) => void
a20f0ba5 270 /**
20c6f652 271 * Sets the worker node tasks queue options in this pool.
a20f0ba5 272 *
20c6f652 273 * @param tasksQueueOptions - The worker node tasks queue options.
a20f0ba5 274 */
4b628b48 275 readonly setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
c97c7edb 276}