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