docs: refine some comments
[poolifier.git] / src / pools / abstract-pool.ts
CommitLineData
ded253e2 1import { AsyncResource } from 'node:async_hooks'
2845f2a5 2import { randomUUID } from 'node:crypto'
ded253e2 3import { EventEmitterAsyncResource } from 'node:events'
62c15a68 4import { performance } from 'node:perf_hooks'
ef083f7b 5import type { TransferListItem } from 'node:worker_threads'
ded253e2 6
9df282a0 7import { defaultBucketSize } from '../priority-queue.js'
5c4d16da
JB
8import type {
9 MessageValue,
10 PromiseResponseWrapper,
31847469 11 Task,
3a502712 12 TaskFunctionProperties,
d35e5717 13} from '../utility-types.js'
bbeadd16 14import {
ded253e2 15 average,
31847469 16 buildTaskFunctionProperties,
ff128cc9 17 DEFAULT_TASK_NAME,
bbeadd16 18 EMPTY_FUNCTION,
463226a4 19 exponentialDelay,
59317253 20 isKillBehavior,
0d80593b 21 isPlainObject,
90d6701c 22 max,
afe0d5bf 23 median,
90d6701c 24 min,
463226a4 25 round,
3a502712 26 sleep,
d35e5717 27} from '../utils.js'
31847469
JB
28import type {
29 TaskFunction,
3a502712 30 TaskFunctionObject,
31847469 31} from '../worker/task-functions.js'
ded253e2 32import { KillBehaviors } from '../worker/worker-options.js'
c4855468 33import {
65d7a1c9 34 type IPool,
c4855468 35 PoolEvents,
6b27d407 36 type PoolInfo,
c4855468 37 type PoolOptions,
6b27d407
JB
38 type PoolType,
39 PoolTypes,
3a502712 40 type TasksQueueOptions,
d35e5717 41} from './pool.js'
a35560ba 42import {
f0d7f803 43 Measurements,
a35560ba 44 WorkerChoiceStrategies,
a20f0ba5 45 type WorkerChoiceStrategy,
3a502712 46 type WorkerChoiceStrategyOptions,
d35e5717 47} from './selection-strategies/selection-strategies-types.js'
bcfb06ce 48import { WorkerChoiceStrategiesContext } from './selection-strategies/worker-choice-strategies-context.js'
bde6b5d7
JB
49import {
50 checkFilePath,
95d1a734 51 checkValidPriority,
bde6b5d7 52 checkValidTasksQueueOptions,
bfc75cca 53 checkValidWorkerChoiceStrategy,
32b141fd 54 getDefaultTasksQueueOptions,
c329fd41
JB
55 updateEluWorkerUsage,
56 updateRunTimeWorkerUsage,
57 updateTaskStatisticsWorkerUsage,
58 updateWaitTimeWorkerUsage,
3a502712 59 waitWorkerNodeEvents,
d35e5717 60} from './utils.js'
ded253e2
JB
61import { version } from './version.js'
62import type {
63 IWorker,
64 IWorkerNode,
65 WorkerInfo,
66 WorkerNodeEventDetail,
3a502712 67 WorkerType,
ded253e2
JB
68} from './worker.js'
69import { WorkerNode } from './worker-node.js'
23ccf9d7 70
729c563d 71/**
ea7a90d3 72 * Base class that implements some shared logic for all poolifier pools.
38e795c1 73 * @typeParam Worker - Type of worker which manages this pool.
e102732c
JB
74 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
75 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
729c563d 76 */
c97c7edb 77export abstract class AbstractPool<
f06e48d8 78 Worker extends IWorker,
d3c8a1a8
S
79 Data = unknown,
80 Response = unknown
c4855468 81> implements IPool<Worker, Data, Response> {
afc003b2 82 /** @inheritDoc */
3a502712 83 public readonly workerNodes: IWorkerNode<Worker, Data>[] = []
4a6952ff 84
afc003b2 85 /** @inheritDoc */
f80125ca 86 public emitter?: EventEmitterAsyncResource
7c0ba920 87
be0676b3 88 /**
419e8121 89 * The task execution response promise map:
2740a743 90 * - `key`: The message id of each submitted task.
bcfb06ce 91 * - `value`: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.
be0676b3 92 *
a3445496 93 * When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
be0676b3 94 */
84781cd6
JB
95 protected promiseResponseMap: Map<
96 `${string}-${string}-${string}-${string}-${string}`,
3a502712 97 PromiseResponseWrapper<Response>
84781cd6
JB
98 > = new Map<
99 `${string}-${string}-${string}-${string}-${string}`,
100 PromiseResponseWrapper<Response>
3a502712 101 >()
c97c7edb 102
a35560ba 103 /**
bcfb06ce 104 * Worker choice strategies context referencing worker choice algorithms implementation.
a35560ba 105 */
bcfb06ce 106 protected workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
3a502712
JB
107 Worker,
108 Data,
109 Response
a35560ba
S
110 >
111
72ae84a2
JB
112 /**
113 * The task functions added at runtime map:
114 * - `key`: The task function name.
31847469 115 * - `value`: The task function object.
72ae84a2 116 */
31847469 117 private readonly taskFunctions: Map<
3a502712
JB
118 string,
119 TaskFunctionObject<Data, Response>
31847469 120 >
72ae84a2 121
15b176e0
JB
122 /**
123 * Whether the pool is started or not.
124 */
125 private started: boolean
47352846
JB
126 /**
127 * Whether the pool is starting or not.
128 */
129 private starting: boolean
711623b8
JB
130 /**
131 * Whether the pool is destroying or not.
132 */
133 private destroying: boolean
b362a929
JB
134 /**
135 * Whether the minimum number of workers is starting or not.
136 */
137 private startingMinimumNumberOfWorkers: boolean
55082af9
JB
138 /**
139 * Whether the pool ready event has been emitted or not.
140 */
141 private readyEventEmitted: boolean
afe0d5bf
JB
142 /**
143 * The start timestamp of the pool.
144 */
97dc65d9 145 private startTimestamp?: number
afe0d5bf 146
729c563d
S
147 /**
148 * Constructs a new poolifier pool.
00e1bdeb 149 * @param minimumNumberOfWorkers - Minimum number of workers that this pool manages.
029715f0 150 * @param filePath - Path to the worker file.
38e795c1 151 * @param opts - Options for the pool.
00e1bdeb 152 * @param maximumNumberOfWorkers - Maximum number of workers that this pool manages.
729c563d 153 */
c97c7edb 154 public constructor (
26ce26ca 155 protected readonly minimumNumberOfWorkers: number,
b4213b7f 156 protected readonly filePath: string,
26ce26ca
JB
157 protected readonly opts: PoolOptions<Worker>,
158 protected readonly maximumNumberOfWorkers?: number
c97c7edb 159 ) {
78cea37e 160 if (!this.isMain()) {
04f45163 161 throw new Error(
8c6d4acf 162 'Cannot start a pool from a worker with the same type as the pool'
04f45163 163 )
c97c7edb 164 }
26ce26ca 165 this.checkPoolType()
bde6b5d7 166 checkFilePath(this.filePath)
26ce26ca 167 this.checkMinimumNumberOfWorkers(this.minimumNumberOfWorkers)
7c0ba920 168 this.checkPoolOptions(this.opts)
1086026a 169
7254e419
JB
170 this.chooseWorkerNode = this.chooseWorkerNode.bind(this)
171 this.executeTask = this.executeTask.bind(this)
172 this.enqueueTask = this.enqueueTask.bind(this)
1086026a 173
6bd72cd0 174 if (this.opts.enableEvents === true) {
e0843544 175 this.initEventEmitter()
7c0ba920 176 }
bcfb06ce 177 this.workerChoiceStrategiesContext = new WorkerChoiceStrategiesContext<
3a502712
JB
178 Worker,
179 Data,
180 Response
da309861
JB
181 >(
182 this,
bcfb06ce
JB
183 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
184 [this.opts.workerChoiceStrategy!],
da309861
JB
185 this.opts.workerChoiceStrategyOptions
186 )
b6b32453
JB
187
188 this.setupHook()
189
31847469 190 this.taskFunctions = new Map<string, TaskFunctionObject<Data, Response>>()
72ae84a2 191
47352846 192 this.started = false
075e51d1 193 this.starting = false
711623b8 194 this.destroying = false
55082af9 195 this.readyEventEmitted = false
b362a929 196 this.startingMinimumNumberOfWorkers = false
47352846
JB
197 if (this.opts.startWorkers === true) {
198 this.start()
199 }
c97c7edb
S
200 }
201
26ce26ca
JB
202 private checkPoolType (): void {
203 if (this.type === PoolTypes.fixed && this.maximumNumberOfWorkers != null) {
204 throw new Error(
205 'Cannot instantiate a fixed pool with a maximum number of workers specified at initialization'
206 )
207 }
208 }
209
c63a35a0
JB
210 private checkMinimumNumberOfWorkers (
211 minimumNumberOfWorkers: number | undefined
212 ): void {
af7f2788 213 if (minimumNumberOfWorkers == null) {
8d3782fa
JB
214 throw new Error(
215 'Cannot instantiate a pool without specifying the number of workers'
216 )
af7f2788 217 } else if (!Number.isSafeInteger(minimumNumberOfWorkers)) {
473c717a 218 throw new TypeError(
0d80593b 219 'Cannot instantiate a pool with a non safe integer number of workers'
8d3782fa 220 )
af7f2788 221 } else if (minimumNumberOfWorkers < 0) {
473c717a 222 throw new RangeError(
8d3782fa
JB
223 'Cannot instantiate a pool with a negative number of workers'
224 )
af7f2788 225 } else if (this.type === PoolTypes.fixed && minimumNumberOfWorkers === 0) {
2431bdb4
JB
226 throw new RangeError('Cannot instantiate a fixed pool with zero worker')
227 }
228 }
229
7c0ba920 230 private checkPoolOptions (opts: PoolOptions<Worker>): void {
0d80593b 231 if (isPlainObject(opts)) {
47352846 232 this.opts.startWorkers = opts.startWorkers ?? true
c63a35a0 233 checkValidWorkerChoiceStrategy(opts.workerChoiceStrategy)
0d80593b
JB
234 this.opts.workerChoiceStrategy =
235 opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
2324f8c9 236 this.checkValidWorkerChoiceStrategyOptions(
c63a35a0 237 opts.workerChoiceStrategyOptions
2324f8c9 238 )
26ce26ca
JB
239 if (opts.workerChoiceStrategyOptions != null) {
240 this.opts.workerChoiceStrategyOptions = opts.workerChoiceStrategyOptions
8990357d 241 }
1f68cede 242 this.opts.restartWorkerOnError = opts.restartWorkerOnError ?? true
0d80593b
JB
243 this.opts.enableEvents = opts.enableEvents ?? true
244 this.opts.enableTasksQueue = opts.enableTasksQueue ?? false
245 if (this.opts.enableTasksQueue) {
c63a35a0 246 checkValidTasksQueueOptions(opts.tasksQueueOptions)
0d80593b 247 this.opts.tasksQueueOptions = this.buildTasksQueueOptions(
c63a35a0 248 opts.tasksQueueOptions
0d80593b
JB
249 )
250 }
251 } else {
252 throw new TypeError('Invalid pool options: must be a plain object')
7171d33f 253 }
aee46736
JB
254 }
255
0d80593b 256 private checkValidWorkerChoiceStrategyOptions (
c63a35a0 257 workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | undefined
0d80593b 258 ): void {
2324f8c9
JB
259 if (
260 workerChoiceStrategyOptions != null &&
261 !isPlainObject(workerChoiceStrategyOptions)
262 ) {
0d80593b
JB
263 throw new TypeError(
264 'Invalid worker choice strategy options: must be a plain object'
265 )
266 }
49be33fe 267 if (
2324f8c9 268 workerChoiceStrategyOptions?.weights != null &&
26ce26ca
JB
269 Object.keys(workerChoiceStrategyOptions.weights).length !==
270 (this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers)
49be33fe
JB
271 ) {
272 throw new Error(
273 'Invalid worker choice strategy options: must have a weight for each worker node'
274 )
275 }
f0d7f803 276 if (
2324f8c9 277 workerChoiceStrategyOptions?.measurement != null &&
f0d7f803
JB
278 !Object.values(Measurements).includes(
279 workerChoiceStrategyOptions.measurement
280 )
281 ) {
282 throw new Error(
283 `Invalid worker choice strategy options: invalid measurement '${workerChoiceStrategyOptions.measurement}'`
284 )
285 }
0d80593b
JB
286 }
287
e0843544 288 private initEventEmitter (): void {
5b7d00b4 289 this.emitter = new EventEmitterAsyncResource({
3a502712 290 name: `poolifier:${this.type}-${this.worker}-pool`,
b5604034
JB
291 })
292 }
293
08f3f44c 294 /** @inheritDoc */
6b27d407
JB
295 public get info (): PoolInfo {
296 return {
23ccf9d7 297 version,
6b27d407 298 type: this.type,
184855e6 299 worker: this.worker,
47352846 300 started: this.started,
2431bdb4 301 ready: this.ready,
67f3f2d6 302 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
bcfb06ce
JB
303 defaultStrategy: this.opts.workerChoiceStrategy!,
304 strategyRetries: this.workerChoiceStrategiesContext?.retriesCount ?? 0,
26ce26ca
JB
305 minSize: this.minimumNumberOfWorkers,
306 maxSize: this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers,
bcfb06ce 307 ...(this.workerChoiceStrategiesContext?.getTaskStatisticsRequirements()
f4d0a470 308 .runTime.aggregate === true &&
bcfb06ce 309 this.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
c63a35a0 310 .waitTime.aggregate && {
3a502712 311 utilization: round(this.utilization),
c63a35a0 312 }),
6b27d407
JB
313 workerNodes: this.workerNodes.length,
314 idleWorkerNodes: this.workerNodes.reduce(
315 (accumulator, workerNode) =>
f59e1027 316 workerNode.usage.tasks.executing === 0
a4e07f72
JB
317 ? accumulator + 1
318 : accumulator,
6b27d407
JB
319 0
320 ),
5eb72b9e
JB
321 ...(this.opts.enableTasksQueue === true && {
322 stealingWorkerNodes: this.workerNodes.reduce(
323 (accumulator, workerNode) =>
324 workerNode.info.stealing ? accumulator + 1 : accumulator,
325 0
3a502712 326 ),
5eb72b9e 327 }),
6b27d407 328 busyWorkerNodes: this.workerNodes.reduce(
533a8e22 329 (accumulator, _, workerNodeKey) =>
42c677c1 330 this.isWorkerNodeBusy(workerNodeKey) ? accumulator + 1 : accumulator,
6b27d407
JB
331 0
332 ),
a4e07f72 333 executedTasks: this.workerNodes.reduce(
6b27d407 334 (accumulator, workerNode) =>
f59e1027 335 accumulator + workerNode.usage.tasks.executed,
a4e07f72
JB
336 0
337 ),
338 executingTasks: this.workerNodes.reduce(
339 (accumulator, workerNode) =>
f59e1027 340 accumulator + workerNode.usage.tasks.executing,
6b27d407
JB
341 0
342 ),
daf86646
JB
343 ...(this.opts.enableTasksQueue === true && {
344 queuedTasks: this.workerNodes.reduce(
345 (accumulator, workerNode) =>
346 accumulator + workerNode.usage.tasks.queued,
347 0
3a502712 348 ),
daf86646
JB
349 }),
350 ...(this.opts.enableTasksQueue === true && {
351 maxQueuedTasks: this.workerNodes.reduce(
352 (accumulator, workerNode) =>
c63a35a0 353 accumulator + (workerNode.usage.tasks.maxQueued ?? 0),
daf86646 354 0
3a502712 355 ),
daf86646 356 }),
a1763c54 357 ...(this.opts.enableTasksQueue === true && {
3a502712 358 backPressure: this.hasBackPressure(),
a1763c54 359 }),
68cbdc84
JB
360 ...(this.opts.enableTasksQueue === true && {
361 stolenTasks: this.workerNodes.reduce(
362 (accumulator, workerNode) =>
363 accumulator + workerNode.usage.tasks.stolen,
364 0
3a502712 365 ),
68cbdc84 366 }),
a4e07f72
JB
367 failedTasks: this.workerNodes.reduce(
368 (accumulator, workerNode) =>
f59e1027 369 accumulator + workerNode.usage.tasks.failed,
a4e07f72 370 0
1dcf8b7b 371 ),
bcfb06ce 372 ...(this.workerChoiceStrategiesContext?.getTaskStatisticsRequirements()
f4d0a470 373 .runTime.aggregate === true && {
1dcf8b7b 374 runTime: {
98e72cda 375 minimum: round(
90d6701c 376 min(
98e72cda 377 ...this.workerNodes.map(
80115618
JB
378 workerNode =>
379 workerNode.usage.runTime.minimum ?? Number.POSITIVE_INFINITY
98e72cda 380 )
1dcf8b7b
JB
381 )
382 ),
98e72cda 383 maximum: round(
90d6701c 384 max(
98e72cda 385 ...this.workerNodes.map(
80115618
JB
386 workerNode =>
387 workerNode.usage.runTime.maximum ?? Number.NEGATIVE_INFINITY
98e72cda 388 )
1dcf8b7b 389 )
98e72cda 390 ),
bcfb06ce 391 ...(this.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
3baa0837
JB
392 .runTime.average && {
393 average: round(
394 average(
395 this.workerNodes.reduce<number[]>(
396 (accumulator, workerNode) =>
f12182ad
JB
397 accumulator.concat(
398 workerNode.usage.runTime.history.toArray()
399 ),
3baa0837
JB
400 []
401 )
98e72cda 402 )
3a502712 403 ),
3baa0837 404 }),
bcfb06ce 405 ...(this.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
98e72cda
JB
406 .runTime.median && {
407 median: round(
408 median(
3baa0837
JB
409 this.workerNodes.reduce<number[]>(
410 (accumulator, workerNode) =>
f12182ad
JB
411 accumulator.concat(
412 workerNode.usage.runTime.history.toArray()
413 ),
3baa0837 414 []
98e72cda
JB
415 )
416 )
3a502712
JB
417 ),
418 }),
419 },
1dcf8b7b 420 }),
bcfb06ce 421 ...(this.workerChoiceStrategiesContext?.getTaskStatisticsRequirements()
f4d0a470 422 .waitTime.aggregate === true && {
1dcf8b7b 423 waitTime: {
98e72cda 424 minimum: round(
90d6701c 425 min(
98e72cda 426 ...this.workerNodes.map(
80115618
JB
427 workerNode =>
428 workerNode.usage.waitTime.minimum ?? Number.POSITIVE_INFINITY
98e72cda 429 )
1dcf8b7b
JB
430 )
431 ),
98e72cda 432 maximum: round(
90d6701c 433 max(
98e72cda 434 ...this.workerNodes.map(
80115618
JB
435 workerNode =>
436 workerNode.usage.waitTime.maximum ?? Number.NEGATIVE_INFINITY
98e72cda 437 )
1dcf8b7b 438 )
98e72cda 439 ),
bcfb06ce 440 ...(this.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
3baa0837
JB
441 .waitTime.average && {
442 average: round(
443 average(
444 this.workerNodes.reduce<number[]>(
445 (accumulator, workerNode) =>
f12182ad
JB
446 accumulator.concat(
447 workerNode.usage.waitTime.history.toArray()
448 ),
3baa0837
JB
449 []
450 )
98e72cda 451 )
3a502712 452 ),
3baa0837 453 }),
bcfb06ce 454 ...(this.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
98e72cda
JB
455 .waitTime.median && {
456 median: round(
457 median(
3baa0837
JB
458 this.workerNodes.reduce<number[]>(
459 (accumulator, workerNode) =>
f12182ad
JB
460 accumulator.concat(
461 workerNode.usage.waitTime.history.toArray()
462 ),
3baa0837 463 []
98e72cda
JB
464 )
465 )
3a502712
JB
466 ),
467 }),
468 },
533a8e22
JB
469 }),
470 ...(this.workerChoiceStrategiesContext?.getTaskStatisticsRequirements()
471 .elu.aggregate === true && {
472 elu: {
473 idle: {
474 minimum: round(
475 min(
476 ...this.workerNodes.map(
80115618
JB
477 workerNode =>
478 workerNode.usage.elu.idle.minimum ??
479 Number.POSITIVE_INFINITY
533a8e22
JB
480 )
481 )
482 ),
483 maximum: round(
484 max(
485 ...this.workerNodes.map(
80115618
JB
486 workerNode =>
487 workerNode.usage.elu.idle.maximum ??
488 Number.NEGATIVE_INFINITY
533a8e22
JB
489 )
490 )
491 ),
492 ...(this.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
493 .elu.average && {
494 average: round(
495 average(
496 this.workerNodes.reduce<number[]>(
497 (accumulator, workerNode) =>
f12182ad
JB
498 accumulator.concat(
499 workerNode.usage.elu.idle.history.toArray()
500 ),
533a8e22
JB
501 []
502 )
503 )
3a502712 504 ),
533a8e22
JB
505 }),
506 ...(this.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
507 .elu.median && {
508 median: round(
509 median(
510 this.workerNodes.reduce<number[]>(
511 (accumulator, workerNode) =>
f12182ad
JB
512 accumulator.concat(
513 workerNode.usage.elu.idle.history.toArray()
514 ),
533a8e22
JB
515 []
516 )
517 )
3a502712
JB
518 ),
519 }),
533a8e22
JB
520 },
521 active: {
522 minimum: round(
523 min(
524 ...this.workerNodes.map(
80115618
JB
525 workerNode =>
526 workerNode.usage.elu.active.minimum ??
527 Number.POSITIVE_INFINITY
533a8e22
JB
528 )
529 )
530 ),
531 maximum: round(
532 max(
533 ...this.workerNodes.map(
80115618
JB
534 workerNode =>
535 workerNode.usage.elu.active.maximum ??
536 Number.NEGATIVE_INFINITY
533a8e22
JB
537 )
538 )
539 ),
540 ...(this.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
541 .elu.average && {
542 average: round(
543 average(
544 this.workerNodes.reduce<number[]>(
545 (accumulator, workerNode) =>
f12182ad
JB
546 accumulator.concat(
547 workerNode.usage.elu.active.history.toArray()
548 ),
533a8e22
JB
549 []
550 )
551 )
3a502712 552 ),
533a8e22
JB
553 }),
554 ...(this.workerChoiceStrategiesContext.getTaskStatisticsRequirements()
555 .elu.median && {
556 median: round(
557 median(
558 this.workerNodes.reduce<number[]>(
559 (accumulator, workerNode) =>
f12182ad
JB
560 accumulator.concat(
561 workerNode.usage.elu.active.history.toArray()
562 ),
533a8e22
JB
563 []
564 )
565 )
3a502712
JB
566 ),
567 }),
be202c2c
JB
568 },
569 utilization: {
570 average: round(
571 average(
572 this.workerNodes.map(
573 workerNode => workerNode.usage.elu.utilization ?? 0
574 )
575 )
576 ),
577 median: round(
578 median(
579 this.workerNodes.map(
580 workerNode => workerNode.usage.elu.utilization ?? 0
581 )
582 )
3a502712
JB
583 ),
584 },
585 },
586 }),
6b27d407
JB
587 }
588 }
08f3f44c 589
aa9eede8 590 /**
481f6866
JB
591 * Whether the pool is ready or not.
592 * @returns The pool readiness boolean status.
aa9eede8 593 */
2431bdb4 594 private get ready (): boolean {
8e8d9101
JB
595 if (this.empty) {
596 return false
597 }
2431bdb4 598 return (
b97d82d8
JB
599 this.workerNodes.reduce(
600 (accumulator, workerNode) =>
601 !workerNode.info.dynamic && workerNode.info.ready
602 ? accumulator + 1
603 : accumulator,
604 0
26ce26ca 605 ) >= this.minimumNumberOfWorkers
2431bdb4
JB
606 )
607 }
608
8e8d9101 609 /**
481f6866
JB
610 * Whether the pool is empty or not.
611 * @returns The pool emptiness boolean status.
8e8d9101
JB
612 */
613 protected get empty (): boolean {
fb43035c 614 return this.minimumNumberOfWorkers === 0 && this.workerNodes.length === 0
8e8d9101
JB
615 }
616
afe0d5bf 617 /**
aa9eede8 618 * The approximate pool utilization.
afe0d5bf
JB
619 * @returns The pool utilization.
620 */
621 private get utilization (): number {
97dc65d9
JB
622 if (this.startTimestamp == null) {
623 return 0
624 }
8e5ca040 625 const poolTimeCapacity =
26ce26ca
JB
626 (performance.now() - this.startTimestamp) *
627 (this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers)
afe0d5bf
JB
628 const totalTasksRunTime = this.workerNodes.reduce(
629 (accumulator, workerNode) =>
c63a35a0 630 accumulator + (workerNode.usage.runTime.aggregate ?? 0),
afe0d5bf
JB
631 0
632 )
633 const totalTasksWaitTime = this.workerNodes.reduce(
634 (accumulator, workerNode) =>
c63a35a0 635 accumulator + (workerNode.usage.waitTime.aggregate ?? 0),
afe0d5bf
JB
636 0
637 )
8e5ca040 638 return (totalTasksRunTime + totalTasksWaitTime) / poolTimeCapacity
afe0d5bf
JB
639 }
640
8881ae32 641 /**
aa9eede8 642 * The pool type.
8881ae32
JB
643 *
644 * If it is `'dynamic'`, it provides the `max` property.
645 */
646 protected abstract get type (): PoolType
647
184855e6 648 /**
aa9eede8 649 * The worker type.
184855e6
JB
650 */
651 protected abstract get worker (): WorkerType
652
6b813701
JB
653 /**
654 * Checks if the worker id sent in the received message from a worker is valid.
6b813701
JB
655 * @param message - The received message.
656 * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker id is invalid.
657 */
4d159167 658 private checkMessageWorkerId (message: MessageValue<Data | Response>): void {
310de0aa
JB
659 if (message.workerId == null) {
660 throw new Error('Worker message received without worker id')
8e5a7cf9 661 } else if (this.getWorkerNodeKeyByWorkerId(message.workerId) === -1) {
21f710aa 662 throw new Error(
6e5d7052 663 `Worker message received from unknown worker '${message.workerId.toString()}'`
21f710aa
JB
664 )
665 }
666 }
667
aa9eede8
JB
668 /**
669 * Gets the worker node key given its worker id.
aa9eede8 670 * @param workerId - The worker id.
aad6fb64 671 * @returns The worker node key if the worker id is found in the pool worker nodes, `-1` otherwise.
aa9eede8 672 */
72ae84a2 673 private getWorkerNodeKeyByWorkerId (workerId: number | undefined): number {
aad6fb64 674 return this.workerNodes.findIndex(
041dc05b 675 workerNode => workerNode.info.id === workerId
aad6fb64 676 )
aa9eede8
JB
677 }
678
afc003b2 679 /** @inheritDoc */
a35560ba 680 public setWorkerChoiceStrategy (
59219cbb
JB
681 workerChoiceStrategy: WorkerChoiceStrategy,
682 workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
a35560ba 683 ): void {
19b8be8b 684 let requireSync = false
bde6b5d7 685 checkValidWorkerChoiceStrategy(workerChoiceStrategy)
85bbc7ab 686 if (workerChoiceStrategyOptions != null) {
423f3b7a 687 requireSync = !this.setWorkerChoiceStrategyOptions(
19b8be8b
JB
688 workerChoiceStrategyOptions
689 )
85bbc7ab
JB
690 }
691 if (workerChoiceStrategy !== this.opts.workerChoiceStrategy) {
692 this.opts.workerChoiceStrategy = workerChoiceStrategy
693 this.workerChoiceStrategiesContext?.setDefaultWorkerChoiceStrategy(
694 this.opts.workerChoiceStrategy,
695 this.opts.workerChoiceStrategyOptions
696 )
19b8be8b
JB
697 requireSync = true
698 }
699 if (requireSync) {
85bbc7ab 700 this.workerChoiceStrategiesContext?.syncWorkerChoiceStrategies(
91041638 701 this.getWorkerChoiceStrategies(),
85bbc7ab
JB
702 this.opts.workerChoiceStrategyOptions
703 )
19b8be8b 704 for (const workerNodeKey of this.workerNodes.keys()) {
85bbc7ab
JB
705 this.sendStatisticsMessageToWorker(workerNodeKey)
706 }
59219cbb 707 }
a20f0ba5
JB
708 }
709
710 /** @inheritDoc */
711 public setWorkerChoiceStrategyOptions (
c63a35a0 712 workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | undefined
19b8be8b 713 ): boolean {
0d80593b 714 this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions)
26ce26ca
JB
715 if (workerChoiceStrategyOptions != null) {
716 this.opts.workerChoiceStrategyOptions = workerChoiceStrategyOptions
19b8be8b
JB
717 this.workerChoiceStrategiesContext?.setOptions(
718 this.opts.workerChoiceStrategyOptions
719 )
720 this.workerChoiceStrategiesContext?.syncWorkerChoiceStrategies(
91041638 721 this.getWorkerChoiceStrategies(),
19b8be8b
JB
722 this.opts.workerChoiceStrategyOptions
723 )
724 for (const workerNodeKey of this.workerNodes.keys()) {
725 this.sendStatisticsMessageToWorker(workerNodeKey)
726 }
727 return true
8990357d 728 }
19b8be8b 729 return false
a35560ba
S
730 }
731
a20f0ba5 732 /** @inheritDoc */
8f52842f
JB
733 public enableTasksQueue (
734 enable: boolean,
735 tasksQueueOptions?: TasksQueueOptions
736 ): void {
a20f0ba5 737 if (this.opts.enableTasksQueue === true && !enable) {
d6ca1416
JB
738 this.unsetTaskStealing()
739 this.unsetTasksStealingOnBackPressure()
ef41a6e6 740 this.flushTasksQueues()
a20f0ba5
JB
741 }
742 this.opts.enableTasksQueue = enable
c63a35a0 743 this.setTasksQueueOptions(tasksQueueOptions)
a20f0ba5
JB
744 }
745
746 /** @inheritDoc */
c63a35a0
JB
747 public setTasksQueueOptions (
748 tasksQueueOptions: TasksQueueOptions | undefined
749 ): void {
a20f0ba5 750 if (this.opts.enableTasksQueue === true) {
bde6b5d7 751 checkValidTasksQueueOptions(tasksQueueOptions)
8f52842f
JB
752 this.opts.tasksQueueOptions =
753 this.buildTasksQueueOptions(tasksQueueOptions)
67f3f2d6
JB
754 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
755 this.setTasksQueueSize(this.opts.tasksQueueOptions.size!)
d6ca1416 756 if (this.opts.tasksQueueOptions.taskStealing === true) {
9f99eb9b 757 this.unsetTaskStealing()
d6ca1416
JB
758 this.setTaskStealing()
759 } else {
760 this.unsetTaskStealing()
761 }
762 if (this.opts.tasksQueueOptions.tasksStealingOnBackPressure === true) {
9f99eb9b 763 this.unsetTasksStealingOnBackPressure()
d6ca1416
JB
764 this.setTasksStealingOnBackPressure()
765 } else {
766 this.unsetTasksStealingOnBackPressure()
767 }
5baee0d7 768 } else if (this.opts.tasksQueueOptions != null) {
a20f0ba5
JB
769 delete this.opts.tasksQueueOptions
770 }
771 }
772
9b38ab2d 773 private buildTasksQueueOptions (
c63a35a0 774 tasksQueueOptions: TasksQueueOptions | undefined
9b38ab2d
JB
775 ): TasksQueueOptions {
776 return {
26ce26ca
JB
777 ...getDefaultTasksQueueOptions(
778 this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers
779 ),
3a502712 780 ...tasksQueueOptions,
9b38ab2d
JB
781 }
782 }
783
5b49e864 784 private setTasksQueueSize (size: number): void {
20c6f652 785 for (const workerNode of this.workerNodes) {
ff3f866a 786 workerNode.tasksQueueBackPressureSize = size
20c6f652
JB
787 }
788 }
789
d6ca1416 790 private setTaskStealing (): void {
19b8be8b 791 for (const workerNodeKey of this.workerNodes.keys()) {
e44639e9 792 this.workerNodes[workerNodeKey].on('idle', this.handleWorkerNodeIdleEvent)
d6ca1416
JB
793 }
794 }
795
796 private unsetTaskStealing (): void {
19b8be8b 797 for (const workerNodeKey of this.workerNodes.keys()) {
e1c2dba7 798 this.workerNodes[workerNodeKey].off(
e44639e9
JB
799 'idle',
800 this.handleWorkerNodeIdleEvent
9f95d5eb 801 )
d6ca1416
JB
802 }
803 }
804
805 private setTasksStealingOnBackPressure (): void {
19b8be8b 806 for (const workerNodeKey of this.workerNodes.keys()) {
e1c2dba7 807 this.workerNodes[workerNodeKey].on(
b5e75be8 808 'backPressure',
e44639e9 809 this.handleWorkerNodeBackPressureEvent
9f95d5eb 810 )
d6ca1416
JB
811 }
812 }
813
814 private unsetTasksStealingOnBackPressure (): void {
19b8be8b 815 for (const workerNodeKey of this.workerNodes.keys()) {
e1c2dba7 816 this.workerNodes[workerNodeKey].off(
b5e75be8 817 'backPressure',
e44639e9 818 this.handleWorkerNodeBackPressureEvent
9f95d5eb 819 )
d6ca1416
JB
820 }
821 }
822
c319c66b
JB
823 /**
824 * Whether the pool is full or not.
481f6866 825 * @returns The pool fullness boolean status.
c319c66b 826 */
dea903a8 827 protected get full (): boolean {
26ce26ca
JB
828 return (
829 this.workerNodes.length >=
830 (this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers)
831 )
dea903a8 832 }
c2ade475 833
c319c66b
JB
834 /**
835 * Whether the pool is busy or not.
481f6866 836 * @returns The pool busyness boolean status.
c319c66b
JB
837 */
838 protected abstract get busy (): boolean
7c0ba920 839
6c6afb84 840 /**
3d76750a 841 * Whether worker nodes are executing concurrently their tasks quota or not.
6c6afb84
JB
842 * @returns Worker nodes busyness boolean status.
843 */
c2ade475 844 protected internalBusy (): boolean {
3d76750a
JB
845 if (this.opts.enableTasksQueue === true) {
846 return (
847 this.workerNodes.findIndex(
041dc05b 848 workerNode =>
3d76750a
JB
849 workerNode.info.ready &&
850 workerNode.usage.tasks.executing <
67f3f2d6
JB
851 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
852 this.opts.tasksQueueOptions!.concurrency!
3d76750a
JB
853 ) === -1
854 )
3d76750a 855 }
419e8121
JB
856 return (
857 this.workerNodes.findIndex(
858 workerNode =>
859 workerNode.info.ready && workerNode.usage.tasks.executing === 0
860 ) === -1
861 )
cb70b19d
JB
862 }
863
42c677c1
JB
864 private isWorkerNodeBusy (workerNodeKey: number): boolean {
865 if (this.opts.enableTasksQueue === true) {
866 return (
867 this.workerNodes[workerNodeKey].usage.tasks.executing >=
67f3f2d6
JB
868 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
869 this.opts.tasksQueueOptions!.concurrency!
42c677c1
JB
870 )
871 }
872 return this.workerNodes[workerNodeKey].usage.tasks.executing > 0
873 }
874
e81c38f2 875 private async sendTaskFunctionOperationToWorker (
72ae84a2
JB
876 workerNodeKey: number,
877 message: MessageValue<Data>
878 ): Promise<boolean> {
72ae84a2 879 return await new Promise<boolean>((resolve, reject) => {
ae036c3e
JB
880 const taskFunctionOperationListener = (
881 message: MessageValue<Response>
882 ): void => {
883 this.checkMessageWorkerId(message)
1851fed0 884 const workerId = this.getWorkerInfo(workerNodeKey)?.id
72ae84a2 885 if (
ae036c3e
JB
886 message.taskFunctionOperationStatus != null &&
887 message.workerId === workerId
72ae84a2 888 ) {
ae036c3e
JB
889 if (message.taskFunctionOperationStatus) {
890 resolve(true)
c63a35a0 891 } else {
ae036c3e
JB
892 reject(
893 new Error(
6e5d7052
JB
894 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
895 `Task function operation '${message.taskFunctionOperation?.toString()}' failed on worker ${message.workerId?.toString()} with error: '${
896 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
897 message.workerError?.message
898 }'`
ae036c3e 899 )
72ae84a2 900 )
ae036c3e
JB
901 }
902 this.deregisterWorkerMessageListener(
903 this.getWorkerNodeKeyByWorkerId(message.workerId),
904 taskFunctionOperationListener
72ae84a2
JB
905 )
906 }
ae036c3e
JB
907 }
908 this.registerWorkerMessageListener(
909 workerNodeKey,
910 taskFunctionOperationListener
911 )
72ae84a2
JB
912 this.sendToWorker(workerNodeKey, message)
913 })
914 }
915
916 private async sendTaskFunctionOperationToWorkers (
adee6053 917 message: MessageValue<Data>
e81c38f2
JB
918 ): Promise<boolean> {
919 return await new Promise<boolean>((resolve, reject) => {
ae036c3e
JB
920 const responsesReceived = new Array<MessageValue<Response>>()
921 const taskFunctionOperationsListener = (
922 message: MessageValue<Response>
923 ): void => {
924 this.checkMessageWorkerId(message)
925 if (message.taskFunctionOperationStatus != null) {
926 responsesReceived.push(message)
927 if (responsesReceived.length === this.workerNodes.length) {
e81c38f2 928 if (
e81c38f2
JB
929 responsesReceived.every(
930 message => message.taskFunctionOperationStatus === true
931 )
932 ) {
933 resolve(true)
934 } else if (
e81c38f2
JB
935 responsesReceived.some(
936 message => message.taskFunctionOperationStatus === false
937 )
938 ) {
b0b55f57
JB
939 const errorResponse = responsesReceived.find(
940 response => response.taskFunctionOperationStatus === false
941 )
e81c38f2
JB
942 reject(
943 new Error(
b0b55f57 944 `Task function operation '${
e81c38f2 945 message.taskFunctionOperation as string
6e5d7052
JB
946 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
947 }' failed on worker ${errorResponse?.workerId?.toString()} with error: '${
948 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
c63a35a0 949 errorResponse?.workerError?.message
b0b55f57 950 }'`
e81c38f2
JB
951 )
952 )
953 }
ae036c3e
JB
954 this.deregisterWorkerMessageListener(
955 this.getWorkerNodeKeyByWorkerId(message.workerId),
956 taskFunctionOperationsListener
957 )
e81c38f2 958 }
ae036c3e
JB
959 }
960 }
19b8be8b 961 for (const workerNodeKey of this.workerNodes.keys()) {
ae036c3e
JB
962 this.registerWorkerMessageListener(
963 workerNodeKey,
964 taskFunctionOperationsListener
965 )
72ae84a2 966 this.sendToWorker(workerNodeKey, message)
e81c38f2
JB
967 }
968 })
6703b9f4
JB
969 }
970
971 /** @inheritDoc */
972 public hasTaskFunction (name: string): boolean {
85bbc7ab
JB
973 return this.listTaskFunctionsProperties().some(
974 taskFunctionProperties => taskFunctionProperties.name === name
975 )
6703b9f4
JB
976 }
977
978 /** @inheritDoc */
e81c38f2
JB
979 public async addTaskFunction (
980 name: string,
31847469 981 fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>
e81c38f2 982 ): Promise<boolean> {
3feeab69
JB
983 if (typeof name !== 'string') {
984 throw new TypeError('name argument must be a string')
985 }
986 if (typeof name === 'string' && name.trim().length === 0) {
987 throw new TypeError('name argument must not be an empty string')
988 }
31847469
JB
989 if (typeof fn === 'function') {
990 fn = { taskFunction: fn } satisfies TaskFunctionObject<Data, Response>
991 }
992 if (typeof fn.taskFunction !== 'function') {
993 throw new TypeError('taskFunction property must be a function')
3feeab69 994 }
95d1a734
JB
995 checkValidPriority(fn.priority)
996 checkValidWorkerChoiceStrategy(fn.strategy)
adee6053 997 const opResult = await this.sendTaskFunctionOperationToWorkers({
6703b9f4 998 taskFunctionOperation: 'add',
31847469 999 taskFunctionProperties: buildTaskFunctionProperties(name, fn),
3a502712 1000 taskFunction: fn.taskFunction.toString(),
6703b9f4 1001 })
adee6053 1002 this.taskFunctions.set(name, fn)
85bbc7ab 1003 this.workerChoiceStrategiesContext?.syncWorkerChoiceStrategies(
91041638 1004 this.getWorkerChoiceStrategies()
85bbc7ab 1005 )
9a55fa8c
JB
1006 for (const workerNodeKey of this.workerNodes.keys()) {
1007 this.sendStatisticsMessageToWorker(workerNodeKey)
1008 }
adee6053 1009 return opResult
6703b9f4
JB
1010 }
1011
1012 /** @inheritDoc */
e81c38f2 1013 public async removeTaskFunction (name: string): Promise<boolean> {
9eae3c69
JB
1014 if (!this.taskFunctions.has(name)) {
1015 throw new Error(
16248b23 1016 'Cannot remove a task function not handled on the pool side'
9eae3c69
JB
1017 )
1018 }
adee6053 1019 const opResult = await this.sendTaskFunctionOperationToWorkers({
6703b9f4 1020 taskFunctionOperation: 'remove',
31847469
JB
1021 taskFunctionProperties: buildTaskFunctionProperties(
1022 name,
1023 this.taskFunctions.get(name)
3a502712 1024 ),
6703b9f4 1025 })
9a55fa8c
JB
1026 for (const workerNode of this.workerNodes) {
1027 workerNode.deleteTaskFunctionWorkerUsage(name)
1028 }
adee6053 1029 this.taskFunctions.delete(name)
85bbc7ab 1030 this.workerChoiceStrategiesContext?.syncWorkerChoiceStrategies(
91041638 1031 this.getWorkerChoiceStrategies()
85bbc7ab 1032 )
9a55fa8c
JB
1033 for (const workerNodeKey of this.workerNodes.keys()) {
1034 this.sendStatisticsMessageToWorker(workerNodeKey)
1035 }
adee6053 1036 return opResult
6703b9f4
JB
1037 }
1038
90d7d101 1039 /** @inheritDoc */
31847469 1040 public listTaskFunctionsProperties (): TaskFunctionProperties[] {
f2dbbf95
JB
1041 for (const workerNode of this.workerNodes) {
1042 if (
31847469
JB
1043 Array.isArray(workerNode.info.taskFunctionsProperties) &&
1044 workerNode.info.taskFunctionsProperties.length > 0
f2dbbf95 1045 ) {
31847469 1046 return workerNode.info.taskFunctionsProperties
f2dbbf95 1047 }
90d7d101 1048 }
f2dbbf95 1049 return []
90d7d101
JB
1050 }
1051
bcfb06ce 1052 /**
91041638 1053 * Gets task function worker choice strategy, if any.
bcfb06ce
JB
1054 * @param name - The task function name.
1055 * @returns The task function worker choice strategy if the task function worker choice strategy is defined, `undefined` otherwise.
1056 */
91041638 1057 private readonly getTaskFunctionWorkerChoiceStrategy = (
bcfb06ce
JB
1058 name?: string
1059 ): WorkerChoiceStrategy | undefined => {
91041638
JB
1060 name = name ?? DEFAULT_TASK_NAME
1061 const taskFunctionsProperties = this.listTaskFunctionsProperties()
1062 if (name === DEFAULT_TASK_NAME) {
1063 name = taskFunctionsProperties[1]?.name
bcfb06ce 1064 }
91041638
JB
1065 return taskFunctionsProperties.find(
1066 (taskFunctionProperties: TaskFunctionProperties) =>
1067 taskFunctionProperties.name === name
1068 )?.strategy
1069 }
1070
1071 /**
1072 * Gets worker node task function worker choice strategy, if any.
91041638
JB
1073 * @param workerNodeKey - The worker node key.
1074 * @param name - The task function name.
1075 * @returns The worker node task function worker choice strategy if the worker node task function worker choice strategy is defined, `undefined` otherwise.
1076 */
1077 private readonly getWorkerNodeTaskFunctionWorkerChoiceStrategy = (
1078 workerNodeKey: number,
1079 name?: string
1080 ): WorkerChoiceStrategy | undefined => {
1081 const workerInfo = this.getWorkerInfo(workerNodeKey)
1082 if (workerInfo == null) {
1083 return
1084 }
1085 name = name ?? DEFAULT_TASK_NAME
1086 if (name === DEFAULT_TASK_NAME) {
1087 name = workerInfo.taskFunctionsProperties?.[1]?.name
1088 }
1089 return workerInfo.taskFunctionsProperties?.find(
1090 (taskFunctionProperties: TaskFunctionProperties) =>
1091 taskFunctionProperties.name === name
1092 )?.strategy
bcfb06ce
JB
1093 }
1094
95d1a734
JB
1095 /**
1096 * Gets worker node task function priority, if any.
95d1a734
JB
1097 * @param workerNodeKey - The worker node key.
1098 * @param name - The task function name.
a20062fa 1099 * @returns The worker node task function priority if the worker node task function priority is defined, `undefined` otherwise.
95d1a734
JB
1100 */
1101 private readonly getWorkerNodeTaskFunctionPriority = (
1102 workerNodeKey: number,
1103 name?: string
1104 ): number | undefined => {
91041638
JB
1105 const workerInfo = this.getWorkerInfo(workerNodeKey)
1106 if (workerInfo == null) {
1107 return
95d1a734 1108 }
91041638
JB
1109 name = name ?? DEFAULT_TASK_NAME
1110 if (name === DEFAULT_TASK_NAME) {
1111 name = workerInfo.taskFunctionsProperties?.[1]?.name
1112 }
1113 return workerInfo.taskFunctionsProperties?.find(
1114 (taskFunctionProperties: TaskFunctionProperties) =>
1115 taskFunctionProperties.name === name
1116 )?.priority
95d1a734
JB
1117 }
1118
85bbc7ab
JB
1119 /**
1120 * Gets the worker choice strategies registered in this pool.
85bbc7ab
JB
1121 * @returns The worker choice strategies.
1122 */
91041638 1123 private readonly getWorkerChoiceStrategies =
85bbc7ab
JB
1124 (): Set<WorkerChoiceStrategy> => {
1125 return new Set([
1126 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1127 this.opts.workerChoiceStrategy!,
1128 ...(this.listTaskFunctionsProperties()
1129 .map(
1130 (taskFunctionProperties: TaskFunctionProperties) =>
1131 taskFunctionProperties.strategy
1132 )
1133 .filter(
1134 (strategy: WorkerChoiceStrategy | undefined) => strategy != null
3a502712 1135 ) as WorkerChoiceStrategy[]),
85bbc7ab
JB
1136 ])
1137 }
1138
6703b9f4 1139 /** @inheritDoc */
e81c38f2 1140 public async setDefaultTaskFunction (name: string): Promise<boolean> {
72ae84a2 1141 return await this.sendTaskFunctionOperationToWorkers({
6703b9f4 1142 taskFunctionOperation: 'default',
31847469
JB
1143 taskFunctionProperties: buildTaskFunctionProperties(
1144 name,
1145 this.taskFunctions.get(name)
3a502712 1146 ),
6703b9f4 1147 })
6703b9f4
JB
1148 }
1149
375f7504
JB
1150 private shallExecuteTask (workerNodeKey: number): boolean {
1151 return (
1152 this.tasksQueueSize(workerNodeKey) === 0 &&
1153 this.workerNodes[workerNodeKey].usage.tasks.executing <
67f3f2d6
JB
1154 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1155 this.opts.tasksQueueOptions!.concurrency!
375f7504
JB
1156 )
1157 }
1158
afc003b2 1159 /** @inheritDoc */
7d91a8cd
JB
1160 public async execute (
1161 data?: Data,
1162 name?: string,
6a3ecc50 1163 transferList?: readonly TransferListItem[]
7d91a8cd 1164 ): Promise<Response> {
52b71763 1165 return await new Promise<Response>((resolve, reject) => {
15b176e0 1166 if (!this.started) {
47352846 1167 reject(new Error('Cannot execute a task on not started pool'))
9d2d0da1 1168 return
15b176e0 1169 }
711623b8
JB
1170 if (this.destroying) {
1171 reject(new Error('Cannot execute a task on destroying pool'))
1172 return
1173 }
7d91a8cd
JB
1174 if (name != null && typeof name !== 'string') {
1175 reject(new TypeError('name argument must be a string'))
9d2d0da1 1176 return
7d91a8cd 1177 }
90d7d101
JB
1178 if (
1179 name != null &&
1180 typeof name === 'string' &&
1181 name.trim().length === 0
1182 ) {
f58b60b9 1183 reject(new TypeError('name argument must not be an empty string'))
9d2d0da1 1184 return
90d7d101 1185 }
b558f6b5
JB
1186 if (transferList != null && !Array.isArray(transferList)) {
1187 reject(new TypeError('transferList argument must be an array'))
9d2d0da1 1188 return
b558f6b5
JB
1189 }
1190 const timestamp = performance.now()
91041638 1191 const workerNodeKey = this.chooseWorkerNode(name)
501aea93 1192 const task: Task<Data> = {
52b71763 1193 name: name ?? DEFAULT_TASK_NAME,
52b71763 1194 data: data ?? ({} as Data),
95d1a734 1195 priority: this.getWorkerNodeTaskFunctionPriority(workerNodeKey, name),
91041638
JB
1196 strategy: this.getWorkerNodeTaskFunctionWorkerChoiceStrategy(
1197 workerNodeKey,
1198 name
1199 ),
7d91a8cd 1200 transferList,
52b71763 1201 timestamp,
3a502712 1202 taskId: randomUUID(),
52b71763 1203 }
67f3f2d6
JB
1204 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1205 this.promiseResponseMap.set(task.taskId!, {
2e81254d
JB
1206 resolve,
1207 reject,
f18fd12b
JB
1208 workerNodeKey,
1209 ...(this.emitter != null && {
1210 asyncResource: new AsyncResource('poolifier:task', {
1211 triggerAsyncId: this.emitter.asyncId,
3a502712
JB
1212 requireManualDestroy: true,
1213 }),
1214 }),
2e81254d 1215 })
52b71763 1216 if (
4e377863
JB
1217 this.opts.enableTasksQueue === false ||
1218 (this.opts.enableTasksQueue === true &&
375f7504 1219 this.shallExecuteTask(workerNodeKey))
52b71763 1220 ) {
501aea93 1221 this.executeTask(workerNodeKey, task)
4e377863
JB
1222 } else {
1223 this.enqueueTask(workerNodeKey, task)
52b71763 1224 }
2e81254d 1225 })
280c2a77 1226 }
c97c7edb 1227
d0798374
JB
1228
1229 /** @inheritDoc */
1230 public mapExecute (
1231 data: Iterable<Data>,
1232 name?: string,
1233 transferList?: readonly TransferListItem[]
1234 ): Promise<Response[]> {
27469db4
JB
1235 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1236 if (data == null) {
1237 throw new TypeError('data argument must be a defined iterable')
1238 }
1239 if (typeof data[Symbol.iterator] !== 'function') {
1240 throw new TypeError('data argument must be an iterable')
1241 }
1242 if (!Array.isArray(data)) {
1243 data = [...data]
1244 }
d0798374 1245 return Promise.all(
27469db4 1246 (data as Data[]).map(data => this.execute(data, name, transferList))
d0798374
JB
1247 )
1248 }
1249
60dc0a9c
JB
1250 /**
1251 * Starts the minimum number of workers.
ec8ed549 1252 * @param initWorkerNodeUsage - Whether to initialize the worker node usage or not. @defaultValue false
60dc0a9c 1253 */
e0843544 1254 private startMinimumNumberOfWorkers (initWorkerNodeUsage = false): void {
b362a929 1255 this.startingMinimumNumberOfWorkers = true
60dc0a9c
JB
1256 while (
1257 this.workerNodes.reduce(
1258 (accumulator, workerNode) =>
1259 !workerNode.info.dynamic ? accumulator + 1 : accumulator,
1260 0
1261 ) < this.minimumNumberOfWorkers
1262 ) {
e0843544
JB
1263 const workerNodeKey = this.createAndSetupWorkerNode()
1264 initWorkerNodeUsage &&
1265 this.initWorkerNodeUsage(this.workerNodes[workerNodeKey])
60dc0a9c 1266 }
b362a929 1267 this.startingMinimumNumberOfWorkers = false
60dc0a9c
JB
1268 }
1269
47352846
JB
1270 /** @inheritdoc */
1271 public start (): void {
711623b8
JB
1272 if (this.started) {
1273 throw new Error('Cannot start an already started pool')
1274 }
1275 if (this.starting) {
1276 throw new Error('Cannot start an already starting pool')
1277 }
1278 if (this.destroying) {
1279 throw new Error('Cannot start a destroying pool')
1280 }
47352846 1281 this.starting = true
60dc0a9c 1282 this.startMinimumNumberOfWorkers()
2008bccd 1283 this.startTimestamp = performance.now()
47352846
JB
1284 this.starting = false
1285 this.started = true
1286 }
1287
afc003b2 1288 /** @inheritDoc */
c97c7edb 1289 public async destroy (): Promise<void> {
711623b8
JB
1290 if (!this.started) {
1291 throw new Error('Cannot destroy an already destroyed pool')
1292 }
1293 if (this.starting) {
1294 throw new Error('Cannot destroy an starting pool')
1295 }
1296 if (this.destroying) {
1297 throw new Error('Cannot destroy an already destroying pool')
1298 }
1299 this.destroying = true
1fbcaa7c 1300 await Promise.all(
533a8e22 1301 this.workerNodes.map(async (_, workerNodeKey) => {
aa9eede8 1302 await this.destroyWorkerNode(workerNodeKey)
1fbcaa7c
JB
1303 })
1304 )
33e6bb4c 1305 this.emitter?.emit(PoolEvents.destroy, this.info)
f80125ca 1306 this.emitter?.emitDestroy()
55082af9 1307 this.readyEventEmitted = false
2008bccd 1308 delete this.startTimestamp
711623b8 1309 this.destroying = false
15b176e0 1310 this.started = false
c97c7edb
S
1311 }
1312
26ce26ca 1313 private async sendKillMessageToWorker (workerNodeKey: number): Promise<void> {
9edb9717 1314 await new Promise<void>((resolve, reject) => {
6e5d7052 1315 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
c63a35a0 1316 if (this.workerNodes[workerNodeKey] == null) {
ad3836ed 1317 resolve()
85b2561d
JB
1318 return
1319 }
ae036c3e
JB
1320 const killMessageListener = (message: MessageValue<Response>): void => {
1321 this.checkMessageWorkerId(message)
1e3214b6
JB
1322 if (message.kill === 'success') {
1323 resolve()
1324 } else if (message.kill === 'failure') {
72ae84a2
JB
1325 reject(
1326 new Error(
6e5d7052
JB
1327 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
1328 `Kill message handling failed on worker ${message.workerId?.toString()}`
72ae84a2
JB
1329 )
1330 )
1e3214b6 1331 }
ae036c3e 1332 }
51d9cfbd 1333 // FIXME: should be registered only once
ae036c3e 1334 this.registerWorkerMessageListener(workerNodeKey, killMessageListener)
72ae84a2 1335 this.sendToWorker(workerNodeKey, { kill: true })
1e3214b6 1336 })
1e3214b6
JB
1337 }
1338
4a6952ff 1339 /**
aa9eede8 1340 * Terminates the worker node given its worker node key.
aa9eede8 1341 * @param workerNodeKey - The worker node key.
4a6952ff 1342 */
07e0c9e5
JB
1343 protected async destroyWorkerNode (workerNodeKey: number): Promise<void> {
1344 this.flagWorkerNodeAsNotReady(workerNodeKey)
87347ea8 1345 const flushedTasks = this.flushTasksQueue(workerNodeKey)
07e0c9e5 1346 const workerNode = this.workerNodes[workerNodeKey]
32b141fd
JB
1347 await waitWorkerNodeEvents(
1348 workerNode,
1349 'taskFinished',
1350 flushedTasks,
1351 this.opts.tasksQueueOptions?.tasksFinishedTimeout ??
26ce26ca
JB
1352 getDefaultTasksQueueOptions(
1353 this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers
1354 ).tasksFinishedTimeout
32b141fd 1355 )
07e0c9e5
JB
1356 await this.sendKillMessageToWorker(workerNodeKey)
1357 await workerNode.terminate()
1358 }
c97c7edb 1359
729c563d 1360 /**
6677a3d3
JB
1361 * Setup hook to execute code before worker nodes are created in the abstract constructor.
1362 * Can be overridden.
729c563d 1363 */
280c2a77 1364 protected setupHook (): void {
965df41c 1365 /* Intentionally empty */
280c2a77 1366 }
c97c7edb 1367
729c563d 1368 /**
5bec72fd 1369 * Returns whether the worker is the main worker or not.
5bec72fd 1370 * @returns `true` if the worker is the main worker, `false` otherwise.
280c2a77
S
1371 */
1372 protected abstract isMain (): boolean
1373
1374 /**
2e81254d 1375 * Hook executed before the worker task execution.
bf9549ae 1376 * Can be overridden.
f06e48d8 1377 * @param workerNodeKey - The worker node key.
1c6fe997 1378 * @param task - The task to execute.
729c563d 1379 */
1c6fe997
JB
1380 protected beforeTaskExecutionHook (
1381 workerNodeKey: number,
1382 task: Task<Data>
1383 ): void {
6e5d7052 1384 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
efabc98d 1385 if (this.workerNodes[workerNodeKey]?.usage != null) {
94407def
JB
1386 const workerUsage = this.workerNodes[workerNodeKey].usage
1387 ++workerUsage.tasks.executing
c329fd41 1388 updateWaitTimeWorkerUsage(
bcfb06ce 1389 this.workerChoiceStrategiesContext,
c329fd41
JB
1390 workerUsage,
1391 task
1392 )
94407def
JB
1393 }
1394 if (
1395 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
67f3f2d6
JB
1396 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1397 this.workerNodes[workerNodeKey].getTaskFunctionWorkerUsage(task.name!) !=
1398 null
94407def 1399 ) {
67f3f2d6 1400 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
db0e38ee 1401 const taskFunctionWorkerUsage = this.workerNodes[
b558f6b5 1402 workerNodeKey
67f3f2d6
JB
1403 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1404 ].getTaskFunctionWorkerUsage(task.name!)!
5623b8d5 1405 ++taskFunctionWorkerUsage.tasks.executing
c329fd41 1406 updateWaitTimeWorkerUsage(
bcfb06ce 1407 this.workerChoiceStrategiesContext,
c329fd41
JB
1408 taskFunctionWorkerUsage,
1409 task
1410 )
b558f6b5 1411 }
c97c7edb
S
1412 }
1413
c01733f1 1414 /**
2e81254d 1415 * Hook executed after the worker task execution.
bf9549ae 1416 * Can be overridden.
501aea93 1417 * @param workerNodeKey - The worker node key.
38e795c1 1418 * @param message - The received message.
c01733f1 1419 */
2e81254d 1420 protected afterTaskExecutionHook (
501aea93 1421 workerNodeKey: number,
2740a743 1422 message: MessageValue<Response>
bf9549ae 1423 ): void {
9a55fa8c 1424 let needWorkerChoiceStrategiesUpdate = false
6e5d7052 1425 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
efabc98d 1426 if (this.workerNodes[workerNodeKey]?.usage != null) {
94407def 1427 const workerUsage = this.workerNodes[workerNodeKey].usage
c329fd41
JB
1428 updateTaskStatisticsWorkerUsage(workerUsage, message)
1429 updateRunTimeWorkerUsage(
bcfb06ce 1430 this.workerChoiceStrategiesContext,
c329fd41
JB
1431 workerUsage,
1432 message
1433 )
1434 updateEluWorkerUsage(
bcfb06ce 1435 this.workerChoiceStrategiesContext,
c329fd41
JB
1436 workerUsage,
1437 message
1438 )
9a55fa8c 1439 needWorkerChoiceStrategiesUpdate = true
94407def
JB
1440 }
1441 if (
1442 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
1443 this.workerNodes[workerNodeKey].getTaskFunctionWorkerUsage(
67f3f2d6
JB
1444 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1445 message.taskPerformance!.name
94407def
JB
1446 ) != null
1447 ) {
67f3f2d6 1448 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
db0e38ee 1449 const taskFunctionWorkerUsage = this.workerNodes[
b558f6b5 1450 workerNodeKey
67f3f2d6
JB
1451 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1452 ].getTaskFunctionWorkerUsage(message.taskPerformance!.name)!
c329fd41
JB
1453 updateTaskStatisticsWorkerUsage(taskFunctionWorkerUsage, message)
1454 updateRunTimeWorkerUsage(
bcfb06ce 1455 this.workerChoiceStrategiesContext,
c329fd41
JB
1456 taskFunctionWorkerUsage,
1457 message
1458 )
1459 updateEluWorkerUsage(
bcfb06ce 1460 this.workerChoiceStrategiesContext,
c329fd41
JB
1461 taskFunctionWorkerUsage,
1462 message
1463 )
9a55fa8c 1464 needWorkerChoiceStrategiesUpdate = true
c329fd41 1465 }
9a55fa8c 1466 if (needWorkerChoiceStrategiesUpdate) {
bcfb06ce 1467 this.workerChoiceStrategiesContext?.update(workerNodeKey)
b558f6b5
JB
1468 }
1469 }
1470
db0e38ee
JB
1471 /**
1472 * Whether the worker node shall update its task function worker usage or not.
db0e38ee
JB
1473 * @param workerNodeKey - The worker node key.
1474 * @returns `true` if the worker node shall update its task function worker usage, `false` otherwise.
1475 */
1476 private shallUpdateTaskFunctionWorkerUsage (workerNodeKey: number): boolean {
a5d15204 1477 const workerInfo = this.getWorkerInfo(workerNodeKey)
b558f6b5 1478 return (
1851fed0 1479 workerInfo != null &&
31847469
JB
1480 Array.isArray(workerInfo.taskFunctionsProperties) &&
1481 workerInfo.taskFunctionsProperties.length > 2
b558f6b5 1482 )
f1c06930
JB
1483 }
1484
280c2a77 1485 /**
91041638 1486 * Chooses a worker node for the next task.
91041638 1487 * @param name - The task function name.
db89e3bc 1488 * @returns The chosen worker node key.
280c2a77 1489 */
91041638 1490 private chooseWorkerNode (name?: string): number {
930dcf12 1491 if (this.shallCreateDynamicWorker()) {
aa9eede8 1492 const workerNodeKey = this.createAndSetupDynamicWorkerNode()
6c6afb84 1493 if (
bcfb06ce
JB
1494 this.workerChoiceStrategiesContext?.getPolicy().dynamicWorkerUsage ===
1495 true
6c6afb84 1496 ) {
aa9eede8 1497 return workerNodeKey
6c6afb84 1498 }
17393ac8 1499 }
c63a35a0 1500 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
91041638
JB
1501 return this.workerChoiceStrategiesContext!.execute(
1502 this.getTaskFunctionWorkerChoiceStrategy(name)
1503 )
930dcf12
JB
1504 }
1505
6c6afb84
JB
1506 /**
1507 * Conditions for dynamic worker creation.
6c6afb84
JB
1508 * @returns Whether to create a dynamic worker or not.
1509 */
9d9fb7b6 1510 protected abstract shallCreateDynamicWorker (): boolean
c97c7edb 1511
280c2a77 1512 /**
aa9eede8 1513 * Sends a message to worker given its worker node key.
aa9eede8 1514 * @param workerNodeKey - The worker node key.
38e795c1 1515 * @param message - The message.
7d91a8cd 1516 * @param transferList - The optional array of transferable objects.
280c2a77
S
1517 */
1518 protected abstract sendToWorker (
aa9eede8 1519 workerNodeKey: number,
7d91a8cd 1520 message: MessageValue<Data>,
6a3ecc50 1521 transferList?: readonly TransferListItem[]
280c2a77
S
1522 ): void
1523
e0843544
JB
1524 /**
1525 * Initializes the worker node usage with sensible default values gathered during runtime.
e0843544
JB
1526 * @param workerNode - The worker node.
1527 */
1528 private initWorkerNodeUsage (workerNode: IWorkerNode<Worker, Data>): void {
1529 if (
1530 this.workerChoiceStrategiesContext?.getTaskStatisticsRequirements()
1531 .runTime.aggregate === true
1532 ) {
1533 workerNode.usage.runTime.aggregate = min(
1534 ...this.workerNodes.map(
80115618
JB
1535 workerNode =>
1536 workerNode.usage.runTime.aggregate ?? Number.POSITIVE_INFINITY
e0843544
JB
1537 )
1538 )
1539 }
1540 if (
1541 this.workerChoiceStrategiesContext?.getTaskStatisticsRequirements()
1542 .waitTime.aggregate === true
1543 ) {
1544 workerNode.usage.waitTime.aggregate = min(
1545 ...this.workerNodes.map(
80115618
JB
1546 workerNode =>
1547 workerNode.usage.waitTime.aggregate ?? Number.POSITIVE_INFINITY
e0843544
JB
1548 )
1549 )
1550 }
1551 if (
1552 this.workerChoiceStrategiesContext?.getTaskStatisticsRequirements().elu
1553 .aggregate === true
1554 ) {
1555 workerNode.usage.elu.active.aggregate = min(
1556 ...this.workerNodes.map(
80115618
JB
1557 workerNode =>
1558 workerNode.usage.elu.active.aggregate ?? Number.POSITIVE_INFINITY
e0843544
JB
1559 )
1560 )
1561 }
1562 }
1563
4a6952ff 1564 /**
aa9eede8 1565 * Creates a new, completely set up worker node.
aa9eede8 1566 * @returns New, completely set up worker node key.
4a6952ff 1567 */
aa9eede8 1568 protected createAndSetupWorkerNode (): number {
c3719753
JB
1569 const workerNode = this.createWorkerNode()
1570 workerNode.registerWorkerEventHandler(
1571 'online',
1572 this.opts.onlineHandler ?? EMPTY_FUNCTION
1573 )
1574 workerNode.registerWorkerEventHandler(
1575 'message',
1576 this.opts.messageHandler ?? EMPTY_FUNCTION
1577 )
1578 workerNode.registerWorkerEventHandler(
1579 'error',
1580 this.opts.errorHandler ?? EMPTY_FUNCTION
1581 )
b271fce0 1582 workerNode.registerOnceWorkerEventHandler('error', (error: Error) => {
07e0c9e5 1583 workerNode.info.ready = false
2a69b8c5 1584 this.emitter?.emit(PoolEvents.error, error)
15b176e0 1585 if (
b6bfca01 1586 this.started &&
711623b8 1587 !this.destroying &&
9b38ab2d 1588 this.opts.restartWorkerOnError === true
15b176e0 1589 ) {
07e0c9e5 1590 if (workerNode.info.dynamic) {
aa9eede8 1591 this.createAndSetupDynamicWorkerNode()
b362a929 1592 } else if (!this.startingMinimumNumberOfWorkers) {
e0843544 1593 this.startMinimumNumberOfWorkers(true)
8a1260a3 1594 }
5baee0d7 1595 }
3c9123c7
JB
1596 if (
1597 this.started &&
1598 !this.destroying &&
1599 this.opts.enableTasksQueue === true
1600 ) {
9974369e 1601 this.redistributeQueuedTasks(this.workerNodes.indexOf(workerNode))
19dbc45b 1602 }
6e5d7052 1603 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
07f6f7b1 1604 workerNode?.terminate().catch((error: unknown) => {
07e0c9e5
JB
1605 this.emitter?.emit(PoolEvents.error, error)
1606 })
5baee0d7 1607 })
c3719753
JB
1608 workerNode.registerWorkerEventHandler(
1609 'exit',
1610 this.opts.exitHandler ?? EMPTY_FUNCTION
1611 )
1612 workerNode.registerOnceWorkerEventHandler('exit', () => {
9974369e 1613 this.removeWorkerNode(workerNode)
b362a929
JB
1614 if (
1615 this.started &&
1616 !this.startingMinimumNumberOfWorkers &&
1617 !this.destroying
1618 ) {
e0843544 1619 this.startMinimumNumberOfWorkers(true)
60dc0a9c 1620 }
a974afa6 1621 })
c3719753 1622 const workerNodeKey = this.addWorkerNode(workerNode)
aa9eede8 1623 this.afterWorkerNodeSetup(workerNodeKey)
aa9eede8 1624 return workerNodeKey
c97c7edb 1625 }
be0676b3 1626
930dcf12 1627 /**
aa9eede8 1628 * Creates a new, completely set up dynamic worker node.
aa9eede8 1629 * @returns New, completely set up dynamic worker node key.
930dcf12 1630 */
aa9eede8
JB
1631 protected createAndSetupDynamicWorkerNode (): number {
1632 const workerNodeKey = this.createAndSetupWorkerNode()
041dc05b 1633 this.registerWorkerMessageListener(workerNodeKey, message => {
4d159167 1634 this.checkMessageWorkerId(message)
aa9eede8
JB
1635 const localWorkerNodeKey = this.getWorkerNodeKeyByWorkerId(
1636 message.workerId
aad6fb64 1637 )
152e87a8 1638 const workerInfo = this.getWorkerInfo(localWorkerNodeKey)
2b6b412f 1639 const workerUsage = this.workerNodes[localWorkerNodeKey]?.usage
81c02522 1640 // Kill message received from worker
930dcf12
JB
1641 if (
1642 isKillBehavior(KillBehaviors.HARD, message.kill) ||
1e3214b6 1643 (isKillBehavior(KillBehaviors.SOFT, message.kill) &&
7b56f532 1644 ((this.opts.enableTasksQueue === false &&
aa9eede8 1645 workerUsage.tasks.executing === 0) ||
7b56f532 1646 (this.opts.enableTasksQueue === true &&
152e87a8
JB
1647 workerInfo != null &&
1648 !workerInfo.stealing &&
aa9eede8
JB
1649 workerUsage.tasks.executing === 0 &&
1650 this.tasksQueueSize(localWorkerNodeKey) === 0)))
930dcf12 1651 ) {
f3827d5d 1652 // Flag the worker node as not ready immediately
ae3ab61d 1653 this.flagWorkerNodeAsNotReady(localWorkerNodeKey)
07f6f7b1 1654 this.destroyWorkerNode(localWorkerNodeKey).catch((error: unknown) => {
5270d253
JB
1655 this.emitter?.emit(PoolEvents.error, error)
1656 })
930dcf12
JB
1657 }
1658 })
aa9eede8 1659 this.sendToWorker(workerNodeKey, {
3a502712 1660 checkActive: true,
21f710aa 1661 })
72ae84a2 1662 if (this.taskFunctions.size > 0) {
31847469 1663 for (const [taskFunctionName, taskFunctionObject] of this.taskFunctions) {
72ae84a2
JB
1664 this.sendTaskFunctionOperationToWorker(workerNodeKey, {
1665 taskFunctionOperation: 'add',
31847469
JB
1666 taskFunctionProperties: buildTaskFunctionProperties(
1667 taskFunctionName,
1668 taskFunctionObject
1669 ),
3a502712 1670 taskFunction: taskFunctionObject.taskFunction.toString(),
07f6f7b1 1671 }).catch((error: unknown) => {
72ae84a2
JB
1672 this.emitter?.emit(PoolEvents.error, error)
1673 })
1674 }
1675 }
e44639e9
JB
1676 const workerNode = this.workerNodes[workerNodeKey]
1677 workerNode.info.dynamic = true
b1aae695 1678 if (
bcfb06ce
JB
1679 this.workerChoiceStrategiesContext?.getPolicy().dynamicWorkerReady ===
1680 true ||
1681 this.workerChoiceStrategiesContext?.getPolicy().dynamicWorkerUsage ===
1682 true
b1aae695 1683 ) {
e44639e9 1684 workerNode.info.ready = true
b5e113f6 1685 }
e0843544 1686 this.initWorkerNodeUsage(workerNode)
33e6bb4c 1687 this.checkAndEmitDynamicWorkerCreationEvents()
aa9eede8 1688 return workerNodeKey
930dcf12
JB
1689 }
1690
a2ed5053 1691 /**
aa9eede8 1692 * Registers a listener callback on the worker given its worker node key.
aa9eede8 1693 * @param workerNodeKey - The worker node key.
a2ed5053
JB
1694 * @param listener - The message listener callback.
1695 */
85aeb3f3
JB
1696 protected abstract registerWorkerMessageListener<
1697 Message extends Data | Response
aa9eede8
JB
1698 >(
1699 workerNodeKey: number,
1700 listener: (message: MessageValue<Message>) => void
1701 ): void
a2ed5053 1702
ae036c3e
JB
1703 /**
1704 * Registers once a listener callback on the worker given its worker node key.
ae036c3e
JB
1705 * @param workerNodeKey - The worker node key.
1706 * @param listener - The message listener callback.
1707 */
1708 protected abstract registerOnceWorkerMessageListener<
1709 Message extends Data | Response
1710 >(
1711 workerNodeKey: number,
1712 listener: (message: MessageValue<Message>) => void
1713 ): void
1714
1715 /**
1716 * Deregisters a listener callback on the worker given its worker node key.
ae036c3e
JB
1717 * @param workerNodeKey - The worker node key.
1718 * @param listener - The message listener callback.
1719 */
1720 protected abstract deregisterWorkerMessageListener<
1721 Message extends Data | Response
1722 >(
1723 workerNodeKey: number,
1724 listener: (message: MessageValue<Message>) => void
1725 ): void
1726
a2ed5053 1727 /**
aa9eede8 1728 * Method hooked up after a worker node has been newly created.
a2ed5053 1729 * Can be overridden.
aa9eede8 1730 * @param workerNodeKey - The newly created worker node key.
a2ed5053 1731 */
aa9eede8 1732 protected afterWorkerNodeSetup (workerNodeKey: number): void {
a2ed5053 1733 // Listen to worker messages.
fcd39179
JB
1734 this.registerWorkerMessageListener(
1735 workerNodeKey,
3a776b6d 1736 this.workerMessageListener
fcd39179 1737 )
85aeb3f3 1738 // Send the startup message to worker.
aa9eede8 1739 this.sendStartupMessageToWorker(workerNodeKey)
9edb9717
JB
1740 // Send the statistics message to worker.
1741 this.sendStatisticsMessageToWorker(workerNodeKey)
72695f86 1742 if (this.opts.enableTasksQueue === true) {
dbd73092 1743 if (this.opts.tasksQueueOptions?.taskStealing === true) {
e1c2dba7 1744 this.workerNodes[workerNodeKey].on(
e44639e9
JB
1745 'idle',
1746 this.handleWorkerNodeIdleEvent
9f95d5eb 1747 )
47352846
JB
1748 }
1749 if (this.opts.tasksQueueOptions?.tasksStealingOnBackPressure === true) {
e1c2dba7 1750 this.workerNodes[workerNodeKey].on(
b5e75be8 1751 'backPressure',
e44639e9 1752 this.handleWorkerNodeBackPressureEvent
9f95d5eb 1753 )
47352846 1754 }
72695f86 1755 }
d2c73f82
JB
1756 }
1757
85aeb3f3 1758 /**
aa9eede8 1759 * Sends the startup message to worker given its worker node key.
aa9eede8
JB
1760 * @param workerNodeKey - The worker node key.
1761 */
1762 protected abstract sendStartupMessageToWorker (workerNodeKey: number): void
1763
1764 /**
9edb9717 1765 * Sends the statistics message to worker given its worker node key.
aa9eede8 1766 * @param workerNodeKey - The worker node key.
85aeb3f3 1767 */
9edb9717 1768 private sendStatisticsMessageToWorker (workerNodeKey: number): void {
aa9eede8
JB
1769 this.sendToWorker(workerNodeKey, {
1770 statistics: {
1771 runTime:
bcfb06ce 1772 this.workerChoiceStrategiesContext?.getTaskStatisticsRequirements()
f4d0a470 1773 .runTime.aggregate ?? false,
c63a35a0 1774 elu:
bcfb06ce 1775 this.workerChoiceStrategiesContext?.getTaskStatisticsRequirements()
3a502712
JB
1776 .elu.aggregate ?? false,
1777 },
aa9eede8
JB
1778 })
1779 }
a2ed5053 1780
5eb72b9e
JB
1781 private cannotStealTask (): boolean {
1782 return this.workerNodes.length <= 1 || this.info.queuedTasks === 0
1783 }
1784
42c677c1
JB
1785 private handleTask (workerNodeKey: number, task: Task<Data>): void {
1786 if (this.shallExecuteTask(workerNodeKey)) {
1787 this.executeTask(workerNodeKey, task)
1788 } else {
1789 this.enqueueTask(workerNodeKey, task)
1790 }
1791 }
1792
2d1d3b2d
JB
1793 private redistributeQueuedTasks (sourceWorkerNodeKey: number): void {
1794 if (sourceWorkerNodeKey === -1 || this.cannotStealTask()) {
cb71d660
JB
1795 return
1796 }
2d1d3b2d 1797 while (this.tasksQueueSize(sourceWorkerNodeKey) > 0) {
f201a0cd
JB
1798 const destinationWorkerNodeKey = this.workerNodes.reduce(
1799 (minWorkerNodeKey, workerNode, workerNodeKey, workerNodes) => {
2d1d3b2d
JB
1800 return sourceWorkerNodeKey !== workerNodeKey &&
1801 workerNode.info.ready &&
852ed3e4
JB
1802 workerNode.usage.tasks.queued <
1803 workerNodes[minWorkerNodeKey].usage.tasks.queued
f201a0cd
JB
1804 ? workerNodeKey
1805 : minWorkerNodeKey
1806 },
1807 0
1808 )
42c677c1
JB
1809 this.handleTask(
1810 destinationWorkerNodeKey,
67f3f2d6 1811 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2d1d3b2d 1812 this.dequeueTask(sourceWorkerNodeKey)!
42c677c1 1813 )
dd951876
JB
1814 }
1815 }
1816
b1838604
JB
1817 private updateTaskStolenStatisticsWorkerUsage (
1818 workerNodeKey: number,
b1838604
JB
1819 taskName: string
1820 ): void {
1a880eca 1821 const workerNode = this.workerNodes[workerNodeKey]
6e5d7052 1822 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
efabc98d 1823 if (workerNode?.usage != null) {
b1838604
JB
1824 ++workerNode.usage.tasks.stolen
1825 }
1826 if (
1827 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
1828 workerNode.getTaskFunctionWorkerUsage(taskName) != null
1829 ) {
8bd0556f
JB
1830 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1831 ++workerNode.getTaskFunctionWorkerUsage(taskName)!.tasks.stolen
b1838604
JB
1832 }
1833 }
1834
463226a4 1835 private updateTaskSequentiallyStolenStatisticsWorkerUsage (
2d1d3b2d
JB
1836 workerNodeKey: number,
1837 taskName: string,
8bd0556f 1838 previousTaskName?: string
463226a4
JB
1839 ): void {
1840 const workerNode = this.workerNodes[workerNodeKey]
6e5d7052 1841 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
7aa2f476 1842 if (workerNode?.usage != null) {
463226a4
JB
1843 ++workerNode.usage.tasks.sequentiallyStolen
1844 }
1845 if (
1846 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
3b33cd2a
JB
1847 workerNode.getTaskFunctionWorkerUsage(taskName) != null
1848 ) {
1849 const taskFunctionWorkerUsage =
1850 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1851 workerNode.getTaskFunctionWorkerUsage(taskName)!
1852 if (
1853 taskFunctionWorkerUsage.tasks.sequentiallyStolen === 0 ||
8bd0556f
JB
1854 (previousTaskName != null &&
1855 previousTaskName === taskName &&
3b33cd2a
JB
1856 taskFunctionWorkerUsage.tasks.sequentiallyStolen > 0)
1857 ) {
1858 ++taskFunctionWorkerUsage.tasks.sequentiallyStolen
1859 } else if (taskFunctionWorkerUsage.tasks.sequentiallyStolen > 0) {
1860 taskFunctionWorkerUsage.tasks.sequentiallyStolen = 0
1861 }
463226a4
JB
1862 }
1863 }
1864
1865 private resetTaskSequentiallyStolenStatisticsWorkerUsage (
2d1d3b2d
JB
1866 workerNodeKey: number,
1867 taskName: string
463226a4
JB
1868 ): void {
1869 const workerNode = this.workerNodes[workerNodeKey]
6e5d7052 1870 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
efabc98d 1871 if (workerNode?.usage != null) {
463226a4
JB
1872 workerNode.usage.tasks.sequentiallyStolen = 0
1873 }
1874 if (
1875 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
1876 workerNode.getTaskFunctionWorkerUsage(taskName) != null
1877 ) {
8bd0556f
JB
1878 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1879 workerNode.getTaskFunctionWorkerUsage(
1880 taskName
1881 )!.tasks.sequentiallyStolen = 0
463226a4
JB
1882 }
1883 }
1884
e44639e9 1885 private readonly handleWorkerNodeIdleEvent = (
e1c2dba7 1886 eventDetail: WorkerNodeEventDetail,
463226a4 1887 previousStolenTask?: Task<Data>
9f95d5eb 1888 ): void => {
e1c2dba7 1889 const { workerNodeKey } = eventDetail
463226a4
JB
1890 if (workerNodeKey == null) {
1891 throw new Error(
c63a35a0 1892 "WorkerNode event detail 'workerNodeKey' property must be defined"
463226a4
JB
1893 )
1894 }
c63a35a0 1895 const workerInfo = this.getWorkerInfo(workerNodeKey)
010f158c
JB
1896 if (workerInfo == null) {
1897 throw new Error(
6e5d7052 1898 `Worker node with key '${workerNodeKey.toString()}' not found in pool`
010f158c
JB
1899 )
1900 }
5eb72b9e
JB
1901 if (
1902 this.cannotStealTask() ||
c63a35a0
JB
1903 (this.info.stealingWorkerNodes ?? 0) >
1904 Math.floor(this.workerNodes.length / 2)
5eb72b9e 1905 ) {
010f158c 1906 if (previousStolenTask != null) {
c63a35a0 1907 workerInfo.stealing = false
2d1d3b2d
JB
1908 this.resetTaskSequentiallyStolenStatisticsWorkerUsage(
1909 workerNodeKey,
1910 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1911 previousStolenTask.name!
1912 )
5eb72b9e
JB
1913 }
1914 return
1915 }
463226a4
JB
1916 const workerNodeTasksUsage = this.workerNodes[workerNodeKey].usage.tasks
1917 if (
1918 previousStolenTask != null &&
463226a4
JB
1919 (workerNodeTasksUsage.executing > 0 ||
1920 this.tasksQueueSize(workerNodeKey) > 0)
1921 ) {
c63a35a0 1922 workerInfo.stealing = false
2d1d3b2d
JB
1923 this.resetTaskSequentiallyStolenStatisticsWorkerUsage(
1924 workerNodeKey,
1925 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1926 previousStolenTask.name!
1927 )
463226a4
JB
1928 return
1929 }
c63a35a0 1930 workerInfo.stealing = true
463226a4 1931 const stolenTask = this.workerNodeStealTask(workerNodeKey)
8bd0556f 1932 if (stolenTask != null) {
2d1d3b2d
JB
1933 this.updateTaskSequentiallyStolenStatisticsWorkerUsage(
1934 workerNodeKey,
67f3f2d6 1935 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2d1d3b2d 1936 stolenTask.name!,
8bd0556f 1937 previousStolenTask?.name
2d1d3b2d 1938 )
f1f77f45 1939 }
463226a4
JB
1940 sleep(exponentialDelay(workerNodeTasksUsage.sequentiallyStolen))
1941 .then(() => {
e44639e9 1942 this.handleWorkerNodeIdleEvent(eventDetail, stolenTask)
463226a4
JB
1943 return undefined
1944 })
07f6f7b1 1945 .catch((error: unknown) => {
2e8cfbb7
JB
1946 this.emitter?.emit(PoolEvents.error, error)
1947 })
463226a4
JB
1948 }
1949
1950 private readonly workerNodeStealTask = (
1951 workerNodeKey: number
1952 ): Task<Data> | undefined => {
dd951876 1953 const workerNodes = this.workerNodes
a6b3272b 1954 .slice()
dd951876
JB
1955 .sort(
1956 (workerNodeA, workerNodeB) =>
1957 workerNodeB.usage.tasks.queued - workerNodeA.usage.tasks.queued
1958 )
f201a0cd 1959 const sourceWorkerNode = workerNodes.find(
463226a4
JB
1960 (sourceWorkerNode, sourceWorkerNodeKey) =>
1961 sourceWorkerNode.info.ready &&
5eb72b9e 1962 !sourceWorkerNode.info.stealing &&
463226a4
JB
1963 sourceWorkerNodeKey !== workerNodeKey &&
1964 sourceWorkerNode.usage.tasks.queued > 0
f201a0cd
JB
1965 )
1966 if (sourceWorkerNode != null) {
67f3f2d6 1967 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2eee7220 1968 const task = sourceWorkerNode.dequeueLastPrioritizedTask()!
42c677c1 1969 this.handleTask(workerNodeKey, task)
67f3f2d6
JB
1970 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1971 this.updateTaskStolenStatisticsWorkerUsage(workerNodeKey, task.name!)
463226a4 1972 return task
72695f86
JB
1973 }
1974 }
1975
e44639e9 1976 private readonly handleWorkerNodeBackPressureEvent = (
e1c2dba7 1977 eventDetail: WorkerNodeEventDetail
9f95d5eb 1978 ): void => {
5eb72b9e
JB
1979 if (
1980 this.cannotStealTask() ||
2eee7220 1981 this.hasBackPressure() ||
c63a35a0
JB
1982 (this.info.stealingWorkerNodes ?? 0) >
1983 Math.floor(this.workerNodes.length / 2)
5eb72b9e 1984 ) {
cb71d660
JB
1985 return
1986 }
f778c355 1987 const sizeOffset = 1
67f3f2d6
JB
1988 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1989 if (this.opts.tasksQueueOptions!.size! <= sizeOffset) {
68dbcdc0
JB
1990 return
1991 }
7b2c5627 1992 const { workerId } = eventDetail
72695f86 1993 const sourceWorkerNode =
b5e75be8 1994 this.workerNodes[this.getWorkerNodeKeyByWorkerId(workerId)]
72695f86 1995 const workerNodes = this.workerNodes
a6b3272b 1996 .slice()
72695f86
JB
1997 .sort(
1998 (workerNodeA, workerNodeB) =>
1999 workerNodeA.usage.tasks.queued - workerNodeB.usage.tasks.queued
2000 )
2001 for (const [workerNodeKey, workerNode] of workerNodes.entries()) {
2002 if (
0bc68267 2003 sourceWorkerNode.usage.tasks.queued > 0 &&
a6b3272b 2004 workerNode.info.ready &&
5eb72b9e 2005 !workerNode.info.stealing &&
b5e75be8 2006 workerNode.info.id !== workerId &&
0bc68267 2007 workerNode.usage.tasks.queued <
67f3f2d6
JB
2008 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2009 this.opts.tasksQueueOptions!.size! - sizeOffset
72695f86 2010 ) {
c63a35a0 2011 const workerInfo = this.getWorkerInfo(workerNodeKey)
1851fed0
JB
2012 if (workerInfo == null) {
2013 throw new Error(
6e5d7052 2014 `Worker node with key '${workerNodeKey.toString()}' not found in pool`
1851fed0
JB
2015 )
2016 }
c63a35a0 2017 workerInfo.stealing = true
67f3f2d6 2018 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2eee7220 2019 const task = sourceWorkerNode.dequeueLastPrioritizedTask()!
42c677c1 2020 this.handleTask(workerNodeKey, task)
67f3f2d6
JB
2021 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2022 this.updateTaskStolenStatisticsWorkerUsage(workerNodeKey, task.name!)
c63a35a0 2023 workerInfo.stealing = false
10ecf8fd 2024 }
a2ed5053
JB
2025 }
2026 }
2027
fcfc3353
JB
2028 private setTasksQueuePriority (workerNodeKey: number): void {
2029 this.workerNodes[workerNodeKey].setTasksQueuePriority(
2030 this.getTasksQueuePriority()
2031 )
2032 }
2033
be0676b3 2034 /**
fcd39179 2035 * This method is the message listener registered on each worker.
ec8ed549 2036 * @param message - The message received from the worker.
be0676b3 2037 */
3a776b6d
JB
2038 protected readonly workerMessageListener = (
2039 message: MessageValue<Response>
2040 ): void => {
fcd39179 2041 this.checkMessageWorkerId(message)
31847469
JB
2042 const { workerId, ready, taskId, taskFunctionsProperties } = message
2043 if (ready != null && taskFunctionsProperties != null) {
fcd39179
JB
2044 // Worker ready response received from worker
2045 this.handleWorkerReadyResponse(message)
31847469
JB
2046 } else if (taskFunctionsProperties != null) {
2047 // Task function properties message received from worker
9a55fa8c
JB
2048 const workerNodeKey = this.getWorkerNodeKeyByWorkerId(workerId)
2049 const workerInfo = this.getWorkerInfo(workerNodeKey)
1851fed0 2050 if (workerInfo != null) {
31847469 2051 workerInfo.taskFunctionsProperties = taskFunctionsProperties
9a55fa8c 2052 this.sendStatisticsMessageToWorker(workerNodeKey)
fcfc3353 2053 this.setTasksQueuePriority(workerNodeKey)
1851fed0 2054 }
31847469
JB
2055 } else if (taskId != null) {
2056 // Task execution response received from worker
2057 this.handleTaskExecutionResponse(message)
6b272951
JB
2058 }
2059 }
2060
8e8d9101
JB
2061 private checkAndEmitReadyEvent (): void {
2062 if (!this.readyEventEmitted && this.ready) {
2063 this.emitter?.emit(PoolEvents.ready, this.info)
2064 this.readyEventEmitted = true
2065 }
2066 }
2067
10e2aa7e 2068 private handleWorkerReadyResponse (message: MessageValue<Response>): void {
31847469 2069 const { workerId, ready, taskFunctionsProperties } = message
e44639e9 2070 if (ready == null || !ready) {
6e5d7052
JB
2071 // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
2072 throw new Error(`Worker ${workerId?.toString()} failed to initialize`)
f05ed93c 2073 }
9a55fa8c
JB
2074 const workerNodeKey = this.getWorkerNodeKeyByWorkerId(workerId)
2075 const workerNode = this.workerNodes[workerNodeKey]
e44639e9 2076 workerNode.info.ready = ready
31847469 2077 workerNode.info.taskFunctionsProperties = taskFunctionsProperties
9a55fa8c 2078 this.sendStatisticsMessageToWorker(workerNodeKey)
fcfc3353 2079 this.setTasksQueuePriority(workerNodeKey)
8e8d9101 2080 this.checkAndEmitReadyEvent()
6b272951
JB
2081 }
2082
2083 private handleTaskExecutionResponse (message: MessageValue<Response>): void {
463226a4 2084 const { workerId, taskId, workerError, data } = message
67f3f2d6
JB
2085 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2086 const promiseResponse = this.promiseResponseMap.get(taskId!)
6b272951 2087 if (promiseResponse != null) {
f18fd12b 2088 const { resolve, reject, workerNodeKey, asyncResource } = promiseResponse
9b358e72 2089 const workerNode = this.workerNodes[workerNodeKey]
6703b9f4
JB
2090 if (workerError != null) {
2091 this.emitter?.emit(PoolEvents.taskError, workerError)
f18fd12b
JB
2092 asyncResource != null
2093 ? asyncResource.runInAsyncScope(
2094 reject,
2095 this.emitter,
2096 workerError.message
2097 )
2098 : reject(workerError.message)
6b272951 2099 } else {
f18fd12b
JB
2100 asyncResource != null
2101 ? asyncResource.runInAsyncScope(resolve, this.emitter, data)
2102 : resolve(data as Response)
6b272951 2103 }
f18fd12b 2104 asyncResource?.emitDestroy()
501aea93 2105 this.afterTaskExecutionHook(workerNodeKey, message)
67f3f2d6
JB
2106 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2107 this.promiseResponseMap.delete(taskId!)
6e5d7052 2108 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
cdaecaee 2109 workerNode?.emit('taskFinished', taskId)
16d7e943
JB
2110 if (
2111 this.opts.enableTasksQueue === true &&
2112 !this.destroying &&
6e5d7052 2113 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
16d7e943
JB
2114 workerNode != null
2115 ) {
9b358e72 2116 const workerNodeTasksUsage = workerNode.usage.tasks
463226a4
JB
2117 if (
2118 this.tasksQueueSize(workerNodeKey) > 0 &&
2119 workerNodeTasksUsage.executing <
67f3f2d6
JB
2120 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2121 this.opts.tasksQueueOptions!.concurrency!
463226a4 2122 ) {
67f3f2d6
JB
2123 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2124 this.executeTask(workerNodeKey, this.dequeueTask(workerNodeKey)!)
463226a4
JB
2125 }
2126 if (
2127 workerNodeTasksUsage.executing === 0 &&
2128 this.tasksQueueSize(workerNodeKey) === 0 &&
2129 workerNodeTasksUsage.sequentiallyStolen === 0
2130 ) {
e44639e9 2131 workerNode.emit('idle', {
7f0e1334 2132 workerId,
3a502712 2133 workerNodeKey,
e1c2dba7 2134 })
463226a4 2135 }
be0676b3
APA
2136 }
2137 }
be0676b3 2138 }
7c0ba920 2139
a1763c54 2140 private checkAndEmitTaskExecutionEvents (): void {
33e6bb4c
JB
2141 if (this.busy) {
2142 this.emitter?.emit(PoolEvents.busy, this.info)
a1763c54
JB
2143 }
2144 }
2145
2146 private checkAndEmitTaskQueuingEvents (): void {
2147 if (this.hasBackPressure()) {
2148 this.emitter?.emit(PoolEvents.backPressure, this.info)
164d950a
JB
2149 }
2150 }
2151
d0878034
JB
2152 /**
2153 * Emits dynamic worker creation events.
2154 */
2155 protected abstract checkAndEmitDynamicWorkerCreationEvents (): void
33e6bb4c 2156
8a1260a3 2157 /**
aa9eede8 2158 * Gets the worker information given its worker node key.
8a1260a3 2159 * @param workerNodeKey - The worker node key.
3f09ed9f 2160 * @returns The worker information.
8a1260a3 2161 */
1851fed0
JB
2162 protected getWorkerInfo (workerNodeKey: number): WorkerInfo | undefined {
2163 return this.workerNodes[workerNodeKey]?.info
e221309a
JB
2164 }
2165
fcfc3353
JB
2166 private getTasksQueuePriority (): boolean {
2167 return this.listTaskFunctionsProperties().some(
2168 taskFunctionProperties => taskFunctionProperties.priority != null
2169 )
2170 }
2171
a05c10de 2172 /**
c3719753 2173 * Creates a worker node.
c3719753 2174 * @returns The created worker node.
ea7a90d3 2175 */
c3719753 2176 private createWorkerNode (): IWorkerNode<Worker, Data> {
671d5154 2177 const workerNode = new WorkerNode<Worker, Data>(
c3719753
JB
2178 this.worker,
2179 this.filePath,
2180 {
2181 env: this.opts.env,
2182 workerOptions: this.opts.workerOptions,
2183 tasksQueueBackPressureSize:
32b141fd 2184 this.opts.tasksQueueOptions?.size ??
26ce26ca
JB
2185 getDefaultTasksQueueOptions(
2186 this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers
95d1a734 2187 ).size,
fcfc3353 2188 tasksQueueBucketSize: defaultBucketSize,
3a502712 2189 tasksQueuePriority: this.getTasksQueuePriority(),
c3719753 2190 }
671d5154 2191 )
b97d82d8 2192 // Flag the worker node as ready at pool startup.
d2c73f82
JB
2193 if (this.starting) {
2194 workerNode.info.ready = true
2195 }
c3719753
JB
2196 return workerNode
2197 }
2198
2199 /**
2200 * Adds the given worker node in the pool worker nodes.
c3719753
JB
2201 * @param workerNode - The worker node.
2202 * @returns The added worker node key.
2203 * @throws {@link https://nodejs.org/api/errors.html#class-error} If the added worker node is not found.
2204 */
2205 private addWorkerNode (workerNode: IWorkerNode<Worker, Data>): number {
aa9eede8 2206 this.workerNodes.push(workerNode)
c3719753 2207 const workerNodeKey = this.workerNodes.indexOf(workerNode)
aa9eede8 2208 if (workerNodeKey === -1) {
86ed0598 2209 throw new Error('Worker added not found in worker nodes')
aa9eede8
JB
2210 }
2211 return workerNodeKey
ea7a90d3 2212 }
c923ce56 2213
8e8d9101
JB
2214 private checkAndEmitEmptyEvent (): void {
2215 if (this.empty) {
2216 this.emitter?.emit(PoolEvents.empty, this.info)
2217 this.readyEventEmitted = false
2218 }
2219 }
2220
51fe3d3c 2221 /**
9974369e 2222 * Removes the worker node from the pool worker nodes.
9974369e 2223 * @param workerNode - The worker node.
51fe3d3c 2224 */
9974369e
JB
2225 private removeWorkerNode (workerNode: IWorkerNode<Worker, Data>): void {
2226 const workerNodeKey = this.workerNodes.indexOf(workerNode)
1f68cede
JB
2227 if (workerNodeKey !== -1) {
2228 this.workerNodes.splice(workerNodeKey, 1)
bcfb06ce 2229 this.workerChoiceStrategiesContext?.remove(workerNodeKey)
1f68cede 2230 }
8e8d9101 2231 this.checkAndEmitEmptyEvent()
51fe3d3c 2232 }
adc3c320 2233
ae3ab61d 2234 protected flagWorkerNodeAsNotReady (workerNodeKey: number): void {
1851fed0
JB
2235 const workerInfo = this.getWorkerInfo(workerNodeKey)
2236 if (workerInfo != null) {
2237 workerInfo.ready = false
2238 }
ae3ab61d
JB
2239 }
2240
9e844245
JB
2241 private hasBackPressure (): boolean {
2242 return (
2243 this.opts.enableTasksQueue === true &&
2244 this.workerNodes.findIndex(
041dc05b 2245 workerNode => !workerNode.hasBackPressure()
a1763c54 2246 ) === -1
9e844245 2247 )
e2b31e32
JB
2248 }
2249
b0a4db63 2250 /**
aa9eede8 2251 * Executes the given task on the worker given its worker node key.
aa9eede8 2252 * @param workerNodeKey - The worker node key.
b0a4db63
JB
2253 * @param task - The task to execute.
2254 */
2e81254d 2255 private executeTask (workerNodeKey: number, task: Task<Data>): void {
1c6fe997 2256 this.beforeTaskExecutionHook(workerNodeKey, task)
bbfa38a2 2257 this.sendToWorker(workerNodeKey, task, task.transferList)
a1763c54 2258 this.checkAndEmitTaskExecutionEvents()
2e81254d
JB
2259 }
2260
f9f00b5f 2261 private enqueueTask (workerNodeKey: number, task: Task<Data>): number {
a1763c54
JB
2262 const tasksQueueSize = this.workerNodes[workerNodeKey].enqueueTask(task)
2263 this.checkAndEmitTaskQueuingEvents()
2264 return tasksQueueSize
adc3c320
JB
2265 }
2266
0d4e88b3
JB
2267 private dequeueTask (workerNodeKey: number): Task<Data> | undefined {
2268 return this.workerNodes[workerNodeKey].dequeueTask()
adc3c320
JB
2269 }
2270
416fd65c 2271 private tasksQueueSize (workerNodeKey: number): number {
4b628b48 2272 return this.workerNodes[workerNodeKey].tasksQueueSize()
df593701
JB
2273 }
2274
87347ea8
JB
2275 protected flushTasksQueue (workerNodeKey: number): number {
2276 let flushedTasks = 0
920278a2 2277 while (this.tasksQueueSize(workerNodeKey) > 0) {
67f3f2d6
JB
2278 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
2279 this.executeTask(workerNodeKey, this.dequeueTask(workerNodeKey)!)
87347ea8 2280 ++flushedTasks
ff733df7 2281 }
4b628b48 2282 this.workerNodes[workerNodeKey].clearTasksQueue()
87347ea8 2283 return flushedTasks
ff733df7
JB
2284 }
2285
ef41a6e6 2286 private flushTasksQueues (): void {
19b8be8b 2287 for (const workerNodeKey of this.workerNodes.keys()) {
ef41a6e6
JB
2288 this.flushTasksQueue(workerNodeKey)
2289 }
2290 }
c97c7edb 2291}