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