1 import { randomUUID
} from
'node:crypto'
2 import { performance
} from
'node:perf_hooks'
3 import type { TransferListItem
} from
'node:worker_threads'
4 import { EventEmitterAsyncResource
} from
'node:events'
7 PromiseResponseWrapper
,
9 } from
'../utility-types'
12 DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
,
22 import { KillBehaviors
} from
'../worker/worker-options'
23 import type { TaskFunction
} from
'../worker/task-functions'
31 type TasksQueueOptions
37 WorkerNodeEventDetail
,
42 type MeasurementStatisticsRequirements
,
44 WorkerChoiceStrategies
,
45 type WorkerChoiceStrategy
,
46 type WorkerChoiceStrategyOptions
47 } from
'./selection-strategies/selection-strategies-types'
48 import { WorkerChoiceStrategyContext
} from
'./selection-strategies/worker-choice-strategy-context'
49 import { version
} from
'./version'
50 import { WorkerNode
} from
'./worker-node'
53 checkValidTasksQueueOptions
,
54 checkValidWorkerChoiceStrategy
,
55 updateMeasurementStatistics
59 * Base class that implements some shared logic for all poolifier pools.
61 * @typeParam Worker - Type of worker which manages this pool.
62 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
63 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
65 export abstract class AbstractPool
<
66 Worker
extends IWorker
,
69 > implements IPool
<Worker
, Data
, Response
> {
71 public readonly workerNodes
: Array<IWorkerNode
<Worker
, Data
>> = []
74 public emitter
?: EventEmitterAsyncResource
77 * Dynamic pool maximum size property placeholder.
79 protected readonly max
?: number
82 * The task execution response promise map:
83 * - `key`: The message id of each submitted task.
84 * - `value`: An object that contains the worker, the execution response promise resolve and reject callbacks.
86 * When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
88 protected promiseResponseMap
: Map
<string, PromiseResponseWrapper
<Response
>> =
89 new Map
<string, PromiseResponseWrapper
<Response
>>()
92 * Worker choice strategy context referencing a worker choice algorithm implementation.
94 protected workerChoiceStrategyContext
: WorkerChoiceStrategyContext
<
101 * The task functions added at runtime map:
102 * - `key`: The task function name.
103 * - `value`: The task function itself.
105 private readonly taskFunctions
: Map
<string, TaskFunction
<Data
, Response
>>
108 * Whether the pool is started or not.
110 private started
: boolean
112 * Whether the pool is starting or not.
114 private starting
: boolean
116 * The start timestamp of the pool.
118 private readonly startTimestamp
121 * Constructs a new poolifier pool.
123 * @param numberOfWorkers - Number of workers that this pool should manage.
124 * @param filePath - Path to the worker file.
125 * @param opts - Options for the pool.
128 protected readonly numberOfWorkers
: number,
129 protected readonly filePath
: string,
130 protected readonly opts
: PoolOptions
<Worker
>
132 if (!this.isMain()) {
134 'Cannot start a pool from a worker with the same type as the pool'
137 checkFilePath(this.filePath
)
138 this.checkNumberOfWorkers(this.numberOfWorkers
)
139 this.checkPoolOptions(this.opts
)
141 this.chooseWorkerNode
= this.chooseWorkerNode
.bind(this)
142 this.executeTask
= this.executeTask
.bind(this)
143 this.enqueueTask
= this.enqueueTask
.bind(this)
145 if (this.opts
.enableEvents
=== true) {
146 this.initializeEventEmitter()
148 this.workerChoiceStrategyContext
= new WorkerChoiceStrategyContext
<
154 this.opts
.workerChoiceStrategy
,
155 this.opts
.workerChoiceStrategyOptions
160 this.taskFunctions
= new Map
<string, TaskFunction
<Data
, Response
>>()
163 this.starting
= false
164 if (this.opts
.startWorkers
=== true) {
168 this.startTimestamp
= performance
.now()
171 private checkNumberOfWorkers (numberOfWorkers
: number): void {
172 if (numberOfWorkers
== null) {
174 'Cannot instantiate a pool without specifying the number of workers'
176 } else if (!Number.isSafeInteger(numberOfWorkers
)) {
178 'Cannot instantiate a pool with a non safe integer number of workers'
180 } else if (numberOfWorkers
< 0) {
181 throw new RangeError(
182 'Cannot instantiate a pool with a negative number of workers'
184 } else if (this.type === PoolTypes
.fixed
&& numberOfWorkers
=== 0) {
185 throw new RangeError('Cannot instantiate a fixed pool with zero worker')
189 private checkPoolOptions (opts
: PoolOptions
<Worker
>): void {
190 if (isPlainObject(opts
)) {
191 this.opts
.startWorkers
= opts
.startWorkers
?? true
192 checkValidWorkerChoiceStrategy(
193 opts
.workerChoiceStrategy
as WorkerChoiceStrategy
195 this.opts
.workerChoiceStrategy
=
196 opts
.workerChoiceStrategy
?? WorkerChoiceStrategies
.ROUND_ROBIN
197 this.checkValidWorkerChoiceStrategyOptions(
198 opts
.workerChoiceStrategyOptions
as WorkerChoiceStrategyOptions
200 this.opts
.workerChoiceStrategyOptions
= {
201 ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
,
202 ...opts
.workerChoiceStrategyOptions
204 this.opts
.restartWorkerOnError
= opts
.restartWorkerOnError
?? true
205 this.opts
.enableEvents
= opts
.enableEvents
?? true
206 this.opts
.enableTasksQueue
= opts
.enableTasksQueue
?? false
207 if (this.opts
.enableTasksQueue
) {
208 checkValidTasksQueueOptions(opts
.tasksQueueOptions
as TasksQueueOptions
)
209 this.opts
.tasksQueueOptions
= this.buildTasksQueueOptions(
210 opts
.tasksQueueOptions
as TasksQueueOptions
214 throw new TypeError('Invalid pool options: must be a plain object')
218 private checkValidWorkerChoiceStrategyOptions (
219 workerChoiceStrategyOptions
: WorkerChoiceStrategyOptions
222 workerChoiceStrategyOptions
!= null &&
223 !isPlainObject(workerChoiceStrategyOptions
)
226 'Invalid worker choice strategy options: must be a plain object'
230 workerChoiceStrategyOptions
?.retries
!= null &&
231 !Number.isSafeInteger(workerChoiceStrategyOptions
.retries
)
234 'Invalid worker choice strategy options: retries must be an integer'
238 workerChoiceStrategyOptions
?.retries
!= null &&
239 workerChoiceStrategyOptions
.retries
< 0
241 throw new RangeError(
242 `Invalid worker choice strategy options: retries '${workerChoiceStrategyOptions.retries}' must be greater or equal than zero`
246 workerChoiceStrategyOptions
?.weights
!= null &&
247 Object.keys(workerChoiceStrategyOptions
.weights
).length
!== this.maxSize
250 'Invalid worker choice strategy options: must have a weight for each worker node'
254 workerChoiceStrategyOptions
?.measurement
!= null &&
255 !Object.values(Measurements
).includes(
256 workerChoiceStrategyOptions
.measurement
260 `Invalid worker choice strategy options: invalid measurement '${workerChoiceStrategyOptions.measurement}'`
265 private initializeEventEmitter (): void {
266 this.emitter
= new EventEmitterAsyncResource({
267 name
: `poolifier:${this.type}-${this.worker}-pool`
272 public get
info (): PoolInfo
{
277 started
: this.started
,
279 strategy
: this.opts
.workerChoiceStrategy
as WorkerChoiceStrategy
,
280 minSize
: this.minSize
,
281 maxSize
: this.maxSize
,
282 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
283 .runTime
.aggregate
&&
284 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
285 .waitTime
.aggregate
&& { utilization
: round(this.utilization
) }),
286 workerNodes
: this.workerNodes
.length
,
287 idleWorkerNodes
: this.workerNodes
.reduce(
288 (accumulator
, workerNode
) =>
289 workerNode
.usage
.tasks
.executing
=== 0
294 busyWorkerNodes
: this.workerNodes
.reduce(
295 (accumulator
, workerNode
) =>
296 workerNode
.usage
.tasks
.executing
> 0 ? accumulator
+ 1 : accumulator
,
299 executedTasks
: this.workerNodes
.reduce(
300 (accumulator
, workerNode
) =>
301 accumulator
+ workerNode
.usage
.tasks
.executed
,
304 executingTasks
: this.workerNodes
.reduce(
305 (accumulator
, workerNode
) =>
306 accumulator
+ workerNode
.usage
.tasks
.executing
,
309 ...(this.opts
.enableTasksQueue
=== true && {
310 queuedTasks
: this.workerNodes
.reduce(
311 (accumulator
, workerNode
) =>
312 accumulator
+ workerNode
.usage
.tasks
.queued
,
316 ...(this.opts
.enableTasksQueue
=== true && {
317 maxQueuedTasks
: this.workerNodes
.reduce(
318 (accumulator
, workerNode
) =>
319 accumulator
+ (workerNode
.usage
.tasks
?.maxQueued
?? 0),
323 ...(this.opts
.enableTasksQueue
=== true && {
324 backPressure
: this.hasBackPressure()
326 ...(this.opts
.enableTasksQueue
=== true && {
327 stolenTasks
: this.workerNodes
.reduce(
328 (accumulator
, workerNode
) =>
329 accumulator
+ workerNode
.usage
.tasks
.stolen
,
333 failedTasks
: this.workerNodes
.reduce(
334 (accumulator
, workerNode
) =>
335 accumulator
+ workerNode
.usage
.tasks
.failed
,
338 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
339 .runTime
.aggregate
&& {
343 ...this.workerNodes
.map(
344 workerNode
=> workerNode
.usage
.runTime
?.minimum
?? Infinity
350 ...this.workerNodes
.map(
351 workerNode
=> workerNode
.usage
.runTime
?.maximum
?? -Infinity
355 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
356 .runTime
.average
&& {
359 this.workerNodes
.reduce
<number[]>(
360 (accumulator
, workerNode
) =>
361 accumulator
.concat(workerNode
.usage
.runTime
.history
),
367 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
371 this.workerNodes
.reduce
<number[]>(
372 (accumulator
, workerNode
) =>
373 accumulator
.concat(workerNode
.usage
.runTime
.history
),
381 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
382 .waitTime
.aggregate
&& {
386 ...this.workerNodes
.map(
387 workerNode
=> workerNode
.usage
.waitTime
?.minimum
?? Infinity
393 ...this.workerNodes
.map(
394 workerNode
=> workerNode
.usage
.waitTime
?.maximum
?? -Infinity
398 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
399 .waitTime
.average
&& {
402 this.workerNodes
.reduce
<number[]>(
403 (accumulator
, workerNode
) =>
404 accumulator
.concat(workerNode
.usage
.waitTime
.history
),
410 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
411 .waitTime
.median
&& {
414 this.workerNodes
.reduce
<number[]>(
415 (accumulator
, workerNode
) =>
416 accumulator
.concat(workerNode
.usage
.waitTime
.history
),
428 * The pool readiness boolean status.
430 private get
ready (): boolean {
432 this.workerNodes
.reduce(
433 (accumulator
, workerNode
) =>
434 !workerNode
.info
.dynamic
&& workerNode
.info
.ready
443 * The approximate pool utilization.
445 * @returns The pool utilization.
447 private get
utilization (): number {
448 const poolTimeCapacity
=
449 (performance
.now() - this.startTimestamp
) * this.maxSize
450 const totalTasksRunTime
= this.workerNodes
.reduce(
451 (accumulator
, workerNode
) =>
452 accumulator
+ (workerNode
.usage
.runTime
?.aggregate
?? 0),
455 const totalTasksWaitTime
= this.workerNodes
.reduce(
456 (accumulator
, workerNode
) =>
457 accumulator
+ (workerNode
.usage
.waitTime
?.aggregate
?? 0),
460 return (totalTasksRunTime
+ totalTasksWaitTime
) / poolTimeCapacity
466 * If it is `'dynamic'`, it provides the `max` property.
468 protected abstract get
type (): PoolType
473 protected abstract get
worker (): WorkerType
476 * The pool minimum size.
478 protected get
minSize (): number {
479 return this.numberOfWorkers
483 * The pool maximum size.
485 protected get
maxSize (): number {
486 return this.max
?? this.numberOfWorkers
490 * Checks if the worker id sent in the received message from a worker is valid.
492 * @param message - The received message.
493 * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker id is invalid.
495 private checkMessageWorkerId (message
: MessageValue
<Data
| Response
>): void {
496 if (message
.workerId
== null) {
497 throw new Error('Worker message received without worker id')
499 message
.workerId
!= null &&
500 this.getWorkerNodeKeyByWorkerId(message
.workerId
) === -1
503 `Worker message received from unknown worker '${message.workerId}'`
509 * Gets the given worker its worker node key.
511 * @param worker - The worker.
512 * @returns The worker node key if found in the pool worker nodes, `-1` otherwise.
514 private getWorkerNodeKeyByWorker (worker
: Worker
): number {
515 return this.workerNodes
.findIndex(
516 workerNode
=> workerNode
.worker
=== worker
521 * Gets the worker node key given its worker id.
523 * @param workerId - The worker id.
524 * @returns The worker node key if the worker id is found in the pool worker nodes, `-1` otherwise.
526 private getWorkerNodeKeyByWorkerId (workerId
: number | undefined): number {
527 return this.workerNodes
.findIndex(
528 workerNode
=> workerNode
.info
.id
=== workerId
533 public setWorkerChoiceStrategy (
534 workerChoiceStrategy
: WorkerChoiceStrategy
,
535 workerChoiceStrategyOptions
?: WorkerChoiceStrategyOptions
537 checkValidWorkerChoiceStrategy(workerChoiceStrategy
)
538 this.opts
.workerChoiceStrategy
= workerChoiceStrategy
539 this.workerChoiceStrategyContext
.setWorkerChoiceStrategy(
540 this.opts
.workerChoiceStrategy
542 if (workerChoiceStrategyOptions
!= null) {
543 this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions
)
545 for (const [workerNodeKey
, workerNode
] of this.workerNodes
.entries()) {
546 workerNode
.resetUsage()
547 this.sendStatisticsMessageToWorker(workerNodeKey
)
552 public setWorkerChoiceStrategyOptions (
553 workerChoiceStrategyOptions
: WorkerChoiceStrategyOptions
555 this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions
)
556 this.opts
.workerChoiceStrategyOptions
= {
557 ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
,
558 ...workerChoiceStrategyOptions
560 this.workerChoiceStrategyContext
.setOptions(
561 this.opts
.workerChoiceStrategyOptions
566 public enableTasksQueue (
568 tasksQueueOptions
?: TasksQueueOptions
570 if (this.opts
.enableTasksQueue
=== true && !enable
) {
571 this.unsetTaskStealing()
572 this.unsetTasksStealingOnBackPressure()
573 this.flushTasksQueues()
575 this.opts
.enableTasksQueue
= enable
576 this.setTasksQueueOptions(tasksQueueOptions
as TasksQueueOptions
)
580 public setTasksQueueOptions (tasksQueueOptions
: TasksQueueOptions
): void {
581 if (this.opts
.enableTasksQueue
=== true) {
582 checkValidTasksQueueOptions(tasksQueueOptions
)
583 this.opts
.tasksQueueOptions
=
584 this.buildTasksQueueOptions(tasksQueueOptions
)
585 this.setTasksQueueSize(this.opts
.tasksQueueOptions
.size
as number)
586 if (this.opts
.tasksQueueOptions
.taskStealing
=== true) {
587 this.setTaskStealing()
589 this.unsetTaskStealing()
591 if (this.opts
.tasksQueueOptions
.tasksStealingOnBackPressure
=== true) {
592 this.setTasksStealingOnBackPressure()
594 this.unsetTasksStealingOnBackPressure()
596 } else if (this.opts
.tasksQueueOptions
!= null) {
597 delete this.opts
.tasksQueueOptions
601 private buildTasksQueueOptions (
602 tasksQueueOptions
: TasksQueueOptions
603 ): TasksQueueOptions
{
606 size
: Math.pow(this.maxSize
, 2),
609 tasksStealingOnBackPressure
: true
615 private setTasksQueueSize (size
: number): void {
616 for (const workerNode
of this.workerNodes
) {
617 workerNode
.tasksQueueBackPressureSize
= size
621 private setTaskStealing (): void {
622 for (const [workerNodeKey
] of this.workerNodes
.entries()) {
623 this.workerNodes
[workerNodeKey
].addEventListener(
625 this.handleEmptyQueueEvent
as EventListener
630 private unsetTaskStealing (): void {
631 for (const [workerNodeKey
] of this.workerNodes
.entries()) {
632 this.workerNodes
[workerNodeKey
].removeEventListener(
634 this.handleEmptyQueueEvent
as EventListener
639 private setTasksStealingOnBackPressure (): void {
640 for (const [workerNodeKey
] of this.workerNodes
.entries()) {
641 this.workerNodes
[workerNodeKey
].addEventListener(
643 this.handleBackPressureEvent
as EventListener
648 private unsetTasksStealingOnBackPressure (): void {
649 for (const [workerNodeKey
] of this.workerNodes
.entries()) {
650 this.workerNodes
[workerNodeKey
].removeEventListener(
652 this.handleBackPressureEvent
as EventListener
658 * Whether the pool is full or not.
660 * The pool filling boolean status.
662 protected get
full (): boolean {
663 return this.workerNodes
.length
>= this.maxSize
667 * Whether the pool is busy or not.
669 * The pool busyness boolean status.
671 protected abstract get
busy (): boolean
674 * Whether worker nodes are executing concurrently their tasks quota or not.
676 * @returns Worker nodes busyness boolean status.
678 protected internalBusy (): boolean {
679 if (this.opts
.enableTasksQueue
=== true) {
681 this.workerNodes
.findIndex(
683 workerNode
.info
.ready
&&
684 workerNode
.usage
.tasks
.executing
<
685 (this.opts
.tasksQueueOptions
?.concurrency
as number)
690 this.workerNodes
.findIndex(
692 workerNode
.info
.ready
&& workerNode
.usage
.tasks
.executing
=== 0
697 private async sendTaskFunctionOperationToWorker (
698 workerNodeKey
: number,
699 message
: MessageValue
<Data
>
700 ): Promise
<boolean> {
701 return await new Promise
<boolean>((resolve
, reject
) => {
702 const taskFunctionOperationListener
= (
703 message
: MessageValue
<Response
>
705 this.checkMessageWorkerId(message
)
706 const workerId
= this.getWorkerInfo(workerNodeKey
).id
as number
708 message
.taskFunctionOperationStatus
!= null &&
709 message
.workerId
=== workerId
711 if (message
.taskFunctionOperationStatus
) {
713 } else if (!message
.taskFunctionOperationStatus
) {
716 `Task function operation '${
717 message.taskFunctionOperation as string
718 }' failed on worker ${message.workerId} with error: '${
719 message.workerError?.message as string
724 this.deregisterWorkerMessageListener(
725 this.getWorkerNodeKeyByWorkerId(message
.workerId
),
726 taskFunctionOperationListener
730 this.registerWorkerMessageListener(
732 taskFunctionOperationListener
734 this.sendToWorker(workerNodeKey
, message
)
738 private async sendTaskFunctionOperationToWorkers (
739 message
: MessageValue
<Data
>
740 ): Promise
<boolean> {
741 return await new Promise
<boolean>((resolve
, reject
) => {
742 const responsesReceived
= new Array<MessageValue
<Response
>>()
743 const taskFunctionOperationsListener
= (
744 message
: MessageValue
<Response
>
746 this.checkMessageWorkerId(message
)
747 if (message
.taskFunctionOperationStatus
!= null) {
748 responsesReceived
.push(message
)
749 if (responsesReceived
.length
=== this.workerNodes
.length
) {
751 responsesReceived
.every(
752 message
=> message
.taskFunctionOperationStatus
=== true
757 responsesReceived
.some(
758 message
=> message
.taskFunctionOperationStatus
=== false
761 const errorResponse
= responsesReceived
.find(
762 response
=> response
.taskFunctionOperationStatus
=== false
766 `Task function operation '${
767 message.taskFunctionOperation as string
768 }' failed on worker ${
769 errorResponse?.workerId as number
771 errorResponse?.workerError?.message as string
776 this.deregisterWorkerMessageListener(
777 this.getWorkerNodeKeyByWorkerId(message
.workerId
),
778 taskFunctionOperationsListener
783 for (const [workerNodeKey
] of this.workerNodes
.entries()) {
784 this.registerWorkerMessageListener(
786 taskFunctionOperationsListener
788 this.sendToWorker(workerNodeKey
, message
)
794 public hasTaskFunction (name
: string): boolean {
795 for (const workerNode
of this.workerNodes
) {
797 Array.isArray(workerNode
.info
.taskFunctionNames
) &&
798 workerNode
.info
.taskFunctionNames
.includes(name
)
807 public async addTaskFunction (
809 fn
: TaskFunction
<Data
, Response
>
810 ): Promise
<boolean> {
811 if (typeof name
!== 'string') {
812 throw new TypeError('name argument must be a string')
814 if (typeof name
=== 'string' && name
.trim().length
=== 0) {
815 throw new TypeError('name argument must not be an empty string')
817 if (typeof fn
!== 'function') {
818 throw new TypeError('fn argument must be a function')
820 const opResult
= await this.sendTaskFunctionOperationToWorkers({
821 taskFunctionOperation
: 'add',
822 taskFunctionName
: name
,
823 taskFunction
: fn
.toString()
825 this.taskFunctions
.set(name
, fn
)
830 public async removeTaskFunction (name
: string): Promise
<boolean> {
831 if (!this.taskFunctions
.has(name
)) {
833 'Cannot remove a task function not handled on the pool side'
836 const opResult
= await this.sendTaskFunctionOperationToWorkers({
837 taskFunctionOperation
: 'remove',
838 taskFunctionName
: name
840 this.deleteTaskFunctionWorkerUsages(name
)
841 this.taskFunctions
.delete(name
)
846 public listTaskFunctionNames (): string[] {
847 for (const workerNode
of this.workerNodes
) {
849 Array.isArray(workerNode
.info
.taskFunctionNames
) &&
850 workerNode
.info
.taskFunctionNames
.length
> 0
852 return workerNode
.info
.taskFunctionNames
859 public async setDefaultTaskFunction (name
: string): Promise
<boolean> {
860 return await this.sendTaskFunctionOperationToWorkers({
861 taskFunctionOperation
: 'default',
862 taskFunctionName
: name
866 private deleteTaskFunctionWorkerUsages (name
: string): void {
867 for (const workerNode
of this.workerNodes
) {
868 workerNode
.deleteTaskFunctionWorkerUsage(name
)
872 private shallExecuteTask (workerNodeKey
: number): boolean {
874 this.tasksQueueSize(workerNodeKey
) === 0 &&
875 this.workerNodes
[workerNodeKey
].usage
.tasks
.executing
<
876 (this.opts
.tasksQueueOptions
?.concurrency
as number)
881 public async execute (
884 transferList
?: TransferListItem
[]
885 ): Promise
<Response
> {
886 return await new Promise
<Response
>((resolve
, reject
) => {
888 reject(new Error('Cannot execute a task on not started pool'))
891 if (name
!= null && typeof name
!== 'string') {
892 reject(new TypeError('name argument must be a string'))
897 typeof name
=== 'string' &&
898 name
.trim().length
=== 0
900 reject(new TypeError('name argument must not be an empty string'))
903 if (transferList
!= null && !Array.isArray(transferList
)) {
904 reject(new TypeError('transferList argument must be an array'))
907 const timestamp
= performance
.now()
908 const workerNodeKey
= this.chooseWorkerNode()
909 const task
: Task
<Data
> = {
910 name
: name
?? DEFAULT_TASK_NAME
,
911 // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
912 data
: data
?? ({} as Data
),
917 this.promiseResponseMap
.set(task
.taskId
as string, {
923 this.opts
.enableTasksQueue
=== false ||
924 (this.opts
.enableTasksQueue
=== true &&
925 this.shallExecuteTask(workerNodeKey
))
927 this.executeTask(workerNodeKey
, task
)
929 this.enqueueTask(workerNodeKey
, task
)
935 public start (): void {
938 this.workerNodes
.reduce(
939 (accumulator
, workerNode
) =>
940 !workerNode
.info
.dynamic
? accumulator
+ 1 : accumulator
,
942 ) < this.numberOfWorkers
944 this.createAndSetupWorkerNode()
946 this.starting
= false
951 public async destroy (): Promise
<void> {
953 this.workerNodes
.map(async (_
, workerNodeKey
) => {
954 await this.destroyWorkerNode(workerNodeKey
)
957 this.emitter
?.emit(PoolEvents
.destroy
, this.info
)
958 this.emitter
?.emitDestroy()
962 protected async sendKillMessageToWorker (
963 workerNodeKey
: number
965 await new Promise
<void>((resolve
, reject
) => {
966 const killMessageListener
= (message
: MessageValue
<Response
>): void => {
967 this.checkMessageWorkerId(message
)
968 if (message
.kill
=== 'success') {
970 } else if (message
.kill
=== 'failure') {
973 `Kill message handling failed on worker ${
974 message.workerId as number
980 this.registerWorkerMessageListener(workerNodeKey
, killMessageListener
)
981 this.sendToWorker(workerNodeKey
, { kill
: true })
986 * Terminates the worker node given its worker node key.
988 * @param workerNodeKey - The worker node key.
990 protected abstract destroyWorkerNode (workerNodeKey
: number): Promise
<void>
993 * Setup hook to execute code before worker nodes are created in the abstract constructor.
998 protected setupHook (): void {
999 /* Intentionally empty */
1003 * Should return whether the worker is the main worker or not.
1005 protected abstract isMain (): boolean
1008 * Hook executed before the worker task execution.
1009 * Can be overridden.
1011 * @param workerNodeKey - The worker node key.
1012 * @param task - The task to execute.
1014 protected beforeTaskExecutionHook (
1015 workerNodeKey
: number,
1018 if (this.workerNodes
[workerNodeKey
]?.usage
!= null) {
1019 const workerUsage
= this.workerNodes
[workerNodeKey
].usage
1020 ++workerUsage
.tasks
.executing
1021 this.updateWaitTimeWorkerUsage(workerUsage
, task
)
1024 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey
) &&
1025 this.workerNodes
[workerNodeKey
].getTaskFunctionWorkerUsage(
1029 const taskFunctionWorkerUsage
= this.workerNodes
[
1031 ].getTaskFunctionWorkerUsage(task
.name
as string) as WorkerUsage
1032 ++taskFunctionWorkerUsage
.tasks
.executing
1033 this.updateWaitTimeWorkerUsage(taskFunctionWorkerUsage
, task
)
1038 * Hook executed after the worker task execution.
1039 * Can be overridden.
1041 * @param workerNodeKey - The worker node key.
1042 * @param message - The received message.
1044 protected afterTaskExecutionHook (
1045 workerNodeKey
: number,
1046 message
: MessageValue
<Response
>
1048 if (this.workerNodes
[workerNodeKey
]?.usage
!= null) {
1049 const workerUsage
= this.workerNodes
[workerNodeKey
].usage
1050 this.updateTaskStatisticsWorkerUsage(workerUsage
, message
)
1051 this.updateRunTimeWorkerUsage(workerUsage
, message
)
1052 this.updateEluWorkerUsage(workerUsage
, message
)
1055 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey
) &&
1056 this.workerNodes
[workerNodeKey
].getTaskFunctionWorkerUsage(
1057 message
.taskPerformance
?.name
as string
1060 const taskFunctionWorkerUsage
= this.workerNodes
[
1062 ].getTaskFunctionWorkerUsage(
1063 message
.taskPerformance
?.name
as string
1065 this.updateTaskStatisticsWorkerUsage(taskFunctionWorkerUsage
, message
)
1066 this.updateRunTimeWorkerUsage(taskFunctionWorkerUsage
, message
)
1067 this.updateEluWorkerUsage(taskFunctionWorkerUsage
, message
)
1072 * Whether the worker node shall update its task function worker usage or not.
1074 * @param workerNodeKey - The worker node key.
1075 * @returns `true` if the worker node shall update its task function worker usage, `false` otherwise.
1077 private shallUpdateTaskFunctionWorkerUsage (workerNodeKey
: number): boolean {
1078 const workerInfo
= this.getWorkerInfo(workerNodeKey
)
1080 workerInfo
!= null &&
1081 Array.isArray(workerInfo
.taskFunctionNames
) &&
1082 workerInfo
.taskFunctionNames
.length
> 2
1086 private updateTaskStatisticsWorkerUsage (
1087 workerUsage
: WorkerUsage
,
1088 message
: MessageValue
<Response
>
1090 const workerTaskStatistics
= workerUsage
.tasks
1092 workerTaskStatistics
.executing
!= null &&
1093 workerTaskStatistics
.executing
> 0
1095 --workerTaskStatistics
.executing
1097 if (message
.workerError
== null) {
1098 ++workerTaskStatistics
.executed
1100 ++workerTaskStatistics
.failed
1104 private updateRunTimeWorkerUsage (
1105 workerUsage
: WorkerUsage
,
1106 message
: MessageValue
<Response
>
1108 if (message
.workerError
!= null) {
1111 updateMeasurementStatistics(
1112 workerUsage
.runTime
,
1113 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements().runTime
,
1114 message
.taskPerformance
?.runTime
?? 0
1118 private updateWaitTimeWorkerUsage (
1119 workerUsage
: WorkerUsage
,
1122 const timestamp
= performance
.now()
1123 const taskWaitTime
= timestamp
- (task
.timestamp
?? timestamp
)
1124 updateMeasurementStatistics(
1125 workerUsage
.waitTime
,
1126 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements().waitTime
,
1131 private updateEluWorkerUsage (
1132 workerUsage
: WorkerUsage
,
1133 message
: MessageValue
<Response
>
1135 if (message
.workerError
!= null) {
1138 const eluTaskStatisticsRequirements
: MeasurementStatisticsRequirements
=
1139 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements().elu
1140 updateMeasurementStatistics(
1141 workerUsage
.elu
.active
,
1142 eluTaskStatisticsRequirements
,
1143 message
.taskPerformance
?.elu
?.active
?? 0
1145 updateMeasurementStatistics(
1146 workerUsage
.elu
.idle
,
1147 eluTaskStatisticsRequirements
,
1148 message
.taskPerformance
?.elu
?.idle
?? 0
1150 if (eluTaskStatisticsRequirements
.aggregate
) {
1151 if (message
.taskPerformance
?.elu
!= null) {
1152 if (workerUsage
.elu
.utilization
!= null) {
1153 workerUsage
.elu
.utilization
=
1154 (workerUsage
.elu
.utilization
+
1155 message
.taskPerformance
.elu
.utilization
) /
1158 workerUsage
.elu
.utilization
= message
.taskPerformance
.elu
.utilization
1165 * Chooses a worker node for the next task.
1167 * The default worker choice strategy uses a round robin algorithm to distribute the tasks.
1169 * @returns The chosen worker node key
1171 private chooseWorkerNode (): number {
1172 if (this.shallCreateDynamicWorker()) {
1173 const workerNodeKey
= this.createAndSetupDynamicWorkerNode()
1175 this.workerChoiceStrategyContext
.getStrategyPolicy().dynamicWorkerUsage
1177 return workerNodeKey
1180 return this.workerChoiceStrategyContext
.execute()
1184 * Conditions for dynamic worker creation.
1186 * @returns Whether to create a dynamic worker or not.
1188 private shallCreateDynamicWorker (): boolean {
1189 return this.type === PoolTypes
.dynamic
&& !this.full
&& this.internalBusy()
1193 * Sends a message to worker given its worker node key.
1195 * @param workerNodeKey - The worker node key.
1196 * @param message - The message.
1197 * @param transferList - The optional array of transferable objects.
1199 protected abstract sendToWorker (
1200 workerNodeKey
: number,
1201 message
: MessageValue
<Data
>,
1202 transferList
?: TransferListItem
[]
1206 * Creates a new worker.
1208 * @returns Newly created worker.
1210 protected abstract createWorker (): Worker
1213 * Creates a new, completely set up worker node.
1215 * @returns New, completely set up worker node key.
1217 protected createAndSetupWorkerNode (): number {
1218 const worker
= this.createWorker()
1220 worker
.on('online', this.opts
.onlineHandler
?? EMPTY_FUNCTION
)
1221 worker
.on('message', this.opts
.messageHandler
?? EMPTY_FUNCTION
)
1222 worker
.on('error', this.opts
.errorHandler
?? EMPTY_FUNCTION
)
1223 worker
.on('error', error
=> {
1224 const workerNodeKey
= this.getWorkerNodeKeyByWorker(worker
)
1225 const workerInfo
= this.getWorkerInfo(workerNodeKey
)
1226 workerInfo
.ready
= false
1227 this.emitter
?.emit(PoolEvents
.error
, error
)
1228 this.workerNodes
[workerNodeKey
].closeChannel()
1232 this.opts
.restartWorkerOnError
=== true
1234 if (workerInfo
.dynamic
) {
1235 this.createAndSetupDynamicWorkerNode()
1237 this.createAndSetupWorkerNode()
1240 if (this.started
&& this.opts
.enableTasksQueue
=== true) {
1241 this.redistributeQueuedTasks(workerNodeKey
)
1244 worker
.on('exit', this.opts
.exitHandler
?? EMPTY_FUNCTION
)
1245 worker
.once('exit', () => {
1246 this.removeWorkerNode(worker
)
1249 const workerNodeKey
= this.addWorkerNode(worker
)
1251 this.afterWorkerNodeSetup(workerNodeKey
)
1253 return workerNodeKey
1257 * Creates a new, completely set up dynamic worker node.
1259 * @returns New, completely set up dynamic worker node key.
1261 protected createAndSetupDynamicWorkerNode (): number {
1262 const workerNodeKey
= this.createAndSetupWorkerNode()
1263 this.registerWorkerMessageListener(workerNodeKey
, message
=> {
1264 this.checkMessageWorkerId(message
)
1265 const localWorkerNodeKey
= this.getWorkerNodeKeyByWorkerId(
1268 const workerUsage
= this.workerNodes
[localWorkerNodeKey
].usage
1269 // Kill message received from worker
1271 isKillBehavior(KillBehaviors
.HARD
, message
.kill
) ||
1272 (isKillBehavior(KillBehaviors
.SOFT
, message
.kill
) &&
1273 ((this.opts
.enableTasksQueue
=== false &&
1274 workerUsage
.tasks
.executing
=== 0) ||
1275 (this.opts
.enableTasksQueue
=== true &&
1276 workerUsage
.tasks
.executing
=== 0 &&
1277 this.tasksQueueSize(localWorkerNodeKey
) === 0)))
1279 this.destroyWorkerNode(localWorkerNodeKey
).catch(error
=> {
1280 this.emitter
?.emit(PoolEvents
.error
, error
)
1284 const workerInfo
= this.getWorkerInfo(workerNodeKey
)
1285 this.sendToWorker(workerNodeKey
, {
1288 if (this.taskFunctions
.size
> 0) {
1289 for (const [taskFunctionName
, taskFunction
] of this.taskFunctions
) {
1290 this.sendTaskFunctionOperationToWorker(workerNodeKey
, {
1291 taskFunctionOperation
: 'add',
1293 taskFunction
: taskFunction
.toString()
1295 this.emitter
?.emit(PoolEvents
.error
, error
)
1299 workerInfo
.dynamic
= true
1301 this.workerChoiceStrategyContext
.getStrategyPolicy().dynamicWorkerReady
||
1302 this.workerChoiceStrategyContext
.getStrategyPolicy().dynamicWorkerUsage
1304 workerInfo
.ready
= true
1306 this.checkAndEmitDynamicWorkerCreationEvents()
1307 return workerNodeKey
1311 * Registers a listener callback on the worker given its worker node key.
1313 * @param workerNodeKey - The worker node key.
1314 * @param listener - The message listener callback.
1316 protected abstract registerWorkerMessageListener
<
1317 Message
extends Data
| Response
1319 workerNodeKey
: number,
1320 listener
: (message
: MessageValue
<Message
>) => void
1324 * Registers once a listener callback on the worker given its worker node key.
1326 * @param workerNodeKey - The worker node key.
1327 * @param listener - The message listener callback.
1329 protected abstract registerOnceWorkerMessageListener
<
1330 Message
extends Data
| Response
1332 workerNodeKey
: number,
1333 listener
: (message
: MessageValue
<Message
>) => void
1337 * Deregisters a listener callback on the worker given its worker node key.
1339 * @param workerNodeKey - The worker node key.
1340 * @param listener - The message listener callback.
1342 protected abstract deregisterWorkerMessageListener
<
1343 Message
extends Data
| Response
1345 workerNodeKey
: number,
1346 listener
: (message
: MessageValue
<Message
>) => void
1350 * Method hooked up after a worker node has been newly created.
1351 * Can be overridden.
1353 * @param workerNodeKey - The newly created worker node key.
1355 protected afterWorkerNodeSetup (workerNodeKey
: number): void {
1356 // Listen to worker messages.
1357 this.registerWorkerMessageListener(
1359 this.workerMessageListener
.bind(this)
1361 // Send the startup message to worker.
1362 this.sendStartupMessageToWorker(workerNodeKey
)
1363 // Send the statistics message to worker.
1364 this.sendStatisticsMessageToWorker(workerNodeKey
)
1365 if (this.opts
.enableTasksQueue
=== true) {
1366 if (this.opts
.tasksQueueOptions
?.taskStealing
=== true) {
1367 this.workerNodes
[workerNodeKey
].addEventListener(
1369 this.handleEmptyQueueEvent
as EventListener
1372 if (this.opts
.tasksQueueOptions
?.tasksStealingOnBackPressure
=== true) {
1373 this.workerNodes
[workerNodeKey
].addEventListener(
1375 this.handleBackPressureEvent
as EventListener
1382 * Sends the startup message to worker given its worker node key.
1384 * @param workerNodeKey - The worker node key.
1386 protected abstract sendStartupMessageToWorker (workerNodeKey
: number): void
1389 * Sends the statistics message to worker given its worker node key.
1391 * @param workerNodeKey - The worker node key.
1393 private sendStatisticsMessageToWorker (workerNodeKey
: number): void {
1394 this.sendToWorker(workerNodeKey
, {
1397 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
1399 elu
: this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
1405 private redistributeQueuedTasks (workerNodeKey
: number): void {
1406 while (this.tasksQueueSize(workerNodeKey
) > 0) {
1407 const destinationWorkerNodeKey
= this.workerNodes
.reduce(
1408 (minWorkerNodeKey
, workerNode
, workerNodeKey
, workerNodes
) => {
1409 return workerNode
.info
.ready
&&
1410 workerNode
.usage
.tasks
.queued
<
1411 workerNodes
[minWorkerNodeKey
].usage
.tasks
.queued
1417 const task
= this.dequeueTask(workerNodeKey
) as Task
<Data
>
1418 if (this.shallExecuteTask(destinationWorkerNodeKey
)) {
1419 this.executeTask(destinationWorkerNodeKey
, task
)
1421 this.enqueueTask(destinationWorkerNodeKey
, task
)
1426 private updateTaskStolenStatisticsWorkerUsage (
1427 workerNodeKey
: number,
1430 const workerNode
= this.workerNodes
[workerNodeKey
]
1431 if (workerNode
?.usage
!= null) {
1432 ++workerNode
.usage
.tasks
.stolen
1435 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey
) &&
1436 workerNode
.getTaskFunctionWorkerUsage(taskName
) != null
1438 const taskFunctionWorkerUsage
= workerNode
.getTaskFunctionWorkerUsage(
1441 ++taskFunctionWorkerUsage
.tasks
.stolen
1445 private readonly handleEmptyQueueEvent
= (
1446 event
: CustomEvent
<WorkerNodeEventDetail
>
1448 const destinationWorkerNodeKey
= this.getWorkerNodeKeyByWorkerId(
1449 event
.detail
.workerId
1451 const workerNodes
= this.workerNodes
1454 (workerNodeA
, workerNodeB
) =>
1455 workerNodeB
.usage
.tasks
.queued
- workerNodeA
.usage
.tasks
.queued
1457 const sourceWorkerNode
= workerNodes
.find(
1459 workerNode
.info
.ready
&&
1460 workerNode
.info
.id
!== event
.detail
.workerId
&&
1461 workerNode
.usage
.tasks
.queued
> 0
1463 if (sourceWorkerNode
!= null) {
1464 const task
= sourceWorkerNode
.popTask() as Task
<Data
>
1465 if (this.shallExecuteTask(destinationWorkerNodeKey
)) {
1466 this.executeTask(destinationWorkerNodeKey
, task
)
1468 this.enqueueTask(destinationWorkerNodeKey
, task
)
1470 this.updateTaskStolenStatisticsWorkerUsage(
1471 destinationWorkerNodeKey
,
1477 private readonly handleBackPressureEvent
= (
1478 event
: CustomEvent
<WorkerNodeEventDetail
>
1480 const sizeOffset
= 1
1481 if ((this.opts
.tasksQueueOptions
?.size
as number) <= sizeOffset
) {
1484 const sourceWorkerNode
=
1485 this.workerNodes
[this.getWorkerNodeKeyByWorkerId(event
.detail
.workerId
)]
1486 const workerNodes
= this.workerNodes
1489 (workerNodeA
, workerNodeB
) =>
1490 workerNodeA
.usage
.tasks
.queued
- workerNodeB
.usage
.tasks
.queued
1492 for (const [workerNodeKey
, workerNode
] of workerNodes
.entries()) {
1494 sourceWorkerNode
.usage
.tasks
.queued
> 0 &&
1495 workerNode
.info
.ready
&&
1496 workerNode
.info
.id
!== event
.detail
.workerId
&&
1497 workerNode
.usage
.tasks
.queued
<
1498 (this.opts
.tasksQueueOptions
?.size
as number) - sizeOffset
1500 const task
= sourceWorkerNode
.popTask() as Task
<Data
>
1501 if (this.shallExecuteTask(workerNodeKey
)) {
1502 this.executeTask(workerNodeKey
, task
)
1504 this.enqueueTask(workerNodeKey
, task
)
1506 this.updateTaskStolenStatisticsWorkerUsage(
1515 * This method is the message listener registered on each worker.
1517 protected workerMessageListener (message
: MessageValue
<Response
>): void {
1518 this.checkMessageWorkerId(message
)
1519 if (message
.ready
!= null && message
.taskFunctionNames
!= null) {
1520 // Worker ready response received from worker
1521 this.handleWorkerReadyResponse(message
)
1522 } else if (message
.taskId
!= null) {
1523 // Task execution response received from worker
1524 this.handleTaskExecutionResponse(message
)
1525 } else if (message
.taskFunctionNames
!= null) {
1526 // Task function names message received from worker
1528 this.getWorkerNodeKeyByWorkerId(message
.workerId
)
1529 ).taskFunctionNames
= message
.taskFunctionNames
1533 private handleWorkerReadyResponse (message
: MessageValue
<Response
>): void {
1534 if (message
.ready
=== false) {
1536 `Worker ${message.workerId as number} failed to initialize`
1539 const workerInfo
= this.getWorkerInfo(
1540 this.getWorkerNodeKeyByWorkerId(message
.workerId
)
1542 workerInfo
.ready
= message
.ready
as boolean
1543 workerInfo
.taskFunctionNames
= message
.taskFunctionNames
1545 this.emitter
?.emit(PoolEvents
.ready
, this.info
)
1549 private handleTaskExecutionResponse (message
: MessageValue
<Response
>): void {
1550 const { taskId
, workerError
, data
} = message
1551 const promiseResponse
= this.promiseResponseMap
.get(taskId
as string)
1552 if (promiseResponse
!= null) {
1553 if (workerError
!= null) {
1554 this.emitter
?.emit(PoolEvents
.taskError
, workerError
)
1555 promiseResponse
.reject(workerError
.message
)
1557 promiseResponse
.resolve(data
as Response
)
1559 const workerNodeKey
= promiseResponse
.workerNodeKey
1560 this.afterTaskExecutionHook(workerNodeKey
, message
)
1561 this.workerChoiceStrategyContext
.update(workerNodeKey
)
1562 this.promiseResponseMap
.delete(taskId
as string)
1564 this.opts
.enableTasksQueue
=== true &&
1565 this.tasksQueueSize(workerNodeKey
) > 0 &&
1566 this.workerNodes
[workerNodeKey
].usage
.tasks
.executing
<
1567 (this.opts
.tasksQueueOptions
?.concurrency
as number)
1571 this.dequeueTask(workerNodeKey
) as Task
<Data
>
1577 private checkAndEmitTaskExecutionEvents (): void {
1579 this.emitter
?.emit(PoolEvents
.busy
, this.info
)
1583 private checkAndEmitTaskQueuingEvents (): void {
1584 if (this.hasBackPressure()) {
1585 this.emitter
?.emit(PoolEvents
.backPressure
, this.info
)
1589 private checkAndEmitDynamicWorkerCreationEvents (): void {
1590 if (this.type === PoolTypes
.dynamic
) {
1592 this.emitter
?.emit(PoolEvents
.full
, this.info
)
1598 * Gets the worker information given its worker node key.
1600 * @param workerNodeKey - The worker node key.
1601 * @returns The worker information.
1603 protected getWorkerInfo (workerNodeKey
: number): WorkerInfo
{
1604 return this.workerNodes
[workerNodeKey
]?.info
1608 * Adds the given worker in the pool worker nodes.
1610 * @param worker - The worker.
1611 * @returns The added worker node key.
1612 * @throws {@link https://nodejs.org/api/errors.html#class-error} If the added worker node is not found.
1614 private addWorkerNode (worker
: Worker
): number {
1615 const workerNode
= new WorkerNode
<Worker
, Data
>(
1617 this.opts
.tasksQueueOptions
?.size
?? Math.pow(this.maxSize
, 2)
1619 // Flag the worker node as ready at pool startup.
1620 if (this.starting
) {
1621 workerNode
.info
.ready
= true
1623 this.workerNodes
.push(workerNode
)
1624 const workerNodeKey
= this.getWorkerNodeKeyByWorker(worker
)
1625 if (workerNodeKey
=== -1) {
1626 throw new Error('Worker added not found in worker nodes')
1628 return workerNodeKey
1632 * Removes the given worker from the pool worker nodes.
1634 * @param worker - The worker.
1636 private removeWorkerNode (worker
: Worker
): void {
1637 const workerNodeKey
= this.getWorkerNodeKeyByWorker(worker
)
1638 if (workerNodeKey
!== -1) {
1639 this.workerNodes
.splice(workerNodeKey
, 1)
1640 this.workerChoiceStrategyContext
.remove(workerNodeKey
)
1645 public hasWorkerNodeBackPressure (workerNodeKey
: number): boolean {
1647 this.opts
.enableTasksQueue
=== true &&
1648 this.workerNodes
[workerNodeKey
].hasBackPressure()
1652 private hasBackPressure (): boolean {
1654 this.opts
.enableTasksQueue
=== true &&
1655 this.workerNodes
.findIndex(
1656 workerNode
=> !workerNode
.hasBackPressure()
1662 * Executes the given task on the worker given its worker node key.
1664 * @param workerNodeKey - The worker node key.
1665 * @param task - The task to execute.
1667 private executeTask (workerNodeKey
: number, task
: Task
<Data
>): void {
1668 this.beforeTaskExecutionHook(workerNodeKey
, task
)
1669 this.sendToWorker(workerNodeKey
, task
, task
.transferList
)
1670 this.checkAndEmitTaskExecutionEvents()
1673 private enqueueTask (workerNodeKey
: number, task
: Task
<Data
>): number {
1674 const tasksQueueSize
= this.workerNodes
[workerNodeKey
].enqueueTask(task
)
1675 this.checkAndEmitTaskQueuingEvents()
1676 return tasksQueueSize
1679 private dequeueTask (workerNodeKey
: number): Task
<Data
> | undefined {
1680 return this.workerNodes
[workerNodeKey
].dequeueTask()
1683 private tasksQueueSize (workerNodeKey
: number): number {
1684 return this.workerNodes
[workerNodeKey
].tasksQueueSize()
1687 protected flushTasksQueue (workerNodeKey
: number): void {
1688 while (this.tasksQueueSize(workerNodeKey
) > 0) {
1691 this.dequeueTask(workerNodeKey
) as Task
<Data
>
1694 this.workerNodes
[workerNodeKey
].clearTasksQueue()
1697 private flushTasksQueues (): void {
1698 for (const [workerNodeKey
] of this.workerNodes
.entries()) {
1699 this.flushTasksQueue(workerNodeKey
)