Commit | Line | Data |
---|---|---|
2845f2a5 | 1 | import { randomUUID } from 'node:crypto' |
62c15a68 | 2 | import { performance } from 'node:perf_hooks' |
3d6dd312 | 3 | import { existsSync } from 'node:fs' |
7d91a8cd | 4 | import { type TransferListItem } from 'node:worker_threads' |
5c4d16da JB |
5 | import type { |
6 | MessageValue, | |
7 | PromiseResponseWrapper, | |
76d91ea0 | 8 | Task |
5c4d16da | 9 | } from '../utility-types' |
bbeadd16 | 10 | import { |
ff128cc9 | 11 | DEFAULT_TASK_NAME, |
bbeadd16 JB |
12 | DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, |
13 | EMPTY_FUNCTION, | |
dc021bcc | 14 | average, |
59317253 | 15 | isKillBehavior, |
0d80593b | 16 | isPlainObject, |
90d6701c | 17 | max, |
afe0d5bf | 18 | median, |
90d6701c | 19 | min, |
e4f20deb JB |
20 | round, |
21 | updateMeasurementStatistics | |
bbeadd16 | 22 | } from '../utils' |
59317253 | 23 | import { KillBehaviors } from '../worker/worker-options' |
c4855468 | 24 | import { |
65d7a1c9 | 25 | type IPool, |
7c5a1080 | 26 | PoolEmitter, |
c4855468 | 27 | PoolEvents, |
6b27d407 | 28 | type PoolInfo, |
c4855468 | 29 | type PoolOptions, |
6b27d407 JB |
30 | type PoolType, |
31 | PoolTypes, | |
4b628b48 | 32 | type TasksQueueOptions |
c4855468 | 33 | } from './pool' |
bbfa38a2 JB |
34 | import type { |
35 | IWorker, | |
36 | IWorkerNode, | |
37 | WorkerInfo, | |
38 | WorkerType, | |
39 | WorkerUsage | |
e102732c | 40 | } from './worker' |
a35560ba | 41 | import { |
008512c7 | 42 | type MeasurementStatisticsRequirements, |
f0d7f803 | 43 | Measurements, |
a35560ba | 44 | WorkerChoiceStrategies, |
a20f0ba5 JB |
45 | type WorkerChoiceStrategy, |
46 | type WorkerChoiceStrategyOptions | |
bdaf31cd JB |
47 | } from './selection-strategies/selection-strategies-types' |
48 | import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context' | |
92b1feaa | 49 | import { version } from './version' |
4b628b48 | 50 | import { WorkerNode } from './worker-node' |
23ccf9d7 | 51 | |
729c563d | 52 | /** |
ea7a90d3 | 53 | * Base class that implements some shared logic for all poolifier pools. |
729c563d | 54 | * |
38e795c1 | 55 | * @typeParam Worker - Type of worker which manages this pool. |
e102732c JB |
56 | * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. |
57 | * @typeParam Response - Type of execution response. This can only be structured-cloneable data. | |
729c563d | 58 | */ |
c97c7edb | 59 | export abstract class AbstractPool< |
f06e48d8 | 60 | Worker extends IWorker, |
d3c8a1a8 S |
61 | Data = unknown, |
62 | Response = unknown | |
c4855468 | 63 | > implements IPool<Worker, Data, Response> { |
afc003b2 | 64 | /** @inheritDoc */ |
4b628b48 | 65 | public readonly workerNodes: Array<IWorkerNode<Worker, Data>> = [] |
4a6952ff | 66 | |
afc003b2 | 67 | /** @inheritDoc */ |
7c0ba920 JB |
68 | public readonly emitter?: PoolEmitter |
69 | ||
be0676b3 | 70 | /** |
192566ec | 71 | * The task execution response promise map: |
2740a743 | 72 | * - `key`: The message id of each submitted task. |
a3445496 | 73 | * - `value`: An object that contains the worker, the execution response promise resolve and reject callbacks. |
be0676b3 | 74 | * |
a3445496 | 75 | * When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id. |
be0676b3 | 76 | */ |
501aea93 JB |
77 | protected promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = |
78 | new Map<string, PromiseResponseWrapper<Response>>() | |
c97c7edb | 79 | |
a35560ba | 80 | /** |
51fe3d3c | 81 | * Worker choice strategy context referencing a worker choice algorithm implementation. |
a35560ba S |
82 | */ |
83 | protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< | |
78cea37e JB |
84 | Worker, |
85 | Data, | |
86 | Response | |
a35560ba S |
87 | > |
88 | ||
8735b4e5 JB |
89 | /** |
90 | * Dynamic pool maximum size property placeholder. | |
91 | */ | |
92 | protected readonly max?: number | |
93 | ||
15b176e0 JB |
94 | /** |
95 | * Whether the pool is started or not. | |
96 | */ | |
97 | private started: boolean | |
47352846 JB |
98 | /** |
99 | * Whether the pool is starting or not. | |
100 | */ | |
101 | private starting: boolean | |
afe0d5bf JB |
102 | /** |
103 | * The start timestamp of the pool. | |
104 | */ | |
105 | private readonly startTimestamp | |
106 | ||
729c563d S |
107 | /** |
108 | * Constructs a new poolifier pool. | |
109 | * | |
38e795c1 | 110 | * @param numberOfWorkers - Number of workers that this pool should manage. |
029715f0 | 111 | * @param filePath - Path to the worker file. |
38e795c1 | 112 | * @param opts - Options for the pool. |
729c563d | 113 | */ |
c97c7edb | 114 | public constructor ( |
b4213b7f JB |
115 | protected readonly numberOfWorkers: number, |
116 | protected readonly filePath: string, | |
117 | protected readonly opts: PoolOptions<Worker> | |
c97c7edb | 118 | ) { |
78cea37e | 119 | if (!this.isMain()) { |
04f45163 | 120 | throw new Error( |
8c6d4acf | 121 | 'Cannot start a pool from a worker with the same type as the pool' |
04f45163 | 122 | ) |
c97c7edb | 123 | } |
8d3782fa | 124 | this.checkNumberOfWorkers(this.numberOfWorkers) |
c510fea7 | 125 | this.checkFilePath(this.filePath) |
7c0ba920 | 126 | this.checkPoolOptions(this.opts) |
1086026a | 127 | |
7254e419 JB |
128 | this.chooseWorkerNode = this.chooseWorkerNode.bind(this) |
129 | this.executeTask = this.executeTask.bind(this) | |
130 | this.enqueueTask = this.enqueueTask.bind(this) | |
1086026a | 131 | |
6bd72cd0 | 132 | if (this.opts.enableEvents === true) { |
7c0ba920 JB |
133 | this.emitter = new PoolEmitter() |
134 | } | |
d59df138 JB |
135 | this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext< |
136 | Worker, | |
137 | Data, | |
138 | Response | |
da309861 JB |
139 | >( |
140 | this, | |
141 | this.opts.workerChoiceStrategy, | |
142 | this.opts.workerChoiceStrategyOptions | |
143 | ) | |
b6b32453 JB |
144 | |
145 | this.setupHook() | |
146 | ||
47352846 | 147 | this.started = false |
075e51d1 | 148 | this.starting = false |
47352846 JB |
149 | if (this.opts.startWorkers === true) { |
150 | this.start() | |
151 | } | |
afe0d5bf JB |
152 | |
153 | this.startTimestamp = performance.now() | |
c97c7edb S |
154 | } |
155 | ||
a35560ba | 156 | private checkFilePath (filePath: string): void { |
ffcbbad8 JB |
157 | if ( |
158 | filePath == null || | |
3d6dd312 | 159 | typeof filePath !== 'string' || |
ffcbbad8 JB |
160 | (typeof filePath === 'string' && filePath.trim().length === 0) |
161 | ) { | |
c510fea7 APA |
162 | throw new Error('Please specify a file with a worker implementation') |
163 | } | |
3d6dd312 JB |
164 | if (!existsSync(filePath)) { |
165 | throw new Error(`Cannot find the worker file '${filePath}'`) | |
166 | } | |
c510fea7 APA |
167 | } |
168 | ||
8d3782fa JB |
169 | private checkNumberOfWorkers (numberOfWorkers: number): void { |
170 | if (numberOfWorkers == null) { | |
171 | throw new Error( | |
172 | 'Cannot instantiate a pool without specifying the number of workers' | |
173 | ) | |
78cea37e | 174 | } else if (!Number.isSafeInteger(numberOfWorkers)) { |
473c717a | 175 | throw new TypeError( |
0d80593b | 176 | 'Cannot instantiate a pool with a non safe integer number of workers' |
8d3782fa JB |
177 | ) |
178 | } else if (numberOfWorkers < 0) { | |
473c717a | 179 | throw new RangeError( |
8d3782fa JB |
180 | 'Cannot instantiate a pool with a negative number of workers' |
181 | ) | |
6b27d407 | 182 | } else if (this.type === PoolTypes.fixed && numberOfWorkers === 0) { |
2431bdb4 JB |
183 | throw new RangeError('Cannot instantiate a fixed pool with zero worker') |
184 | } | |
185 | } | |
186 | ||
187 | protected checkDynamicPoolSize (min: number, max: number): void { | |
079de991 | 188 | if (this.type === PoolTypes.dynamic) { |
a5ed75b7 | 189 | if (max == null) { |
e695d66f | 190 | throw new TypeError( |
a5ed75b7 JB |
191 | 'Cannot instantiate a dynamic pool without specifying the maximum pool size' |
192 | ) | |
193 | } else if (!Number.isSafeInteger(max)) { | |
2761efb4 JB |
194 | throw new TypeError( |
195 | 'Cannot instantiate a dynamic pool with a non safe integer maximum pool size' | |
196 | ) | |
197 | } else if (min > max) { | |
079de991 JB |
198 | throw new RangeError( |
199 | 'Cannot instantiate a dynamic pool with a maximum pool size inferior to the minimum pool size' | |
200 | ) | |
b97d82d8 | 201 | } else if (max === 0) { |
079de991 | 202 | throw new RangeError( |
d640b48b | 203 | 'Cannot instantiate a dynamic pool with a maximum pool size equal to zero' |
079de991 JB |
204 | ) |
205 | } else if (min === max) { | |
206 | throw new RangeError( | |
207 | 'Cannot instantiate a dynamic pool with a minimum pool size equal to the maximum pool size. Use a fixed pool instead' | |
208 | ) | |
209 | } | |
8d3782fa JB |
210 | } |
211 | } | |
212 | ||
7c0ba920 | 213 | private checkPoolOptions (opts: PoolOptions<Worker>): void { |
0d80593b | 214 | if (isPlainObject(opts)) { |
47352846 | 215 | this.opts.startWorkers = opts.startWorkers ?? true |
0d80593b JB |
216 | this.opts.workerChoiceStrategy = |
217 | opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN | |
218 | this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy) | |
8990357d JB |
219 | this.opts.workerChoiceStrategyOptions = { |
220 | ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, | |
221 | ...opts.workerChoiceStrategyOptions | |
222 | } | |
49be33fe JB |
223 | this.checkValidWorkerChoiceStrategyOptions( |
224 | this.opts.workerChoiceStrategyOptions | |
225 | ) | |
1f68cede | 226 | this.opts.restartWorkerOnError = opts.restartWorkerOnError ?? true |
0d80593b JB |
227 | this.opts.enableEvents = opts.enableEvents ?? true |
228 | this.opts.enableTasksQueue = opts.enableTasksQueue ?? false | |
229 | if (this.opts.enableTasksQueue) { | |
230 | this.checkValidTasksQueueOptions( | |
231 | opts.tasksQueueOptions as TasksQueueOptions | |
232 | ) | |
233 | this.opts.tasksQueueOptions = this.buildTasksQueueOptions( | |
234 | opts.tasksQueueOptions as TasksQueueOptions | |
235 | ) | |
236 | } | |
237 | } else { | |
238 | throw new TypeError('Invalid pool options: must be a plain object') | |
7171d33f | 239 | } |
aee46736 JB |
240 | } |
241 | ||
242 | private checkValidWorkerChoiceStrategy ( | |
243 | workerChoiceStrategy: WorkerChoiceStrategy | |
244 | ): void { | |
245 | if (!Object.values(WorkerChoiceStrategies).includes(workerChoiceStrategy)) { | |
b529c323 | 246 | throw new Error( |
aee46736 | 247 | `Invalid worker choice strategy '${workerChoiceStrategy}'` |
b529c323 JB |
248 | ) |
249 | } | |
7c0ba920 JB |
250 | } |
251 | ||
0d80593b JB |
252 | private checkValidWorkerChoiceStrategyOptions ( |
253 | workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | |
254 | ): void { | |
255 | if (!isPlainObject(workerChoiceStrategyOptions)) { | |
256 | throw new TypeError( | |
257 | 'Invalid worker choice strategy options: must be a plain object' | |
258 | ) | |
259 | } | |
8990357d | 260 | if ( |
8c0b113f JB |
261 | workerChoiceStrategyOptions.retries != null && |
262 | !Number.isSafeInteger(workerChoiceStrategyOptions.retries) | |
8990357d JB |
263 | ) { |
264 | throw new TypeError( | |
8c0b113f | 265 | 'Invalid worker choice strategy options: retries must be an integer' |
8990357d JB |
266 | ) |
267 | } | |
268 | if ( | |
8c0b113f JB |
269 | workerChoiceStrategyOptions.retries != null && |
270 | workerChoiceStrategyOptions.retries < 0 | |
8990357d JB |
271 | ) { |
272 | throw new RangeError( | |
8c0b113f | 273 | `Invalid worker choice strategy options: retries '${workerChoiceStrategyOptions.retries}' must be greater or equal than zero` |
8990357d JB |
274 | ) |
275 | } | |
49be33fe JB |
276 | if ( |
277 | workerChoiceStrategyOptions.weights != null && | |
6b27d407 | 278 | Object.keys(workerChoiceStrategyOptions.weights).length !== this.maxSize |
49be33fe JB |
279 | ) { |
280 | throw new Error( | |
281 | 'Invalid worker choice strategy options: must have a weight for each worker node' | |
282 | ) | |
283 | } | |
f0d7f803 JB |
284 | if ( |
285 | workerChoiceStrategyOptions.measurement != null && | |
286 | !Object.values(Measurements).includes( | |
287 | workerChoiceStrategyOptions.measurement | |
288 | ) | |
289 | ) { | |
290 | throw new Error( | |
291 | `Invalid worker choice strategy options: invalid measurement '${workerChoiceStrategyOptions.measurement}'` | |
292 | ) | |
293 | } | |
0d80593b JB |
294 | } |
295 | ||
a20f0ba5 | 296 | private checkValidTasksQueueOptions ( |
76d91ea0 | 297 | tasksQueueOptions: TasksQueueOptions |
a20f0ba5 | 298 | ): void { |
0d80593b JB |
299 | if (tasksQueueOptions != null && !isPlainObject(tasksQueueOptions)) { |
300 | throw new TypeError('Invalid tasks queue options: must be a plain object') | |
301 | } | |
f0d7f803 | 302 | if ( |
b7d085c4 JB |
303 | tasksQueueOptions?.concurrency != null && |
304 | !Number.isSafeInteger(tasksQueueOptions?.concurrency) | |
f0d7f803 JB |
305 | ) { |
306 | throw new TypeError( | |
20c6f652 | 307 | 'Invalid worker node tasks concurrency: must be an integer' |
f0d7f803 JB |
308 | ) |
309 | } | |
310 | if ( | |
b7d085c4 JB |
311 | tasksQueueOptions?.concurrency != null && |
312 | tasksQueueOptions?.concurrency <= 0 | |
f0d7f803 | 313 | ) { |
e695d66f | 314 | throw new RangeError( |
b7d085c4 | 315 | `Invalid worker node tasks concurrency: ${tasksQueueOptions?.concurrency} is a negative integer or zero` |
20c6f652 JB |
316 | ) |
317 | } | |
20c6f652 | 318 | if ( |
b7d085c4 JB |
319 | tasksQueueOptions?.size != null && |
320 | !Number.isSafeInteger(tasksQueueOptions?.size) | |
20c6f652 | 321 | ) { |
ff3f866a | 322 | throw new TypeError( |
68dbcdc0 | 323 | 'Invalid worker node tasks queue size: must be an integer' |
ff3f866a JB |
324 | ) |
325 | } | |
b7d085c4 | 326 | if (tasksQueueOptions?.size != null && tasksQueueOptions?.size <= 0) { |
20c6f652 | 327 | throw new RangeError( |
b7d085c4 | 328 | `Invalid worker node tasks queue size: ${tasksQueueOptions?.size} is a negative integer or zero` |
a20f0ba5 JB |
329 | ) |
330 | } | |
331 | } | |
332 | ||
08f3f44c | 333 | /** @inheritDoc */ |
6b27d407 JB |
334 | public get info (): PoolInfo { |
335 | return { | |
23ccf9d7 | 336 | version, |
6b27d407 | 337 | type: this.type, |
184855e6 | 338 | worker: this.worker, |
47352846 | 339 | started: this.started, |
2431bdb4 JB |
340 | ready: this.ready, |
341 | strategy: this.opts.workerChoiceStrategy as WorkerChoiceStrategy, | |
6b27d407 JB |
342 | minSize: this.minSize, |
343 | maxSize: this.maxSize, | |
c05f0d50 JB |
344 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() |
345 | .runTime.aggregate && | |
1305e9a8 JB |
346 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements() |
347 | .waitTime.aggregate && { utilization: round(this.utilization) }), | |
6b27d407 JB |
348 | workerNodes: this.workerNodes.length, |
349 | idleWorkerNodes: this.workerNodes.reduce( | |
350 | (accumulator, workerNode) => | |
f59e1027 | 351 | workerNode.usage.tasks.executing === 0 |
a4e07f72 JB |
352 | ? accumulator + 1 |
353 | : accumulator, | |
6b27d407 JB |
354 | 0 |
355 | ), | |
356 | busyWorkerNodes: this.workerNodes.reduce( | |
357 | (accumulator, workerNode) => | |
f59e1027 | 358 | workerNode.usage.tasks.executing > 0 ? accumulator + 1 : accumulator, |
6b27d407 JB |
359 | 0 |
360 | ), | |
a4e07f72 | 361 | executedTasks: this.workerNodes.reduce( |
6b27d407 | 362 | (accumulator, workerNode) => |
f59e1027 | 363 | accumulator + workerNode.usage.tasks.executed, |
a4e07f72 JB |
364 | 0 |
365 | ), | |
366 | executingTasks: this.workerNodes.reduce( | |
367 | (accumulator, workerNode) => | |
f59e1027 | 368 | accumulator + workerNode.usage.tasks.executing, |
6b27d407 JB |
369 | 0 |
370 | ), | |
daf86646 JB |
371 | ...(this.opts.enableTasksQueue === true && { |
372 | queuedTasks: this.workerNodes.reduce( | |
373 | (accumulator, workerNode) => | |
374 | accumulator + workerNode.usage.tasks.queued, | |
375 | 0 | |
376 | ) | |
377 | }), | |
378 | ...(this.opts.enableTasksQueue === true && { | |
379 | maxQueuedTasks: this.workerNodes.reduce( | |
380 | (accumulator, workerNode) => | |
381 | accumulator + (workerNode.usage.tasks?.maxQueued ?? 0), | |
382 | 0 | |
383 | ) | |
384 | }), | |
a1763c54 JB |
385 | ...(this.opts.enableTasksQueue === true && { |
386 | backPressure: this.hasBackPressure() | |
387 | }), | |
68cbdc84 JB |
388 | ...(this.opts.enableTasksQueue === true && { |
389 | stolenTasks: this.workerNodes.reduce( | |
390 | (accumulator, workerNode) => | |
391 | accumulator + workerNode.usage.tasks.stolen, | |
392 | 0 | |
393 | ) | |
394 | }), | |
a4e07f72 JB |
395 | failedTasks: this.workerNodes.reduce( |
396 | (accumulator, workerNode) => | |
f59e1027 | 397 | accumulator + workerNode.usage.tasks.failed, |
a4e07f72 | 398 | 0 |
1dcf8b7b JB |
399 | ), |
400 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
401 | .runTime.aggregate && { | |
402 | runTime: { | |
98e72cda | 403 | minimum: round( |
90d6701c | 404 | min( |
98e72cda | 405 | ...this.workerNodes.map( |
041dc05b | 406 | workerNode => workerNode.usage.runTime?.minimum ?? Infinity |
98e72cda | 407 | ) |
1dcf8b7b JB |
408 | ) |
409 | ), | |
98e72cda | 410 | maximum: round( |
90d6701c | 411 | max( |
98e72cda | 412 | ...this.workerNodes.map( |
041dc05b | 413 | workerNode => workerNode.usage.runTime?.maximum ?? -Infinity |
98e72cda | 414 | ) |
1dcf8b7b | 415 | ) |
98e72cda | 416 | ), |
3baa0837 JB |
417 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() |
418 | .runTime.average && { | |
419 | average: round( | |
420 | average( | |
421 | this.workerNodes.reduce<number[]>( | |
422 | (accumulator, workerNode) => | |
423 | accumulator.concat(workerNode.usage.runTime.history), | |
424 | [] | |
425 | ) | |
98e72cda | 426 | ) |
dc021bcc | 427 | ) |
3baa0837 | 428 | }), |
98e72cda JB |
429 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() |
430 | .runTime.median && { | |
431 | median: round( | |
432 | median( | |
3baa0837 JB |
433 | this.workerNodes.reduce<number[]>( |
434 | (accumulator, workerNode) => | |
435 | accumulator.concat(workerNode.usage.runTime.history), | |
436 | [] | |
98e72cda JB |
437 | ) |
438 | ) | |
439 | ) | |
440 | }) | |
1dcf8b7b JB |
441 | } |
442 | }), | |
443 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
444 | .waitTime.aggregate && { | |
445 | waitTime: { | |
98e72cda | 446 | minimum: round( |
90d6701c | 447 | min( |
98e72cda | 448 | ...this.workerNodes.map( |
041dc05b | 449 | workerNode => workerNode.usage.waitTime?.minimum ?? Infinity |
98e72cda | 450 | ) |
1dcf8b7b JB |
451 | ) |
452 | ), | |
98e72cda | 453 | maximum: round( |
90d6701c | 454 | max( |
98e72cda | 455 | ...this.workerNodes.map( |
041dc05b | 456 | workerNode => workerNode.usage.waitTime?.maximum ?? -Infinity |
98e72cda | 457 | ) |
1dcf8b7b | 458 | ) |
98e72cda | 459 | ), |
3baa0837 JB |
460 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() |
461 | .waitTime.average && { | |
462 | average: round( | |
463 | average( | |
464 | this.workerNodes.reduce<number[]>( | |
465 | (accumulator, workerNode) => | |
466 | accumulator.concat(workerNode.usage.waitTime.history), | |
467 | [] | |
468 | ) | |
98e72cda | 469 | ) |
dc021bcc | 470 | ) |
3baa0837 | 471 | }), |
98e72cda JB |
472 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() |
473 | .waitTime.median && { | |
474 | median: round( | |
475 | median( | |
3baa0837 JB |
476 | this.workerNodes.reduce<number[]>( |
477 | (accumulator, workerNode) => | |
478 | accumulator.concat(workerNode.usage.waitTime.history), | |
479 | [] | |
98e72cda JB |
480 | ) |
481 | ) | |
482 | ) | |
483 | }) | |
1dcf8b7b JB |
484 | } |
485 | }) | |
6b27d407 JB |
486 | } |
487 | } | |
08f3f44c | 488 | |
aa9eede8 JB |
489 | /** |
490 | * The pool readiness boolean status. | |
491 | */ | |
2431bdb4 JB |
492 | private get ready (): boolean { |
493 | return ( | |
b97d82d8 JB |
494 | this.workerNodes.reduce( |
495 | (accumulator, workerNode) => | |
496 | !workerNode.info.dynamic && workerNode.info.ready | |
497 | ? accumulator + 1 | |
498 | : accumulator, | |
499 | 0 | |
500 | ) >= this.minSize | |
2431bdb4 JB |
501 | ) |
502 | } | |
503 | ||
afe0d5bf | 504 | /** |
aa9eede8 | 505 | * The approximate pool utilization. |
afe0d5bf JB |
506 | * |
507 | * @returns The pool utilization. | |
508 | */ | |
509 | private get utilization (): number { | |
8e5ca040 | 510 | const poolTimeCapacity = |
fe7d90db | 511 | (performance.now() - this.startTimestamp) * this.maxSize |
afe0d5bf JB |
512 | const totalTasksRunTime = this.workerNodes.reduce( |
513 | (accumulator, workerNode) => | |
71514351 | 514 | accumulator + (workerNode.usage.runTime?.aggregate ?? 0), |
afe0d5bf JB |
515 | 0 |
516 | ) | |
517 | const totalTasksWaitTime = this.workerNodes.reduce( | |
518 | (accumulator, workerNode) => | |
71514351 | 519 | accumulator + (workerNode.usage.waitTime?.aggregate ?? 0), |
afe0d5bf JB |
520 | 0 |
521 | ) | |
8e5ca040 | 522 | return (totalTasksRunTime + totalTasksWaitTime) / poolTimeCapacity |
afe0d5bf JB |
523 | } |
524 | ||
8881ae32 | 525 | /** |
aa9eede8 | 526 | * The pool type. |
8881ae32 JB |
527 | * |
528 | * If it is `'dynamic'`, it provides the `max` property. | |
529 | */ | |
530 | protected abstract get type (): PoolType | |
531 | ||
184855e6 | 532 | /** |
aa9eede8 | 533 | * The worker type. |
184855e6 JB |
534 | */ |
535 | protected abstract get worker (): WorkerType | |
536 | ||
c2ade475 | 537 | /** |
aa9eede8 | 538 | * The pool minimum size. |
c2ade475 | 539 | */ |
8735b4e5 JB |
540 | protected get minSize (): number { |
541 | return this.numberOfWorkers | |
542 | } | |
ff733df7 JB |
543 | |
544 | /** | |
aa9eede8 | 545 | * The pool maximum size. |
ff733df7 | 546 | */ |
8735b4e5 JB |
547 | protected get maxSize (): number { |
548 | return this.max ?? this.numberOfWorkers | |
549 | } | |
a35560ba | 550 | |
6b813701 JB |
551 | /** |
552 | * Checks if the worker id sent in the received message from a worker is valid. | |
553 | * | |
554 | * @param message - The received message. | |
555 | * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker id is invalid. | |
556 | */ | |
21f710aa | 557 | private checkMessageWorkerId (message: MessageValue<Response>): void { |
310de0aa JB |
558 | if (message.workerId == null) { |
559 | throw new Error('Worker message received without worker id') | |
560 | } else if ( | |
21f710aa | 561 | message.workerId != null && |
aad6fb64 | 562 | this.getWorkerNodeKeyByWorkerId(message.workerId) === -1 |
21f710aa JB |
563 | ) { |
564 | throw new Error( | |
565 | `Worker message received from unknown worker '${message.workerId}'` | |
566 | ) | |
567 | } | |
568 | } | |
569 | ||
ffcbbad8 | 570 | /** |
f06e48d8 | 571 | * Gets the given worker its worker node key. |
ffcbbad8 JB |
572 | * |
573 | * @param worker - The worker. | |
f59e1027 | 574 | * @returns The worker node key if found in the pool worker nodes, `-1` otherwise. |
ffcbbad8 | 575 | */ |
aad6fb64 | 576 | private getWorkerNodeKeyByWorker (worker: Worker): number { |
f06e48d8 | 577 | return this.workerNodes.findIndex( |
041dc05b | 578 | workerNode => workerNode.worker === worker |
f06e48d8 | 579 | ) |
bf9549ae JB |
580 | } |
581 | ||
aa9eede8 JB |
582 | /** |
583 | * Gets the worker node key given its worker id. | |
584 | * | |
585 | * @param workerId - The worker id. | |
aad6fb64 | 586 | * @returns The worker node key if the worker id is found in the pool worker nodes, `-1` otherwise. |
aa9eede8 | 587 | */ |
aad6fb64 JB |
588 | private getWorkerNodeKeyByWorkerId (workerId: number): number { |
589 | return this.workerNodes.findIndex( | |
041dc05b | 590 | workerNode => workerNode.info.id === workerId |
aad6fb64 | 591 | ) |
aa9eede8 JB |
592 | } |
593 | ||
afc003b2 | 594 | /** @inheritDoc */ |
a35560ba | 595 | public setWorkerChoiceStrategy ( |
59219cbb JB |
596 | workerChoiceStrategy: WorkerChoiceStrategy, |
597 | workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions | |
a35560ba | 598 | ): void { |
aee46736 | 599 | this.checkValidWorkerChoiceStrategy(workerChoiceStrategy) |
b98ec2e6 | 600 | this.opts.workerChoiceStrategy = workerChoiceStrategy |
b6b32453 JB |
601 | this.workerChoiceStrategyContext.setWorkerChoiceStrategy( |
602 | this.opts.workerChoiceStrategy | |
603 | ) | |
604 | if (workerChoiceStrategyOptions != null) { | |
605 | this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) | |
606 | } | |
aa9eede8 | 607 | for (const [workerNodeKey, workerNode] of this.workerNodes.entries()) { |
4b628b48 | 608 | workerNode.resetUsage() |
9edb9717 | 609 | this.sendStatisticsMessageToWorker(workerNodeKey) |
59219cbb | 610 | } |
a20f0ba5 JB |
611 | } |
612 | ||
613 | /** @inheritDoc */ | |
614 | public setWorkerChoiceStrategyOptions ( | |
615 | workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | |
616 | ): void { | |
0d80593b | 617 | this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) |
8990357d JB |
618 | this.opts.workerChoiceStrategyOptions = { |
619 | ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, | |
620 | ...workerChoiceStrategyOptions | |
621 | } | |
a20f0ba5 JB |
622 | this.workerChoiceStrategyContext.setOptions( |
623 | this.opts.workerChoiceStrategyOptions | |
a35560ba S |
624 | ) |
625 | } | |
626 | ||
a20f0ba5 | 627 | /** @inheritDoc */ |
8f52842f JB |
628 | public enableTasksQueue ( |
629 | enable: boolean, | |
630 | tasksQueueOptions?: TasksQueueOptions | |
631 | ): void { | |
a20f0ba5 | 632 | if (this.opts.enableTasksQueue === true && !enable) { |
ef41a6e6 | 633 | this.flushTasksQueues() |
a20f0ba5 JB |
634 | } |
635 | this.opts.enableTasksQueue = enable | |
8f52842f | 636 | this.setTasksQueueOptions(tasksQueueOptions as TasksQueueOptions) |
a20f0ba5 JB |
637 | } |
638 | ||
639 | /** @inheritDoc */ | |
8f52842f | 640 | public setTasksQueueOptions (tasksQueueOptions: TasksQueueOptions): void { |
a20f0ba5 | 641 | if (this.opts.enableTasksQueue === true) { |
8f52842f JB |
642 | this.checkValidTasksQueueOptions(tasksQueueOptions) |
643 | this.opts.tasksQueueOptions = | |
644 | this.buildTasksQueueOptions(tasksQueueOptions) | |
5b49e864 | 645 | this.setTasksQueueSize(this.opts.tasksQueueOptions.size as number) |
5baee0d7 | 646 | } else if (this.opts.tasksQueueOptions != null) { |
a20f0ba5 JB |
647 | delete this.opts.tasksQueueOptions |
648 | } | |
649 | } | |
650 | ||
5b49e864 | 651 | private setTasksQueueSize (size: number): void { |
20c6f652 | 652 | for (const workerNode of this.workerNodes) { |
ff3f866a | 653 | workerNode.tasksQueueBackPressureSize = size |
20c6f652 JB |
654 | } |
655 | } | |
656 | ||
a20f0ba5 JB |
657 | private buildTasksQueueOptions ( |
658 | tasksQueueOptions: TasksQueueOptions | |
659 | ): TasksQueueOptions { | |
660 | return { | |
20c6f652 | 661 | ...{ |
ff3f866a | 662 | size: Math.pow(this.maxSize, 2), |
47352846 | 663 | concurrency: 1, |
dbd73092 | 664 | taskStealing: true, |
47352846 | 665 | tasksStealingOnBackPressure: true |
20c6f652 JB |
666 | }, |
667 | ...tasksQueueOptions | |
a20f0ba5 JB |
668 | } |
669 | } | |
670 | ||
c319c66b JB |
671 | /** |
672 | * Whether the pool is full or not. | |
673 | * | |
674 | * The pool filling boolean status. | |
675 | */ | |
dea903a8 JB |
676 | protected get full (): boolean { |
677 | return this.workerNodes.length >= this.maxSize | |
678 | } | |
c2ade475 | 679 | |
c319c66b JB |
680 | /** |
681 | * Whether the pool is busy or not. | |
682 | * | |
683 | * The pool busyness boolean status. | |
684 | */ | |
685 | protected abstract get busy (): boolean | |
7c0ba920 | 686 | |
6c6afb84 | 687 | /** |
3d76750a | 688 | * Whether worker nodes are executing concurrently their tasks quota or not. |
6c6afb84 JB |
689 | * |
690 | * @returns Worker nodes busyness boolean status. | |
691 | */ | |
c2ade475 | 692 | protected internalBusy (): boolean { |
3d76750a JB |
693 | if (this.opts.enableTasksQueue === true) { |
694 | return ( | |
695 | this.workerNodes.findIndex( | |
041dc05b | 696 | workerNode => |
3d76750a JB |
697 | workerNode.info.ready && |
698 | workerNode.usage.tasks.executing < | |
699 | (this.opts.tasksQueueOptions?.concurrency as number) | |
700 | ) === -1 | |
701 | ) | |
3d76750a | 702 | } |
9d21ee7f JB |
703 | return ( |
704 | this.workerNodes.findIndex( | |
705 | workerNode => | |
706 | workerNode.info.ready && workerNode.usage.tasks.executing === 0 | |
707 | ) === -1 | |
708 | ) | |
cb70b19d JB |
709 | } |
710 | ||
90d7d101 JB |
711 | /** @inheritDoc */ |
712 | public listTaskFunctions (): string[] { | |
f2dbbf95 JB |
713 | for (const workerNode of this.workerNodes) { |
714 | if ( | |
715 | Array.isArray(workerNode.info.taskFunctions) && | |
716 | workerNode.info.taskFunctions.length > 0 | |
717 | ) { | |
718 | return workerNode.info.taskFunctions | |
719 | } | |
90d7d101 | 720 | } |
f2dbbf95 | 721 | return [] |
90d7d101 JB |
722 | } |
723 | ||
375f7504 JB |
724 | private shallExecuteTask (workerNodeKey: number): boolean { |
725 | return ( | |
726 | this.tasksQueueSize(workerNodeKey) === 0 && | |
727 | this.workerNodes[workerNodeKey].usage.tasks.executing < | |
728 | (this.opts.tasksQueueOptions?.concurrency as number) | |
729 | ) | |
730 | } | |
731 | ||
afc003b2 | 732 | /** @inheritDoc */ |
7d91a8cd JB |
733 | public async execute ( |
734 | data?: Data, | |
735 | name?: string, | |
736 | transferList?: TransferListItem[] | |
737 | ): Promise<Response> { | |
52b71763 | 738 | return await new Promise<Response>((resolve, reject) => { |
15b176e0 | 739 | if (!this.started) { |
47352846 | 740 | reject(new Error('Cannot execute a task on not started pool')) |
9d2d0da1 | 741 | return |
15b176e0 | 742 | } |
7d91a8cd JB |
743 | if (name != null && typeof name !== 'string') { |
744 | reject(new TypeError('name argument must be a string')) | |
9d2d0da1 | 745 | return |
7d91a8cd | 746 | } |
90d7d101 JB |
747 | if ( |
748 | name != null && | |
749 | typeof name === 'string' && | |
750 | name.trim().length === 0 | |
751 | ) { | |
f58b60b9 | 752 | reject(new TypeError('name argument must not be an empty string')) |
9d2d0da1 | 753 | return |
90d7d101 | 754 | } |
b558f6b5 JB |
755 | if (transferList != null && !Array.isArray(transferList)) { |
756 | reject(new TypeError('transferList argument must be an array')) | |
9d2d0da1 | 757 | return |
b558f6b5 JB |
758 | } |
759 | const timestamp = performance.now() | |
760 | const workerNodeKey = this.chooseWorkerNode() | |
501aea93 | 761 | const task: Task<Data> = { |
52b71763 JB |
762 | name: name ?? DEFAULT_TASK_NAME, |
763 | // eslint-disable-next-line @typescript-eslint/consistent-type-assertions | |
764 | data: data ?? ({} as Data), | |
7d91a8cd | 765 | transferList, |
52b71763 | 766 | timestamp, |
1a28f967 | 767 | workerId: this.getWorkerInfo(workerNodeKey).id as number, |
7629bdf1 | 768 | taskId: randomUUID() |
52b71763 | 769 | } |
7629bdf1 | 770 | this.promiseResponseMap.set(task.taskId as string, { |
2e81254d JB |
771 | resolve, |
772 | reject, | |
501aea93 | 773 | workerNodeKey |
2e81254d | 774 | }) |
52b71763 | 775 | if ( |
4e377863 JB |
776 | this.opts.enableTasksQueue === false || |
777 | (this.opts.enableTasksQueue === true && | |
375f7504 | 778 | this.shallExecuteTask(workerNodeKey)) |
52b71763 | 779 | ) { |
501aea93 | 780 | this.executeTask(workerNodeKey, task) |
4e377863 JB |
781 | } else { |
782 | this.enqueueTask(workerNodeKey, task) | |
52b71763 | 783 | } |
2e81254d | 784 | }) |
280c2a77 | 785 | } |
c97c7edb | 786 | |
47352846 JB |
787 | /** @inheritdoc */ |
788 | public start (): void { | |
789 | this.starting = true | |
790 | while ( | |
791 | this.workerNodes.reduce( | |
792 | (accumulator, workerNode) => | |
793 | !workerNode.info.dynamic ? accumulator + 1 : accumulator, | |
794 | 0 | |
795 | ) < this.numberOfWorkers | |
796 | ) { | |
797 | this.createAndSetupWorkerNode() | |
798 | } | |
799 | this.starting = false | |
800 | this.started = true | |
801 | } | |
802 | ||
afc003b2 | 803 | /** @inheritDoc */ |
c97c7edb | 804 | public async destroy (): Promise<void> { |
1fbcaa7c | 805 | await Promise.all( |
81c02522 | 806 | this.workerNodes.map(async (_, workerNodeKey) => { |
aa9eede8 | 807 | await this.destroyWorkerNode(workerNodeKey) |
1fbcaa7c JB |
808 | }) |
809 | ) | |
33e6bb4c | 810 | this.emitter?.emit(PoolEvents.destroy, this.info) |
15b176e0 | 811 | this.started = false |
c97c7edb S |
812 | } |
813 | ||
1e3214b6 JB |
814 | protected async sendKillMessageToWorker ( |
815 | workerNodeKey: number, | |
816 | workerId: number | |
817 | ): Promise<void> { | |
9edb9717 | 818 | await new Promise<void>((resolve, reject) => { |
041dc05b | 819 | this.registerWorkerMessageListener(workerNodeKey, message => { |
1e3214b6 JB |
820 | if (message.kill === 'success') { |
821 | resolve() | |
822 | } else if (message.kill === 'failure') { | |
e1af34e6 | 823 | reject(new Error(`Worker ${workerId} kill message handling failed`)) |
1e3214b6 JB |
824 | } |
825 | }) | |
9edb9717 | 826 | this.sendToWorker(workerNodeKey, { kill: true, workerId }) |
1e3214b6 | 827 | }) |
1e3214b6 JB |
828 | } |
829 | ||
4a6952ff | 830 | /** |
aa9eede8 | 831 | * Terminates the worker node given its worker node key. |
4a6952ff | 832 | * |
aa9eede8 | 833 | * @param workerNodeKey - The worker node key. |
4a6952ff | 834 | */ |
81c02522 | 835 | protected abstract destroyWorkerNode (workerNodeKey: number): Promise<void> |
c97c7edb | 836 | |
729c563d | 837 | /** |
6677a3d3 JB |
838 | * Setup hook to execute code before worker nodes are created in the abstract constructor. |
839 | * Can be overridden. | |
afc003b2 JB |
840 | * |
841 | * @virtual | |
729c563d | 842 | */ |
280c2a77 | 843 | protected setupHook (): void { |
965df41c | 844 | /* Intentionally empty */ |
280c2a77 | 845 | } |
c97c7edb | 846 | |
729c563d | 847 | /** |
280c2a77 S |
848 | * Should return whether the worker is the main worker or not. |
849 | */ | |
850 | protected abstract isMain (): boolean | |
851 | ||
852 | /** | |
2e81254d | 853 | * Hook executed before the worker task execution. |
bf9549ae | 854 | * Can be overridden. |
729c563d | 855 | * |
f06e48d8 | 856 | * @param workerNodeKey - The worker node key. |
1c6fe997 | 857 | * @param task - The task to execute. |
729c563d | 858 | */ |
1c6fe997 JB |
859 | protected beforeTaskExecutionHook ( |
860 | workerNodeKey: number, | |
861 | task: Task<Data> | |
862 | ): void { | |
94407def JB |
863 | if (this.workerNodes[workerNodeKey]?.usage != null) { |
864 | const workerUsage = this.workerNodes[workerNodeKey].usage | |
865 | ++workerUsage.tasks.executing | |
866 | this.updateWaitTimeWorkerUsage(workerUsage, task) | |
867 | } | |
868 | if ( | |
869 | this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) && | |
870 | this.workerNodes[workerNodeKey].getTaskFunctionWorkerUsage( | |
871 | task.name as string | |
872 | ) != null | |
873 | ) { | |
db0e38ee | 874 | const taskFunctionWorkerUsage = this.workerNodes[ |
b558f6b5 | 875 | workerNodeKey |
db0e38ee | 876 | ].getTaskFunctionWorkerUsage(task.name as string) as WorkerUsage |
5623b8d5 JB |
877 | ++taskFunctionWorkerUsage.tasks.executing |
878 | this.updateWaitTimeWorkerUsage(taskFunctionWorkerUsage, task) | |
b558f6b5 | 879 | } |
c97c7edb S |
880 | } |
881 | ||
c01733f1 | 882 | /** |
2e81254d | 883 | * Hook executed after the worker task execution. |
bf9549ae | 884 | * Can be overridden. |
c01733f1 | 885 | * |
501aea93 | 886 | * @param workerNodeKey - The worker node key. |
38e795c1 | 887 | * @param message - The received message. |
c01733f1 | 888 | */ |
2e81254d | 889 | protected afterTaskExecutionHook ( |
501aea93 | 890 | workerNodeKey: number, |
2740a743 | 891 | message: MessageValue<Response> |
bf9549ae | 892 | ): void { |
94407def JB |
893 | if (this.workerNodes[workerNodeKey]?.usage != null) { |
894 | const workerUsage = this.workerNodes[workerNodeKey].usage | |
895 | this.updateTaskStatisticsWorkerUsage(workerUsage, message) | |
896 | this.updateRunTimeWorkerUsage(workerUsage, message) | |
897 | this.updateEluWorkerUsage(workerUsage, message) | |
898 | } | |
899 | if ( | |
900 | this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) && | |
901 | this.workerNodes[workerNodeKey].getTaskFunctionWorkerUsage( | |
5623b8d5 | 902 | message.taskPerformance?.name as string |
94407def JB |
903 | ) != null |
904 | ) { | |
db0e38ee | 905 | const taskFunctionWorkerUsage = this.workerNodes[ |
b558f6b5 | 906 | workerNodeKey |
db0e38ee | 907 | ].getTaskFunctionWorkerUsage( |
0628755c | 908 | message.taskPerformance?.name as string |
b558f6b5 | 909 | ) as WorkerUsage |
db0e38ee JB |
910 | this.updateTaskStatisticsWorkerUsage(taskFunctionWorkerUsage, message) |
911 | this.updateRunTimeWorkerUsage(taskFunctionWorkerUsage, message) | |
912 | this.updateEluWorkerUsage(taskFunctionWorkerUsage, message) | |
b558f6b5 JB |
913 | } |
914 | } | |
915 | ||
db0e38ee JB |
916 | /** |
917 | * Whether the worker node shall update its task function worker usage or not. | |
918 | * | |
919 | * @param workerNodeKey - The worker node key. | |
920 | * @returns `true` if the worker node shall update its task function worker usage, `false` otherwise. | |
921 | */ | |
922 | private shallUpdateTaskFunctionWorkerUsage (workerNodeKey: number): boolean { | |
a5d15204 | 923 | const workerInfo = this.getWorkerInfo(workerNodeKey) |
b558f6b5 | 924 | return ( |
94407def | 925 | workerInfo != null && |
a5d15204 | 926 | Array.isArray(workerInfo.taskFunctions) && |
db0e38ee | 927 | workerInfo.taskFunctions.length > 2 |
b558f6b5 | 928 | ) |
f1c06930 JB |
929 | } |
930 | ||
931 | private updateTaskStatisticsWorkerUsage ( | |
932 | workerUsage: WorkerUsage, | |
933 | message: MessageValue<Response> | |
934 | ): void { | |
a4e07f72 | 935 | const workerTaskStatistics = workerUsage.tasks |
5bb5be17 JB |
936 | if ( |
937 | workerTaskStatistics.executing != null && | |
938 | workerTaskStatistics.executing > 0 | |
939 | ) { | |
940 | --workerTaskStatistics.executing | |
5bb5be17 | 941 | } |
98e72cda JB |
942 | if (message.taskError == null) { |
943 | ++workerTaskStatistics.executed | |
944 | } else { | |
a4e07f72 | 945 | ++workerTaskStatistics.failed |
2740a743 | 946 | } |
f8eb0a2a JB |
947 | } |
948 | ||
a4e07f72 JB |
949 | private updateRunTimeWorkerUsage ( |
950 | workerUsage: WorkerUsage, | |
f8eb0a2a JB |
951 | message: MessageValue<Response> |
952 | ): void { | |
dc021bcc JB |
953 | if (message.taskError != null) { |
954 | return | |
955 | } | |
e4f20deb JB |
956 | updateMeasurementStatistics( |
957 | workerUsage.runTime, | |
958 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime, | |
dc021bcc | 959 | message.taskPerformance?.runTime ?? 0 |
e4f20deb | 960 | ) |
f8eb0a2a JB |
961 | } |
962 | ||
a4e07f72 JB |
963 | private updateWaitTimeWorkerUsage ( |
964 | workerUsage: WorkerUsage, | |
1c6fe997 | 965 | task: Task<Data> |
f8eb0a2a | 966 | ): void { |
1c6fe997 JB |
967 | const timestamp = performance.now() |
968 | const taskWaitTime = timestamp - (task.timestamp ?? timestamp) | |
e4f20deb JB |
969 | updateMeasurementStatistics( |
970 | workerUsage.waitTime, | |
971 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements().waitTime, | |
dc021bcc | 972 | taskWaitTime |
e4f20deb | 973 | ) |
c01733f1 | 974 | } |
975 | ||
a4e07f72 | 976 | private updateEluWorkerUsage ( |
5df69fab | 977 | workerUsage: WorkerUsage, |
62c15a68 JB |
978 | message: MessageValue<Response> |
979 | ): void { | |
dc021bcc JB |
980 | if (message.taskError != null) { |
981 | return | |
982 | } | |
008512c7 JB |
983 | const eluTaskStatisticsRequirements: MeasurementStatisticsRequirements = |
984 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu | |
e4f20deb JB |
985 | updateMeasurementStatistics( |
986 | workerUsage.elu.active, | |
008512c7 | 987 | eluTaskStatisticsRequirements, |
dc021bcc | 988 | message.taskPerformance?.elu?.active ?? 0 |
e4f20deb JB |
989 | ) |
990 | updateMeasurementStatistics( | |
991 | workerUsage.elu.idle, | |
008512c7 | 992 | eluTaskStatisticsRequirements, |
dc021bcc | 993 | message.taskPerformance?.elu?.idle ?? 0 |
e4f20deb | 994 | ) |
008512c7 | 995 | if (eluTaskStatisticsRequirements.aggregate) { |
f7510105 | 996 | if (message.taskPerformance?.elu != null) { |
f7510105 JB |
997 | if (workerUsage.elu.utilization != null) { |
998 | workerUsage.elu.utilization = | |
999 | (workerUsage.elu.utilization + | |
1000 | message.taskPerformance.elu.utilization) / | |
1001 | 2 | |
1002 | } else { | |
1003 | workerUsage.elu.utilization = message.taskPerformance.elu.utilization | |
1004 | } | |
62c15a68 JB |
1005 | } |
1006 | } | |
1007 | } | |
1008 | ||
280c2a77 | 1009 | /** |
f06e48d8 | 1010 | * Chooses a worker node for the next task. |
280c2a77 | 1011 | * |
6c6afb84 | 1012 | * The default worker choice strategy uses a round robin algorithm to distribute the tasks. |
280c2a77 | 1013 | * |
aa9eede8 | 1014 | * @returns The chosen worker node key |
280c2a77 | 1015 | */ |
6c6afb84 | 1016 | private chooseWorkerNode (): number { |
930dcf12 | 1017 | if (this.shallCreateDynamicWorker()) { |
aa9eede8 | 1018 | const workerNodeKey = this.createAndSetupDynamicWorkerNode() |
6c6afb84 | 1019 | if ( |
b1aae695 | 1020 | this.workerChoiceStrategyContext.getStrategyPolicy().dynamicWorkerUsage |
6c6afb84 | 1021 | ) { |
aa9eede8 | 1022 | return workerNodeKey |
6c6afb84 | 1023 | } |
17393ac8 | 1024 | } |
930dcf12 JB |
1025 | return this.workerChoiceStrategyContext.execute() |
1026 | } | |
1027 | ||
6c6afb84 JB |
1028 | /** |
1029 | * Conditions for dynamic worker creation. | |
1030 | * | |
1031 | * @returns Whether to create a dynamic worker or not. | |
1032 | */ | |
1033 | private shallCreateDynamicWorker (): boolean { | |
930dcf12 | 1034 | return this.type === PoolTypes.dynamic && !this.full && this.internalBusy() |
c97c7edb S |
1035 | } |
1036 | ||
280c2a77 | 1037 | /** |
aa9eede8 | 1038 | * Sends a message to worker given its worker node key. |
280c2a77 | 1039 | * |
aa9eede8 | 1040 | * @param workerNodeKey - The worker node key. |
38e795c1 | 1041 | * @param message - The message. |
7d91a8cd | 1042 | * @param transferList - The optional array of transferable objects. |
280c2a77 S |
1043 | */ |
1044 | protected abstract sendToWorker ( | |
aa9eede8 | 1045 | workerNodeKey: number, |
7d91a8cd JB |
1046 | message: MessageValue<Data>, |
1047 | transferList?: TransferListItem[] | |
280c2a77 S |
1048 | ): void |
1049 | ||
729c563d | 1050 | /** |
41344292 | 1051 | * Creates a new worker. |
6c6afb84 JB |
1052 | * |
1053 | * @returns Newly created worker. | |
729c563d | 1054 | */ |
280c2a77 | 1055 | protected abstract createWorker (): Worker |
c97c7edb | 1056 | |
4a6952ff | 1057 | /** |
aa9eede8 | 1058 | * Creates a new, completely set up worker node. |
4a6952ff | 1059 | * |
aa9eede8 | 1060 | * @returns New, completely set up worker node key. |
4a6952ff | 1061 | */ |
aa9eede8 | 1062 | protected createAndSetupWorkerNode (): number { |
bdacc2d2 | 1063 | const worker = this.createWorker() |
280c2a77 | 1064 | |
fd04474e | 1065 | worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION) |
35cf1c03 | 1066 | worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION) |
a35560ba | 1067 | worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION) |
041dc05b | 1068 | worker.on('error', error => { |
aad6fb64 | 1069 | const workerNodeKey = this.getWorkerNodeKeyByWorker(worker) |
46b0bb09 | 1070 | const workerInfo = this.getWorkerInfo(workerNodeKey) |
9b106837 | 1071 | workerInfo.ready = false |
0dc838e3 | 1072 | this.workerNodes[workerNodeKey].closeChannel() |
2a69b8c5 | 1073 | this.emitter?.emit(PoolEvents.error, error) |
15b176e0 JB |
1074 | if ( |
1075 | this.opts.restartWorkerOnError === true && | |
b6bfca01 JB |
1076 | this.started && |
1077 | !this.starting | |
15b176e0 | 1078 | ) { |
9b106837 | 1079 | if (workerInfo.dynamic) { |
aa9eede8 | 1080 | this.createAndSetupDynamicWorkerNode() |
8a1260a3 | 1081 | } else { |
aa9eede8 | 1082 | this.createAndSetupWorkerNode() |
8a1260a3 | 1083 | } |
5baee0d7 | 1084 | } |
19dbc45b | 1085 | if (this.opts.enableTasksQueue === true) { |
9b106837 | 1086 | this.redistributeQueuedTasks(workerNodeKey) |
19dbc45b | 1087 | } |
5baee0d7 | 1088 | }) |
a35560ba | 1089 | worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION) |
a974afa6 | 1090 | worker.once('exit', () => { |
f06e48d8 | 1091 | this.removeWorkerNode(worker) |
a974afa6 | 1092 | }) |
280c2a77 | 1093 | |
aa9eede8 | 1094 | const workerNodeKey = this.addWorkerNode(worker) |
280c2a77 | 1095 | |
aa9eede8 | 1096 | this.afterWorkerNodeSetup(workerNodeKey) |
280c2a77 | 1097 | |
aa9eede8 | 1098 | return workerNodeKey |
c97c7edb | 1099 | } |
be0676b3 | 1100 | |
930dcf12 | 1101 | /** |
aa9eede8 | 1102 | * Creates a new, completely set up dynamic worker node. |
930dcf12 | 1103 | * |
aa9eede8 | 1104 | * @returns New, completely set up dynamic worker node key. |
930dcf12 | 1105 | */ |
aa9eede8 JB |
1106 | protected createAndSetupDynamicWorkerNode (): number { |
1107 | const workerNodeKey = this.createAndSetupWorkerNode() | |
041dc05b | 1108 | this.registerWorkerMessageListener(workerNodeKey, message => { |
aa9eede8 JB |
1109 | const localWorkerNodeKey = this.getWorkerNodeKeyByWorkerId( |
1110 | message.workerId | |
aad6fb64 | 1111 | ) |
aa9eede8 | 1112 | const workerUsage = this.workerNodes[localWorkerNodeKey].usage |
81c02522 | 1113 | // Kill message received from worker |
930dcf12 JB |
1114 | if ( |
1115 | isKillBehavior(KillBehaviors.HARD, message.kill) || | |
1e3214b6 | 1116 | (isKillBehavior(KillBehaviors.SOFT, message.kill) && |
7b56f532 | 1117 | ((this.opts.enableTasksQueue === false && |
aa9eede8 | 1118 | workerUsage.tasks.executing === 0) || |
7b56f532 | 1119 | (this.opts.enableTasksQueue === true && |
aa9eede8 JB |
1120 | workerUsage.tasks.executing === 0 && |
1121 | this.tasksQueueSize(localWorkerNodeKey) === 0))) | |
930dcf12 | 1122 | ) { |
041dc05b | 1123 | this.destroyWorkerNode(localWorkerNodeKey).catch(error => { |
5270d253 JB |
1124 | this.emitter?.emit(PoolEvents.error, error) |
1125 | }) | |
930dcf12 JB |
1126 | } |
1127 | }) | |
46b0bb09 | 1128 | const workerInfo = this.getWorkerInfo(workerNodeKey) |
aa9eede8 | 1129 | this.sendToWorker(workerNodeKey, { |
b0a4db63 | 1130 | checkActive: true, |
21f710aa JB |
1131 | workerId: workerInfo.id as number |
1132 | }) | |
b5e113f6 | 1133 | workerInfo.dynamic = true |
b1aae695 JB |
1134 | if ( |
1135 | this.workerChoiceStrategyContext.getStrategyPolicy().dynamicWorkerReady || | |
1136 | this.workerChoiceStrategyContext.getStrategyPolicy().dynamicWorkerUsage | |
1137 | ) { | |
b5e113f6 JB |
1138 | workerInfo.ready = true |
1139 | } | |
33e6bb4c | 1140 | this.checkAndEmitDynamicWorkerCreationEvents() |
aa9eede8 | 1141 | return workerNodeKey |
930dcf12 JB |
1142 | } |
1143 | ||
a2ed5053 | 1144 | /** |
aa9eede8 | 1145 | * Registers a listener callback on the worker given its worker node key. |
a2ed5053 | 1146 | * |
aa9eede8 | 1147 | * @param workerNodeKey - The worker node key. |
a2ed5053 JB |
1148 | * @param listener - The message listener callback. |
1149 | */ | |
85aeb3f3 JB |
1150 | protected abstract registerWorkerMessageListener< |
1151 | Message extends Data | Response | |
aa9eede8 JB |
1152 | >( |
1153 | workerNodeKey: number, | |
1154 | listener: (message: MessageValue<Message>) => void | |
1155 | ): void | |
a2ed5053 JB |
1156 | |
1157 | /** | |
aa9eede8 | 1158 | * Method hooked up after a worker node has been newly created. |
a2ed5053 JB |
1159 | * Can be overridden. |
1160 | * | |
aa9eede8 | 1161 | * @param workerNodeKey - The newly created worker node key. |
a2ed5053 | 1162 | */ |
aa9eede8 | 1163 | protected afterWorkerNodeSetup (workerNodeKey: number): void { |
a2ed5053 | 1164 | // Listen to worker messages. |
aa9eede8 | 1165 | this.registerWorkerMessageListener(workerNodeKey, this.workerListener()) |
85aeb3f3 | 1166 | // Send the startup message to worker. |
aa9eede8 | 1167 | this.sendStartupMessageToWorker(workerNodeKey) |
9edb9717 JB |
1168 | // Send the statistics message to worker. |
1169 | this.sendStatisticsMessageToWorker(workerNodeKey) | |
72695f86 | 1170 | if (this.opts.enableTasksQueue === true) { |
dbd73092 | 1171 | if (this.opts.tasksQueueOptions?.taskStealing === true) { |
47352846 JB |
1172 | this.workerNodes[workerNodeKey].onEmptyQueue = |
1173 | this.taskStealingOnEmptyQueue.bind(this) | |
1174 | } | |
1175 | if (this.opts.tasksQueueOptions?.tasksStealingOnBackPressure === true) { | |
1176 | this.workerNodes[workerNodeKey].onBackPressure = | |
1177 | this.tasksStealingOnBackPressure.bind(this) | |
1178 | } | |
72695f86 | 1179 | } |
d2c73f82 JB |
1180 | } |
1181 | ||
85aeb3f3 | 1182 | /** |
aa9eede8 JB |
1183 | * Sends the startup message to worker given its worker node key. |
1184 | * | |
1185 | * @param workerNodeKey - The worker node key. | |
1186 | */ | |
1187 | protected abstract sendStartupMessageToWorker (workerNodeKey: number): void | |
1188 | ||
1189 | /** | |
9edb9717 | 1190 | * Sends the statistics message to worker given its worker node key. |
85aeb3f3 | 1191 | * |
aa9eede8 | 1192 | * @param workerNodeKey - The worker node key. |
85aeb3f3 | 1193 | */ |
9edb9717 | 1194 | private sendStatisticsMessageToWorker (workerNodeKey: number): void { |
aa9eede8 JB |
1195 | this.sendToWorker(workerNodeKey, { |
1196 | statistics: { | |
1197 | runTime: | |
1198 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
1199 | .runTime.aggregate, | |
1200 | elu: this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
1201 | .elu.aggregate | |
1202 | }, | |
46b0bb09 | 1203 | workerId: this.getWorkerInfo(workerNodeKey).id as number |
aa9eede8 JB |
1204 | }) |
1205 | } | |
a2ed5053 JB |
1206 | |
1207 | private redistributeQueuedTasks (workerNodeKey: number): void { | |
1208 | while (this.tasksQueueSize(workerNodeKey) > 0) { | |
f201a0cd JB |
1209 | const destinationWorkerNodeKey = this.workerNodes.reduce( |
1210 | (minWorkerNodeKey, workerNode, workerNodeKey, workerNodes) => { | |
852ed3e4 JB |
1211 | return workerNode.info.ready && |
1212 | workerNode.usage.tasks.queued < | |
1213 | workerNodes[minWorkerNodeKey].usage.tasks.queued | |
f201a0cd JB |
1214 | ? workerNodeKey |
1215 | : minWorkerNodeKey | |
1216 | }, | |
1217 | 0 | |
1218 | ) | |
3f690f25 JB |
1219 | const destinationWorkerNode = this.workerNodes[destinationWorkerNodeKey] |
1220 | const task = { | |
1221 | ...(this.dequeueTask(workerNodeKey) as Task<Data>), | |
1222 | workerId: destinationWorkerNode.info.id as number | |
1223 | } | |
1224 | if (this.shallExecuteTask(destinationWorkerNodeKey)) { | |
1225 | this.executeTask(destinationWorkerNodeKey, task) | |
1226 | } else { | |
1227 | this.enqueueTask(destinationWorkerNodeKey, task) | |
dd951876 JB |
1228 | } |
1229 | } | |
1230 | } | |
1231 | ||
b1838604 JB |
1232 | private updateTaskStolenStatisticsWorkerUsage ( |
1233 | workerNodeKey: number, | |
b1838604 JB |
1234 | taskName: string |
1235 | ): void { | |
1a880eca | 1236 | const workerNode = this.workerNodes[workerNodeKey] |
b1838604 JB |
1237 | if (workerNode?.usage != null) { |
1238 | ++workerNode.usage.tasks.stolen | |
1239 | } | |
1240 | if ( | |
1241 | this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) && | |
1242 | workerNode.getTaskFunctionWorkerUsage(taskName) != null | |
1243 | ) { | |
1244 | const taskFunctionWorkerUsage = workerNode.getTaskFunctionWorkerUsage( | |
1245 | taskName | |
1246 | ) as WorkerUsage | |
1247 | ++taskFunctionWorkerUsage.tasks.stolen | |
1248 | } | |
1249 | } | |
1250 | ||
dd951876 | 1251 | private taskStealingOnEmptyQueue (workerId: number): void { |
a6b3272b JB |
1252 | const destinationWorkerNodeKey = this.getWorkerNodeKeyByWorkerId(workerId) |
1253 | const destinationWorkerNode = this.workerNodes[destinationWorkerNodeKey] | |
dd951876 | 1254 | const workerNodes = this.workerNodes |
a6b3272b | 1255 | .slice() |
dd951876 JB |
1256 | .sort( |
1257 | (workerNodeA, workerNodeB) => | |
1258 | workerNodeB.usage.tasks.queued - workerNodeA.usage.tasks.queued | |
1259 | ) | |
f201a0cd | 1260 | const sourceWorkerNode = workerNodes.find( |
041dc05b | 1261 | workerNode => |
f201a0cd JB |
1262 | workerNode.info.ready && |
1263 | workerNode.info.id !== workerId && | |
1264 | workerNode.usage.tasks.queued > 0 | |
1265 | ) | |
1266 | if (sourceWorkerNode != null) { | |
1267 | const task = { | |
1268 | ...(sourceWorkerNode.popTask() as Task<Data>), | |
1269 | workerId: destinationWorkerNode.info.id as number | |
0bc68267 | 1270 | } |
f201a0cd JB |
1271 | if (this.shallExecuteTask(destinationWorkerNodeKey)) { |
1272 | this.executeTask(destinationWorkerNodeKey, task) | |
1273 | } else { | |
1274 | this.enqueueTask(destinationWorkerNodeKey, task) | |
72695f86 | 1275 | } |
f201a0cd JB |
1276 | this.updateTaskStolenStatisticsWorkerUsage( |
1277 | destinationWorkerNodeKey, | |
1278 | task.name as string | |
1279 | ) | |
72695f86 JB |
1280 | } |
1281 | } | |
1282 | ||
1283 | private tasksStealingOnBackPressure (workerId: number): void { | |
f778c355 JB |
1284 | const sizeOffset = 1 |
1285 | if ((this.opts.tasksQueueOptions?.size as number) <= sizeOffset) { | |
68dbcdc0 JB |
1286 | return |
1287 | } | |
72695f86 JB |
1288 | const sourceWorkerNode = |
1289 | this.workerNodes[this.getWorkerNodeKeyByWorkerId(workerId)] | |
1290 | const workerNodes = this.workerNodes | |
a6b3272b | 1291 | .slice() |
72695f86 JB |
1292 | .sort( |
1293 | (workerNodeA, workerNodeB) => | |
1294 | workerNodeA.usage.tasks.queued - workerNodeB.usage.tasks.queued | |
1295 | ) | |
1296 | for (const [workerNodeKey, workerNode] of workerNodes.entries()) { | |
1297 | if ( | |
0bc68267 | 1298 | sourceWorkerNode.usage.tasks.queued > 0 && |
a6b3272b JB |
1299 | workerNode.info.ready && |
1300 | workerNode.info.id !== workerId && | |
0bc68267 | 1301 | workerNode.usage.tasks.queued < |
f778c355 | 1302 | (this.opts.tasksQueueOptions?.size as number) - sizeOffset |
72695f86 | 1303 | ) { |
dd951876 JB |
1304 | const task = { |
1305 | ...(sourceWorkerNode.popTask() as Task<Data>), | |
1306 | workerId: workerNode.info.id as number | |
1307 | } | |
375f7504 | 1308 | if (this.shallExecuteTask(workerNodeKey)) { |
dd951876 | 1309 | this.executeTask(workerNodeKey, task) |
4de3d785 | 1310 | } else { |
dd951876 | 1311 | this.enqueueTask(workerNodeKey, task) |
4de3d785 | 1312 | } |
b1838604 JB |
1313 | this.updateTaskStolenStatisticsWorkerUsage( |
1314 | workerNodeKey, | |
b1838604 JB |
1315 | task.name as string |
1316 | ) | |
10ecf8fd | 1317 | } |
a2ed5053 JB |
1318 | } |
1319 | } | |
1320 | ||
be0676b3 | 1321 | /** |
aa9eede8 | 1322 | * This method is the listener registered for each worker message. |
be0676b3 | 1323 | * |
bdacc2d2 | 1324 | * @returns The listener function to execute when a message is received from a worker. |
be0676b3 APA |
1325 | */ |
1326 | protected workerListener (): (message: MessageValue<Response>) => void { | |
041dc05b | 1327 | return message => { |
21f710aa | 1328 | this.checkMessageWorkerId(message) |
a5d15204 | 1329 | if (message.ready != null && message.taskFunctions != null) { |
81c02522 | 1330 | // Worker ready response received from worker |
10e2aa7e | 1331 | this.handleWorkerReadyResponse(message) |
7629bdf1 | 1332 | } else if (message.taskId != null) { |
81c02522 | 1333 | // Task execution response received from worker |
6b272951 | 1334 | this.handleTaskExecutionResponse(message) |
90d7d101 JB |
1335 | } else if (message.taskFunctions != null) { |
1336 | // Task functions message received from worker | |
46b0bb09 JB |
1337 | this.getWorkerInfo( |
1338 | this.getWorkerNodeKeyByWorkerId(message.workerId) | |
b558f6b5 | 1339 | ).taskFunctions = message.taskFunctions |
6b272951 JB |
1340 | } |
1341 | } | |
1342 | } | |
1343 | ||
10e2aa7e | 1344 | private handleWorkerReadyResponse (message: MessageValue<Response>): void { |
f05ed93c JB |
1345 | if (message.ready === false) { |
1346 | throw new Error(`Worker ${message.workerId} failed to initialize`) | |
1347 | } | |
a5d15204 | 1348 | const workerInfo = this.getWorkerInfo( |
aad6fb64 | 1349 | this.getWorkerNodeKeyByWorkerId(message.workerId) |
46b0bb09 | 1350 | ) |
a5d15204 JB |
1351 | workerInfo.ready = message.ready as boolean |
1352 | workerInfo.taskFunctions = message.taskFunctions | |
2431bdb4 JB |
1353 | if (this.emitter != null && this.ready) { |
1354 | this.emitter.emit(PoolEvents.ready, this.info) | |
1355 | } | |
6b272951 JB |
1356 | } |
1357 | ||
1358 | private handleTaskExecutionResponse (message: MessageValue<Response>): void { | |
5441aea6 JB |
1359 | const { taskId, taskError, data } = message |
1360 | const promiseResponse = this.promiseResponseMap.get(taskId as string) | |
6b272951 | 1361 | if (promiseResponse != null) { |
5441aea6 JB |
1362 | if (taskError != null) { |
1363 | this.emitter?.emit(PoolEvents.taskError, taskError) | |
1364 | promiseResponse.reject(taskError.message) | |
6b272951 | 1365 | } else { |
5441aea6 | 1366 | promiseResponse.resolve(data as Response) |
6b272951 | 1367 | } |
501aea93 JB |
1368 | const workerNodeKey = promiseResponse.workerNodeKey |
1369 | this.afterTaskExecutionHook(workerNodeKey, message) | |
f3a91bac | 1370 | this.workerChoiceStrategyContext.update(workerNodeKey) |
5441aea6 | 1371 | this.promiseResponseMap.delete(taskId as string) |
6b272951 JB |
1372 | if ( |
1373 | this.opts.enableTasksQueue === true && | |
b5e113f6 JB |
1374 | this.tasksQueueSize(workerNodeKey) > 0 && |
1375 | this.workerNodes[workerNodeKey].usage.tasks.executing < | |
1376 | (this.opts.tasksQueueOptions?.concurrency as number) | |
6b272951 JB |
1377 | ) { |
1378 | this.executeTask( | |
1379 | workerNodeKey, | |
1380 | this.dequeueTask(workerNodeKey) as Task<Data> | |
1381 | ) | |
be0676b3 APA |
1382 | } |
1383 | } | |
be0676b3 | 1384 | } |
7c0ba920 | 1385 | |
a1763c54 | 1386 | private checkAndEmitTaskExecutionEvents (): void { |
33e6bb4c JB |
1387 | if (this.busy) { |
1388 | this.emitter?.emit(PoolEvents.busy, this.info) | |
a1763c54 JB |
1389 | } |
1390 | } | |
1391 | ||
1392 | private checkAndEmitTaskQueuingEvents (): void { | |
1393 | if (this.hasBackPressure()) { | |
1394 | this.emitter?.emit(PoolEvents.backPressure, this.info) | |
164d950a JB |
1395 | } |
1396 | } | |
1397 | ||
33e6bb4c JB |
1398 | private checkAndEmitDynamicWorkerCreationEvents (): void { |
1399 | if (this.type === PoolTypes.dynamic) { | |
1400 | if (this.full) { | |
1401 | this.emitter?.emit(PoolEvents.full, this.info) | |
1402 | } | |
1403 | } | |
1404 | } | |
1405 | ||
8a1260a3 | 1406 | /** |
aa9eede8 | 1407 | * Gets the worker information given its worker node key. |
8a1260a3 JB |
1408 | * |
1409 | * @param workerNodeKey - The worker node key. | |
3f09ed9f | 1410 | * @returns The worker information. |
8a1260a3 | 1411 | */ |
46b0bb09 JB |
1412 | protected getWorkerInfo (workerNodeKey: number): WorkerInfo { |
1413 | return this.workerNodes[workerNodeKey].info | |
e221309a JB |
1414 | } |
1415 | ||
a05c10de | 1416 | /** |
b0a4db63 | 1417 | * Adds the given worker in the pool worker nodes. |
ea7a90d3 | 1418 | * |
38e795c1 | 1419 | * @param worker - The worker. |
aa9eede8 JB |
1420 | * @returns The added worker node key. |
1421 | * @throws {@link https://nodejs.org/api/errors.html#class-error} If the added worker node is not found. | |
ea7a90d3 | 1422 | */ |
b0a4db63 | 1423 | private addWorkerNode (worker: Worker): number { |
671d5154 JB |
1424 | const workerNode = new WorkerNode<Worker, Data>( |
1425 | worker, | |
ff3f866a | 1426 | this.opts.tasksQueueOptions?.size ?? Math.pow(this.maxSize, 2) |
671d5154 | 1427 | ) |
b97d82d8 | 1428 | // Flag the worker node as ready at pool startup. |
d2c73f82 JB |
1429 | if (this.starting) { |
1430 | workerNode.info.ready = true | |
1431 | } | |
aa9eede8 | 1432 | this.workerNodes.push(workerNode) |
aad6fb64 | 1433 | const workerNodeKey = this.getWorkerNodeKeyByWorker(worker) |
aa9eede8 | 1434 | if (workerNodeKey === -1) { |
86ed0598 | 1435 | throw new Error('Worker added not found in worker nodes') |
aa9eede8 JB |
1436 | } |
1437 | return workerNodeKey | |
ea7a90d3 | 1438 | } |
c923ce56 | 1439 | |
51fe3d3c | 1440 | /** |
f06e48d8 | 1441 | * Removes the given worker from the pool worker nodes. |
51fe3d3c | 1442 | * |
f06e48d8 | 1443 | * @param worker - The worker. |
51fe3d3c | 1444 | */ |
416fd65c | 1445 | private removeWorkerNode (worker: Worker): void { |
aad6fb64 | 1446 | const workerNodeKey = this.getWorkerNodeKeyByWorker(worker) |
1f68cede JB |
1447 | if (workerNodeKey !== -1) { |
1448 | this.workerNodes.splice(workerNodeKey, 1) | |
1449 | this.workerChoiceStrategyContext.remove(workerNodeKey) | |
1450 | } | |
51fe3d3c | 1451 | } |
adc3c320 | 1452 | |
e2b31e32 JB |
1453 | /** @inheritDoc */ |
1454 | public hasWorkerNodeBackPressure (workerNodeKey: number): boolean { | |
9e844245 | 1455 | return ( |
e2b31e32 JB |
1456 | this.opts.enableTasksQueue === true && |
1457 | this.workerNodes[workerNodeKey].hasBackPressure() | |
9e844245 JB |
1458 | ) |
1459 | } | |
1460 | ||
1461 | private hasBackPressure (): boolean { | |
1462 | return ( | |
1463 | this.opts.enableTasksQueue === true && | |
1464 | this.workerNodes.findIndex( | |
041dc05b | 1465 | workerNode => !workerNode.hasBackPressure() |
a1763c54 | 1466 | ) === -1 |
9e844245 | 1467 | ) |
e2b31e32 JB |
1468 | } |
1469 | ||
b0a4db63 | 1470 | /** |
aa9eede8 | 1471 | * Executes the given task on the worker given its worker node key. |
b0a4db63 | 1472 | * |
aa9eede8 | 1473 | * @param workerNodeKey - The worker node key. |
b0a4db63 JB |
1474 | * @param task - The task to execute. |
1475 | */ | |
2e81254d | 1476 | private executeTask (workerNodeKey: number, task: Task<Data>): void { |
1c6fe997 | 1477 | this.beforeTaskExecutionHook(workerNodeKey, task) |
bbfa38a2 | 1478 | this.sendToWorker(workerNodeKey, task, task.transferList) |
a1763c54 | 1479 | this.checkAndEmitTaskExecutionEvents() |
2e81254d JB |
1480 | } |
1481 | ||
f9f00b5f | 1482 | private enqueueTask (workerNodeKey: number, task: Task<Data>): number { |
a1763c54 JB |
1483 | const tasksQueueSize = this.workerNodes[workerNodeKey].enqueueTask(task) |
1484 | this.checkAndEmitTaskQueuingEvents() | |
1485 | return tasksQueueSize | |
adc3c320 JB |
1486 | } |
1487 | ||
416fd65c | 1488 | private dequeueTask (workerNodeKey: number): Task<Data> | undefined { |
4b628b48 | 1489 | return this.workerNodes[workerNodeKey].dequeueTask() |
adc3c320 JB |
1490 | } |
1491 | ||
416fd65c | 1492 | private tasksQueueSize (workerNodeKey: number): number { |
4b628b48 | 1493 | return this.workerNodes[workerNodeKey].tasksQueueSize() |
df593701 JB |
1494 | } |
1495 | ||
81c02522 | 1496 | protected flushTasksQueue (workerNodeKey: number): void { |
920278a2 JB |
1497 | while (this.tasksQueueSize(workerNodeKey) > 0) { |
1498 | this.executeTask( | |
1499 | workerNodeKey, | |
1500 | this.dequeueTask(workerNodeKey) as Task<Data> | |
1501 | ) | |
ff733df7 | 1502 | } |
4b628b48 | 1503 | this.workerNodes[workerNodeKey].clearTasksQueue() |
ff733df7 JB |
1504 | } |
1505 | ||
ef41a6e6 JB |
1506 | private flushTasksQueues (): void { |
1507 | for (const [workerNodeKey] of this.workerNodes.entries()) { | |
1508 | this.flushTasksQueue(workerNodeKey) | |
1509 | } | |
1510 | } | |
c97c7edb | 1511 | } |