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