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