Merge branch 'master' into combined-prs-branch
[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 (
193 minimumNumberOfWorkers: number | undefined
194 ): void {
195 if (minimumNumberOfWorkers == null) {
196 throw new Error(
197 'Cannot instantiate a pool without specifying the number of workers'
198 )
199 } else if (!Number.isSafeInteger(minimumNumberOfWorkers)) {
200 throw new TypeError(
201 'Cannot instantiate a pool with a non safe integer number of workers'
202 )
203 } else if (minimumNumberOfWorkers < 0) {
204 throw new RangeError(
205 'Cannot instantiate a pool with a negative number of workers'
206 )
207 } else if (this.type === PoolTypes.fixed && minimumNumberOfWorkers === 0) {
208 throw new RangeError('Cannot instantiate a fixed pool with zero worker')
209 }
210 }
211
212 private checkPoolOptions (opts: PoolOptions<Worker>): void {
213 if (isPlainObject(opts)) {
214 this.opts.startWorkers = opts.startWorkers ?? true
215 checkValidWorkerChoiceStrategy(opts.workerChoiceStrategy)
216 this.opts.workerChoiceStrategy =
217 opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
218 this.checkValidWorkerChoiceStrategyOptions(
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 checkValidTasksQueueOptions(opts.tasksQueueOptions)
229 this.opts.tasksQueueOptions = this.buildTasksQueueOptions(
230 opts.tasksQueueOptions
231 )
232 }
233 } else {
234 throw new TypeError('Invalid pool options: must be a plain object')
235 }
236 }
237
238 private checkValidWorkerChoiceStrategyOptions (
239 workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | undefined
240 ): void {
241 if (
242 workerChoiceStrategyOptions != null &&
243 !isPlainObject(workerChoiceStrategyOptions)
244 ) {
245 throw new TypeError(
246 'Invalid worker choice strategy options: must be a plain object'
247 )
248 }
249 if (
250 workerChoiceStrategyOptions?.weights != null &&
251 Object.keys(workerChoiceStrategyOptions.weights).length !==
252 (this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers)
253 ) {
254 throw new Error(
255 'Invalid worker choice strategy options: must have a weight for each worker node'
256 )
257 }
258 if (
259 workerChoiceStrategyOptions?.measurement != null &&
260 !Object.values(Measurements).includes(
261 workerChoiceStrategyOptions.measurement
262 )
263 ) {
264 throw new Error(
265 `Invalid worker choice strategy options: invalid measurement '${workerChoiceStrategyOptions.measurement}'`
266 )
267 }
268 }
269
270 private initializeEventEmitter (): void {
271 this.emitter = new EventEmitterAsyncResource({
272 name: `poolifier:${this.type}-${this.worker}-pool`
273 })
274 }
275
276 /** @inheritDoc */
277 public get info (): PoolInfo {
278 return {
279 version,
280 type: this.type,
281 worker: this.worker,
282 started: this.started,
283 ready: this.ready,
284 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
285 strategy: this.opts.workerChoiceStrategy!,
286 minSize: this.minimumNumberOfWorkers,
287 maxSize: this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers,
288 ...(this.workerChoiceStrategyContext?.getTaskStatisticsRequirements()
289 ?.runTime.aggregate === true &&
290 this.workerChoiceStrategyContext.getTaskStatisticsRequirements()
291 .waitTime.aggregate && {
292 utilization: round(this.utilization)
293 }),
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 === true && {
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 === true && {
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 | undefined
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 this.setTasksQueueOptions(tasksQueueOptions)
563 }
564
565 /** @inheritDoc */
566 public setTasksQueueOptions (
567 tasksQueueOptions: TasksQueueOptions | undefined
568 ): void {
569 if (this.opts.enableTasksQueue === true) {
570 checkValidTasksQueueOptions(tasksQueueOptions)
571 this.opts.tasksQueueOptions =
572 this.buildTasksQueueOptions(tasksQueueOptions)
573 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
574 this.setTasksQueueSize(this.opts.tasksQueueOptions.size!)
575 if (this.opts.tasksQueueOptions.taskStealing === true) {
576 this.unsetTaskStealing()
577 this.setTaskStealing()
578 } else {
579 this.unsetTaskStealing()
580 }
581 if (this.opts.tasksQueueOptions.tasksStealingOnBackPressure === true) {
582 this.unsetTasksStealingOnBackPressure()
583 this.setTasksStealingOnBackPressure()
584 } else {
585 this.unsetTasksStealingOnBackPressure()
586 }
587 } else if (this.opts.tasksQueueOptions != null) {
588 delete this.opts.tasksQueueOptions
589 }
590 }
591
592 private buildTasksQueueOptions (
593 tasksQueueOptions: TasksQueueOptions | undefined
594 ): TasksQueueOptions {
595 return {
596 ...getDefaultTasksQueueOptions(
597 this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers
598 ),
599 ...tasksQueueOptions
600 }
601 }
602
603 private setTasksQueueSize (size: number): void {
604 for (const workerNode of this.workerNodes) {
605 workerNode.tasksQueueBackPressureSize = size
606 }
607 }
608
609 private setTaskStealing (): void {
610 for (const [workerNodeKey] of this.workerNodes.entries()) {
611 this.workerNodes[workerNodeKey].on('idle', this.handleWorkerNodeIdleEvent)
612 }
613 }
614
615 private unsetTaskStealing (): void {
616 for (const [workerNodeKey] of this.workerNodes.entries()) {
617 this.workerNodes[workerNodeKey].off(
618 'idle',
619 this.handleWorkerNodeIdleEvent
620 )
621 }
622 }
623
624 private setTasksStealingOnBackPressure (): void {
625 for (const [workerNodeKey] of this.workerNodes.entries()) {
626 this.workerNodes[workerNodeKey].on(
627 'backPressure',
628 this.handleWorkerNodeBackPressureEvent
629 )
630 }
631 }
632
633 private unsetTasksStealingOnBackPressure (): void {
634 for (const [workerNodeKey] of this.workerNodes.entries()) {
635 this.workerNodes[workerNodeKey].off(
636 'backPressure',
637 this.handleWorkerNodeBackPressureEvent
638 )
639 }
640 }
641
642 /**
643 * Whether the pool is full or not.
644 *
645 * The pool filling boolean status.
646 */
647 protected get full (): boolean {
648 return (
649 this.workerNodes.length >=
650 (this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers)
651 )
652 }
653
654 /**
655 * Whether the pool is busy or not.
656 *
657 * The pool busyness boolean status.
658 */
659 protected abstract get busy (): boolean
660
661 /**
662 * Whether worker nodes are executing concurrently their tasks quota or not.
663 *
664 * @returns Worker nodes busyness boolean status.
665 */
666 protected internalBusy (): boolean {
667 if (this.opts.enableTasksQueue === true) {
668 return (
669 this.workerNodes.findIndex(
670 workerNode =>
671 workerNode.info.ready &&
672 workerNode.usage.tasks.executing <
673 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
674 this.opts.tasksQueueOptions!.concurrency!
675 ) === -1
676 )
677 }
678 return (
679 this.workerNodes.findIndex(
680 workerNode =>
681 workerNode.info.ready && workerNode.usage.tasks.executing === 0
682 ) === -1
683 )
684 }
685
686 private isWorkerNodeBusy (workerNodeKey: number): boolean {
687 if (this.opts.enableTasksQueue === true) {
688 return (
689 this.workerNodes[workerNodeKey].usage.tasks.executing >=
690 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
691 this.opts.tasksQueueOptions!.concurrency!
692 )
693 }
694 return this.workerNodes[workerNodeKey].usage.tasks.executing > 0
695 }
696
697 private async sendTaskFunctionOperationToWorker (
698 workerNodeKey: number,
699 message: MessageValue<Data>
700 ): Promise<boolean> {
701 return await new Promise<boolean>((resolve, reject) => {
702 const taskFunctionOperationListener = (
703 message: MessageValue<Response>
704 ): void => {
705 this.checkMessageWorkerId(message)
706 const workerId = this.getWorkerInfo(workerNodeKey)?.id
707 if (
708 message.taskFunctionOperationStatus != null &&
709 message.workerId === workerId
710 ) {
711 if (message.taskFunctionOperationStatus) {
712 resolve(true)
713 } else {
714 reject(
715 new Error(
716 `Task function operation '${message.taskFunctionOperation}' failed on worker ${message.workerId} with error: '${message.workerError?.message}'`
717 )
718 )
719 }
720 this.deregisterWorkerMessageListener(
721 this.getWorkerNodeKeyByWorkerId(message.workerId),
722 taskFunctionOperationListener
723 )
724 }
725 }
726 this.registerWorkerMessageListener(
727 workerNodeKey,
728 taskFunctionOperationListener
729 )
730 this.sendToWorker(workerNodeKey, message)
731 })
732 }
733
734 private async sendTaskFunctionOperationToWorkers (
735 message: MessageValue<Data>
736 ): Promise<boolean> {
737 return await new Promise<boolean>((resolve, reject) => {
738 const responsesReceived = new Array<MessageValue<Response>>()
739 const taskFunctionOperationsListener = (
740 message: MessageValue<Response>
741 ): void => {
742 this.checkMessageWorkerId(message)
743 if (message.taskFunctionOperationStatus != null) {
744 responsesReceived.push(message)
745 if (responsesReceived.length === this.workerNodes.length) {
746 if (
747 responsesReceived.every(
748 message => message.taskFunctionOperationStatus === true
749 )
750 ) {
751 resolve(true)
752 } else if (
753 responsesReceived.some(
754 message => message.taskFunctionOperationStatus === false
755 )
756 ) {
757 const errorResponse = responsesReceived.find(
758 response => response.taskFunctionOperationStatus === false
759 )
760 reject(
761 new Error(
762 `Task function operation '${
763 message.taskFunctionOperation as string
764 }' failed on worker ${errorResponse?.workerId} with error: '${
765 errorResponse?.workerError?.message
766 }'`
767 )
768 )
769 }
770 this.deregisterWorkerMessageListener(
771 this.getWorkerNodeKeyByWorkerId(message.workerId),
772 taskFunctionOperationsListener
773 )
774 }
775 }
776 }
777 for (const [workerNodeKey] of this.workerNodes.entries()) {
778 this.registerWorkerMessageListener(
779 workerNodeKey,
780 taskFunctionOperationsListener
781 )
782 this.sendToWorker(workerNodeKey, message)
783 }
784 })
785 }
786
787 /** @inheritDoc */
788 public hasTaskFunction (name: string): boolean {
789 for (const workerNode of this.workerNodes) {
790 if (
791 Array.isArray(workerNode.info.taskFunctionNames) &&
792 workerNode.info.taskFunctionNames.includes(name)
793 ) {
794 return true
795 }
796 }
797 return false
798 }
799
800 /** @inheritDoc */
801 public async addTaskFunction (
802 name: string,
803 fn: TaskFunction<Data, Response>
804 ): Promise<boolean> {
805 if (typeof name !== 'string') {
806 throw new TypeError('name argument must be a string')
807 }
808 if (typeof name === 'string' && name.trim().length === 0) {
809 throw new TypeError('name argument must not be an empty string')
810 }
811 if (typeof fn !== 'function') {
812 throw new TypeError('fn argument must be a function')
813 }
814 const opResult = await this.sendTaskFunctionOperationToWorkers({
815 taskFunctionOperation: 'add',
816 taskFunctionName: name,
817 taskFunction: fn.toString()
818 })
819 this.taskFunctions.set(name, fn)
820 return opResult
821 }
822
823 /** @inheritDoc */
824 public async removeTaskFunction (name: string): Promise<boolean> {
825 if (!this.taskFunctions.has(name)) {
826 throw new Error(
827 'Cannot remove a task function not handled on the pool side'
828 )
829 }
830 const opResult = await this.sendTaskFunctionOperationToWorkers({
831 taskFunctionOperation: 'remove',
832 taskFunctionName: name
833 })
834 this.deleteTaskFunctionWorkerUsages(name)
835 this.taskFunctions.delete(name)
836 return opResult
837 }
838
839 /** @inheritDoc */
840 public listTaskFunctionNames (): string[] {
841 for (const workerNode of this.workerNodes) {
842 if (
843 Array.isArray(workerNode.info.taskFunctionNames) &&
844 workerNode.info.taskFunctionNames.length > 0
845 ) {
846 return workerNode.info.taskFunctionNames
847 }
848 }
849 return []
850 }
851
852 /** @inheritDoc */
853 public async setDefaultTaskFunction (name: string): Promise<boolean> {
854 return await this.sendTaskFunctionOperationToWorkers({
855 taskFunctionOperation: 'default',
856 taskFunctionName: name
857 })
858 }
859
860 private deleteTaskFunctionWorkerUsages (name: string): void {
861 for (const workerNode of this.workerNodes) {
862 workerNode.deleteTaskFunctionWorkerUsage(name)
863 }
864 }
865
866 private shallExecuteTask (workerNodeKey: number): boolean {
867 return (
868 this.tasksQueueSize(workerNodeKey) === 0 &&
869 this.workerNodes[workerNodeKey].usage.tasks.executing <
870 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
871 this.opts.tasksQueueOptions!.concurrency!
872 )
873 }
874
875 /** @inheritDoc */
876 public async execute (
877 data?: Data,
878 name?: string,
879 transferList?: TransferListItem[]
880 ): Promise<Response> {
881 return await new Promise<Response>((resolve, reject) => {
882 if (!this.started) {
883 reject(new Error('Cannot execute a task on not started pool'))
884 return
885 }
886 if (this.destroying) {
887 reject(new Error('Cannot execute a task on destroying pool'))
888 return
889 }
890 if (name != null && typeof name !== 'string') {
891 reject(new TypeError('name argument must be a string'))
892 return
893 }
894 if (
895 name != null &&
896 typeof name === 'string' &&
897 name.trim().length === 0
898 ) {
899 reject(new TypeError('name argument must not be an empty string'))
900 return
901 }
902 if (transferList != null && !Array.isArray(transferList)) {
903 reject(new TypeError('transferList argument must be an array'))
904 return
905 }
906 const timestamp = performance.now()
907 const workerNodeKey = this.chooseWorkerNode()
908 const task: Task<Data> = {
909 name: name ?? DEFAULT_TASK_NAME,
910 // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
911 data: data ?? ({} as Data),
912 transferList,
913 timestamp,
914 taskId: randomUUID()
915 }
916 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
917 this.promiseResponseMap.set(task.taskId!, {
918 resolve,
919 reject,
920 workerNodeKey,
921 ...(this.emitter != null && {
922 asyncResource: new AsyncResource('poolifier:task', {
923 triggerAsyncId: this.emitter.asyncId,
924 requireManualDestroy: true
925 })
926 })
927 })
928 if (
929 this.opts.enableTasksQueue === false ||
930 (this.opts.enableTasksQueue === true &&
931 this.shallExecuteTask(workerNodeKey))
932 ) {
933 this.executeTask(workerNodeKey, task)
934 } else {
935 this.enqueueTask(workerNodeKey, task)
936 }
937 })
938 }
939
940 /** @inheritdoc */
941 public start (): void {
942 if (this.started) {
943 throw new Error('Cannot start an already started pool')
944 }
945 if (this.starting) {
946 throw new Error('Cannot start an already starting pool')
947 }
948 if (this.destroying) {
949 throw new Error('Cannot start a destroying pool')
950 }
951 this.starting = true
952 while (
953 this.workerNodes.reduce(
954 (accumulator, workerNode) =>
955 !workerNode.info.dynamic ? accumulator + 1 : accumulator,
956 0
957 ) < this.minimumNumberOfWorkers
958 ) {
959 this.createAndSetupWorkerNode()
960 }
961 this.starting = false
962 this.started = true
963 }
964
965 /** @inheritDoc */
966 public async destroy (): Promise<void> {
967 if (!this.started) {
968 throw new Error('Cannot destroy an already destroyed pool')
969 }
970 if (this.starting) {
971 throw new Error('Cannot destroy an starting pool')
972 }
973 if (this.destroying) {
974 throw new Error('Cannot destroy an already destroying pool')
975 }
976 this.destroying = true
977 await Promise.all(
978 this.workerNodes.map(async (_workerNode, workerNodeKey) => {
979 await this.destroyWorkerNode(workerNodeKey)
980 })
981 )
982 this.emitter?.emit(PoolEvents.destroy, this.info)
983 this.emitter?.emitDestroy()
984 this.emitter?.removeAllListeners()
985 this.readyEventEmitted = false
986 this.destroying = false
987 this.started = false
988 }
989
990 private async sendKillMessageToWorker (workerNodeKey: number): Promise<void> {
991 await new Promise<void>((resolve, reject) => {
992 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
993 if (this.workerNodes[workerNodeKey] == null) {
994 resolve()
995 return
996 }
997 const killMessageListener = (message: MessageValue<Response>): void => {
998 this.checkMessageWorkerId(message)
999 if (message.kill === 'success') {
1000 resolve()
1001 } else if (message.kill === 'failure') {
1002 reject(
1003 new Error(
1004 `Kill message handling failed on worker ${message.workerId}`
1005 )
1006 )
1007 }
1008 }
1009 // FIXME: should be registered only once
1010 this.registerWorkerMessageListener(workerNodeKey, killMessageListener)
1011 this.sendToWorker(workerNodeKey, { kill: true })
1012 })
1013 }
1014
1015 /**
1016 * Terminates the worker node given its worker node key.
1017 *
1018 * @param workerNodeKey - The worker node key.
1019 */
1020 protected async destroyWorkerNode (workerNodeKey: number): Promise<void> {
1021 this.flagWorkerNodeAsNotReady(workerNodeKey)
1022 const flushedTasks = this.flushTasksQueue(workerNodeKey)
1023 const workerNode = this.workerNodes[workerNodeKey]
1024 await waitWorkerNodeEvents(
1025 workerNode,
1026 'taskFinished',
1027 flushedTasks,
1028 this.opts.tasksQueueOptions?.tasksFinishedTimeout ??
1029 getDefaultTasksQueueOptions(
1030 this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers
1031 ).tasksFinishedTimeout
1032 )
1033 await this.sendKillMessageToWorker(workerNodeKey)
1034 await workerNode.terminate()
1035 }
1036
1037 /**
1038 * Setup hook to execute code before worker nodes are created in the abstract constructor.
1039 * Can be overridden.
1040 *
1041 * @virtual
1042 */
1043 protected setupHook (): void {
1044 /* Intentionally empty */
1045 }
1046
1047 /**
1048 * Should return whether the worker is the main worker or not.
1049 */
1050 protected abstract isMain (): boolean
1051
1052 /**
1053 * Hook executed before the worker task execution.
1054 * Can be overridden.
1055 *
1056 * @param workerNodeKey - The worker node key.
1057 * @param task - The task to execute.
1058 */
1059 protected beforeTaskExecutionHook (
1060 workerNodeKey: number,
1061 task: Task<Data>
1062 ): void {
1063 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1064 if (this.workerNodes[workerNodeKey]?.usage != null) {
1065 const workerUsage = this.workerNodes[workerNodeKey].usage
1066 ++workerUsage.tasks.executing
1067 updateWaitTimeWorkerUsage(
1068 this.workerChoiceStrategyContext,
1069 workerUsage,
1070 task
1071 )
1072 }
1073 if (
1074 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
1075 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1076 this.workerNodes[workerNodeKey].getTaskFunctionWorkerUsage(task.name!) !=
1077 null
1078 ) {
1079 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1080 const taskFunctionWorkerUsage = this.workerNodes[
1081 workerNodeKey
1082 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1083 ].getTaskFunctionWorkerUsage(task.name!)!
1084 ++taskFunctionWorkerUsage.tasks.executing
1085 updateWaitTimeWorkerUsage(
1086 this.workerChoiceStrategyContext,
1087 taskFunctionWorkerUsage,
1088 task
1089 )
1090 }
1091 }
1092
1093 /**
1094 * Hook executed after the worker task execution.
1095 * Can be overridden.
1096 *
1097 * @param workerNodeKey - The worker node key.
1098 * @param message - The received message.
1099 */
1100 protected afterTaskExecutionHook (
1101 workerNodeKey: number,
1102 message: MessageValue<Response>
1103 ): void {
1104 let needWorkerChoiceStrategyUpdate = false
1105 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1106 if (this.workerNodes[workerNodeKey]?.usage != null) {
1107 const workerUsage = this.workerNodes[workerNodeKey].usage
1108 updateTaskStatisticsWorkerUsage(workerUsage, message)
1109 updateRunTimeWorkerUsage(
1110 this.workerChoiceStrategyContext,
1111 workerUsage,
1112 message
1113 )
1114 updateEluWorkerUsage(
1115 this.workerChoiceStrategyContext,
1116 workerUsage,
1117 message
1118 )
1119 needWorkerChoiceStrategyUpdate = true
1120 }
1121 if (
1122 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
1123 this.workerNodes[workerNodeKey].getTaskFunctionWorkerUsage(
1124 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1125 message.taskPerformance!.name
1126 ) != null
1127 ) {
1128 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1129 const taskFunctionWorkerUsage = this.workerNodes[
1130 workerNodeKey
1131 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1132 ].getTaskFunctionWorkerUsage(message.taskPerformance!.name)!
1133 updateTaskStatisticsWorkerUsage(taskFunctionWorkerUsage, message)
1134 updateRunTimeWorkerUsage(
1135 this.workerChoiceStrategyContext,
1136 taskFunctionWorkerUsage,
1137 message
1138 )
1139 updateEluWorkerUsage(
1140 this.workerChoiceStrategyContext,
1141 taskFunctionWorkerUsage,
1142 message
1143 )
1144 needWorkerChoiceStrategyUpdate = true
1145 }
1146 if (needWorkerChoiceStrategyUpdate) {
1147 this.workerChoiceStrategyContext?.update(workerNodeKey)
1148 }
1149 }
1150
1151 /**
1152 * Whether the worker node shall update its task function worker usage or not.
1153 *
1154 * @param workerNodeKey - The worker node key.
1155 * @returns `true` if the worker node shall update its task function worker usage, `false` otherwise.
1156 */
1157 private shallUpdateTaskFunctionWorkerUsage (workerNodeKey: number): boolean {
1158 const workerInfo = this.getWorkerInfo(workerNodeKey)
1159 return (
1160 workerInfo != null &&
1161 Array.isArray(workerInfo.taskFunctionNames) &&
1162 workerInfo.taskFunctionNames.length > 2
1163 )
1164 }
1165
1166 /**
1167 * Chooses a worker node for the next task.
1168 *
1169 * The default worker choice strategy uses a round robin algorithm to distribute the tasks.
1170 *
1171 * @returns The chosen worker node key
1172 */
1173 private chooseWorkerNode (): number {
1174 if (this.shallCreateDynamicWorker()) {
1175 const workerNodeKey = this.createAndSetupDynamicWorkerNode()
1176 if (
1177 this.workerChoiceStrategyContext?.getStrategyPolicy()
1178 .dynamicWorkerUsage === true
1179 ) {
1180 return workerNodeKey
1181 }
1182 }
1183 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1184 return this.workerChoiceStrategyContext!.execute()
1185 }
1186
1187 /**
1188 * Conditions for dynamic worker creation.
1189 *
1190 * @returns Whether to create a dynamic worker or not.
1191 */
1192 protected abstract shallCreateDynamicWorker (): boolean
1193
1194 /**
1195 * Sends a message to worker given its worker node key.
1196 *
1197 * @param workerNodeKey - The worker node key.
1198 * @param message - The message.
1199 * @param transferList - The optional array of transferable objects.
1200 */
1201 protected abstract sendToWorker (
1202 workerNodeKey: number,
1203 message: MessageValue<Data>,
1204 transferList?: TransferListItem[]
1205 ): void
1206
1207 /**
1208 * Creates a new, completely set up worker node.
1209 *
1210 * @returns New, completely set up worker node key.
1211 */
1212 protected createAndSetupWorkerNode (): number {
1213 const workerNode = this.createWorkerNode()
1214 workerNode.registerWorkerEventHandler(
1215 'online',
1216 this.opts.onlineHandler ?? EMPTY_FUNCTION
1217 )
1218 workerNode.registerWorkerEventHandler(
1219 'message',
1220 this.opts.messageHandler ?? EMPTY_FUNCTION
1221 )
1222 workerNode.registerWorkerEventHandler(
1223 'error',
1224 this.opts.errorHandler ?? EMPTY_FUNCTION
1225 )
1226 workerNode.registerWorkerEventHandler('error', (error: Error) => {
1227 workerNode.info.ready = false
1228 this.emitter?.emit(PoolEvents.error, error)
1229 if (
1230 this.started &&
1231 !this.destroying &&
1232 this.opts.restartWorkerOnError === true
1233 ) {
1234 if (workerNode.info.dynamic) {
1235 this.createAndSetupDynamicWorkerNode()
1236 } else {
1237 this.createAndSetupWorkerNode()
1238 }
1239 }
1240 if (
1241 this.started &&
1242 !this.destroying &&
1243 this.opts.enableTasksQueue === true
1244 ) {
1245 this.redistributeQueuedTasks(this.workerNodes.indexOf(workerNode))
1246 }
1247 workerNode.terminate().catch(error => {
1248 this.emitter?.emit(PoolEvents.error, error)
1249 })
1250 })
1251 workerNode.registerWorkerEventHandler(
1252 'exit',
1253 this.opts.exitHandler ?? EMPTY_FUNCTION
1254 )
1255 workerNode.registerOnceWorkerEventHandler('exit', () => {
1256 this.removeWorkerNode(workerNode)
1257 })
1258 const workerNodeKey = this.addWorkerNode(workerNode)
1259 this.afterWorkerNodeSetup(workerNodeKey)
1260 return workerNodeKey
1261 }
1262
1263 /**
1264 * Creates a new, completely set up dynamic worker node.
1265 *
1266 * @returns New, completely set up dynamic worker node key.
1267 */
1268 protected createAndSetupDynamicWorkerNode (): number {
1269 const workerNodeKey = this.createAndSetupWorkerNode()
1270 this.registerWorkerMessageListener(workerNodeKey, message => {
1271 this.checkMessageWorkerId(message)
1272 const localWorkerNodeKey = this.getWorkerNodeKeyByWorkerId(
1273 message.workerId
1274 )
1275 const workerUsage = this.workerNodes[localWorkerNodeKey].usage
1276 // Kill message received from worker
1277 if (
1278 isKillBehavior(KillBehaviors.HARD, message.kill) ||
1279 (isKillBehavior(KillBehaviors.SOFT, message.kill) &&
1280 ((this.opts.enableTasksQueue === false &&
1281 workerUsage.tasks.executing === 0) ||
1282 (this.opts.enableTasksQueue === true &&
1283 workerUsage.tasks.executing === 0 &&
1284 this.tasksQueueSize(localWorkerNodeKey) === 0)))
1285 ) {
1286 // Flag the worker node as not ready immediately
1287 this.flagWorkerNodeAsNotReady(localWorkerNodeKey)
1288 this.destroyWorkerNode(localWorkerNodeKey).catch(error => {
1289 this.emitter?.emit(PoolEvents.error, error)
1290 })
1291 }
1292 })
1293 this.sendToWorker(workerNodeKey, {
1294 checkActive: true
1295 })
1296 if (this.taskFunctions.size > 0) {
1297 for (const [taskFunctionName, taskFunction] of this.taskFunctions) {
1298 this.sendTaskFunctionOperationToWorker(workerNodeKey, {
1299 taskFunctionOperation: 'add',
1300 taskFunctionName,
1301 taskFunction: taskFunction.toString()
1302 }).catch(error => {
1303 this.emitter?.emit(PoolEvents.error, error)
1304 })
1305 }
1306 }
1307 const workerNode = this.workerNodes[workerNodeKey]
1308 workerNode.info.dynamic = true
1309 if (
1310 this.workerChoiceStrategyContext?.getStrategyPolicy()
1311 .dynamicWorkerReady === true ||
1312 this.workerChoiceStrategyContext?.getStrategyPolicy()
1313 .dynamicWorkerUsage === true
1314 ) {
1315 workerNode.info.ready = true
1316 }
1317 this.checkAndEmitDynamicWorkerCreationEvents()
1318 return workerNodeKey
1319 }
1320
1321 /**
1322 * Registers a listener callback on the worker given its worker node key.
1323 *
1324 * @param workerNodeKey - The worker node key.
1325 * @param listener - The message listener callback.
1326 */
1327 protected abstract registerWorkerMessageListener<
1328 Message extends Data | Response
1329 >(
1330 workerNodeKey: number,
1331 listener: (message: MessageValue<Message>) => void
1332 ): void
1333
1334 /**
1335 * Registers once a listener callback on the worker given its worker node key.
1336 *
1337 * @param workerNodeKey - The worker node key.
1338 * @param listener - The message listener callback.
1339 */
1340 protected abstract registerOnceWorkerMessageListener<
1341 Message extends Data | Response
1342 >(
1343 workerNodeKey: number,
1344 listener: (message: MessageValue<Message>) => void
1345 ): void
1346
1347 /**
1348 * Deregisters a listener callback on the worker given its worker node key.
1349 *
1350 * @param workerNodeKey - The worker node key.
1351 * @param listener - The message listener callback.
1352 */
1353 protected abstract deregisterWorkerMessageListener<
1354 Message extends Data | Response
1355 >(
1356 workerNodeKey: number,
1357 listener: (message: MessageValue<Message>) => void
1358 ): void
1359
1360 /**
1361 * Method hooked up after a worker node has been newly created.
1362 * Can be overridden.
1363 *
1364 * @param workerNodeKey - The newly created worker node key.
1365 */
1366 protected afterWorkerNodeSetup (workerNodeKey: number): void {
1367 // Listen to worker messages.
1368 this.registerWorkerMessageListener(
1369 workerNodeKey,
1370 this.workerMessageListener
1371 )
1372 // Send the startup message to worker.
1373 this.sendStartupMessageToWorker(workerNodeKey)
1374 // Send the statistics message to worker.
1375 this.sendStatisticsMessageToWorker(workerNodeKey)
1376 if (this.opts.enableTasksQueue === true) {
1377 if (this.opts.tasksQueueOptions?.taskStealing === true) {
1378 this.workerNodes[workerNodeKey].on(
1379 'idle',
1380 this.handleWorkerNodeIdleEvent
1381 )
1382 }
1383 if (this.opts.tasksQueueOptions?.tasksStealingOnBackPressure === true) {
1384 this.workerNodes[workerNodeKey].on(
1385 'backPressure',
1386 this.handleWorkerNodeBackPressureEvent
1387 )
1388 }
1389 }
1390 }
1391
1392 /**
1393 * Sends the startup message to worker given its worker node key.
1394 *
1395 * @param workerNodeKey - The worker node key.
1396 */
1397 protected abstract sendStartupMessageToWorker (workerNodeKey: number): void
1398
1399 /**
1400 * Sends the statistics message to worker given its worker node key.
1401 *
1402 * @param workerNodeKey - The worker node key.
1403 */
1404 private sendStatisticsMessageToWorker (workerNodeKey: number): void {
1405 this.sendToWorker(workerNodeKey, {
1406 statistics: {
1407 runTime:
1408 this.workerChoiceStrategyContext?.getTaskStatisticsRequirements()
1409 ?.runTime.aggregate ?? false,
1410 elu:
1411 this.workerChoiceStrategyContext?.getTaskStatisticsRequirements()?.elu
1412 .aggregate ?? false
1413 }
1414 })
1415 }
1416
1417 private cannotStealTask (): boolean {
1418 return this.workerNodes.length <= 1 || this.info.queuedTasks === 0
1419 }
1420
1421 private handleTask (workerNodeKey: number, task: Task<Data>): void {
1422 if (this.shallExecuteTask(workerNodeKey)) {
1423 this.executeTask(workerNodeKey, task)
1424 } else {
1425 this.enqueueTask(workerNodeKey, task)
1426 }
1427 }
1428
1429 private redistributeQueuedTasks (workerNodeKey: number): void {
1430 if (workerNodeKey === -1 || this.cannotStealTask()) {
1431 return
1432 }
1433 while (this.tasksQueueSize(workerNodeKey) > 0) {
1434 const destinationWorkerNodeKey = this.workerNodes.reduce(
1435 (minWorkerNodeKey, workerNode, workerNodeKey, workerNodes) => {
1436 return workerNode.info.ready &&
1437 workerNode.usage.tasks.queued <
1438 workerNodes[minWorkerNodeKey].usage.tasks.queued
1439 ? workerNodeKey
1440 : minWorkerNodeKey
1441 },
1442 0
1443 )
1444 this.handleTask(
1445 destinationWorkerNodeKey,
1446 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1447 this.dequeueTask(workerNodeKey)!
1448 )
1449 }
1450 }
1451
1452 private updateTaskStolenStatisticsWorkerUsage (
1453 workerNodeKey: number,
1454 taskName: string
1455 ): void {
1456 const workerNode = this.workerNodes[workerNodeKey]
1457 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1458 if (workerNode?.usage != null) {
1459 ++workerNode.usage.tasks.stolen
1460 }
1461 if (
1462 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
1463 workerNode.getTaskFunctionWorkerUsage(taskName) != null
1464 ) {
1465 const taskFunctionWorkerUsage =
1466 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1467 workerNode.getTaskFunctionWorkerUsage(taskName)!
1468 ++taskFunctionWorkerUsage.tasks.stolen
1469 }
1470 }
1471
1472 private updateTaskSequentiallyStolenStatisticsWorkerUsage (
1473 workerNodeKey: number
1474 ): void {
1475 const workerNode = this.workerNodes[workerNodeKey]
1476 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1477 if (workerNode?.usage != null) {
1478 ++workerNode.usage.tasks.sequentiallyStolen
1479 }
1480 }
1481
1482 private updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage (
1483 workerNodeKey: number,
1484 taskName: string
1485 ): void {
1486 const workerNode = this.workerNodes[workerNodeKey]
1487 if (
1488 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
1489 workerNode.getTaskFunctionWorkerUsage(taskName) != null
1490 ) {
1491 const taskFunctionWorkerUsage =
1492 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1493 workerNode.getTaskFunctionWorkerUsage(taskName)!
1494 ++taskFunctionWorkerUsage.tasks.sequentiallyStolen
1495 }
1496 }
1497
1498 private resetTaskSequentiallyStolenStatisticsWorkerUsage (
1499 workerNodeKey: number
1500 ): void {
1501 const workerNode = this.workerNodes[workerNodeKey]
1502 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1503 if (workerNode?.usage != null) {
1504 workerNode.usage.tasks.sequentiallyStolen = 0
1505 }
1506 }
1507
1508 private resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage (
1509 workerNodeKey: number,
1510 taskName: string
1511 ): void {
1512 const workerNode = this.workerNodes[workerNodeKey]
1513 if (
1514 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
1515 workerNode.getTaskFunctionWorkerUsage(taskName) != null
1516 ) {
1517 const taskFunctionWorkerUsage =
1518 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1519 workerNode.getTaskFunctionWorkerUsage(taskName)!
1520 taskFunctionWorkerUsage.tasks.sequentiallyStolen = 0
1521 }
1522 }
1523
1524 private readonly handleWorkerNodeIdleEvent = (
1525 eventDetail: WorkerNodeEventDetail,
1526 previousStolenTask?: Task<Data>
1527 ): void => {
1528 const { workerNodeKey } = eventDetail
1529 if (workerNodeKey == null) {
1530 throw new Error(
1531 "WorkerNode event detail 'workerNodeKey' property must be defined"
1532 )
1533 }
1534 const workerInfo = this.getWorkerInfo(workerNodeKey)
1535 if (
1536 this.cannotStealTask() ||
1537 (this.info.stealingWorkerNodes ?? 0) >
1538 Math.floor(this.workerNodes.length / 2)
1539 ) {
1540 if (workerInfo != null && previousStolenTask != null) {
1541 workerInfo.stealing = false
1542 }
1543 return
1544 }
1545 const workerNodeTasksUsage = this.workerNodes[workerNodeKey].usage.tasks
1546 if (
1547 workerInfo != null &&
1548 previousStolenTask != null &&
1549 workerNodeTasksUsage.sequentiallyStolen > 0 &&
1550 (workerNodeTasksUsage.executing > 0 ||
1551 this.tasksQueueSize(workerNodeKey) > 0)
1552 ) {
1553 workerInfo.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 if (workerInfo == null) {
1566 throw new Error(
1567 `Worker node with key '${workerNodeKey}' not found in pool`
1568 )
1569 }
1570 workerInfo.stealing = true
1571 const stolenTask = this.workerNodeStealTask(workerNodeKey)
1572 if (
1573 this.shallUpdateTaskFunctionWorkerUsage(workerNodeKey) &&
1574 stolenTask != null
1575 ) {
1576 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1577 const taskFunctionTasksWorkerUsage = this.workerNodes[
1578 workerNodeKey
1579 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1580 ].getTaskFunctionWorkerUsage(stolenTask.name!)!.tasks
1581 if (
1582 taskFunctionTasksWorkerUsage.sequentiallyStolen === 0 ||
1583 (previousStolenTask != null &&
1584 previousStolenTask.name === stolenTask.name &&
1585 taskFunctionTasksWorkerUsage.sequentiallyStolen > 0)
1586 ) {
1587 this.updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(
1588 workerNodeKey,
1589 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1590 stolenTask.name!
1591 )
1592 } else {
1593 this.resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(
1594 workerNodeKey,
1595 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1596 stolenTask.name!
1597 )
1598 }
1599 }
1600 sleep(exponentialDelay(workerNodeTasksUsage.sequentiallyStolen))
1601 .then(() => {
1602 this.handleWorkerNodeIdleEvent(eventDetail, stolenTask)
1603 return undefined
1604 })
1605 .catch(EMPTY_FUNCTION)
1606 }
1607
1608 private readonly workerNodeStealTask = (
1609 workerNodeKey: number
1610 ): Task<Data> | undefined => {
1611 const workerNodes = this.workerNodes
1612 .slice()
1613 .sort(
1614 (workerNodeA, workerNodeB) =>
1615 workerNodeB.usage.tasks.queued - workerNodeA.usage.tasks.queued
1616 )
1617 const sourceWorkerNode = workerNodes.find(
1618 (sourceWorkerNode, sourceWorkerNodeKey) =>
1619 sourceWorkerNode.info.ready &&
1620 !sourceWorkerNode.info.stealing &&
1621 sourceWorkerNodeKey !== workerNodeKey &&
1622 sourceWorkerNode.usage.tasks.queued > 0
1623 )
1624 if (sourceWorkerNode != null) {
1625 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1626 const task = sourceWorkerNode.popTask()!
1627 this.handleTask(workerNodeKey, task)
1628 this.updateTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey)
1629 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1630 this.updateTaskStolenStatisticsWorkerUsage(workerNodeKey, task.name!)
1631 return task
1632 }
1633 }
1634
1635 private readonly handleWorkerNodeBackPressureEvent = (
1636 eventDetail: WorkerNodeEventDetail
1637 ): void => {
1638 if (
1639 this.cannotStealTask() ||
1640 (this.info.stealingWorkerNodes ?? 0) >
1641 Math.floor(this.workerNodes.length / 2)
1642 ) {
1643 return
1644 }
1645 const { workerId } = eventDetail
1646 const sizeOffset = 1
1647 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1648 if (this.opts.tasksQueueOptions!.size! <= sizeOffset) {
1649 return
1650 }
1651 const sourceWorkerNode =
1652 this.workerNodes[this.getWorkerNodeKeyByWorkerId(workerId)]
1653 const workerNodes = this.workerNodes
1654 .slice()
1655 .sort(
1656 (workerNodeA, workerNodeB) =>
1657 workerNodeA.usage.tasks.queued - workerNodeB.usage.tasks.queued
1658 )
1659 for (const [workerNodeKey, workerNode] of workerNodes.entries()) {
1660 if (
1661 sourceWorkerNode.usage.tasks.queued > 0 &&
1662 workerNode.info.ready &&
1663 !workerNode.info.stealing &&
1664 workerNode.info.id !== workerId &&
1665 workerNode.usage.tasks.queued <
1666 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1667 this.opts.tasksQueueOptions!.size! - sizeOffset
1668 ) {
1669 const workerInfo = this.getWorkerInfo(workerNodeKey)
1670 if (workerInfo == null) {
1671 throw new Error(
1672 `Worker node with key '${workerNodeKey}' not found in pool`
1673 )
1674 }
1675 workerInfo.stealing = true
1676 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1677 const task = sourceWorkerNode.popTask()!
1678 this.handleTask(workerNodeKey, task)
1679 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1680 this.updateTaskStolenStatisticsWorkerUsage(workerNodeKey, task.name!)
1681 workerInfo.stealing = false
1682 }
1683 }
1684 }
1685
1686 /**
1687 * This method is the message listener registered on each worker.
1688 */
1689 protected readonly workerMessageListener = (
1690 message: MessageValue<Response>
1691 ): void => {
1692 this.checkMessageWorkerId(message)
1693 const { workerId, ready, taskId, taskFunctionNames } = message
1694 if (ready != null && taskFunctionNames != null) {
1695 // Worker ready response received from worker
1696 this.handleWorkerReadyResponse(message)
1697 } else if (taskId != null) {
1698 // Task execution response received from worker
1699 this.handleTaskExecutionResponse(message)
1700 } else if (taskFunctionNames != null) {
1701 // Task function names message received from worker
1702 const workerInfo = this.getWorkerInfo(
1703 this.getWorkerNodeKeyByWorkerId(workerId)
1704 )
1705 if (workerInfo != null) {
1706 workerInfo.taskFunctionNames = taskFunctionNames
1707 }
1708 }
1709 }
1710
1711 private handleWorkerReadyResponse (message: MessageValue<Response>): void {
1712 const { workerId, ready, taskFunctionNames } = message
1713 if (ready == null || !ready) {
1714 throw new Error(`Worker ${workerId} failed to initialize`)
1715 }
1716 const workerNode =
1717 this.workerNodes[this.getWorkerNodeKeyByWorkerId(workerId)]
1718 workerNode.info.ready = ready
1719 workerNode.info.taskFunctionNames = taskFunctionNames
1720 if (!this.readyEventEmitted && this.ready) {
1721 this.emitter?.emit(PoolEvents.ready, this.info)
1722 this.readyEventEmitted = true
1723 }
1724 }
1725
1726 private handleTaskExecutionResponse (message: MessageValue<Response>): void {
1727 const { workerId, taskId, workerError, data } = message
1728 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1729 const promiseResponse = this.promiseResponseMap.get(taskId!)
1730 if (promiseResponse != null) {
1731 const { resolve, reject, workerNodeKey, asyncResource } = promiseResponse
1732 const workerNode = this.workerNodes[workerNodeKey]
1733 if (workerError != null) {
1734 this.emitter?.emit(PoolEvents.taskError, workerError)
1735 asyncResource != null
1736 ? asyncResource.runInAsyncScope(
1737 reject,
1738 this.emitter,
1739 workerError.message
1740 )
1741 : reject(workerError.message)
1742 } else {
1743 asyncResource != null
1744 ? asyncResource.runInAsyncScope(resolve, this.emitter, data)
1745 : resolve(data as Response)
1746 }
1747 asyncResource?.emitDestroy()
1748 this.afterTaskExecutionHook(workerNodeKey, message)
1749 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1750 this.promiseResponseMap.delete(taskId!)
1751 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
1752 workerNode?.emit('taskFinished', taskId)
1753 if (this.opts.enableTasksQueue === true && !this.destroying) {
1754 const workerNodeTasksUsage = workerNode.usage.tasks
1755 if (
1756 this.tasksQueueSize(workerNodeKey) > 0 &&
1757 workerNodeTasksUsage.executing <
1758 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1759 this.opts.tasksQueueOptions!.concurrency!
1760 ) {
1761 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1762 this.executeTask(workerNodeKey, this.dequeueTask(workerNodeKey)!)
1763 }
1764 if (
1765 workerNodeTasksUsage.executing === 0 &&
1766 this.tasksQueueSize(workerNodeKey) === 0 &&
1767 workerNodeTasksUsage.sequentiallyStolen === 0
1768 ) {
1769 workerNode.emit('idle', {
1770 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1771 workerId: workerId!,
1772 workerNodeKey
1773 })
1774 }
1775 }
1776 }
1777 }
1778
1779 private checkAndEmitTaskExecutionEvents (): void {
1780 if (this.busy) {
1781 this.emitter?.emit(PoolEvents.busy, this.info)
1782 }
1783 }
1784
1785 private checkAndEmitTaskQueuingEvents (): void {
1786 if (this.hasBackPressure()) {
1787 this.emitter?.emit(PoolEvents.backPressure, this.info)
1788 }
1789 }
1790
1791 /**
1792 * Emits dynamic worker creation events.
1793 */
1794 protected abstract checkAndEmitDynamicWorkerCreationEvents (): void
1795
1796 /**
1797 * Gets the worker information given its worker node key.
1798 *
1799 * @param workerNodeKey - The worker node key.
1800 * @returns The worker information.
1801 */
1802 protected getWorkerInfo (workerNodeKey: number): WorkerInfo | undefined {
1803 return this.workerNodes[workerNodeKey]?.info
1804 }
1805
1806 /**
1807 * Creates a worker node.
1808 *
1809 * @returns The created worker node.
1810 */
1811 private createWorkerNode (): IWorkerNode<Worker, Data> {
1812 const workerNode = new WorkerNode<Worker, Data>(
1813 this.worker,
1814 this.filePath,
1815 {
1816 env: this.opts.env,
1817 workerOptions: this.opts.workerOptions,
1818 tasksQueueBackPressureSize:
1819 this.opts.tasksQueueOptions?.size ??
1820 getDefaultTasksQueueOptions(
1821 this.maximumNumberOfWorkers ?? this.minimumNumberOfWorkers
1822 ).size
1823 }
1824 )
1825 // Flag the worker node as ready at pool startup.
1826 if (this.starting) {
1827 workerNode.info.ready = true
1828 }
1829 return workerNode
1830 }
1831
1832 /**
1833 * Adds the given worker node in the pool worker nodes.
1834 *
1835 * @param workerNode - The worker node.
1836 * @returns The added worker node key.
1837 * @throws {@link https://nodejs.org/api/errors.html#class-error} If the added worker node is not found.
1838 */
1839 private addWorkerNode (workerNode: IWorkerNode<Worker, Data>): number {
1840 this.workerNodes.push(workerNode)
1841 const workerNodeKey = this.workerNodes.indexOf(workerNode)
1842 if (workerNodeKey === -1) {
1843 throw new Error('Worker added not found in worker nodes')
1844 }
1845 return workerNodeKey
1846 }
1847
1848 /**
1849 * Removes the worker node from the pool worker nodes.
1850 *
1851 * @param workerNode - The worker node.
1852 */
1853 private removeWorkerNode (workerNode: IWorkerNode<Worker, Data>): void {
1854 const workerNodeKey = this.workerNodes.indexOf(workerNode)
1855 if (workerNodeKey !== -1) {
1856 this.workerNodes.splice(workerNodeKey, 1)
1857 this.workerChoiceStrategyContext?.remove(workerNodeKey)
1858 }
1859 }
1860
1861 protected flagWorkerNodeAsNotReady (workerNodeKey: number): void {
1862 const workerInfo = this.getWorkerInfo(workerNodeKey)
1863 if (workerInfo != null) {
1864 workerInfo.ready = false
1865 }
1866 }
1867
1868 private hasBackPressure (): boolean {
1869 return (
1870 this.opts.enableTasksQueue === true &&
1871 this.workerNodes.findIndex(
1872 workerNode => !workerNode.hasBackPressure()
1873 ) === -1
1874 )
1875 }
1876
1877 /**
1878 * Executes the given task on the worker given its worker node key.
1879 *
1880 * @param workerNodeKey - The worker node key.
1881 * @param task - The task to execute.
1882 */
1883 private executeTask (workerNodeKey: number, task: Task<Data>): void {
1884 this.beforeTaskExecutionHook(workerNodeKey, task)
1885 this.sendToWorker(workerNodeKey, task, task.transferList)
1886 this.checkAndEmitTaskExecutionEvents()
1887 }
1888
1889 private enqueueTask (workerNodeKey: number, task: Task<Data>): number {
1890 const tasksQueueSize = this.workerNodes[workerNodeKey].enqueueTask(task)
1891 this.checkAndEmitTaskQueuingEvents()
1892 return tasksQueueSize
1893 }
1894
1895 private dequeueTask (workerNodeKey: number): Task<Data> | undefined {
1896 return this.workerNodes[workerNodeKey].dequeueTask()
1897 }
1898
1899 private tasksQueueSize (workerNodeKey: number): number {
1900 return this.workerNodes[workerNodeKey].tasksQueueSize()
1901 }
1902
1903 protected flushTasksQueue (workerNodeKey: number): number {
1904 let flushedTasks = 0
1905 while (this.tasksQueueSize(workerNodeKey) > 0) {
1906 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
1907 this.executeTask(workerNodeKey, this.dequeueTask(workerNodeKey)!)
1908 ++flushedTasks
1909 }
1910 this.workerNodes[workerNodeKey].clearTasksQueue()
1911 return flushedTasks
1912 }
1913
1914 private flushTasksQueues (): void {
1915 for (const [workerNodeKey] of this.workerNodes.entries()) {
1916 this.flushTasksQueue(workerNodeKey)
1917 }
1918 }
1919 }