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