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