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