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