-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
abstract-pool.ts
571 lines (519 loc) · 17 KB
/
abstract-pool.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
import crypto from 'node:crypto'
import type { MessageValue, PromiseResponseWrapper } from '../utility-types'
import { EMPTY_FUNCTION, median } from '../utils'
import { KillBehaviors, isKillBehavior } from '../worker/worker-options'
import { PoolEvents, type PoolOptions } from './pool'
import { PoolEmitter } from './pool'
import type { IPoolInternal } from './pool-internal'
import { PoolType } from './pool-internal'
import type { IWorker, Task, TasksUsage, WorkerNode } from './worker'
import {
WorkerChoiceStrategies,
type WorkerChoiceStrategy
} from './selection-strategies/selection-strategies-types'
import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context'
import { CircularArray } from '../circular-array'
/**
* Base class that implements some shared logic for all poolifier pools.
*
* @typeParam Worker - Type of worker which manages this pool.
* @typeParam Data - Type of data sent to the worker. This can only be serializable data.
* @typeParam Response - Type of response of execution. This can only be serializable data.
*/
export abstract class AbstractPool<
Worker extends IWorker,
Data = unknown,
Response = unknown
> implements IPoolInternal<Worker, Data, Response> {
/** @inheritDoc */
public readonly workerNodes: Array<WorkerNode<Worker, Data>> = []
/** @inheritDoc */
public readonly emitter?: PoolEmitter
/**
* The execution response promise map.
*
* - `key`: The message id of each submitted task.
* - `value`: An object that contains the worker, the execution response promise resolve and reject callbacks.
*
* When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
*/
protected promiseResponseMap: Map<
string,
PromiseResponseWrapper<Worker, Response>
> = new Map<string, PromiseResponseWrapper<Worker, Response>>()
/**
* Worker choice strategy context referencing a worker choice algorithm implementation.
*
* Default to a round robin algorithm.
*/
protected workerChoiceStrategyContext: WorkerChoiceStrategyContext<
Worker,
Data,
Response
>
/**
* Constructs a new poolifier pool.
*
* @param numberOfWorkers - Number of workers that this pool should manage.
* @param filePath - Path to the worker-file.
* @param opts - Options for the pool.
*/
public constructor (
public readonly numberOfWorkers: number,
public readonly filePath: string,
public readonly opts: PoolOptions<Worker>
) {
if (!this.isMain()) {
throw new Error('Cannot start a pool from a worker!')
}
this.checkNumberOfWorkers(this.numberOfWorkers)
this.checkFilePath(this.filePath)
this.checkPoolOptions(this.opts)
this.chooseWorkerNode.bind(this)
this.executeTask.bind(this)
this.enqueueTask.bind(this)
this.checkAndEmitEvents.bind(this)
this.setupHook()
for (let i = 1; i <= this.numberOfWorkers; i++) {
this.createAndSetupWorker()
}
if (this.opts.enableEvents === true) {
this.emitter = new PoolEmitter()
}
this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext<
Worker,
Data,
Response
>(
this,
this.opts.workerChoiceStrategy,
this.opts.workerChoiceStrategyOptions
)
}
private checkFilePath (filePath: string): void {
if (
filePath == null ||
(typeof filePath === 'string' && filePath.trim().length === 0)
) {
throw new Error('Please specify a file with a worker implementation')
}
}
private checkNumberOfWorkers (numberOfWorkers: number): void {
if (numberOfWorkers == null) {
throw new Error(
'Cannot instantiate a pool without specifying the number of workers'
)
} else if (!Number.isSafeInteger(numberOfWorkers)) {
throw new TypeError(
'Cannot instantiate a pool with a non integer number of workers'
)
} else if (numberOfWorkers < 0) {
throw new RangeError(
'Cannot instantiate a pool with a negative number of workers'
)
} else if (this.type === PoolType.FIXED && numberOfWorkers === 0) {
throw new Error('Cannot instantiate a fixed pool with no worker')
}
}
private checkPoolOptions (opts: PoolOptions<Worker>): void {
this.opts.workerChoiceStrategy =
opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy)
this.opts.workerChoiceStrategyOptions =
opts.workerChoiceStrategyOptions ?? { medRunTime: false }
this.opts.enableEvents = opts.enableEvents ?? true
this.opts.enableTasksQueue = opts.enableTasksQueue ?? false
}
private checkValidWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
if (!Object.values(WorkerChoiceStrategies).includes(workerChoiceStrategy)) {
throw new Error(
`Invalid worker choice strategy '${workerChoiceStrategy}'`
)
}
}
/** @inheritDoc */
public abstract get type (): PoolType
/**
* Number of tasks running in the pool.
*/
private get numberOfRunningTasks (): number {
return this.workerNodes.reduce(
(accumulator, workerNode) => accumulator + workerNode.tasksUsage.running,
0
)
}
/**
* Number of tasks queued in the pool.
*/
private get numberOfQueuedTasks (): number {
if (this.opts.enableTasksQueue === false) {
return 0
}
return this.workerNodes.reduce(
(accumulator, workerNode) => accumulator + workerNode.tasksQueue.length,
0
)
}
/**
* Gets the given worker its worker node key.
*
* @param worker - The worker.
* @returns The worker node key if the worker is found in the pool worker nodes, `-1` otherwise.
*/
private getWorkerNodeKey (worker: Worker): number {
return this.workerNodes.findIndex(
workerNode => workerNode.worker === worker
)
}
/** @inheritDoc */
public setWorkerChoiceStrategy (
workerChoiceStrategy: WorkerChoiceStrategy
): void {
this.checkValidWorkerChoiceStrategy(workerChoiceStrategy)
this.opts.workerChoiceStrategy = workerChoiceStrategy
for (const workerNode of this.workerNodes) {
this.setWorkerNodeTasksUsage(workerNode, {
run: 0,
running: 0,
runTime: 0,
runTimeHistory: new CircularArray(),
avgRunTime: 0,
medRunTime: 0,
error: 0
})
}
this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
workerChoiceStrategy
)
}
/** @inheritDoc */
public abstract get full (): boolean
/** @inheritDoc */
public abstract get busy (): boolean
protected internalBusy (): boolean {
return this.findFreeWorkerNodeKey() === -1
}
/** @inheritDoc */
public findFreeWorkerNodeKey (): number {
return this.workerNodes.findIndex(workerNode => {
return workerNode.tasksUsage?.running === 0
})
}
/** @inheritDoc */
public async execute (data: Data): Promise<Response> {
const [workerNodeKey, workerNode] = this.chooseWorkerNode()
const submittedTask: Task<Data> = {
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
data: data ?? ({} as Data),
id: crypto.randomUUID()
}
const res = new Promise<Response>((resolve, reject) => {
this.promiseResponseMap.set(submittedTask.id, {
resolve,
reject,
worker: workerNode.worker
})
})
if (
this.opts.enableTasksQueue === true &&
(this.busy || this.workerNodes[workerNodeKey].tasksUsage.running > 0)
) {
this.enqueueTask(workerNodeKey, submittedTask)
} else {
this.executeTask(workerNodeKey, submittedTask)
}
this.checkAndEmitEvents()
// eslint-disable-next-line @typescript-eslint/return-await
return res
}
/** @inheritDoc */
public async destroy (): Promise<void> {
await Promise.all(
this.workerNodes.map(async (workerNode, workerNodeKey) => {
this.flushTasksQueue(workerNodeKey)
await this.destroyWorker(workerNode.worker)
})
)
}
/**
* Shutdowns the given worker.
*
* @param worker - A worker within `workerNodes`.
*/
protected abstract destroyWorker (worker: Worker): void | Promise<void>
/**
* Setup hook to execute code before worker node are created in the abstract constructor.
* Can be overridden
*
* @virtual
*/
protected setupHook (): void {
// Intentionally empty
}
/**
* Should return whether the worker is the main worker or not.
*/
protected abstract isMain (): boolean
/**
* Hook executed before the worker task execution.
* Can be overridden.
*
* @param workerNodeKey - The worker node key.
*/
protected beforeTaskExecutionHook (workerNodeKey: number): void {
++this.workerNodes[workerNodeKey].tasksUsage.running
}
/**
* Hook executed after the worker task execution.
* Can be overridden.
*
* @param worker - The worker.
* @param message - The received message.
*/
protected afterTaskExecutionHook (
worker: Worker,
message: MessageValue<Response>
): void {
const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage
--workerTasksUsage.running
++workerTasksUsage.run
if (message.error != null) {
++workerTasksUsage.error
}
if (this.workerChoiceStrategyContext.getRequiredStatistics().runTime) {
workerTasksUsage.runTime += message.runTime ?? 0
if (
this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime &&
workerTasksUsage.run !== 0
) {
workerTasksUsage.avgRunTime =
workerTasksUsage.runTime / workerTasksUsage.run
}
if (this.workerChoiceStrategyContext.getRequiredStatistics().medRunTime) {
workerTasksUsage.runTimeHistory.push(message.runTime ?? 0)
workerTasksUsage.medRunTime = median(workerTasksUsage.runTimeHistory)
}
}
}
/**
* Chooses a worker node for the next task.
*
* The default uses a round robin algorithm to distribute the load.
*
* @returns [worker node key, worker node].
*/
protected chooseWorkerNode (): [number, WorkerNode<Worker, Data>] {
let workerNodeKey: number
if (this.type === PoolType.DYNAMIC && !this.full && this.internalBusy()) {
const workerCreated = this.createAndSetupWorker()
this.registerWorkerMessageListener(workerCreated, message => {
if (
isKillBehavior(KillBehaviors.HARD, message.kill) ||
(message.kill != null &&
this.getWorkerTasksUsage(workerCreated)?.running === 0)
) {
// Kill message received from the worker: no new tasks are submitted to that worker for a while ( > maxInactiveTime)
this.flushTasksQueueByWorker(workerCreated)
void this.destroyWorker(workerCreated)
}
})
workerNodeKey = this.getWorkerNodeKey(workerCreated)
} else {
workerNodeKey = this.workerChoiceStrategyContext.execute()
}
return [workerNodeKey, this.workerNodes[workerNodeKey]]
}
/**
* Sends a message to the given worker.
*
* @param worker - The worker which should receive the message.
* @param message - The message.
*/
protected abstract sendToWorker (
worker: Worker,
message: MessageValue<Data>
): void
/**
* Registers a listener callback on the given worker.
*
* @param worker - The worker which should register a listener.
* @param listener - The message listener callback.
*/
protected abstract registerWorkerMessageListener<
Message extends Data | Response
>(worker: Worker, listener: (message: MessageValue<Message>) => void): void
/**
* Returns a newly created worker.
*/
protected abstract createWorker (): Worker
/**
* Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.
*
* Can be used to update the `maxListeners` or binding the `main-worker`\<-\>`worker` connection if not bind by default.
*
* @param worker - The newly created worker.
*/
protected abstract afterWorkerSetup (worker: Worker): void
/**
* Creates a new worker and sets it up completely in the pool worker nodes.
*
* @returns New, completely set up worker.
*/
protected createAndSetupWorker (): Worker {
const worker = this.createWorker()
worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION)
worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION)
worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION)
worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION)
worker.once('exit', () => {
this.removeWorkerNode(worker)
})
this.pushWorkerNode(worker)
this.afterWorkerSetup(worker)
return worker
}
/**
* This function is the listener registered for each worker message.
*
* @returns The listener function to execute when a message is received from a worker.
*/
protected workerListener (): (message: MessageValue<Response>) => void {
return message => {
if (message.id != null) {
// Task execution response received
const promiseResponse = this.promiseResponseMap.get(message.id)
if (promiseResponse != null) {
if (message.error != null) {
promiseResponse.reject(message.error)
} else {
promiseResponse.resolve(message.data as Response)
}
this.afterTaskExecutionHook(promiseResponse.worker, message)
this.promiseResponseMap.delete(message.id)
const workerNodeKey = this.getWorkerNodeKey(promiseResponse.worker)
if (
this.opts.enableTasksQueue === true &&
this.tasksQueueSize(workerNodeKey) > 0
) {
this.executeTask(
workerNodeKey,
this.dequeueTask(workerNodeKey) as Task<Data>
)
}
}
}
}
}
private checkAndEmitEvents (): void {
if (this.opts.enableEvents === true) {
if (this.busy) {
this.emitter?.emit(PoolEvents.busy)
}
if (this.type === PoolType.DYNAMIC && this.full) {
this.emitter?.emit(PoolEvents.full)
}
}
}
/**
* Sets the given worker node its tasks usage in the pool.
*
* @param workerNode - The worker node.
* @param tasksUsage - The worker node tasks usage.
*/
private setWorkerNodeTasksUsage (
workerNode: WorkerNode<Worker, Data>,
tasksUsage: TasksUsage
): void {
workerNode.tasksUsage = tasksUsage
}
/**
* Gets the given worker its tasks usage in the pool.
*
* @param worker - The worker.
* @returns The worker tasks usage.
*/
private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined {
const workerNodeKey = this.getWorkerNodeKey(worker)
if (workerNodeKey !== -1) {
return this.workerNodes[workerNodeKey].tasksUsage
}
throw new Error('Worker could not be found in the pool worker nodes')
}
/**
* Pushes the given worker in the pool worker nodes.
*
* @param worker - The worker.
* @returns The worker nodes length.
*/
private pushWorkerNode (worker: Worker): number {
return this.workerNodes.push({
worker,
tasksUsage: {
run: 0,
running: 0,
runTime: 0,
runTimeHistory: new CircularArray(),
avgRunTime: 0,
medRunTime: 0,
error: 0
},
tasksQueue: []
})
}
/**
* Sets the given worker in the pool worker nodes.
*
* @param workerNodeKey - The worker node key.
* @param worker - The worker.
* @param tasksUsage - The worker tasks usage.
* @param tasksQueue - The worker task queue.
*/
private setWorkerNode (
workerNodeKey: number,
worker: Worker,
tasksUsage: TasksUsage,
tasksQueue: Array<Task<Data>>
): void {
this.workerNodes[workerNodeKey] = {
worker,
tasksUsage,
tasksQueue
}
}
/**
* Removes the given worker from the pool worker nodes.
*
* @param worker - The worker.
*/
private removeWorkerNode (worker: Worker): void {
const workerNodeKey = this.getWorkerNodeKey(worker)
this.workerNodes.splice(workerNodeKey, 1)
this.workerChoiceStrategyContext.remove(workerNodeKey)
}
private executeTask (workerNodeKey: number, task: Task<Data>): void {
this.beforeTaskExecutionHook(workerNodeKey)
this.sendToWorker(this.workerNodes[workerNodeKey].worker, task)
}
private enqueueTask (workerNodeKey: number, task: Task<Data>): number {
return this.workerNodes[workerNodeKey].tasksQueue.push(task)
}
private dequeueTask (workerNodeKey: number): Task<Data> | undefined {
return this.workerNodes[workerNodeKey].tasksQueue.shift()
}
private tasksQueueSize (workerNodeKey: number): number {
return this.workerNodes[workerNodeKey].tasksQueue.length
}
private flushTasksQueue (workerNodeKey: number): void {
if (this.tasksQueueSize(workerNodeKey) > 0) {
for (const task of this.workerNodes[workerNodeKey].tasksQueue) {
this.executeTask(workerNodeKey, task)
}
}
}
private flushTasksQueueByWorker (worker: Worker): void {
const workerNodeKey = this.getWorkerNodeKey(worker)
this.flushTasksQueue(workerNodeKey)
}
}