X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=9ac81ce56558ec76fbd66d7789b2399e910a2e69;hb=a22cdf86c993800ec9ea8ae32ef0d8dbda07ec61;hp=62def61e6dd28a1f042280f3a1a676bd07f226a2;hpb=2740a743fcbf64e0ee674530e3cbcf6df710c1ef;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 62def61e..9ac81ce5 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -2,7 +2,7 @@ import crypto from 'node:crypto' import type { MessageValue, PromiseResponseWrapper } from '../utility-types' import { EMPTY_FUNCTION } from '../utils' import { KillBehaviors, isKillBehavior } from '../worker/worker-options' -import type { PoolOptions } from './pool' +import { PoolEvents, type PoolOptions } from './pool' import { PoolEmitter } from './pool' import type { IPoolInternal, TasksUsage, WorkerType } from './pool-internal' import { PoolType } from './pool-internal' @@ -25,27 +25,29 @@ export abstract class AbstractPool< Data = unknown, Response = unknown > implements IPoolInternal { - /** {@inheritDoc} */ + /** @inheritDoc */ public readonly workers: Array> = [] - /** {@inheritDoc} */ + /** @inheritDoc */ public readonly emitter?: PoolEmitter /** * The promise response map. * * - `key`: The message id of each submitted task. - * - `value`: An object that contains the worker key, the promise resolve and reject callbacks. + * - `value`: An object that contains the worker, the 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. */ - protected promiseResponseMap: Map> = - new Map>() + protected promiseResponseMap: Map< + string, + PromiseResponseWrapper + > = new Map>() /** - * Worker choice strategy instance implementing the worker choice algorithm. + * Worker choice strategy context referencing a worker choice algorithm implementation. * - * Default to a strategy implementing a round robin algorithm. + * Default to a round robin algorithm. */ protected workerChoiceStrategyContext: WorkerChoiceStrategyContext< Worker, @@ -71,6 +73,13 @@ export abstract class AbstractPool< this.checkNumberOfWorkers(this.numberOfWorkers) this.checkFilePath(this.filePath) this.checkPoolOptions(this.opts) + + this.chooseWorker.bind(this) + this.internalExecute.bind(this) + this.checkAndEmitFull.bind(this) + this.checkAndEmitBusy.bind(this) + this.sendToWorker.bind(this) + this.setupHook() for (let i = 1; i <= this.numberOfWorkers; i++) { @@ -80,23 +89,11 @@ export abstract class AbstractPool< if (this.opts.enableEvents === true) { this.emitter = new PoolEmitter() } - this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext( - this, - () => { - const workerCreated = this.createAndSetupWorker() - this.registerWorkerMessageListener(workerCreated, message => { - if ( - isKillBehavior(KillBehaviors.HARD, message.kill) || - this.getWorkerTasksUsage(workerCreated)?.running === 0 - ) { - // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime) - void this.destroyWorker(workerCreated) - } - }) - return workerCreated - }, - this.opts.workerChoiceStrategy - ) + this.workerChoiceStrategyContext = new WorkerChoiceStrategyContext< + Worker, + Data, + Response + >(this, this.opts.workerChoiceStrategy) } private checkFilePath (filePath: string): void { @@ -129,14 +126,27 @@ export abstract class AbstractPool< private checkPoolOptions (opts: PoolOptions): void { this.opts.workerChoiceStrategy = opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN + this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy) this.opts.enableEvents = opts.enableEvents ?? true } - /** {@inheritDoc} */ + 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 - /** {@inheritDoc} */ - public get numberOfRunningTasks (): number { + /** + * Number of tasks concurrently running in the pool. + */ + private get numberOfRunningTasks (): number { return this.promiseResponseMap.size } @@ -144,19 +154,20 @@ export abstract class AbstractPool< * Gets the given worker key. * * @param worker - The worker. - * @returns The worker key. + * @returns The worker key if the worker is found in the pool, `-1` otherwise. */ private getWorkerKey (worker: Worker): number { return this.workers.findIndex(workerItem => workerItem.worker === worker) } - /** {@inheritDoc} */ + /** @inheritDoc */ public setWorkerChoiceStrategy ( workerChoiceStrategy: WorkerChoiceStrategy ): void { + this.checkValidWorkerChoiceStrategy(workerChoiceStrategy) this.opts.workerChoiceStrategy = workerChoiceStrategy - for (const workerItem of this.workers) { - this.setWorker(workerItem.worker, { + for (const [index, workerItem] of this.workers.entries()) { + this.setWorker(index, workerItem.worker, { run: 0, running: 0, runTime: 0, @@ -169,32 +180,32 @@ export abstract class AbstractPool< ) } - /** {@inheritDoc} */ + /** @inheritDoc */ + public abstract get full (): boolean + + /** @inheritDoc */ public abstract get busy (): boolean - protected internalGetBusyStatus (): boolean { + protected internalBusy (): boolean { return ( this.numberOfRunningTasks >= this.numberOfWorkers && - this.findFreeWorker() === false + this.findFreeWorkerKey() === -1 ) } - /** {@inheritDoc} */ - public findFreeWorker (): Worker | false { - for (const workerItem of this.workers) { - if (workerItem.tasksUsage.running === 0) { - // A worker is free, return the matching worker - return workerItem.worker - } - } - return false + /** @inheritDoc */ + public findFreeWorkerKey (): number { + return this.workers.findIndex(workerItem => { + return workerItem.tasksUsage.running === 0 + }) } - /** {@inheritDoc} */ + /** @inheritDoc */ public async execute (data: Data): Promise { - const worker = this.chooseWorker() + const [workerKey, worker] = this.chooseWorker() const messageId = crypto.randomUUID() - const res = this.internalExecute(this.getWorkerKey(worker), messageId) + const res = this.internalExecute(workerKey, worker, messageId) + this.checkAndEmitFull() this.checkAndEmitBusy() this.sendToWorker(worker, { // eslint-disable-next-line @typescript-eslint/consistent-type-assertions @@ -205,7 +216,7 @@ export abstract class AbstractPool< return res } - /** {@inheritDoc} */ + /** @inheritDoc */ public async destroy (): Promise { await Promise.all( this.workers.map(async workerItem => { @@ -215,7 +226,7 @@ export abstract class AbstractPool< } /** - * Shutdowns given worker. + * Shutdowns given worker in the pool. * * @param worker - A worker within `workers`. */ @@ -224,9 +235,12 @@ export abstract class AbstractPool< /** * Setup hook that can be overridden by a Poolifier pool implementation * to run code before workers are created in the abstract constructor. + * Can be overridden + * + * @virtual */ protected setupHook (): void { - // Can be overridden + // Intentionally empty } /** @@ -248,49 +262,61 @@ export abstract class AbstractPool< * Hook executed after the worker task promise resolution. * Can be overridden. * - * @param workerKey - The worker key. + * @param worker - The worker. * @param message - The received message. */ protected afterPromiseResponseHook ( - workerKey: number, + worker: Worker, message: MessageValue ): void { - const workerTasksUsage = this.workers[workerKey].tasksUsage + const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage --workerTasksUsage.running ++workerTasksUsage.run if (message.error != null) { ++workerTasksUsage.error } - if ( - this.workerChoiceStrategyContext.getWorkerChoiceStrategy() - .requiredStatistics.runTime - ) { - workerTasksUsage.runTime += message.taskRunTime ?? 0 - if (workerTasksUsage.run !== 0) { + if (this.workerChoiceStrategyContext.getRequiredStatistics().runTime) { + workerTasksUsage.runTime += message.runTime ?? 0 + if ( + this.workerChoiceStrategyContext.getRequiredStatistics().avgRunTime && + workerTasksUsage.run !== 0 + ) { workerTasksUsage.avgRunTime = workerTasksUsage.runTime / workerTasksUsage.run } } } - /** - * Removes the given worker from the pool. - * - * @param worker - The worker that will be removed. - */ - protected removeWorker (worker: Worker): void { - this.workers.splice(this.getWorkerKey(worker), 1) - } - /** * Chooses a worker for the next task. * - * The default implementation uses a round robin algorithm to distribute the load. + * The default uses a round robin algorithm to distribute the load. * - * @returns Worker. + * @returns [worker key, worker]. */ - protected chooseWorker (): Worker { - return this.workerChoiceStrategyContext.execute() + protected chooseWorker (): [number, Worker] { + let workerKey: number + if ( + this.type === PoolType.DYNAMIC && + !this.full && + this.findFreeWorkerKey() === -1 + ) { + const createdWorker = this.createAndSetupWorker() + this.registerWorkerMessageListener(createdWorker, message => { + if ( + isKillBehavior(KillBehaviors.HARD, message.kill) || + (message.kill != null && + this.getWorkerTasksUsage(createdWorker)?.running === 0) + ) { + // Kill message received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime) + void this.destroyWorker(createdWorker) + } + }) + workerKey = this.getWorkerKey(createdWorker) + } else { + workerKey = this.workerChoiceStrategyContext.execute() + } + return [workerKey, this.workers[workerKey].worker] } /** @@ -325,6 +351,7 @@ export abstract class AbstractPool< * 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. + * @virtual */ protected abstract afterWorkerSetup (worker: Worker): void @@ -344,7 +371,7 @@ export abstract class AbstractPool< this.removeWorker(worker) }) - this.setWorker(worker, { + this.pushWorker(worker, { run: 0, running: 0, runTime: 0, @@ -364,15 +391,16 @@ export abstract class AbstractPool< */ protected workerListener (): (message: MessageValue) => void { return message => { - if (message.id !== undefined) { + if (message.id != null) { + // Task response received const promiseResponse = this.promiseResponseMap.get(message.id) - if (promiseResponse !== undefined) { + if (promiseResponse != null) { if (message.error != null) { promiseResponse.reject(message.error) } else { promiseResponse.resolve(message.data as Response) } - this.afterPromiseResponseHook(promiseResponse.workerKey, message) + this.afterPromiseResponseHook(promiseResponse.worker, message) this.promiseResponseMap.delete(message.id) } } @@ -381,22 +409,38 @@ export abstract class AbstractPool< private async internalExecute ( workerKey: number, + worker: Worker, messageId: string ): Promise { this.beforePromiseResponseHook(workerKey) return await new Promise((resolve, reject) => { - this.promiseResponseMap.set(messageId, { resolve, reject, workerKey }) + this.promiseResponseMap.set(messageId, { resolve, reject, worker }) }) } private checkAndEmitBusy (): void { if (this.opts.enableEvents === true && this.busy) { - this.emitter?.emit('busy') + this.emitter?.emit(PoolEvents.busy) } } - /** {@inheritDoc} */ - public getWorkerTasksUsage (worker: Worker): TasksUsage | undefined { + private checkAndEmitFull (): void { + if ( + this.type === PoolType.DYNAMIC && + this.opts.enableEvents === true && + this.full + ) { + this.emitter?.emit(PoolEvents.full) + } + } + + /** + * Gets the given worker tasks usage in the pool. + * + * @param worker - The worker. + * @returns The worker tasks usage. + */ + private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined { const workerKey = this.getWorkerKey(worker) if (workerKey !== -1) { return this.workers[workerKey].tasksUsage @@ -405,15 +449,44 @@ export abstract class AbstractPool< } /** - * Sets the given worker. + * Pushes the given worker in the pool. * * @param worker - The worker. * @param tasksUsage - The worker tasks usage. */ - private setWorker (worker: Worker, tasksUsage: TasksUsage): void { + private pushWorker (worker: Worker, tasksUsage: TasksUsage): void { this.workers.push({ worker, tasksUsage }) } + + /** + * Sets the given worker in the pool. + * + * @param workerKey - The worker key. + * @param worker - The worker. + * @param tasksUsage - The worker tasks usage. + */ + private setWorker ( + workerKey: number, + worker: Worker, + tasksUsage: TasksUsage + ): void { + this.workers[workerKey] = { + worker, + tasksUsage + } + } + + /** + * Removes the given worker from the pool. + * + * @param worker - The worker that will be removed. + */ + protected removeWorker (worker: Worker): void { + const workerKey = this.getWorkerKey(worker) + this.workers.splice(workerKey, 1) + this.workerChoiceStrategyContext.remove(workerKey) + } }