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