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