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