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