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