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