1 import { randomUUID
} from
'node:crypto'
2 import { performance
} from
'node:perf_hooks'
3 import { existsSync
} from
'node:fs'
6 PromiseResponseWrapper
,
8 } from
'../utility-types'
11 DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
,
18 updateMeasurementStatistics
20 import { KillBehaviors
} from
'../worker/worker-options'
29 type TasksQueueOptions
39 type MeasurementStatisticsRequirements
,
41 WorkerChoiceStrategies
,
42 type WorkerChoiceStrategy
,
43 type WorkerChoiceStrategyOptions
44 } from
'./selection-strategies/selection-strategies-types'
45 import { WorkerChoiceStrategyContext
} from
'./selection-strategies/worker-choice-strategy-context'
46 import { version
} from
'./version'
47 import { WorkerNode
} from
'./worker-node'
50 * Base class that implements some shared logic for all poolifier pools.
52 * @typeParam Worker - Type of worker which manages this pool.
53 * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
54 * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
56 export abstract class AbstractPool
<
57 Worker
extends IWorker
,
60 > implements IPool
<Worker
, Data
, Response
> {
62 public readonly workerNodes
: Array<IWorkerNode
<Worker
, Data
>> = []
65 public readonly emitter
?: PoolEmitter
68 * The task execution response promise map.
70 * - `key`: The message id of each submitted task.
71 * - `value`: An object that contains the worker, the execution response promise resolve and reject callbacks.
73 * When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
75 protected promiseResponseMap
: Map
<string, PromiseResponseWrapper
<Response
>> =
76 new Map
<string, PromiseResponseWrapper
<Response
>>()
79 * Worker choice strategy context referencing a worker choice algorithm implementation.
81 protected workerChoiceStrategyContext
: WorkerChoiceStrategyContext
<
88 * Whether the pool is starting or not.
90 private readonly starting
: boolean
92 * The start timestamp of the pool.
94 private readonly startTimestamp
97 * Constructs a new poolifier pool.
99 * @param numberOfWorkers - Number of workers that this pool should manage.
100 * @param filePath - Path to the worker file.
101 * @param opts - Options for the pool.
104 protected readonly numberOfWorkers
: number,
105 protected readonly filePath
: string,
106 protected readonly opts
: PoolOptions
<Worker
>
108 if (!this.isMain()) {
109 throw new Error('Cannot start a pool from a worker!')
111 this.checkNumberOfWorkers(this.numberOfWorkers
)
112 this.checkFilePath(this.filePath
)
113 this.checkPoolOptions(this.opts
)
115 this.chooseWorkerNode
= this.chooseWorkerNode
.bind(this)
116 this.executeTask
= this.executeTask
.bind(this)
117 this.enqueueTask
= this.enqueueTask
.bind(this)
118 this.dequeueTask
= this.dequeueTask
.bind(this)
119 this.checkAndEmitEvents
= this.checkAndEmitEvents
.bind(this)
121 if (this.opts
.enableEvents
=== true) {
122 this.emitter
= new PoolEmitter()
124 this.workerChoiceStrategyContext
= new WorkerChoiceStrategyContext
<
130 this.opts
.workerChoiceStrategy
,
131 this.opts
.workerChoiceStrategyOptions
138 this.starting
= false
140 this.startTimestamp
= performance
.now()
143 private checkFilePath (filePath
: string): void {
146 typeof filePath
!== 'string' ||
147 (typeof filePath
=== 'string' && filePath
.trim().length
=== 0)
149 throw new Error('Please specify a file with a worker implementation')
151 if (!existsSync(filePath
)) {
152 throw new Error(`Cannot find the worker file '${filePath}'`)
156 private checkNumberOfWorkers (numberOfWorkers
: number): void {
157 if (numberOfWorkers
== null) {
159 'Cannot instantiate a pool without specifying the number of workers'
161 } else if (!Number.isSafeInteger(numberOfWorkers
)) {
163 'Cannot instantiate a pool with a non safe integer number of workers'
165 } else if (numberOfWorkers
< 0) {
166 throw new RangeError(
167 'Cannot instantiate a pool with a negative number of workers'
169 } else if (this.type === PoolTypes
.fixed
&& numberOfWorkers
=== 0) {
170 throw new RangeError('Cannot instantiate a fixed pool with zero worker')
174 protected checkDynamicPoolSize (min
: number, max
: number): void {
175 if (this.type === PoolTypes
.dynamic
) {
178 'Cannot instantiate a dynamic pool without specifying the maximum pool size'
180 } else if (!Number.isSafeInteger(max
)) {
182 'Cannot instantiate a dynamic pool with a non safe integer maximum pool size'
184 } else if (min
> max
) {
185 throw new RangeError(
186 'Cannot instantiate a dynamic pool with a maximum pool size inferior to the minimum pool size'
188 } else if (max
=== 0) {
189 throw new RangeError(
190 'Cannot instantiate a dynamic pool with a pool size equal to zero'
192 } else if (min
=== max
) {
193 throw new RangeError(
194 'Cannot instantiate a dynamic pool with a minimum pool size equal to the maximum pool size. Use a fixed pool instead'
200 private checkPoolOptions (opts
: PoolOptions
<Worker
>): void {
201 if (isPlainObject(opts
)) {
202 this.opts
.workerChoiceStrategy
=
203 opts
.workerChoiceStrategy
?? WorkerChoiceStrategies
.ROUND_ROBIN
204 this.checkValidWorkerChoiceStrategy(this.opts
.workerChoiceStrategy
)
205 this.opts
.workerChoiceStrategyOptions
=
206 opts
.workerChoiceStrategyOptions
??
207 DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
208 this.checkValidWorkerChoiceStrategyOptions(
209 this.opts
.workerChoiceStrategyOptions
211 this.opts
.restartWorkerOnError
= opts
.restartWorkerOnError
?? true
212 this.opts
.enableEvents
= opts
.enableEvents
?? true
213 this.opts
.enableTasksQueue
= opts
.enableTasksQueue
?? false
214 if (this.opts
.enableTasksQueue
) {
215 this.checkValidTasksQueueOptions(
216 opts
.tasksQueueOptions
as TasksQueueOptions
218 this.opts
.tasksQueueOptions
= this.buildTasksQueueOptions(
219 opts
.tasksQueueOptions
as TasksQueueOptions
223 throw new TypeError('Invalid pool options: must be a plain object')
227 private checkValidWorkerChoiceStrategy (
228 workerChoiceStrategy
: WorkerChoiceStrategy
230 if (!Object.values(WorkerChoiceStrategies
).includes(workerChoiceStrategy
)) {
232 `Invalid worker choice strategy '${workerChoiceStrategy}'`
237 private checkValidWorkerChoiceStrategyOptions (
238 workerChoiceStrategyOptions
: WorkerChoiceStrategyOptions
240 if (!isPlainObject(workerChoiceStrategyOptions
)) {
242 'Invalid worker choice strategy options: must be a plain object'
246 workerChoiceStrategyOptions
.weights
!= null &&
247 Object.keys(workerChoiceStrategyOptions
.weights
).length
!== this.maxSize
250 'Invalid worker choice strategy options: must have a weight for each worker node'
254 workerChoiceStrategyOptions
.measurement
!= null &&
255 !Object.values(Measurements
).includes(
256 workerChoiceStrategyOptions
.measurement
260 `Invalid worker choice strategy options: invalid measurement '${workerChoiceStrategyOptions.measurement}'`
265 private checkValidTasksQueueOptions (
266 tasksQueueOptions
: TasksQueueOptions
268 if (tasksQueueOptions
!= null && !isPlainObject(tasksQueueOptions
)) {
269 throw new TypeError('Invalid tasks queue options: must be a plain object')
272 tasksQueueOptions
?.concurrency
!= null &&
273 !Number.isSafeInteger(tasksQueueOptions
.concurrency
)
276 'Invalid worker tasks concurrency: must be an integer'
280 tasksQueueOptions
?.concurrency
!= null &&
281 tasksQueueOptions
.concurrency
<= 0
284 `Invalid worker tasks concurrency '${tasksQueueOptions.concurrency}'`
289 private startPool (): void {
291 this.workerNodes
.reduce(
292 (accumulator
, workerNode
) =>
293 !workerNode
.info
.dynamic
? accumulator
+ 1 : accumulator
,
295 ) < this.numberOfWorkers
297 this.createAndSetupWorkerNode()
302 public get
info (): PoolInfo
{
308 strategy
: this.opts
.workerChoiceStrategy
as WorkerChoiceStrategy
,
309 minSize
: this.minSize
,
310 maxSize
: this.maxSize
,
311 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
312 .runTime
.aggregate
&&
313 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
314 .waitTime
.aggregate
&& { utilization
: round(this.utilization
) }),
315 workerNodes
: this.workerNodes
.length
,
316 idleWorkerNodes
: this.workerNodes
.reduce(
317 (accumulator
, workerNode
) =>
318 workerNode
.usage
.tasks
.executing
=== 0
323 busyWorkerNodes
: this.workerNodes
.reduce(
324 (accumulator
, workerNode
) =>
325 workerNode
.usage
.tasks
.executing
> 0 ? accumulator
+ 1 : accumulator
,
328 executedTasks
: this.workerNodes
.reduce(
329 (accumulator
, workerNode
) =>
330 accumulator
+ workerNode
.usage
.tasks
.executed
,
333 executingTasks
: this.workerNodes
.reduce(
334 (accumulator
, workerNode
) =>
335 accumulator
+ workerNode
.usage
.tasks
.executing
,
338 queuedTasks
: this.workerNodes
.reduce(
339 (accumulator
, workerNode
) =>
340 accumulator
+ workerNode
.usage
.tasks
.queued
,
343 maxQueuedTasks
: this.workerNodes
.reduce(
344 (accumulator
, workerNode
) =>
345 accumulator
+ (workerNode
.usage
.tasks
?.maxQueued
?? 0),
348 failedTasks
: this.workerNodes
.reduce(
349 (accumulator
, workerNode
) =>
350 accumulator
+ workerNode
.usage
.tasks
.failed
,
353 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
354 .runTime
.aggregate
&& {
358 ...this.workerNodes
.map(
359 workerNode
=> workerNode
.usage
.runTime
?.minimum
?? Infinity
365 ...this.workerNodes
.map(
366 workerNode
=> workerNode
.usage
.runTime
?.maximum
?? -Infinity
371 this.workerNodes
.reduce(
372 (accumulator
, workerNode
) =>
373 accumulator
+ (workerNode
.usage
.runTime
?.aggregate
?? 0),
376 this.workerNodes
.reduce(
377 (accumulator
, workerNode
) =>
378 accumulator
+ (workerNode
.usage
.tasks
?.executed
?? 0),
382 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
386 this.workerNodes
.map(
387 workerNode
=> workerNode
.usage
.runTime
?.median
?? 0
394 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
395 .waitTime
.aggregate
&& {
399 ...this.workerNodes
.map(
400 workerNode
=> workerNode
.usage
.waitTime
?.minimum
?? Infinity
406 ...this.workerNodes
.map(
407 workerNode
=> workerNode
.usage
.waitTime
?.maximum
?? -Infinity
412 this.workerNodes
.reduce(
413 (accumulator
, workerNode
) =>
414 accumulator
+ (workerNode
.usage
.waitTime
?.aggregate
?? 0),
417 this.workerNodes
.reduce(
418 (accumulator
, workerNode
) =>
419 accumulator
+ (workerNode
.usage
.tasks
?.executed
?? 0),
423 ...(this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
424 .waitTime
.median
&& {
427 this.workerNodes
.map(
428 workerNode
=> workerNode
.usage
.waitTime
?.median
?? 0
439 * The pool readiness boolean status.
441 private get
ready (): boolean {
443 this.workerNodes
.reduce(
444 (accumulator
, workerNode
) =>
445 !workerNode
.info
.dynamic
&& workerNode
.info
.ready
454 * The approximate pool utilization.
456 * @returns The pool utilization.
458 private get
utilization (): number {
459 const poolTimeCapacity
=
460 (performance
.now() - this.startTimestamp
) * this.maxSize
461 const totalTasksRunTime
= this.workerNodes
.reduce(
462 (accumulator
, workerNode
) =>
463 accumulator
+ (workerNode
.usage
.runTime
?.aggregate
?? 0),
466 const totalTasksWaitTime
= this.workerNodes
.reduce(
467 (accumulator
, workerNode
) =>
468 accumulator
+ (workerNode
.usage
.waitTime
?.aggregate
?? 0),
471 return (totalTasksRunTime
+ totalTasksWaitTime
) / poolTimeCapacity
477 * If it is `'dynamic'`, it provides the `max` property.
479 protected abstract get
type (): PoolType
484 protected abstract get
worker (): WorkerType
487 * The pool minimum size.
489 protected abstract get
minSize (): number
492 * The pool maximum size.
494 protected abstract get
maxSize (): number
497 * Checks if the worker id sent in the received message from a worker is valid.
499 * @param message - The received message.
500 * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker id is invalid.
502 private checkMessageWorkerId (message
: MessageValue
<Response
>): void {
504 message
.workerId
!= null &&
505 this.getWorkerNodeKeyByWorkerId(message
.workerId
) == null
508 `Worker message received from unknown worker '${message.workerId}'`
514 * Gets the given worker its worker node key.
516 * @param worker - The worker.
517 * @returns The worker node key if found in the pool worker nodes, `-1` otherwise.
519 private getWorkerNodeKey (worker
: Worker
): number {
520 return this.workerNodes
.findIndex(
521 workerNode
=> workerNode
.worker
=== worker
526 * Gets the worker node key given its worker id.
528 * @param workerId - The worker id.
529 * @returns The worker node key if the worker id is found in the pool worker nodes, `undefined` otherwise.
531 private getWorkerNodeKeyByWorkerId (workerId
: number): number | undefined {
532 for (const [workerNodeKey
, workerNode
] of this.workerNodes
.entries()) {
533 if (workerNode
.info
.id
=== workerId
) {
540 public setWorkerChoiceStrategy (
541 workerChoiceStrategy
: WorkerChoiceStrategy
,
542 workerChoiceStrategyOptions
?: WorkerChoiceStrategyOptions
544 this.checkValidWorkerChoiceStrategy(workerChoiceStrategy
)
545 this.opts
.workerChoiceStrategy
= workerChoiceStrategy
546 this.workerChoiceStrategyContext
.setWorkerChoiceStrategy(
547 this.opts
.workerChoiceStrategy
549 if (workerChoiceStrategyOptions
!= null) {
550 this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions
)
552 for (const [workerNodeKey
, workerNode
] of this.workerNodes
.entries()) {
553 workerNode
.resetUsage()
554 this.sendWorkerStatisticsMessageToWorker(workerNodeKey
)
559 public setWorkerChoiceStrategyOptions (
560 workerChoiceStrategyOptions
: WorkerChoiceStrategyOptions
562 this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions
)
563 this.opts
.workerChoiceStrategyOptions
= workerChoiceStrategyOptions
564 this.workerChoiceStrategyContext
.setOptions(
565 this.opts
.workerChoiceStrategyOptions
570 public enableTasksQueue (
572 tasksQueueOptions
?: TasksQueueOptions
574 if (this.opts
.enableTasksQueue
=== true && !enable
) {
575 this.flushTasksQueues()
577 this.opts
.enableTasksQueue
= enable
578 this.setTasksQueueOptions(tasksQueueOptions
as TasksQueueOptions
)
582 public setTasksQueueOptions (tasksQueueOptions
: TasksQueueOptions
): void {
583 if (this.opts
.enableTasksQueue
=== true) {
584 this.checkValidTasksQueueOptions(tasksQueueOptions
)
585 this.opts
.tasksQueueOptions
=
586 this.buildTasksQueueOptions(tasksQueueOptions
)
587 } else if (this.opts
.tasksQueueOptions
!= null) {
588 delete this.opts
.tasksQueueOptions
592 private buildTasksQueueOptions (
593 tasksQueueOptions
: TasksQueueOptions
594 ): TasksQueueOptions
{
596 concurrency
: tasksQueueOptions
?.concurrency
?? 1
601 * Whether the pool is full or not.
603 * The pool filling boolean status.
605 protected get
full (): boolean {
606 return this.workerNodes
.length
>= this.maxSize
610 * Whether the pool is busy or not.
612 * The pool busyness boolean status.
614 protected abstract get
busy (): boolean
617 * Whether worker nodes are executing at least one task.
619 * @returns Worker nodes busyness boolean status.
621 protected internalBusy (): boolean {
623 this.workerNodes
.findIndex(workerNode
=> {
624 return workerNode
.usage
.tasks
.executing
=== 0
630 public async execute (data
?: Data
, name
?: string): Promise
<Response
> {
631 return await new Promise
<Response
>((resolve
, reject
) => {
632 const timestamp
= performance
.now()
633 const workerNodeKey
= this.chooseWorkerNode()
634 const task
: Task
<Data
> = {
635 name
: name
?? DEFAULT_TASK_NAME
,
636 // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
637 data
: data
?? ({} as Data
),
639 workerId
: this.getWorkerInfo(workerNodeKey
).id
as number,
642 this.promiseResponseMap
.set(task
.id
as string, {
648 this.opts
.enableTasksQueue
=== true &&
650 this.workerNodes
[workerNodeKey
].usage
.tasks
.executing
>=
651 ((this.opts
.tasksQueueOptions
as TasksQueueOptions
)
652 .concurrency
as number))
654 this.enqueueTask(workerNodeKey
, task
)
656 this.executeTask(workerNodeKey
, task
)
658 this.checkAndEmitEvents()
663 public async destroy (): Promise
<void> {
665 this.workerNodes
.map(async (workerNode
, workerNodeKey
) => {
666 this.flushTasksQueue(workerNodeKey
)
667 // FIXME: wait for tasks to be finished
668 const workerExitPromise
= new Promise
<void>(resolve
=> {
669 workerNode
.worker
.on('exit', () => {
673 await this.destroyWorkerNode(workerNodeKey
)
674 await workerExitPromise
680 * Terminates the worker node given its worker node key.
682 * @param workerNodeKey - The worker node key.
684 protected abstract destroyWorkerNode (
685 workerNodeKey
: number
686 ): void | Promise
<void>
689 * Setup hook to execute code before worker nodes are created in the abstract constructor.
694 protected setupHook (): void {
695 // Intentionally empty
699 * Should return whether the worker is the main worker or not.
701 protected abstract isMain (): boolean
704 * Hook executed before the worker task execution.
707 * @param workerNodeKey - The worker node key.
708 * @param task - The task to execute.
710 protected beforeTaskExecutionHook (
711 workerNodeKey
: number,
714 const workerUsage
= this.workerNodes
[workerNodeKey
].usage
715 ++workerUsage
.tasks
.executing
716 this.updateWaitTimeWorkerUsage(workerUsage
, task
)
717 const taskWorkerUsage
= this.workerNodes
[workerNodeKey
].getTaskWorkerUsage(
720 ++taskWorkerUsage
.tasks
.executing
721 this.updateWaitTimeWorkerUsage(taskWorkerUsage
, task
)
725 * Hook executed after the worker task execution.
728 * @param workerNodeKey - The worker node key.
729 * @param message - The received message.
731 protected afterTaskExecutionHook (
732 workerNodeKey
: number,
733 message
: MessageValue
<Response
>
735 const workerUsage
= this.workerNodes
[workerNodeKey
].usage
736 this.updateTaskStatisticsWorkerUsage(workerUsage
, message
)
737 this.updateRunTimeWorkerUsage(workerUsage
, message
)
738 this.updateEluWorkerUsage(workerUsage
, message
)
739 const taskWorkerUsage
= this.workerNodes
[workerNodeKey
].getTaskWorkerUsage(
740 message
.taskPerformance
?.name
?? DEFAULT_TASK_NAME
742 this.updateTaskStatisticsWorkerUsage(taskWorkerUsage
, message
)
743 this.updateRunTimeWorkerUsage(taskWorkerUsage
, message
)
744 this.updateEluWorkerUsage(taskWorkerUsage
, message
)
747 private updateTaskStatisticsWorkerUsage (
748 workerUsage
: WorkerUsage
,
749 message
: MessageValue
<Response
>
751 const workerTaskStatistics
= workerUsage
.tasks
752 --workerTaskStatistics
.executing
753 if (message
.taskError
== null) {
754 ++workerTaskStatistics
.executed
756 ++workerTaskStatistics
.failed
760 private updateRunTimeWorkerUsage (
761 workerUsage
: WorkerUsage
,
762 message
: MessageValue
<Response
>
764 updateMeasurementStatistics(
766 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements().runTime
,
767 message
.taskPerformance
?.runTime
?? 0,
768 workerUsage
.tasks
.executed
772 private updateWaitTimeWorkerUsage (
773 workerUsage
: WorkerUsage
,
776 const timestamp
= performance
.now()
777 const taskWaitTime
= timestamp
- (task
.timestamp
?? timestamp
)
778 updateMeasurementStatistics(
779 workerUsage
.waitTime
,
780 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements().waitTime
,
782 workerUsage
.tasks
.executed
786 private updateEluWorkerUsage (
787 workerUsage
: WorkerUsage
,
788 message
: MessageValue
<Response
>
790 const eluTaskStatisticsRequirements
: MeasurementStatisticsRequirements
=
791 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements().elu
792 updateMeasurementStatistics(
793 workerUsage
.elu
.active
,
794 eluTaskStatisticsRequirements
,
795 message
.taskPerformance
?.elu
?.active
?? 0,
796 workerUsage
.tasks
.executed
798 updateMeasurementStatistics(
799 workerUsage
.elu
.idle
,
800 eluTaskStatisticsRequirements
,
801 message
.taskPerformance
?.elu
?.idle
?? 0,
802 workerUsage
.tasks
.executed
804 if (eluTaskStatisticsRequirements
.aggregate
) {
805 if (message
.taskPerformance
?.elu
!= null) {
806 if (workerUsage
.elu
.utilization
!= null) {
807 workerUsage
.elu
.utilization
=
808 (workerUsage
.elu
.utilization
+
809 message
.taskPerformance
.elu
.utilization
) /
812 workerUsage
.elu
.utilization
= message
.taskPerformance
.elu
.utilization
819 * Chooses a worker node for the next task.
821 * The default worker choice strategy uses a round robin algorithm to distribute the tasks.
823 * @returns The chosen worker node key
825 private chooseWorkerNode (): number {
826 if (this.shallCreateDynamicWorker()) {
827 const workerNodeKey
= this.createAndSetupDynamicWorkerNode()
829 this.workerChoiceStrategyContext
.getStrategyPolicy().useDynamicWorker
834 return this.workerChoiceStrategyContext
.execute()
838 * Conditions for dynamic worker creation.
840 * @returns Whether to create a dynamic worker or not.
842 private shallCreateDynamicWorker (): boolean {
843 return this.type === PoolTypes
.dynamic
&& !this.full
&& this.internalBusy()
847 * Sends a message to worker given its worker node key.
849 * @param workerNodeKey - The worker node key.
850 * @param message - The message.
852 protected abstract sendToWorker (
853 workerNodeKey
: number,
854 message
: MessageValue
<Data
>
858 * Creates a new worker.
860 * @returns Newly created worker.
862 protected abstract createWorker (): Worker
865 * Creates a new, completely set up worker node.
867 * @returns New, completely set up worker node key.
869 protected createAndSetupWorkerNode (): number {
870 const worker
= this.createWorker()
872 worker
.on('message', this.opts
.messageHandler
?? EMPTY_FUNCTION
)
873 worker
.on('error', this.opts
.errorHandler
?? EMPTY_FUNCTION
)
874 worker
.on('error', error
=> {
875 const workerNodeKey
= this.getWorkerNodeKey(worker
)
876 const workerInfo
= this.getWorkerInfo(workerNodeKey
)
877 workerInfo
.ready
= false
878 this.workerNodes
[workerNodeKey
].closeChannel()
879 this.emitter
?.emit(PoolEvents
.error
, error
)
880 if (this.opts
.restartWorkerOnError
=== true && !this.starting
) {
881 if (workerInfo
.dynamic
) {
882 this.createAndSetupDynamicWorkerNode()
884 this.createAndSetupWorkerNode()
887 if (this.opts
.enableTasksQueue
=== true) {
888 this.redistributeQueuedTasks(workerNodeKey
)
891 worker
.on('online', this.opts
.onlineHandler
?? EMPTY_FUNCTION
)
892 worker
.on('exit', this.opts
.exitHandler
?? EMPTY_FUNCTION
)
893 worker
.once('exit', () => {
894 this.removeWorkerNode(worker
)
897 const workerNodeKey
= this.addWorkerNode(worker
)
899 this.afterWorkerNodeSetup(workerNodeKey
)
905 * Creates a new, completely set up dynamic worker node.
907 * @returns New, completely set up dynamic worker node key.
909 protected createAndSetupDynamicWorkerNode (): number {
910 const workerNodeKey
= this.createAndSetupWorkerNode()
911 this.registerWorkerMessageListener(workerNodeKey
, message
=> {
912 const localWorkerNodeKey
= this.getWorkerNodeKeyByWorkerId(
915 const workerUsage
= this.workerNodes
[localWorkerNodeKey
].usage
917 isKillBehavior(KillBehaviors
.HARD
, message
.kill
) ||
918 (message
.kill
!= null &&
919 ((this.opts
.enableTasksQueue
=== false &&
920 workerUsage
.tasks
.executing
=== 0) ||
921 (this.opts
.enableTasksQueue
=== true &&
922 workerUsage
.tasks
.executing
=== 0 &&
923 this.tasksQueueSize(localWorkerNodeKey
) === 0)))
925 // Kill message received from the worker: no new tasks are submitted to that worker for a while ( > maxInactiveTime)
926 const destroyWorkerNodeBounded
= this.destroyWorkerNode
.bind(this)
927 if (isAsyncFunction(destroyWorkerNodeBounded
)) {
929 destroyWorkerNodeBounded
as (workerNodeKey
: number) => Promise
<void>
930 )(localWorkerNodeKey
).catch(EMPTY_FUNCTION
)
932 (destroyWorkerNodeBounded
as (workerNodeKey
: number) => void)(
938 const workerInfo
= this.getWorkerInfo(workerNodeKey
)
939 workerInfo
.dynamic
= true
940 if (this.workerChoiceStrategyContext
.getStrategyPolicy().useDynamicWorker
) {
941 workerInfo
.ready
= true
943 this.sendToWorker(workerNodeKey
, {
945 workerId
: workerInfo
.id
as number
951 * Registers a listener callback on the worker given its worker node key.
953 * @param workerNodeKey - The worker node key.
954 * @param listener - The message listener callback.
956 protected abstract registerWorkerMessageListener
<
957 Message
extends Data
| Response
959 workerNodeKey
: number,
960 listener
: (message
: MessageValue
<Message
>) => void
964 * Method hooked up after a worker node has been newly created.
967 * @param workerNodeKey - The newly created worker node key.
969 protected afterWorkerNodeSetup (workerNodeKey
: number): void {
970 // Listen to worker messages.
971 this.registerWorkerMessageListener(workerNodeKey
, this.workerListener())
972 // Send the startup message to worker.
973 this.sendStartupMessageToWorker(workerNodeKey
)
974 // Send the worker statistics message to worker.
975 this.sendWorkerStatisticsMessageToWorker(workerNodeKey
)
979 * Sends the startup message to worker given its worker node key.
981 * @param workerNodeKey - The worker node key.
983 protected abstract sendStartupMessageToWorker (workerNodeKey
: number): void
986 * Sends the worker statistics message to worker given its worker node key.
988 * @param workerNodeKey - The worker node key.
990 private sendWorkerStatisticsMessageToWorker (workerNodeKey
: number): void {
991 this.sendToWorker(workerNodeKey
, {
994 this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
996 elu
: this.workerChoiceStrategyContext
.getTaskStatisticsRequirements()
999 workerId
: this.getWorkerInfo(workerNodeKey
).id
as number
1003 private redistributeQueuedTasks (workerNodeKey
: number): void {
1004 while (this.tasksQueueSize(workerNodeKey
) > 0) {
1005 let targetWorkerNodeKey
: number = workerNodeKey
1006 let minQueuedTasks
= Infinity
1007 let executeTask
= false
1008 for (const [workerNodeId
, workerNode
] of this.workerNodes
.entries()) {
1009 const workerInfo
= this.getWorkerInfo(workerNodeId
)
1011 workerNodeId
!== workerNodeKey
&&
1013 workerNode
.usage
.tasks
.queued
=== 0
1016 this.workerNodes
[workerNodeId
].usage
.tasks
.executing
<
1017 (this.opts
.tasksQueueOptions
?.concurrency
as number)
1021 targetWorkerNodeKey
= workerNodeId
1025 workerNodeId
!== workerNodeKey
&&
1027 workerNode
.usage
.tasks
.queued
< minQueuedTasks
1029 minQueuedTasks
= workerNode
.usage
.tasks
.queued
1030 targetWorkerNodeKey
= workerNodeId
1035 targetWorkerNodeKey
,
1036 this.dequeueTask(workerNodeKey
) as Task
<Data
>
1040 targetWorkerNodeKey
,
1041 this.dequeueTask(workerNodeKey
) as Task
<Data
>
1048 * This method is the listener registered for each worker message.
1050 * @returns The listener function to execute when a message is received from a worker.
1052 protected workerListener (): (message
: MessageValue
<Response
>) => void {
1054 this.checkMessageWorkerId(message
)
1055 if (message
.ready
!= null) {
1056 // Worker ready response received
1057 this.handleWorkerReadyResponse(message
)
1058 } else if (message
.id
!= null) {
1059 // Task execution response received
1060 this.handleTaskExecutionResponse(message
)
1065 private handleWorkerReadyResponse (message
: MessageValue
<Response
>): void {
1067 this.getWorkerNodeKeyByWorkerId(message
.workerId
) as number
1068 ).ready
= message
.ready
as boolean
1069 if (this.emitter
!= null && this.ready
) {
1070 this.emitter
.emit(PoolEvents
.ready
, this.info
)
1074 private handleTaskExecutionResponse (message
: MessageValue
<Response
>): void {
1075 const promiseResponse
= this.promiseResponseMap
.get(message
.id
as string)
1076 if (promiseResponse
!= null) {
1077 if (message
.taskError
!= null) {
1078 this.emitter
?.emit(PoolEvents
.taskError
, message
.taskError
)
1079 promiseResponse
.reject(message
.taskError
.message
)
1081 promiseResponse
.resolve(message
.data
as Response
)
1083 const workerNodeKey
= promiseResponse
.workerNodeKey
1084 this.afterTaskExecutionHook(workerNodeKey
, message
)
1085 this.promiseResponseMap
.delete(message
.id
as string)
1087 this.opts
.enableTasksQueue
=== true &&
1088 this.tasksQueueSize(workerNodeKey
) > 0
1092 this.dequeueTask(workerNodeKey
) as Task
<Data
>
1095 this.workerChoiceStrategyContext
.update(workerNodeKey
)
1099 private checkAndEmitEvents (): void {
1100 if (this.emitter
!= null) {
1102 this.emitter
.emit(PoolEvents
.busy
, this.info
)
1104 if (this.type === PoolTypes
.dynamic
&& this.full
) {
1105 this.emitter
.emit(PoolEvents
.full
, this.info
)
1111 * Gets the worker information given its worker node key.
1113 * @param workerNodeKey - The worker node key.
1114 * @returns The worker information.
1116 protected getWorkerInfo (workerNodeKey
: number): WorkerInfo
{
1117 return this.workerNodes
[workerNodeKey
].info
1121 * Adds the given worker in the pool worker nodes.
1123 * @param worker - The worker.
1124 * @returns The added worker node key.
1125 * @throws {@link https://nodejs.org/api/errors.html#class-error} If the added worker node is not found.
1127 private addWorkerNode (worker
: Worker
): number {
1128 const workerNode
= new WorkerNode
<Worker
, Data
>(worker
, this.worker
)
1129 // Flag the worker node as ready at pool startup.
1130 if (this.starting
) {
1131 workerNode
.info
.ready
= true
1133 this.workerNodes
.push(workerNode
)
1134 const workerNodeKey
= this.getWorkerNodeKey(worker
)
1135 if (workerNodeKey
=== -1) {
1136 throw new Error('Worker node not found')
1138 return workerNodeKey
1142 * Removes the given worker from the pool worker nodes.
1144 * @param worker - The worker.
1146 private removeWorkerNode (worker
: Worker
): void {
1147 const workerNodeKey
= this.getWorkerNodeKey(worker
)
1148 if (workerNodeKey
!== -1) {
1149 this.workerNodes
.splice(workerNodeKey
, 1)
1150 this.workerChoiceStrategyContext
.remove(workerNodeKey
)
1155 * Executes the given task on the worker given its worker node key.
1157 * @param workerNodeKey - The worker node key.
1158 * @param task - The task to execute.
1160 private executeTask (workerNodeKey
: number, task
: Task
<Data
>): void {
1161 this.beforeTaskExecutionHook(workerNodeKey
, task
)
1162 this.sendToWorker(workerNodeKey
, task
)
1165 private enqueueTask (workerNodeKey
: number, task
: Task
<Data
>): number {
1166 return this.workerNodes
[workerNodeKey
].enqueueTask(task
)
1169 private dequeueTask (workerNodeKey
: number): Task
<Data
> | undefined {
1170 return this.workerNodes
[workerNodeKey
].dequeueTask()
1173 private tasksQueueSize (workerNodeKey
: number): number {
1174 return this.workerNodes
[workerNodeKey
].tasksQueueSize()
1177 private flushTasksQueue (workerNodeKey
: number): void {
1178 while (this.tasksQueueSize(workerNodeKey
) > 0) {
1181 this.dequeueTask(workerNodeKey
) as Task
<Data
>
1184 this.workerNodes
[workerNodeKey
].clearTasksQueue()
1187 private flushTasksQueues (): void {
1188 for (const [workerNodeKey
] of this.workerNodes
.entries()) {
1189 this.flushTasksQueue(workerNodeKey
)