Commit | Line | Data |
---|---|---|
fc3e6586 | 1 | import crypto from 'node:crypto' |
2740a743 | 2 | import type { MessageValue, PromiseResponseWrapper } from '../utility-types' |
ed6dd37f | 3 | import { EMPTY_FUNCTION } from '../utils' |
34a0cfab | 4 | import { KillBehaviors, isKillBehavior } from '../worker/worker-options' |
bdaf31cd | 5 | import type { PoolOptions } from './pool' |
b4904890 | 6 | import { PoolEmitter } from './pool' |
ffcbbad8 | 7 | import type { IPoolInternal, TasksUsage, WorkerType } from './pool-internal' |
b4904890 | 8 | import { PoolType } from './pool-internal' |
ea7a90d3 | 9 | import type { IPoolWorker } from './pool-worker' |
a35560ba S |
10 | import { |
11 | WorkerChoiceStrategies, | |
63220255 | 12 | type WorkerChoiceStrategy |
bdaf31cd JB |
13 | } from './selection-strategies/selection-strategies-types' |
14 | import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context' | |
c97c7edb | 15 | |
729c563d | 16 | /** |
ea7a90d3 | 17 | * Base class that implements some shared logic for all poolifier pools. |
729c563d | 18 | * |
38e795c1 JB |
19 | * @typeParam Worker - Type of worker which manages this pool. |
20 | * @typeParam Data - Type of data sent to the worker. This can only be serializable data. | |
21 | * @typeParam Response - Type of response of execution. This can only be serializable data. | |
729c563d | 22 | */ |
c97c7edb | 23 | export abstract class AbstractPool< |
ea7a90d3 | 24 | Worker extends IPoolWorker, |
d3c8a1a8 S |
25 | Data = unknown, |
26 | Response = unknown | |
9b2fdd9f | 27 | > implements IPoolInternal<Worker, Data, Response> { |
38e795c1 | 28 | /** {@inheritDoc} */ |
e65c6cd9 | 29 | public readonly workers: Array<WorkerType<Worker>> = [] |
4a6952ff | 30 | |
38e795c1 | 31 | /** {@inheritDoc} */ |
7c0ba920 JB |
32 | public readonly emitter?: PoolEmitter |
33 | ||
be0676b3 | 34 | /** |
2740a743 | 35 | * The promise response map. |
be0676b3 | 36 | * |
2740a743 | 37 | * - `key`: The message id of each submitted task. |
c923ce56 | 38 | * - `value`: An object that contains the worker, the promise resolve and reject callbacks. |
be0676b3 | 39 | * |
2740a743 | 40 | * When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message. |
be0676b3 | 41 | */ |
c923ce56 JB |
42 | protected promiseResponseMap: Map< |
43 | string, | |
44 | PromiseResponseWrapper<Worker, Response> | |
45 | > = new Map<string, PromiseResponseWrapper<Worker, Response>>() | |
c97c7edb | 46 | |
a35560ba | 47 | /** |
51fe3d3c | 48 | * Worker choice strategy context referencing a worker choice algorithm implementation. |
a35560ba | 49 | * |
51fe3d3c | 50 | * Default to a round robin algorithm. |
a35560ba S |
51 | */ |
52 | protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< | |
78cea37e JB |
53 | Worker, |
54 | Data, | |
55 | Response | |
a35560ba S |
56 | > |
57 | ||
729c563d S |
58 | /** |
59 | * Constructs a new poolifier pool. | |
60 | * | |
38e795c1 JB |
61 | * @param numberOfWorkers - Number of workers that this pool should manage. |
62 | * @param filePath - Path to the worker-file. | |
63 | * @param opts - Options for the pool. | |
729c563d | 64 | */ |
c97c7edb | 65 | public constructor ( |
5c5a1fb7 | 66 | public readonly numberOfWorkers: number, |
c97c7edb | 67 | public readonly filePath: string, |
1927ee67 | 68 | public readonly opts: PoolOptions<Worker> |
c97c7edb | 69 | ) { |
78cea37e | 70 | if (!this.isMain()) { |
c97c7edb S |
71 | throw new Error('Cannot start a pool from a worker!') |
72 | } | |
8d3782fa | 73 | this.checkNumberOfWorkers(this.numberOfWorkers) |
c510fea7 | 74 | this.checkFilePath(this.filePath) |
7c0ba920 | 75 | this.checkPoolOptions(this.opts) |
1086026a JB |
76 | |
77 | this.chooseWorker.bind(this) | |
78 | this.internalExecute.bind(this) | |
164d950a | 79 | this.checkAndEmitFull.bind(this) |
1086026a JB |
80 | this.checkAndEmitBusy.bind(this) |
81 | this.sendToWorker.bind(this) | |
82 | ||
c97c7edb S |
83 | this.setupHook() |
84 | ||
5c5a1fb7 | 85 | for (let i = 1; i <= this.numberOfWorkers; i++) { |
280c2a77 | 86 | this.createAndSetupWorker() |
c97c7edb S |
87 | } |
88 | ||
6bd72cd0 | 89 | if (this.opts.enableEvents === true) { |
7c0ba920 JB |
90 | this.emitter = new PoolEmitter() |
91 | } | |
d59df138 JB |
92 | this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext< |
93 | Worker, | |
94 | Data, | |
95 | Response | |
96 | >( | |
a35560ba | 97 | this, |
4a6952ff | 98 | () => { |
c923ce56 JB |
99 | const createdWorker = this.createAndSetupWorker() |
100 | this.registerWorkerMessageListener(createdWorker, message => { | |
4a6952ff JB |
101 | if ( |
102 | isKillBehavior(KillBehaviors.HARD, message.kill) || | |
c923ce56 | 103 | this.getWorkerTasksUsage(createdWorker)?.running === 0 |
4a6952ff JB |
104 | ) { |
105 | // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime) | |
c923ce56 | 106 | void this.destroyWorker(createdWorker) |
4a6952ff JB |
107 | } |
108 | }) | |
c923ce56 | 109 | return this.getWorkerKey(createdWorker) |
4a6952ff | 110 | }, |
e843b904 | 111 | this.opts.workerChoiceStrategy |
a35560ba | 112 | ) |
c97c7edb S |
113 | } |
114 | ||
a35560ba | 115 | private checkFilePath (filePath: string): void { |
ffcbbad8 JB |
116 | if ( |
117 | filePath == null || | |
118 | (typeof filePath === 'string' && filePath.trim().length === 0) | |
119 | ) { | |
c510fea7 APA |
120 | throw new Error('Please specify a file with a worker implementation') |
121 | } | |
122 | } | |
123 | ||
8d3782fa JB |
124 | private checkNumberOfWorkers (numberOfWorkers: number): void { |
125 | if (numberOfWorkers == null) { | |
126 | throw new Error( | |
127 | 'Cannot instantiate a pool without specifying the number of workers' | |
128 | ) | |
78cea37e | 129 | } else if (!Number.isSafeInteger(numberOfWorkers)) { |
473c717a | 130 | throw new TypeError( |
8d3782fa JB |
131 | 'Cannot instantiate a pool with a non integer number of workers' |
132 | ) | |
133 | } else if (numberOfWorkers < 0) { | |
473c717a | 134 | throw new RangeError( |
8d3782fa JB |
135 | 'Cannot instantiate a pool with a negative number of workers' |
136 | ) | |
7c0ba920 | 137 | } else if (this.type === PoolType.FIXED && numberOfWorkers === 0) { |
8d3782fa JB |
138 | throw new Error('Cannot instantiate a fixed pool with no worker') |
139 | } | |
140 | } | |
141 | ||
7c0ba920 | 142 | private checkPoolOptions (opts: PoolOptions<Worker>): void { |
e843b904 JB |
143 | this.opts.workerChoiceStrategy = |
144 | opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN | |
b529c323 JB |
145 | if ( |
146 | !Object.values(WorkerChoiceStrategies).includes( | |
147 | this.opts.workerChoiceStrategy | |
148 | ) | |
149 | ) { | |
150 | throw new Error( | |
151 | `Invalid worker choice strategy '${this.opts.workerChoiceStrategy}'` | |
152 | ) | |
153 | } | |
7c0ba920 JB |
154 | this.opts.enableEvents = opts.enableEvents ?? true |
155 | } | |
156 | ||
38e795c1 | 157 | /** {@inheritDoc} */ |
7c0ba920 JB |
158 | public abstract get type (): PoolType |
159 | ||
c2ade475 | 160 | /** |
51fe3d3c | 161 | * Number of tasks concurrently running in the pool. |
c2ade475 JB |
162 | */ |
163 | private get numberOfRunningTasks (): number { | |
2740a743 | 164 | return this.promiseResponseMap.size |
a35560ba S |
165 | } |
166 | ||
ffcbbad8 | 167 | /** |
b4e75778 | 168 | * Gets the given worker key. |
ffcbbad8 JB |
169 | * |
170 | * @param worker - The worker. | |
7cf00f70 | 171 | * @returns The worker key if the worker is found in the pool, `-1` otherwise. |
ffcbbad8 | 172 | */ |
e65c6cd9 JB |
173 | private getWorkerKey (worker: Worker): number { |
174 | return this.workers.findIndex(workerItem => workerItem.worker === worker) | |
bf9549ae JB |
175 | } |
176 | ||
38e795c1 | 177 | /** {@inheritDoc} */ |
a35560ba S |
178 | public setWorkerChoiceStrategy ( |
179 | workerChoiceStrategy: WorkerChoiceStrategy | |
180 | ): void { | |
b98ec2e6 | 181 | this.opts.workerChoiceStrategy = workerChoiceStrategy |
c923ce56 JB |
182 | for (const [index, workerItem] of this.workers.entries()) { |
183 | this.setWorker(index, workerItem.worker, { | |
ffcbbad8 JB |
184 | run: 0, |
185 | running: 0, | |
186 | runTime: 0, | |
2740a743 JB |
187 | avgRunTime: 0, |
188 | error: 0 | |
ffcbbad8 | 189 | }) |
ea7a90d3 | 190 | } |
a35560ba | 191 | this.workerChoiceStrategyContext.setWorkerChoiceStrategy( |
3300e7bc | 192 | this, |
a35560ba S |
193 | workerChoiceStrategy |
194 | ) | |
195 | } | |
196 | ||
c2ade475 JB |
197 | /** {@inheritDoc} */ |
198 | public abstract get full (): boolean | |
199 | ||
38e795c1 | 200 | /** {@inheritDoc} */ |
7c0ba920 JB |
201 | public abstract get busy (): boolean |
202 | ||
c2ade475 | 203 | protected internalBusy (): boolean { |
7c0ba920 JB |
204 | return ( |
205 | this.numberOfRunningTasks >= this.numberOfWorkers && | |
bf90656c | 206 | this.findFreeWorkerKey() === -1 |
7c0ba920 JB |
207 | ) |
208 | } | |
209 | ||
38e795c1 | 210 | /** {@inheritDoc} */ |
bf90656c JB |
211 | public findFreeWorkerKey (): number { |
212 | return this.workers.findIndex(workerItem => { | |
c923ce56 JB |
213 | return workerItem.tasksUsage.running === 0 |
214 | }) | |
7c0ba920 JB |
215 | } |
216 | ||
38e795c1 | 217 | /** {@inheritDoc} */ |
78cea37e | 218 | public async execute (data: Data): Promise<Response> { |
c923ce56 | 219 | const [workerKey, worker] = this.chooseWorker() |
b4e75778 | 220 | const messageId = crypto.randomUUID() |
c923ce56 | 221 | const res = this.internalExecute(workerKey, worker, messageId) |
164d950a | 222 | this.checkAndEmitFull() |
14916bf9 | 223 | this.checkAndEmitBusy() |
a05c10de | 224 | this.sendToWorker(worker, { |
e5a5c0fc JB |
225 | // eslint-disable-next-line @typescript-eslint/consistent-type-assertions |
226 | data: data ?? ({} as Data), | |
b4e75778 | 227 | id: messageId |
a05c10de | 228 | }) |
78cea37e | 229 | // eslint-disable-next-line @typescript-eslint/return-await |
280c2a77 S |
230 | return res |
231 | } | |
c97c7edb | 232 | |
38e795c1 | 233 | /** {@inheritDoc} */ |
c97c7edb | 234 | public async destroy (): Promise<void> { |
1fbcaa7c | 235 | await Promise.all( |
e65c6cd9 JB |
236 | this.workers.map(async workerItem => { |
237 | await this.destroyWorker(workerItem.worker) | |
1fbcaa7c JB |
238 | }) |
239 | ) | |
c97c7edb S |
240 | } |
241 | ||
4a6952ff | 242 | /** |
675bb809 | 243 | * Shutdowns given worker. |
4a6952ff | 244 | * |
38e795c1 | 245 | * @param worker - A worker within `workers`. |
4a6952ff JB |
246 | */ |
247 | protected abstract destroyWorker (worker: Worker): void | Promise<void> | |
c97c7edb | 248 | |
729c563d | 249 | /** |
280c2a77 S |
250 | * Setup hook that can be overridden by a Poolifier pool implementation |
251 | * to run code before workers are created in the abstract constructor. | |
729c563d | 252 | */ |
280c2a77 S |
253 | protected setupHook (): void { |
254 | // Can be overridden | |
255 | } | |
c97c7edb | 256 | |
729c563d | 257 | /** |
280c2a77 S |
258 | * Should return whether the worker is the main worker or not. |
259 | */ | |
260 | protected abstract isMain (): boolean | |
261 | ||
262 | /** | |
bf9549ae JB |
263 | * Hook executed before the worker task promise resolution. |
264 | * Can be overridden. | |
729c563d | 265 | * |
2740a743 | 266 | * @param workerKey - The worker key. |
729c563d | 267 | */ |
2740a743 JB |
268 | protected beforePromiseResponseHook (workerKey: number): void { |
269 | ++this.workers[workerKey].tasksUsage.running | |
c97c7edb S |
270 | } |
271 | ||
c01733f1 | 272 | /** |
bf9549ae JB |
273 | * Hook executed after the worker task promise resolution. |
274 | * Can be overridden. | |
c01733f1 | 275 | * |
c923ce56 | 276 | * @param worker - The worker. |
38e795c1 | 277 | * @param message - The received message. |
c01733f1 | 278 | */ |
2740a743 | 279 | protected afterPromiseResponseHook ( |
c923ce56 | 280 | worker: Worker, |
2740a743 | 281 | message: MessageValue<Response> |
bf9549ae | 282 | ): void { |
c923ce56 | 283 | const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage |
3032893a JB |
284 | --workerTasksUsage.running |
285 | ++workerTasksUsage.run | |
2740a743 JB |
286 | if (message.error != null) { |
287 | ++workerTasksUsage.error | |
288 | } | |
97a2abc3 | 289 | if (this.workerChoiceStrategyContext.getRequiredStatistics().runTime) { |
3032893a | 290 | workerTasksUsage.runTime += message.taskRunTime ?? 0 |
c6bd2650 JB |
291 | if ( |
292 | this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime && | |
293 | workerTasksUsage.run !== 0 | |
294 | ) { | |
3032893a JB |
295 | workerTasksUsage.avgRunTime = |
296 | workerTasksUsage.runTime / workerTasksUsage.run | |
297 | } | |
298 | } | |
c01733f1 | 299 | } |
300 | ||
280c2a77 | 301 | /** |
675bb809 | 302 | * Chooses a worker for the next task. |
280c2a77 | 303 | * |
51fe3d3c | 304 | * The default uses a round robin algorithm to distribute the load. |
280c2a77 | 305 | * |
c923ce56 | 306 | * @returns [worker key, worker]. |
280c2a77 | 307 | */ |
c923ce56 JB |
308 | protected chooseWorker (): [number, Worker] { |
309 | const workerKey = this.workerChoiceStrategyContext.execute() | |
310 | return [workerKey, this.workers[workerKey].worker] | |
c97c7edb S |
311 | } |
312 | ||
280c2a77 | 313 | /** |
675bb809 | 314 | * Sends a message to the given worker. |
280c2a77 | 315 | * |
38e795c1 JB |
316 | * @param worker - The worker which should receive the message. |
317 | * @param message - The message. | |
280c2a77 S |
318 | */ |
319 | protected abstract sendToWorker ( | |
320 | worker: Worker, | |
321 | message: MessageValue<Data> | |
322 | ): void | |
323 | ||
4a6952ff | 324 | /** |
bdede008 | 325 | * Registers a listener callback on a given worker. |
4a6952ff | 326 | * |
38e795c1 JB |
327 | * @param worker - The worker which should register a listener. |
328 | * @param listener - The message listener callback. | |
4a6952ff JB |
329 | */ |
330 | protected abstract registerWorkerMessageListener< | |
4f7fa42a | 331 | Message extends Data | Response |
78cea37e | 332 | >(worker: Worker, listener: (message: MessageValue<Message>) => void): void |
c97c7edb | 333 | |
729c563d S |
334 | /** |
335 | * Returns a newly created worker. | |
336 | */ | |
280c2a77 | 337 | protected abstract createWorker (): Worker |
c97c7edb | 338 | |
729c563d S |
339 | /** |
340 | * Function that can be hooked up when a worker has been newly created and moved to the workers registry. | |
341 | * | |
38e795c1 | 342 | * Can be used to update the `maxListeners` or binding the `main-worker`\<-\>`worker` connection if not bind by default. |
729c563d | 343 | * |
38e795c1 | 344 | * @param worker - The newly created worker. |
729c563d | 345 | */ |
280c2a77 | 346 | protected abstract afterWorkerSetup (worker: Worker): void |
c97c7edb | 347 | |
4a6952ff JB |
348 | /** |
349 | * Creates a new worker for this pool and sets it up completely. | |
350 | * | |
351 | * @returns New, completely set up worker. | |
352 | */ | |
353 | protected createAndSetupWorker (): Worker { | |
bdacc2d2 | 354 | const worker = this.createWorker() |
280c2a77 | 355 | |
35cf1c03 | 356 | worker.on('message', this.opts.messageHandler ?? EMPTY_FUNCTION) |
a35560ba S |
357 | worker.on('error', this.opts.errorHandler ?? EMPTY_FUNCTION) |
358 | worker.on('online', this.opts.onlineHandler ?? EMPTY_FUNCTION) | |
359 | worker.on('exit', this.opts.exitHandler ?? EMPTY_FUNCTION) | |
a974afa6 JB |
360 | worker.once('exit', () => { |
361 | this.removeWorker(worker) | |
362 | }) | |
280c2a77 | 363 | |
c923ce56 | 364 | this.pushWorker(worker, { |
ffcbbad8 JB |
365 | run: 0, |
366 | running: 0, | |
367 | runTime: 0, | |
2740a743 JB |
368 | avgRunTime: 0, |
369 | error: 0 | |
ffcbbad8 | 370 | }) |
280c2a77 S |
371 | |
372 | this.afterWorkerSetup(worker) | |
373 | ||
c97c7edb S |
374 | return worker |
375 | } | |
be0676b3 APA |
376 | |
377 | /** | |
378 | * This function is the listener registered for each worker. | |
379 | * | |
bdacc2d2 | 380 | * @returns The listener function to execute when a message is received from a worker. |
be0676b3 APA |
381 | */ |
382 | protected workerListener (): (message: MessageValue<Response>) => void { | |
4a6952ff | 383 | return message => { |
bdacc2d2 | 384 | if (message.id !== undefined) { |
2740a743 JB |
385 | const promiseResponse = this.promiseResponseMap.get(message.id) |
386 | if (promiseResponse !== undefined) { | |
78cea37e | 387 | if (message.error != null) { |
2740a743 | 388 | promiseResponse.reject(message.error) |
a05c10de | 389 | } else { |
2740a743 | 390 | promiseResponse.resolve(message.data as Response) |
a05c10de | 391 | } |
c923ce56 | 392 | this.afterPromiseResponseHook(promiseResponse.worker, message) |
2740a743 | 393 | this.promiseResponseMap.delete(message.id) |
be0676b3 APA |
394 | } |
395 | } | |
396 | } | |
be0676b3 | 397 | } |
7c0ba920 | 398 | |
78cea37e | 399 | private async internalExecute ( |
2740a743 | 400 | workerKey: number, |
c923ce56 | 401 | worker: Worker, |
b4e75778 | 402 | messageId: string |
78cea37e | 403 | ): Promise<Response> { |
2740a743 | 404 | this.beforePromiseResponseHook(workerKey) |
78cea37e | 405 | return await new Promise<Response>((resolve, reject) => { |
c923ce56 | 406 | this.promiseResponseMap.set(messageId, { resolve, reject, worker }) |
78cea37e JB |
407 | }) |
408 | } | |
409 | ||
7c0ba920 | 410 | private checkAndEmitBusy (): void { |
78cea37e | 411 | if (this.opts.enableEvents === true && this.busy) { |
7c0ba920 JB |
412 | this.emitter?.emit('busy') |
413 | } | |
414 | } | |
bf9549ae | 415 | |
164d950a JB |
416 | private checkAndEmitFull (): void { |
417 | if ( | |
418 | this.type === PoolType.DYNAMIC && | |
419 | this.opts.enableEvents === true && | |
420 | this.full | |
421 | ) { | |
422 | this.emitter?.emit('full') | |
423 | } | |
424 | } | |
425 | ||
c923ce56 JB |
426 | /** |
427 | * Gets worker tasks usage. | |
428 | * | |
429 | * @param worker - The worker. | |
430 | * @returns The worker tasks usage. | |
431 | */ | |
432 | private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined { | |
3032893a | 433 | const workerKey = this.getWorkerKey(worker) |
e65c6cd9 JB |
434 | if (workerKey !== -1) { |
435 | return this.workers[workerKey].tasksUsage | |
ffcbbad8 | 436 | } |
3032893a | 437 | throw new Error('Worker could not be found in the pool') |
a05c10de JB |
438 | } |
439 | ||
440 | /** | |
51fe3d3c | 441 | * Pushes the given worker in the pool. |
ea7a90d3 | 442 | * |
38e795c1 | 443 | * @param worker - The worker. |
ffcbbad8 | 444 | * @param tasksUsage - The worker tasks usage. |
ea7a90d3 | 445 | */ |
c923ce56 | 446 | private pushWorker (worker: Worker, tasksUsage: TasksUsage): void { |
e65c6cd9 | 447 | this.workers.push({ |
ffcbbad8 JB |
448 | worker, |
449 | tasksUsage | |
ea7a90d3 JB |
450 | }) |
451 | } | |
c923ce56 JB |
452 | |
453 | /** | |
51fe3d3c | 454 | * Sets the given worker in the pool. |
c923ce56 JB |
455 | * |
456 | * @param workerKey - The worker key. | |
457 | * @param worker - The worker. | |
458 | * @param tasksUsage - The worker tasks usage. | |
459 | */ | |
460 | private setWorker ( | |
461 | workerKey: number, | |
462 | worker: Worker, | |
463 | tasksUsage: TasksUsage | |
464 | ): void { | |
465 | this.workers[workerKey] = { | |
466 | worker, | |
467 | tasksUsage | |
468 | } | |
469 | } | |
51fe3d3c JB |
470 | |
471 | /** | |
472 | * Removes the given worker from the pool. | |
473 | * | |
474 | * @param worker - The worker that will be removed. | |
475 | */ | |
476 | protected removeWorker (worker: Worker): void { | |
477 | const workerKey = this.getWorkerKey(worker) | |
478 | this.workers.splice(workerKey, 1) | |
479 | this.workerChoiceStrategyContext.remove(workerKey) | |
480 | } | |
c97c7edb | 481 | } |