Commit | Line | Data |
---|---|---|
2845f2a5 | 1 | import { randomUUID } from 'node:crypto' |
62c15a68 | 2 | import { performance } from 'node:perf_hooks' |
3d6dd312 | 3 | import { existsSync } from 'node:fs' |
5c4d16da JB |
4 | import type { |
5 | MessageValue, | |
6 | PromiseResponseWrapper, | |
7 | Task | |
8 | } from '../utility-types' | |
bbeadd16 | 9 | import { |
ff128cc9 | 10 | DEFAULT_TASK_NAME, |
bbeadd16 JB |
11 | DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, |
12 | EMPTY_FUNCTION, | |
7c89e6a4 | 13 | isAsyncFunction, |
59317253 | 14 | isKillBehavior, |
0d80593b | 15 | isPlainObject, |
afe0d5bf | 16 | median, |
e4f20deb JB |
17 | round, |
18 | updateMeasurementStatistics | |
bbeadd16 | 19 | } from '../utils' |
59317253 | 20 | import { KillBehaviors } from '../worker/worker-options' |
c4855468 | 21 | import { |
65d7a1c9 | 22 | type IPool, |
7c5a1080 | 23 | PoolEmitter, |
c4855468 | 24 | PoolEvents, |
6b27d407 | 25 | type PoolInfo, |
c4855468 | 26 | type PoolOptions, |
6b27d407 JB |
27 | type PoolType, |
28 | PoolTypes, | |
4b628b48 | 29 | type TasksQueueOptions |
c4855468 | 30 | } from './pool' |
e102732c JB |
31 | import type { |
32 | IWorker, | |
4b628b48 | 33 | IWorkerNode, |
8a1260a3 | 34 | WorkerInfo, |
4b628b48 | 35 | WorkerType, |
e102732c JB |
36 | WorkerUsage |
37 | } from './worker' | |
a35560ba | 38 | import { |
008512c7 | 39 | type MeasurementStatisticsRequirements, |
f0d7f803 | 40 | Measurements, |
a35560ba | 41 | WorkerChoiceStrategies, |
a20f0ba5 JB |
42 | type WorkerChoiceStrategy, |
43 | type WorkerChoiceStrategyOptions | |
bdaf31cd JB |
44 | } from './selection-strategies/selection-strategies-types' |
45 | import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context' | |
92b1feaa | 46 | import { version } from './version' |
4b628b48 | 47 | import { WorkerNode } from './worker-node' |
23ccf9d7 | 48 | |
729c563d | 49 | /** |
ea7a90d3 | 50 | * Base class that implements some shared logic for all poolifier pools. |
729c563d | 51 | * |
38e795c1 | 52 | * @typeParam Worker - Type of worker which manages this pool. |
e102732c JB |
53 | * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. |
54 | * @typeParam Response - Type of execution response. This can only be structured-cloneable data. | |
729c563d | 55 | */ |
c97c7edb | 56 | export abstract class AbstractPool< |
f06e48d8 | 57 | Worker extends IWorker, |
d3c8a1a8 S |
58 | Data = unknown, |
59 | Response = unknown | |
c4855468 | 60 | > implements IPool<Worker, Data, Response> { |
afc003b2 | 61 | /** @inheritDoc */ |
4b628b48 | 62 | public readonly workerNodes: Array<IWorkerNode<Worker, Data>> = [] |
4a6952ff | 63 | |
afc003b2 | 64 | /** @inheritDoc */ |
7c0ba920 JB |
65 | public readonly emitter?: PoolEmitter |
66 | ||
be0676b3 | 67 | /** |
52b71763 | 68 | * The task execution response promise map. |
be0676b3 | 69 | * |
2740a743 | 70 | * - `key`: The message id of each submitted task. |
a3445496 | 71 | * - `value`: An object that contains the worker, the execution response promise resolve and reject callbacks. |
be0676b3 | 72 | * |
a3445496 | 73 | * When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id. |
be0676b3 | 74 | */ |
501aea93 JB |
75 | protected promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = |
76 | new Map<string, PromiseResponseWrapper<Response>>() | |
c97c7edb | 77 | |
a35560ba | 78 | /** |
51fe3d3c | 79 | * Worker choice strategy context referencing a worker choice algorithm implementation. |
a35560ba S |
80 | */ |
81 | protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< | |
78cea37e JB |
82 | Worker, |
83 | Data, | |
84 | Response | |
a35560ba S |
85 | > |
86 | ||
075e51d1 | 87 | /** |
adc9cc64 | 88 | * Whether the pool is starting or not. |
075e51d1 JB |
89 | */ |
90 | private readonly starting: boolean | |
afe0d5bf JB |
91 | /** |
92 | * The start timestamp of the pool. | |
93 | */ | |
94 | private readonly startTimestamp | |
95 | ||
729c563d S |
96 | /** |
97 | * Constructs a new poolifier pool. | |
98 | * | |
38e795c1 | 99 | * @param numberOfWorkers - Number of workers that this pool should manage. |
029715f0 | 100 | * @param filePath - Path to the worker file. |
38e795c1 | 101 | * @param opts - Options for the pool. |
729c563d | 102 | */ |
c97c7edb | 103 | public constructor ( |
b4213b7f JB |
104 | protected readonly numberOfWorkers: number, |
105 | protected readonly filePath: string, | |
106 | protected readonly opts: PoolOptions<Worker> | |
c97c7edb | 107 | ) { |
78cea37e | 108 | if (!this.isMain()) { |
c97c7edb S |
109 | throw new Error('Cannot start a pool from a worker!') |
110 | } | |
8d3782fa | 111 | this.checkNumberOfWorkers(this.numberOfWorkers) |
c510fea7 | 112 | this.checkFilePath(this.filePath) |
7c0ba920 | 113 | this.checkPoolOptions(this.opts) |
1086026a | 114 | |
7254e419 JB |
115 | this.chooseWorkerNode = this.chooseWorkerNode.bind(this) |
116 | this.executeTask = this.executeTask.bind(this) | |
117 | this.enqueueTask = this.enqueueTask.bind(this) | |
10ecf8fd | 118 | this.dequeueTask = this.dequeueTask.bind(this) |
7254e419 | 119 | this.checkAndEmitEvents = this.checkAndEmitEvents.bind(this) |
1086026a | 120 | |
6bd72cd0 | 121 | if (this.opts.enableEvents === true) { |
7c0ba920 JB |
122 | this.emitter = new PoolEmitter() |
123 | } | |
d59df138 JB |
124 | this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext< |
125 | Worker, | |
126 | Data, | |
127 | Response | |
da309861 JB |
128 | >( |
129 | this, | |
130 | this.opts.workerChoiceStrategy, | |
131 | this.opts.workerChoiceStrategyOptions | |
132 | ) | |
b6b32453 JB |
133 | |
134 | this.setupHook() | |
135 | ||
075e51d1 | 136 | this.starting = true |
e761c033 | 137 | this.startPool() |
075e51d1 | 138 | this.starting = false |
afe0d5bf JB |
139 | |
140 | this.startTimestamp = performance.now() | |
c97c7edb S |
141 | } |
142 | ||
a35560ba | 143 | private checkFilePath (filePath: string): void { |
ffcbbad8 JB |
144 | if ( |
145 | filePath == null || | |
3d6dd312 | 146 | typeof filePath !== 'string' || |
ffcbbad8 JB |
147 | (typeof filePath === 'string' && filePath.trim().length === 0) |
148 | ) { | |
c510fea7 APA |
149 | throw new Error('Please specify a file with a worker implementation') |
150 | } | |
3d6dd312 JB |
151 | if (!existsSync(filePath)) { |
152 | throw new Error(`Cannot find the worker file '${filePath}'`) | |
153 | } | |
c510fea7 APA |
154 | } |
155 | ||
8d3782fa JB |
156 | private checkNumberOfWorkers (numberOfWorkers: number): void { |
157 | if (numberOfWorkers == null) { | |
158 | throw new Error( | |
159 | 'Cannot instantiate a pool without specifying the number of workers' | |
160 | ) | |
78cea37e | 161 | } else if (!Number.isSafeInteger(numberOfWorkers)) { |
473c717a | 162 | throw new TypeError( |
0d80593b | 163 | 'Cannot instantiate a pool with a non safe integer number of workers' |
8d3782fa JB |
164 | ) |
165 | } else if (numberOfWorkers < 0) { | |
473c717a | 166 | throw new RangeError( |
8d3782fa JB |
167 | 'Cannot instantiate a pool with a negative number of workers' |
168 | ) | |
6b27d407 | 169 | } else if (this.type === PoolTypes.fixed && numberOfWorkers === 0) { |
2431bdb4 JB |
170 | throw new RangeError('Cannot instantiate a fixed pool with zero worker') |
171 | } | |
172 | } | |
173 | ||
174 | protected checkDynamicPoolSize (min: number, max: number): void { | |
079de991 | 175 | if (this.type === PoolTypes.dynamic) { |
a5ed75b7 JB |
176 | if (max == null) { |
177 | throw new Error( | |
178 | 'Cannot instantiate a dynamic pool without specifying the maximum pool size' | |
179 | ) | |
180 | } else if (!Number.isSafeInteger(max)) { | |
2761efb4 JB |
181 | throw new TypeError( |
182 | 'Cannot instantiate a dynamic pool with a non safe integer maximum pool size' | |
183 | ) | |
184 | } else if (min > max) { | |
079de991 JB |
185 | throw new RangeError( |
186 | 'Cannot instantiate a dynamic pool with a maximum pool size inferior to the minimum pool size' | |
187 | ) | |
b97d82d8 | 188 | } else if (max === 0) { |
079de991 | 189 | throw new RangeError( |
b97d82d8 | 190 | 'Cannot instantiate a dynamic pool with a pool size equal to zero' |
079de991 JB |
191 | ) |
192 | } else if (min === max) { | |
193 | throw new RangeError( | |
194 | 'Cannot instantiate a dynamic pool with a minimum pool size equal to the maximum pool size. Use a fixed pool instead' | |
195 | ) | |
196 | } | |
8d3782fa JB |
197 | } |
198 | } | |
199 | ||
7c0ba920 | 200 | private checkPoolOptions (opts: PoolOptions<Worker>): void { |
0d80593b JB |
201 | if (isPlainObject(opts)) { |
202 | this.opts.workerChoiceStrategy = | |
203 | opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN | |
204 | this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy) | |
205 | this.opts.workerChoiceStrategyOptions = | |
206 | opts.workerChoiceStrategyOptions ?? | |
207 | DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS | |
49be33fe JB |
208 | this.checkValidWorkerChoiceStrategyOptions( |
209 | this.opts.workerChoiceStrategyOptions | |
210 | ) | |
1f68cede | 211 | this.opts.restartWorkerOnError = opts.restartWorkerOnError ?? true |
0d80593b JB |
212 | this.opts.enableEvents = opts.enableEvents ?? true |
213 | this.opts.enableTasksQueue = opts.enableTasksQueue ?? false | |
214 | if (this.opts.enableTasksQueue) { | |
215 | this.checkValidTasksQueueOptions( | |
216 | opts.tasksQueueOptions as TasksQueueOptions | |
217 | ) | |
218 | this.opts.tasksQueueOptions = this.buildTasksQueueOptions( | |
219 | opts.tasksQueueOptions as TasksQueueOptions | |
220 | ) | |
221 | } | |
222 | } else { | |
223 | throw new TypeError('Invalid pool options: must be a plain object') | |
7171d33f | 224 | } |
aee46736 JB |
225 | } |
226 | ||
227 | private checkValidWorkerChoiceStrategy ( | |
228 | workerChoiceStrategy: WorkerChoiceStrategy | |
229 | ): void { | |
230 | if (!Object.values(WorkerChoiceStrategies).includes(workerChoiceStrategy)) { | |
b529c323 | 231 | throw new Error( |
aee46736 | 232 | `Invalid worker choice strategy '${workerChoiceStrategy}'` |
b529c323 JB |
233 | ) |
234 | } | |
7c0ba920 JB |
235 | } |
236 | ||
0d80593b JB |
237 | private checkValidWorkerChoiceStrategyOptions ( |
238 | workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | |
239 | ): void { | |
240 | if (!isPlainObject(workerChoiceStrategyOptions)) { | |
241 | throw new TypeError( | |
242 | 'Invalid worker choice strategy options: must be a plain object' | |
243 | ) | |
244 | } | |
49be33fe JB |
245 | if ( |
246 | workerChoiceStrategyOptions.weights != null && | |
6b27d407 | 247 | Object.keys(workerChoiceStrategyOptions.weights).length !== this.maxSize |
49be33fe JB |
248 | ) { |
249 | throw new Error( | |
250 | 'Invalid worker choice strategy options: must have a weight for each worker node' | |
251 | ) | |
252 | } | |
f0d7f803 JB |
253 | if ( |
254 | workerChoiceStrategyOptions.measurement != null && | |
255 | !Object.values(Measurements).includes( | |
256 | workerChoiceStrategyOptions.measurement | |
257 | ) | |
258 | ) { | |
259 | throw new Error( | |
260 | `Invalid worker choice strategy options: invalid measurement '${workerChoiceStrategyOptions.measurement}'` | |
261 | ) | |
262 | } | |
0d80593b JB |
263 | } |
264 | ||
a20f0ba5 JB |
265 | private checkValidTasksQueueOptions ( |
266 | tasksQueueOptions: TasksQueueOptions | |
267 | ): void { | |
0d80593b JB |
268 | if (tasksQueueOptions != null && !isPlainObject(tasksQueueOptions)) { |
269 | throw new TypeError('Invalid tasks queue options: must be a plain object') | |
270 | } | |
f0d7f803 JB |
271 | if ( |
272 | tasksQueueOptions?.concurrency != null && | |
273 | !Number.isSafeInteger(tasksQueueOptions.concurrency) | |
274 | ) { | |
275 | throw new TypeError( | |
276 | 'Invalid worker tasks concurrency: must be an integer' | |
277 | ) | |
278 | } | |
279 | if ( | |
280 | tasksQueueOptions?.concurrency != null && | |
281 | tasksQueueOptions.concurrency <= 0 | |
282 | ) { | |
a20f0ba5 | 283 | throw new Error( |
f0d7f803 | 284 | `Invalid worker tasks concurrency '${tasksQueueOptions.concurrency}'` |
a20f0ba5 JB |
285 | ) |
286 | } | |
287 | } | |
288 | ||
e761c033 JB |
289 | private startPool (): void { |
290 | while ( | |
291 | this.workerNodes.reduce( | |
292 | (accumulator, workerNode) => | |
293 | !workerNode.info.dynamic ? accumulator + 1 : accumulator, | |
294 | 0 | |
295 | ) < this.numberOfWorkers | |
296 | ) { | |
aa9eede8 | 297 | this.createAndSetupWorkerNode() |
e761c033 JB |
298 | } |
299 | } | |
300 | ||
08f3f44c | 301 | /** @inheritDoc */ |
6b27d407 JB |
302 | public get info (): PoolInfo { |
303 | return { | |
23ccf9d7 | 304 | version, |
6b27d407 | 305 | type: this.type, |
184855e6 | 306 | worker: this.worker, |
2431bdb4 JB |
307 | ready: this.ready, |
308 | strategy: this.opts.workerChoiceStrategy as WorkerChoiceStrategy, | |
6b27d407 JB |
309 | minSize: this.minSize, |
310 | maxSize: this.maxSize, | |
c05f0d50 JB |
311 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() |
312 | .runTime.aggregate && | |
1305e9a8 JB |
313 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements() |
314 | .waitTime.aggregate && { utilization: round(this.utilization) }), | |
6b27d407 JB |
315 | workerNodes: this.workerNodes.length, |
316 | idleWorkerNodes: this.workerNodes.reduce( | |
317 | (accumulator, workerNode) => | |
f59e1027 | 318 | workerNode.usage.tasks.executing === 0 |
a4e07f72 JB |
319 | ? accumulator + 1 |
320 | : accumulator, | |
6b27d407 JB |
321 | 0 |
322 | ), | |
323 | busyWorkerNodes: this.workerNodes.reduce( | |
324 | (accumulator, workerNode) => | |
f59e1027 | 325 | workerNode.usage.tasks.executing > 0 ? accumulator + 1 : accumulator, |
6b27d407 JB |
326 | 0 |
327 | ), | |
a4e07f72 | 328 | executedTasks: this.workerNodes.reduce( |
6b27d407 | 329 | (accumulator, workerNode) => |
f59e1027 | 330 | accumulator + workerNode.usage.tasks.executed, |
a4e07f72 JB |
331 | 0 |
332 | ), | |
333 | executingTasks: this.workerNodes.reduce( | |
334 | (accumulator, workerNode) => | |
f59e1027 | 335 | accumulator + workerNode.usage.tasks.executing, |
6b27d407 JB |
336 | 0 |
337 | ), | |
338 | queuedTasks: this.workerNodes.reduce( | |
df593701 | 339 | (accumulator, workerNode) => |
f59e1027 | 340 | accumulator + workerNode.usage.tasks.queued, |
6b27d407 JB |
341 | 0 |
342 | ), | |
343 | maxQueuedTasks: this.workerNodes.reduce( | |
344 | (accumulator, workerNode) => | |
b25a42cd | 345 | accumulator + (workerNode.usage.tasks?.maxQueued ?? 0), |
6b27d407 | 346 | 0 |
a4e07f72 JB |
347 | ), |
348 | failedTasks: this.workerNodes.reduce( | |
349 | (accumulator, workerNode) => | |
f59e1027 | 350 | accumulator + workerNode.usage.tasks.failed, |
a4e07f72 | 351 | 0 |
1dcf8b7b JB |
352 | ), |
353 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
354 | .runTime.aggregate && { | |
355 | runTime: { | |
98e72cda JB |
356 | minimum: round( |
357 | Math.min( | |
358 | ...this.workerNodes.map( | |
359 | workerNode => workerNode.usage.runTime?.minimum ?? Infinity | |
360 | ) | |
1dcf8b7b JB |
361 | ) |
362 | ), | |
98e72cda JB |
363 | maximum: round( |
364 | Math.max( | |
365 | ...this.workerNodes.map( | |
366 | workerNode => workerNode.usage.runTime?.maximum ?? -Infinity | |
367 | ) | |
1dcf8b7b | 368 | ) |
98e72cda JB |
369 | ), |
370 | average: round( | |
371 | this.workerNodes.reduce( | |
372 | (accumulator, workerNode) => | |
373 | accumulator + (workerNode.usage.runTime?.aggregate ?? 0), | |
374 | 0 | |
375 | ) / | |
376 | this.workerNodes.reduce( | |
377 | (accumulator, workerNode) => | |
378 | accumulator + (workerNode.usage.tasks?.executed ?? 0), | |
379 | 0 | |
380 | ) | |
381 | ), | |
382 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
383 | .runTime.median && { | |
384 | median: round( | |
385 | median( | |
386 | this.workerNodes.map( | |
387 | workerNode => workerNode.usage.runTime?.median ?? 0 | |
388 | ) | |
389 | ) | |
390 | ) | |
391 | }) | |
1dcf8b7b JB |
392 | } |
393 | }), | |
394 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
395 | .waitTime.aggregate && { | |
396 | waitTime: { | |
98e72cda JB |
397 | minimum: round( |
398 | Math.min( | |
399 | ...this.workerNodes.map( | |
400 | workerNode => workerNode.usage.waitTime?.minimum ?? Infinity | |
401 | ) | |
1dcf8b7b JB |
402 | ) |
403 | ), | |
98e72cda JB |
404 | maximum: round( |
405 | Math.max( | |
406 | ...this.workerNodes.map( | |
407 | workerNode => workerNode.usage.waitTime?.maximum ?? -Infinity | |
408 | ) | |
1dcf8b7b | 409 | ) |
98e72cda JB |
410 | ), |
411 | average: round( | |
412 | this.workerNodes.reduce( | |
413 | (accumulator, workerNode) => | |
414 | accumulator + (workerNode.usage.waitTime?.aggregate ?? 0), | |
415 | 0 | |
416 | ) / | |
417 | this.workerNodes.reduce( | |
418 | (accumulator, workerNode) => | |
419 | accumulator + (workerNode.usage.tasks?.executed ?? 0), | |
420 | 0 | |
421 | ) | |
422 | ), | |
423 | ...(this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
424 | .waitTime.median && { | |
425 | median: round( | |
426 | median( | |
427 | this.workerNodes.map( | |
428 | workerNode => workerNode.usage.waitTime?.median ?? 0 | |
429 | ) | |
430 | ) | |
431 | ) | |
432 | }) | |
1dcf8b7b JB |
433 | } |
434 | }) | |
6b27d407 JB |
435 | } |
436 | } | |
08f3f44c | 437 | |
aa9eede8 JB |
438 | /** |
439 | * The pool readiness boolean status. | |
440 | */ | |
2431bdb4 JB |
441 | private get ready (): boolean { |
442 | return ( | |
b97d82d8 JB |
443 | this.workerNodes.reduce( |
444 | (accumulator, workerNode) => | |
445 | !workerNode.info.dynamic && workerNode.info.ready | |
446 | ? accumulator + 1 | |
447 | : accumulator, | |
448 | 0 | |
449 | ) >= this.minSize | |
2431bdb4 JB |
450 | ) |
451 | } | |
452 | ||
afe0d5bf | 453 | /** |
aa9eede8 | 454 | * The approximate pool utilization. |
afe0d5bf JB |
455 | * |
456 | * @returns The pool utilization. | |
457 | */ | |
458 | private get utilization (): number { | |
8e5ca040 | 459 | const poolTimeCapacity = |
fe7d90db | 460 | (performance.now() - this.startTimestamp) * this.maxSize |
afe0d5bf JB |
461 | const totalTasksRunTime = this.workerNodes.reduce( |
462 | (accumulator, workerNode) => | |
71514351 | 463 | accumulator + (workerNode.usage.runTime?.aggregate ?? 0), |
afe0d5bf JB |
464 | 0 |
465 | ) | |
466 | const totalTasksWaitTime = this.workerNodes.reduce( | |
467 | (accumulator, workerNode) => | |
71514351 | 468 | accumulator + (workerNode.usage.waitTime?.aggregate ?? 0), |
afe0d5bf JB |
469 | 0 |
470 | ) | |
8e5ca040 | 471 | return (totalTasksRunTime + totalTasksWaitTime) / poolTimeCapacity |
afe0d5bf JB |
472 | } |
473 | ||
8881ae32 | 474 | /** |
aa9eede8 | 475 | * The pool type. |
8881ae32 JB |
476 | * |
477 | * If it is `'dynamic'`, it provides the `max` property. | |
478 | */ | |
479 | protected abstract get type (): PoolType | |
480 | ||
184855e6 | 481 | /** |
aa9eede8 | 482 | * The worker type. |
184855e6 JB |
483 | */ |
484 | protected abstract get worker (): WorkerType | |
485 | ||
c2ade475 | 486 | /** |
aa9eede8 | 487 | * The pool minimum size. |
c2ade475 | 488 | */ |
6b27d407 | 489 | protected abstract get minSize (): number |
ff733df7 JB |
490 | |
491 | /** | |
aa9eede8 | 492 | * The pool maximum size. |
ff733df7 | 493 | */ |
6b27d407 | 494 | protected abstract get maxSize (): number |
a35560ba | 495 | |
6b813701 JB |
496 | /** |
497 | * Checks if the worker id sent in the received message from a worker is valid. | |
498 | * | |
499 | * @param message - The received message. | |
500 | * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker id is invalid. | |
501 | */ | |
21f710aa JB |
502 | private checkMessageWorkerId (message: MessageValue<Response>): void { |
503 | if ( | |
504 | message.workerId != null && | |
aa9eede8 | 505 | this.getWorkerNodeKeyByWorkerId(message.workerId) == null |
21f710aa JB |
506 | ) { |
507 | throw new Error( | |
508 | `Worker message received from unknown worker '${message.workerId}'` | |
509 | ) | |
510 | } | |
511 | } | |
512 | ||
ffcbbad8 | 513 | /** |
f06e48d8 | 514 | * Gets the given worker its worker node key. |
ffcbbad8 JB |
515 | * |
516 | * @param worker - The worker. | |
f59e1027 | 517 | * @returns The worker node key if found in the pool worker nodes, `-1` otherwise. |
ffcbbad8 | 518 | */ |
aa9eede8 | 519 | private getWorkerNodeKey (worker: Worker): number { |
f06e48d8 JB |
520 | return this.workerNodes.findIndex( |
521 | workerNode => workerNode.worker === worker | |
522 | ) | |
bf9549ae JB |
523 | } |
524 | ||
aa9eede8 JB |
525 | /** |
526 | * Gets the worker node key given its worker id. | |
527 | * | |
528 | * @param workerId - The worker id. | |
529 | * @returns The worker node key if the worker id is found in the pool worker nodes, `undefined` otherwise. | |
530 | */ | |
531 | private getWorkerNodeKeyByWorkerId (workerId: number): number | undefined { | |
532 | for (const [workerNodeKey, workerNode] of this.workerNodes.entries()) { | |
533 | if (workerNode.info.id === workerId) { | |
534 | return workerNodeKey | |
535 | } | |
536 | } | |
537 | } | |
538 | ||
afc003b2 | 539 | /** @inheritDoc */ |
a35560ba | 540 | public setWorkerChoiceStrategy ( |
59219cbb JB |
541 | workerChoiceStrategy: WorkerChoiceStrategy, |
542 | workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions | |
a35560ba | 543 | ): void { |
aee46736 | 544 | this.checkValidWorkerChoiceStrategy(workerChoiceStrategy) |
b98ec2e6 | 545 | this.opts.workerChoiceStrategy = workerChoiceStrategy |
b6b32453 JB |
546 | this.workerChoiceStrategyContext.setWorkerChoiceStrategy( |
547 | this.opts.workerChoiceStrategy | |
548 | ) | |
549 | if (workerChoiceStrategyOptions != null) { | |
550 | this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) | |
551 | } | |
aa9eede8 | 552 | for (const [workerNodeKey, workerNode] of this.workerNodes.entries()) { |
4b628b48 | 553 | workerNode.resetUsage() |
aa9eede8 | 554 | this.sendWorkerStatisticsMessageToWorker(workerNodeKey) |
59219cbb | 555 | } |
a20f0ba5 JB |
556 | } |
557 | ||
558 | /** @inheritDoc */ | |
559 | public setWorkerChoiceStrategyOptions ( | |
560 | workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | |
561 | ): void { | |
0d80593b | 562 | this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) |
a20f0ba5 JB |
563 | this.opts.workerChoiceStrategyOptions = workerChoiceStrategyOptions |
564 | this.workerChoiceStrategyContext.setOptions( | |
565 | this.opts.workerChoiceStrategyOptions | |
a35560ba S |
566 | ) |
567 | } | |
568 | ||
a20f0ba5 | 569 | /** @inheritDoc */ |
8f52842f JB |
570 | public enableTasksQueue ( |
571 | enable: boolean, | |
572 | tasksQueueOptions?: TasksQueueOptions | |
573 | ): void { | |
a20f0ba5 | 574 | if (this.opts.enableTasksQueue === true && !enable) { |
ef41a6e6 | 575 | this.flushTasksQueues() |
a20f0ba5 JB |
576 | } |
577 | this.opts.enableTasksQueue = enable | |
8f52842f | 578 | this.setTasksQueueOptions(tasksQueueOptions as TasksQueueOptions) |
a20f0ba5 JB |
579 | } |
580 | ||
581 | /** @inheritDoc */ | |
8f52842f | 582 | public setTasksQueueOptions (tasksQueueOptions: TasksQueueOptions): void { |
a20f0ba5 | 583 | if (this.opts.enableTasksQueue === true) { |
8f52842f JB |
584 | this.checkValidTasksQueueOptions(tasksQueueOptions) |
585 | this.opts.tasksQueueOptions = | |
586 | this.buildTasksQueueOptions(tasksQueueOptions) | |
5baee0d7 | 587 | } else if (this.opts.tasksQueueOptions != null) { |
a20f0ba5 JB |
588 | delete this.opts.tasksQueueOptions |
589 | } | |
590 | } | |
591 | ||
592 | private buildTasksQueueOptions ( | |
593 | tasksQueueOptions: TasksQueueOptions | |
594 | ): TasksQueueOptions { | |
595 | return { | |
596 | concurrency: tasksQueueOptions?.concurrency ?? 1 | |
597 | } | |
598 | } | |
599 | ||
c319c66b JB |
600 | /** |
601 | * Whether the pool is full or not. | |
602 | * | |
603 | * The pool filling boolean status. | |
604 | */ | |
dea903a8 JB |
605 | protected get full (): boolean { |
606 | return this.workerNodes.length >= this.maxSize | |
607 | } | |
c2ade475 | 608 | |
c319c66b JB |
609 | /** |
610 | * Whether the pool is busy or not. | |
611 | * | |
612 | * The pool busyness boolean status. | |
613 | */ | |
614 | protected abstract get busy (): boolean | |
7c0ba920 | 615 | |
6c6afb84 JB |
616 | /** |
617 | * Whether worker nodes are executing at least one task. | |
618 | * | |
619 | * @returns Worker nodes busyness boolean status. | |
620 | */ | |
c2ade475 | 621 | protected internalBusy (): boolean { |
e0ae6100 JB |
622 | return ( |
623 | this.workerNodes.findIndex(workerNode => { | |
f59e1027 | 624 | return workerNode.usage.tasks.executing === 0 |
e0ae6100 JB |
625 | }) === -1 |
626 | ) | |
cb70b19d JB |
627 | } |
628 | ||
afc003b2 | 629 | /** @inheritDoc */ |
a86b6df1 | 630 | public async execute (data?: Data, name?: string): Promise<Response> { |
52b71763 JB |
631 | return await new Promise<Response>((resolve, reject) => { |
632 | const timestamp = performance.now() | |
633 | const workerNodeKey = this.chooseWorkerNode() | |
501aea93 | 634 | const task: Task<Data> = { |
52b71763 JB |
635 | name: name ?? DEFAULT_TASK_NAME, |
636 | // eslint-disable-next-line @typescript-eslint/consistent-type-assertions | |
637 | data: data ?? ({} as Data), | |
638 | timestamp, | |
639 | workerId: this.getWorkerInfo(workerNodeKey).id as number, | |
640 | id: randomUUID() | |
641 | } | |
501aea93 | 642 | this.promiseResponseMap.set(task.id as string, { |
2e81254d JB |
643 | resolve, |
644 | reject, | |
501aea93 | 645 | workerNodeKey |
2e81254d | 646 | }) |
52b71763 JB |
647 | if ( |
648 | this.opts.enableTasksQueue === true && | |
649 | (this.busy || | |
650 | this.workerNodes[workerNodeKey].usage.tasks.executing >= | |
651 | ((this.opts.tasksQueueOptions as TasksQueueOptions) | |
652 | .concurrency as number)) | |
653 | ) { | |
501aea93 | 654 | this.enqueueTask(workerNodeKey, task) |
52b71763 | 655 | } else { |
501aea93 | 656 | this.executeTask(workerNodeKey, task) |
52b71763 JB |
657 | } |
658 | this.checkAndEmitEvents() | |
2e81254d | 659 | }) |
280c2a77 | 660 | } |
c97c7edb | 661 | |
afc003b2 | 662 | /** @inheritDoc */ |
c97c7edb | 663 | public async destroy (): Promise<void> { |
1fbcaa7c | 664 | await Promise.all( |
875a7c37 JB |
665 | this.workerNodes.map(async (workerNode, workerNodeKey) => { |
666 | this.flushTasksQueue(workerNodeKey) | |
47aacbaa | 667 | // FIXME: wait for tasks to be finished |
920278a2 JB |
668 | const workerExitPromise = new Promise<void>(resolve => { |
669 | workerNode.worker.on('exit', () => { | |
670 | resolve() | |
671 | }) | |
672 | }) | |
aa9eede8 | 673 | await this.destroyWorkerNode(workerNodeKey) |
920278a2 | 674 | await workerExitPromise |
1fbcaa7c JB |
675 | }) |
676 | ) | |
c97c7edb S |
677 | } |
678 | ||
4a6952ff | 679 | /** |
aa9eede8 | 680 | * Terminates the worker node given its worker node key. |
4a6952ff | 681 | * |
aa9eede8 | 682 | * @param workerNodeKey - The worker node key. |
4a6952ff | 683 | */ |
aa9eede8 JB |
684 | protected abstract destroyWorkerNode ( |
685 | workerNodeKey: number | |
686 | ): void | Promise<void> | |
c97c7edb | 687 | |
729c563d | 688 | /** |
6677a3d3 JB |
689 | * Setup hook to execute code before worker nodes are created in the abstract constructor. |
690 | * Can be overridden. | |
afc003b2 JB |
691 | * |
692 | * @virtual | |
729c563d | 693 | */ |
280c2a77 | 694 | protected setupHook (): void { |
d99ba5a8 | 695 | // Intentionally empty |
280c2a77 | 696 | } |
c97c7edb | 697 | |
729c563d | 698 | /** |
280c2a77 S |
699 | * Should return whether the worker is the main worker or not. |
700 | */ | |
701 | protected abstract isMain (): boolean | |
702 | ||
703 | /** | |
2e81254d | 704 | * Hook executed before the worker task execution. |
bf9549ae | 705 | * Can be overridden. |
729c563d | 706 | * |
f06e48d8 | 707 | * @param workerNodeKey - The worker node key. |
1c6fe997 | 708 | * @param task - The task to execute. |
729c563d | 709 | */ |
1c6fe997 JB |
710 | protected beforeTaskExecutionHook ( |
711 | workerNodeKey: number, | |
712 | task: Task<Data> | |
713 | ): void { | |
f59e1027 | 714 | const workerUsage = this.workerNodes[workerNodeKey].usage |
1c6fe997 JB |
715 | ++workerUsage.tasks.executing |
716 | this.updateWaitTimeWorkerUsage(workerUsage, task) | |
eb8afc8a | 717 | const taskWorkerUsage = this.workerNodes[workerNodeKey].getTaskWorkerUsage( |
ce1b31be JB |
718 | task.name as string |
719 | ) as WorkerUsage | |
eb8afc8a JB |
720 | ++taskWorkerUsage.tasks.executing |
721 | this.updateWaitTimeWorkerUsage(taskWorkerUsage, task) | |
c97c7edb S |
722 | } |
723 | ||
c01733f1 | 724 | /** |
2e81254d | 725 | * Hook executed after the worker task execution. |
bf9549ae | 726 | * Can be overridden. |
c01733f1 | 727 | * |
501aea93 | 728 | * @param workerNodeKey - The worker node key. |
38e795c1 | 729 | * @param message - The received message. |
c01733f1 | 730 | */ |
2e81254d | 731 | protected afterTaskExecutionHook ( |
501aea93 | 732 | workerNodeKey: number, |
2740a743 | 733 | message: MessageValue<Response> |
bf9549ae | 734 | ): void { |
ff128cc9 | 735 | const workerUsage = this.workerNodes[workerNodeKey].usage |
f1c06930 JB |
736 | this.updateTaskStatisticsWorkerUsage(workerUsage, message) |
737 | this.updateRunTimeWorkerUsage(workerUsage, message) | |
738 | this.updateEluWorkerUsage(workerUsage, message) | |
eb8afc8a | 739 | const taskWorkerUsage = this.workerNodes[workerNodeKey].getTaskWorkerUsage( |
87e44747 | 740 | message.taskPerformance?.name ?? DEFAULT_TASK_NAME |
ce1b31be | 741 | ) as WorkerUsage |
eb8afc8a JB |
742 | this.updateTaskStatisticsWorkerUsage(taskWorkerUsage, message) |
743 | this.updateRunTimeWorkerUsage(taskWorkerUsage, message) | |
744 | this.updateEluWorkerUsage(taskWorkerUsage, message) | |
f1c06930 JB |
745 | } |
746 | ||
747 | private updateTaskStatisticsWorkerUsage ( | |
748 | workerUsage: WorkerUsage, | |
749 | message: MessageValue<Response> | |
750 | ): void { | |
a4e07f72 JB |
751 | const workerTaskStatistics = workerUsage.tasks |
752 | --workerTaskStatistics.executing | |
98e72cda JB |
753 | if (message.taskError == null) { |
754 | ++workerTaskStatistics.executed | |
755 | } else { | |
a4e07f72 | 756 | ++workerTaskStatistics.failed |
2740a743 | 757 | } |
f8eb0a2a JB |
758 | } |
759 | ||
a4e07f72 JB |
760 | private updateRunTimeWorkerUsage ( |
761 | workerUsage: WorkerUsage, | |
f8eb0a2a JB |
762 | message: MessageValue<Response> |
763 | ): void { | |
e4f20deb JB |
764 | updateMeasurementStatistics( |
765 | workerUsage.runTime, | |
766 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements().runTime, | |
767 | message.taskPerformance?.runTime ?? 0, | |
768 | workerUsage.tasks.executed | |
769 | ) | |
f8eb0a2a JB |
770 | } |
771 | ||
a4e07f72 JB |
772 | private updateWaitTimeWorkerUsage ( |
773 | workerUsage: WorkerUsage, | |
1c6fe997 | 774 | task: Task<Data> |
f8eb0a2a | 775 | ): void { |
1c6fe997 JB |
776 | const timestamp = performance.now() |
777 | const taskWaitTime = timestamp - (task.timestamp ?? timestamp) | |
e4f20deb JB |
778 | updateMeasurementStatistics( |
779 | workerUsage.waitTime, | |
780 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements().waitTime, | |
781 | taskWaitTime, | |
782 | workerUsage.tasks.executed | |
783 | ) | |
c01733f1 | 784 | } |
785 | ||
a4e07f72 | 786 | private updateEluWorkerUsage ( |
5df69fab | 787 | workerUsage: WorkerUsage, |
62c15a68 JB |
788 | message: MessageValue<Response> |
789 | ): void { | |
008512c7 JB |
790 | const eluTaskStatisticsRequirements: MeasurementStatisticsRequirements = |
791 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements().elu | |
e4f20deb JB |
792 | updateMeasurementStatistics( |
793 | workerUsage.elu.active, | |
008512c7 | 794 | eluTaskStatisticsRequirements, |
e4f20deb JB |
795 | message.taskPerformance?.elu?.active ?? 0, |
796 | workerUsage.tasks.executed | |
797 | ) | |
798 | updateMeasurementStatistics( | |
799 | workerUsage.elu.idle, | |
008512c7 | 800 | eluTaskStatisticsRequirements, |
e4f20deb JB |
801 | message.taskPerformance?.elu?.idle ?? 0, |
802 | workerUsage.tasks.executed | |
803 | ) | |
008512c7 | 804 | if (eluTaskStatisticsRequirements.aggregate) { |
f7510105 | 805 | if (message.taskPerformance?.elu != null) { |
f7510105 JB |
806 | if (workerUsage.elu.utilization != null) { |
807 | workerUsage.elu.utilization = | |
808 | (workerUsage.elu.utilization + | |
809 | message.taskPerformance.elu.utilization) / | |
810 | 2 | |
811 | } else { | |
812 | workerUsage.elu.utilization = message.taskPerformance.elu.utilization | |
813 | } | |
62c15a68 JB |
814 | } |
815 | } | |
816 | } | |
817 | ||
280c2a77 | 818 | /** |
f06e48d8 | 819 | * Chooses a worker node for the next task. |
280c2a77 | 820 | * |
6c6afb84 | 821 | * The default worker choice strategy uses a round robin algorithm to distribute the tasks. |
280c2a77 | 822 | * |
aa9eede8 | 823 | * @returns The chosen worker node key |
280c2a77 | 824 | */ |
6c6afb84 | 825 | private chooseWorkerNode (): number { |
930dcf12 | 826 | if (this.shallCreateDynamicWorker()) { |
aa9eede8 | 827 | const workerNodeKey = this.createAndSetupDynamicWorkerNode() |
6c6afb84 JB |
828 | if ( |
829 | this.workerChoiceStrategyContext.getStrategyPolicy().useDynamicWorker | |
830 | ) { | |
aa9eede8 | 831 | return workerNodeKey |
6c6afb84 | 832 | } |
17393ac8 | 833 | } |
930dcf12 JB |
834 | return this.workerChoiceStrategyContext.execute() |
835 | } | |
836 | ||
6c6afb84 JB |
837 | /** |
838 | * Conditions for dynamic worker creation. | |
839 | * | |
840 | * @returns Whether to create a dynamic worker or not. | |
841 | */ | |
842 | private shallCreateDynamicWorker (): boolean { | |
930dcf12 | 843 | return this.type === PoolTypes.dynamic && !this.full && this.internalBusy() |
c97c7edb S |
844 | } |
845 | ||
280c2a77 | 846 | /** |
aa9eede8 | 847 | * Sends a message to worker given its worker node key. |
280c2a77 | 848 | * |
aa9eede8 | 849 | * @param workerNodeKey - The worker node key. |
38e795c1 | 850 | * @param message - The message. |
280c2a77 S |
851 | */ |
852 | protected abstract sendToWorker ( | |
aa9eede8 | 853 | workerNodeKey: number, |
280c2a77 S |
854 | message: MessageValue<Data> |
855 | ): void | |
856 | ||
729c563d | 857 | /** |
41344292 | 858 | * Creates a new worker. |
6c6afb84 JB |
859 | * |
860 | * @returns Newly created worker. | |
729c563d | 861 | */ |
280c2a77 | 862 | protected abstract createWorker (): Worker |
c97c7edb | 863 | |
4a6952ff | 864 | /** |
aa9eede8 | 865 | * Creates a new, completely set up worker node. |
4a6952ff | 866 | * |
aa9eede8 | 867 | * @returns New, completely set up worker node key. |
4a6952ff | 868 | */ |
aa9eede8 | 869 | protected createAndSetupWorkerNode (): number { |
bdacc2d2 | 870 | const worker = this.createWorker() |
280c2a77 | 871 | |
35cf1c03 | 872 | worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION) |
a35560ba | 873 | worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION) |
1f68cede | 874 | worker.on('error', error => { |
9b106837 JB |
875 | const workerNodeKey = this.getWorkerNodeKey(worker) |
876 | const workerInfo = this.getWorkerInfo(workerNodeKey) | |
877 | workerInfo.ready = false | |
0dc838e3 | 878 | this.workerNodes[workerNodeKey].closeChannel() |
2a69b8c5 | 879 | this.emitter?.emit(PoolEvents.error, error) |
2431bdb4 | 880 | if (this.opts.restartWorkerOnError === true && !this.starting) { |
9b106837 | 881 | if (workerInfo.dynamic) { |
aa9eede8 | 882 | this.createAndSetupDynamicWorkerNode() |
8a1260a3 | 883 | } else { |
aa9eede8 | 884 | this.createAndSetupWorkerNode() |
8a1260a3 | 885 | } |
5baee0d7 | 886 | } |
19dbc45b | 887 | if (this.opts.enableTasksQueue === true) { |
9b106837 | 888 | this.redistributeQueuedTasks(workerNodeKey) |
19dbc45b | 889 | } |
5baee0d7 | 890 | }) |
a35560ba S |
891 | worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION) |
892 | worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION) | |
a974afa6 | 893 | worker.once('exit', () => { |
f06e48d8 | 894 | this.removeWorkerNode(worker) |
a974afa6 | 895 | }) |
280c2a77 | 896 | |
aa9eede8 | 897 | const workerNodeKey = this.addWorkerNode(worker) |
280c2a77 | 898 | |
aa9eede8 | 899 | this.afterWorkerNodeSetup(workerNodeKey) |
280c2a77 | 900 | |
aa9eede8 | 901 | return workerNodeKey |
c97c7edb | 902 | } |
be0676b3 | 903 | |
930dcf12 | 904 | /** |
aa9eede8 | 905 | * Creates a new, completely set up dynamic worker node. |
930dcf12 | 906 | * |
aa9eede8 | 907 | * @returns New, completely set up dynamic worker node key. |
930dcf12 | 908 | */ |
aa9eede8 JB |
909 | protected createAndSetupDynamicWorkerNode (): number { |
910 | const workerNodeKey = this.createAndSetupWorkerNode() | |
911 | this.registerWorkerMessageListener(workerNodeKey, message => { | |
912 | const localWorkerNodeKey = this.getWorkerNodeKeyByWorkerId( | |
913 | message.workerId | |
914 | ) as number | |
915 | const workerUsage = this.workerNodes[localWorkerNodeKey].usage | |
930dcf12 JB |
916 | if ( |
917 | isKillBehavior(KillBehaviors.HARD, message.kill) || | |
7b56f532 JB |
918 | (message.kill != null && |
919 | ((this.opts.enableTasksQueue === false && | |
aa9eede8 | 920 | workerUsage.tasks.executing === 0) || |
7b56f532 | 921 | (this.opts.enableTasksQueue === true && |
aa9eede8 JB |
922 | workerUsage.tasks.executing === 0 && |
923 | this.tasksQueueSize(localWorkerNodeKey) === 0))) | |
930dcf12 JB |
924 | ) { |
925 | // Kill message received from the worker: no new tasks are submitted to that worker for a while ( > maxInactiveTime) | |
7c89e6a4 JB |
926 | const destroyWorkerNodeBounded = this.destroyWorkerNode.bind(this) |
927 | if (isAsyncFunction(destroyWorkerNodeBounded)) { | |
928 | ( | |
929 | destroyWorkerNodeBounded as (workerNodeKey: number) => Promise<void> | |
930 | )(localWorkerNodeKey).catch(EMPTY_FUNCTION) | |
931 | } else { | |
932 | (destroyWorkerNodeBounded as (workerNodeKey: number) => void)( | |
933 | localWorkerNodeKey | |
934 | ) | |
935 | } | |
930dcf12 JB |
936 | } |
937 | }) | |
aa9eede8 | 938 | const workerInfo = this.getWorkerInfo(workerNodeKey) |
b0a4db63 | 939 | workerInfo.dynamic = true |
b97d82d8 JB |
940 | if (this.workerChoiceStrategyContext.getStrategyPolicy().useDynamicWorker) { |
941 | workerInfo.ready = true | |
942 | } | |
aa9eede8 | 943 | this.sendToWorker(workerNodeKey, { |
b0a4db63 | 944 | checkActive: true, |
21f710aa JB |
945 | workerId: workerInfo.id as number |
946 | }) | |
aa9eede8 | 947 | return workerNodeKey |
930dcf12 JB |
948 | } |
949 | ||
a2ed5053 | 950 | /** |
aa9eede8 | 951 | * Registers a listener callback on the worker given its worker node key. |
a2ed5053 | 952 | * |
aa9eede8 | 953 | * @param workerNodeKey - The worker node key. |
a2ed5053 JB |
954 | * @param listener - The message listener callback. |
955 | */ | |
85aeb3f3 JB |
956 | protected abstract registerWorkerMessageListener< |
957 | Message extends Data | Response | |
aa9eede8 JB |
958 | >( |
959 | workerNodeKey: number, | |
960 | listener: (message: MessageValue<Message>) => void | |
961 | ): void | |
a2ed5053 JB |
962 | |
963 | /** | |
aa9eede8 | 964 | * Method hooked up after a worker node has been newly created. |
a2ed5053 JB |
965 | * Can be overridden. |
966 | * | |
aa9eede8 | 967 | * @param workerNodeKey - The newly created worker node key. |
a2ed5053 | 968 | */ |
aa9eede8 | 969 | protected afterWorkerNodeSetup (workerNodeKey: number): void { |
a2ed5053 | 970 | // Listen to worker messages. |
aa9eede8 | 971 | this.registerWorkerMessageListener(workerNodeKey, this.workerListener()) |
85aeb3f3 | 972 | // Send the startup message to worker. |
aa9eede8 JB |
973 | this.sendStartupMessageToWorker(workerNodeKey) |
974 | // Send the worker statistics message to worker. | |
975 | this.sendWorkerStatisticsMessageToWorker(workerNodeKey) | |
d2c73f82 JB |
976 | } |
977 | ||
85aeb3f3 | 978 | /** |
aa9eede8 JB |
979 | * Sends the startup message to worker given its worker node key. |
980 | * | |
981 | * @param workerNodeKey - The worker node key. | |
982 | */ | |
983 | protected abstract sendStartupMessageToWorker (workerNodeKey: number): void | |
984 | ||
985 | /** | |
986 | * Sends the worker statistics message to worker given its worker node key. | |
85aeb3f3 | 987 | * |
aa9eede8 | 988 | * @param workerNodeKey - The worker node key. |
85aeb3f3 | 989 | */ |
aa9eede8 JB |
990 | private sendWorkerStatisticsMessageToWorker (workerNodeKey: number): void { |
991 | this.sendToWorker(workerNodeKey, { | |
992 | statistics: { | |
993 | runTime: | |
994 | this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
995 | .runTime.aggregate, | |
996 | elu: this.workerChoiceStrategyContext.getTaskStatisticsRequirements() | |
997 | .elu.aggregate | |
998 | }, | |
999 | workerId: this.getWorkerInfo(workerNodeKey).id as number | |
1000 | }) | |
1001 | } | |
a2ed5053 JB |
1002 | |
1003 | private redistributeQueuedTasks (workerNodeKey: number): void { | |
1004 | while (this.tasksQueueSize(workerNodeKey) > 0) { | |
1005 | let targetWorkerNodeKey: number = workerNodeKey | |
1006 | let minQueuedTasks = Infinity | |
10ecf8fd | 1007 | let executeTask = false |
a2ed5053 JB |
1008 | for (const [workerNodeId, workerNode] of this.workerNodes.entries()) { |
1009 | const workerInfo = this.getWorkerInfo(workerNodeId) | |
1010 | if ( | |
1011 | workerNodeId !== workerNodeKey && | |
1012 | workerInfo.ready && | |
1013 | workerNode.usage.tasks.queued === 0 | |
1014 | ) { | |
a5ed75b7 JB |
1015 | if ( |
1016 | this.workerNodes[workerNodeId].usage.tasks.executing < | |
1017 | (this.opts.tasksQueueOptions?.concurrency as number) | |
1018 | ) { | |
10ecf8fd JB |
1019 | executeTask = true |
1020 | } | |
a2ed5053 JB |
1021 | targetWorkerNodeKey = workerNodeId |
1022 | break | |
1023 | } | |
1024 | if ( | |
1025 | workerNodeId !== workerNodeKey && | |
1026 | workerInfo.ready && | |
1027 | workerNode.usage.tasks.queued < minQueuedTasks | |
1028 | ) { | |
1029 | minQueuedTasks = workerNode.usage.tasks.queued | |
1030 | targetWorkerNodeKey = workerNodeId | |
1031 | } | |
1032 | } | |
10ecf8fd JB |
1033 | if (executeTask) { |
1034 | this.executeTask( | |
1035 | targetWorkerNodeKey, | |
1036 | this.dequeueTask(workerNodeKey) as Task<Data> | |
1037 | ) | |
1038 | } else { | |
1039 | this.enqueueTask( | |
1040 | targetWorkerNodeKey, | |
1041 | this.dequeueTask(workerNodeKey) as Task<Data> | |
1042 | ) | |
1043 | } | |
a2ed5053 JB |
1044 | } |
1045 | } | |
1046 | ||
be0676b3 | 1047 | /** |
aa9eede8 | 1048 | * This method is the listener registered for each worker message. |
be0676b3 | 1049 | * |
bdacc2d2 | 1050 | * @returns The listener function to execute when a message is received from a worker. |
be0676b3 APA |
1051 | */ |
1052 | protected workerListener (): (message: MessageValue<Response>) => void { | |
4a6952ff | 1053 | return message => { |
21f710aa | 1054 | this.checkMessageWorkerId(message) |
d2c73f82 | 1055 | if (message.ready != null) { |
10e2aa7e JB |
1056 | // Worker ready response received |
1057 | this.handleWorkerReadyResponse(message) | |
f59e1027 | 1058 | } else if (message.id != null) { |
a3445496 | 1059 | // Task execution response received |
6b272951 JB |
1060 | this.handleTaskExecutionResponse(message) |
1061 | } | |
1062 | } | |
1063 | } | |
1064 | ||
10e2aa7e | 1065 | private handleWorkerReadyResponse (message: MessageValue<Response>): void { |
aa9eede8 JB |
1066 | this.getWorkerInfo( |
1067 | this.getWorkerNodeKeyByWorkerId(message.workerId) as number | |
e221309a | 1068 | ).ready = message.ready as boolean |
2431bdb4 JB |
1069 | if (this.emitter != null && this.ready) { |
1070 | this.emitter.emit(PoolEvents.ready, this.info) | |
1071 | } | |
6b272951 JB |
1072 | } |
1073 | ||
1074 | private handleTaskExecutionResponse (message: MessageValue<Response>): void { | |
1075 | const promiseResponse = this.promiseResponseMap.get(message.id as string) | |
1076 | if (promiseResponse != null) { | |
1077 | if (message.taskError != null) { | |
2a69b8c5 | 1078 | this.emitter?.emit(PoolEvents.taskError, message.taskError) |
6b272951 JB |
1079 | promiseResponse.reject(message.taskError.message) |
1080 | } else { | |
1081 | promiseResponse.resolve(message.data as Response) | |
1082 | } | |
501aea93 JB |
1083 | const workerNodeKey = promiseResponse.workerNodeKey |
1084 | this.afterTaskExecutionHook(workerNodeKey, message) | |
6b272951 | 1085 | this.promiseResponseMap.delete(message.id as string) |
6b272951 JB |
1086 | if ( |
1087 | this.opts.enableTasksQueue === true && | |
1088 | this.tasksQueueSize(workerNodeKey) > 0 | |
1089 | ) { | |
1090 | this.executeTask( | |
1091 | workerNodeKey, | |
1092 | this.dequeueTask(workerNodeKey) as Task<Data> | |
1093 | ) | |
be0676b3 | 1094 | } |
6b272951 | 1095 | this.workerChoiceStrategyContext.update(workerNodeKey) |
be0676b3 | 1096 | } |
be0676b3 | 1097 | } |
7c0ba920 | 1098 | |
ff733df7 | 1099 | private checkAndEmitEvents (): void { |
1f68cede | 1100 | if (this.emitter != null) { |
ff733df7 | 1101 | if (this.busy) { |
2845f2a5 | 1102 | this.emitter.emit(PoolEvents.busy, this.info) |
ff733df7 | 1103 | } |
6b27d407 | 1104 | if (this.type === PoolTypes.dynamic && this.full) { |
2845f2a5 | 1105 | this.emitter.emit(PoolEvents.full, this.info) |
ff733df7 | 1106 | } |
164d950a JB |
1107 | } |
1108 | } | |
1109 | ||
8a1260a3 | 1110 | /** |
aa9eede8 | 1111 | * Gets the worker information given its worker node key. |
8a1260a3 JB |
1112 | * |
1113 | * @param workerNodeKey - The worker node key. | |
3f09ed9f | 1114 | * @returns The worker information. |
8a1260a3 | 1115 | */ |
aa9eede8 | 1116 | protected getWorkerInfo (workerNodeKey: number): WorkerInfo { |
dc02fc29 | 1117 | return this.workerNodes[workerNodeKey].info |
e221309a JB |
1118 | } |
1119 | ||
a05c10de | 1120 | /** |
b0a4db63 | 1121 | * Adds the given worker in the pool worker nodes. |
ea7a90d3 | 1122 | * |
38e795c1 | 1123 | * @param worker - The worker. |
aa9eede8 JB |
1124 | * @returns The added worker node key. |
1125 | * @throws {@link https://nodejs.org/api/errors.html#class-error} If the added worker node is not found. | |
ea7a90d3 | 1126 | */ |
b0a4db63 | 1127 | private addWorkerNode (worker: Worker): number { |
cc3ab78b | 1128 | const workerNode = new WorkerNode<Worker, Data>(worker, this.worker) |
b97d82d8 | 1129 | // Flag the worker node as ready at pool startup. |
d2c73f82 JB |
1130 | if (this.starting) { |
1131 | workerNode.info.ready = true | |
1132 | } | |
aa9eede8 JB |
1133 | this.workerNodes.push(workerNode) |
1134 | const workerNodeKey = this.getWorkerNodeKey(worker) | |
1135 | if (workerNodeKey === -1) { | |
1136 | throw new Error('Worker node not found') | |
1137 | } | |
1138 | return workerNodeKey | |
ea7a90d3 | 1139 | } |
c923ce56 | 1140 | |
51fe3d3c | 1141 | /** |
f06e48d8 | 1142 | * Removes the given worker from the pool worker nodes. |
51fe3d3c | 1143 | * |
f06e48d8 | 1144 | * @param worker - The worker. |
51fe3d3c | 1145 | */ |
416fd65c | 1146 | private removeWorkerNode (worker: Worker): void { |
f06e48d8 | 1147 | const workerNodeKey = this.getWorkerNodeKey(worker) |
1f68cede JB |
1148 | if (workerNodeKey !== -1) { |
1149 | this.workerNodes.splice(workerNodeKey, 1) | |
1150 | this.workerChoiceStrategyContext.remove(workerNodeKey) | |
1151 | } | |
51fe3d3c | 1152 | } |
adc3c320 | 1153 | |
b0a4db63 | 1154 | /** |
aa9eede8 | 1155 | * Executes the given task on the worker given its worker node key. |
b0a4db63 | 1156 | * |
aa9eede8 | 1157 | * @param workerNodeKey - The worker node key. |
b0a4db63 JB |
1158 | * @param task - The task to execute. |
1159 | */ | |
2e81254d | 1160 | private executeTask (workerNodeKey: number, task: Task<Data>): void { |
1c6fe997 | 1161 | this.beforeTaskExecutionHook(workerNodeKey, task) |
aa9eede8 | 1162 | this.sendToWorker(workerNodeKey, task) |
2e81254d JB |
1163 | } |
1164 | ||
f9f00b5f | 1165 | private enqueueTask (workerNodeKey: number, task: Task<Data>): number { |
4b628b48 | 1166 | return this.workerNodes[workerNodeKey].enqueueTask(task) |
adc3c320 JB |
1167 | } |
1168 | ||
416fd65c | 1169 | private dequeueTask (workerNodeKey: number): Task<Data> | undefined { |
4b628b48 | 1170 | return this.workerNodes[workerNodeKey].dequeueTask() |
adc3c320 JB |
1171 | } |
1172 | ||
416fd65c | 1173 | private tasksQueueSize (workerNodeKey: number): number { |
4b628b48 | 1174 | return this.workerNodes[workerNodeKey].tasksQueueSize() |
df593701 JB |
1175 | } |
1176 | ||
416fd65c | 1177 | private flushTasksQueue (workerNodeKey: number): void { |
920278a2 JB |
1178 | while (this.tasksQueueSize(workerNodeKey) > 0) { |
1179 | this.executeTask( | |
1180 | workerNodeKey, | |
1181 | this.dequeueTask(workerNodeKey) as Task<Data> | |
1182 | ) | |
ff733df7 | 1183 | } |
4b628b48 | 1184 | this.workerNodes[workerNodeKey].clearTasksQueue() |
ff733df7 JB |
1185 | } |
1186 | ||
ef41a6e6 JB |
1187 | private flushTasksQueues (): void { |
1188 | for (const [workerNodeKey] of this.workerNodes.entries()) { | |
1189 | this.flushTasksQueue(workerNodeKey) | |
1190 | } | |
1191 | } | |
c97c7edb | 1192 | } |