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