X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=99f65a24a0ee85f606ab7937653cf0b641472bc8;hb=243a550a93e278669fe5602aeba92dc8ba11260e;hp=34aa634e40d8851388fee70119b7a8d02df9cd8b;hpb=416fd65cf4573917610e16e3339b2f1303ce8eda;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 34aa634e..99f65a24 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,8 +1,12 @@ import crypto from 'node:crypto' import type { MessageValue, PromiseResponseWrapper } from '../utility-types' -import { EMPTY_FUNCTION, median } from '../utils' +import { + DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, + EMPTY_FUNCTION, + median +} from '../utils' import { KillBehaviors, isKillBehavior } from '../worker/worker-options' -import { PoolEvents, type PoolOptions } from './pool' +import { PoolEvents, type PoolOptions, type TasksQueueOptions } from './pool' import { PoolEmitter } from './pool' import type { IPoolInternal } from './pool-internal' import { PoolType } from './pool-internal' @@ -33,12 +37,12 @@ export abstract class AbstractPool< public readonly emitter?: PoolEmitter /** - * The promise response map. + * The execution response promise map. * * - `key`: The message id of each submitted task. - * - `value`: An object that contains the worker, the promise resolve and reject callbacks. + * - `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. + * 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, @@ -76,9 +80,9 @@ export abstract class AbstractPool< this.checkPoolOptions(this.opts) this.chooseWorkerNode.bind(this) - this.internalExecute.bind(this) + this.executeTask.bind(this) + this.enqueueTask.bind(this) this.checkAndEmitEvents.bind(this) - this.sendToWorker.bind(this) this.setupHook() @@ -132,9 +136,21 @@ export abstract class AbstractPool< opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy) this.opts.workerChoiceStrategyOptions = - opts.workerChoiceStrategyOptions ?? { medRunTime: false } + opts.workerChoiceStrategyOptions ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS this.opts.enableEvents = opts.enableEvents ?? true this.opts.enableTasksQueue = opts.enableTasksQueue ?? false + if (this.opts.enableTasksQueue) { + if ((opts.tasksQueueOptions?.concurrency as number) <= 0) { + throw new Error( + `Invalid worker tasks concurrency '${ + (opts.tasksQueueOptions as TasksQueueOptions).concurrency as number + }'` + ) + } + this.opts.tasksQueueOptions = { + concurrency: opts.tasksQueueOptions?.concurrency ?? 1 + } + } } private checkValidWorkerChoiceStrategy ( @@ -191,21 +207,16 @@ export abstract class AbstractPool< ): void { this.checkValidWorkerChoiceStrategy(workerChoiceStrategy) this.opts.workerChoiceStrategy = workerChoiceStrategy - for (const [index, workerNode] of this.workerNodes.entries()) { - this.setWorkerNode( - index, - workerNode.worker, - { - run: 0, - running: 0, - runTime: 0, - runTimeHistory: new CircularArray(), - avgRunTime: 0, - medRunTime: 0, - error: 0 - }, - workerNode.tasksQueue - ) + 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 @@ -219,10 +230,7 @@ export abstract class AbstractPool< public abstract get busy (): boolean protected internalBusy (): boolean { - return ( - this.numberOfRunningTasks >= this.numberOfWorkers && - this.findFreeWorkerNodeKey() === -1 - ) + return this.findFreeWorkerNodeKey() === -1 } /** @inheritDoc */ @@ -240,18 +248,25 @@ export abstract class AbstractPool< data: data ?? ({} as Data), id: crypto.randomUUID() } - const res = this.internalExecute(workerNodeKey, workerNode, submittedTask) - let currentTask: Task = submittedTask + const res = new Promise((resolve, reject) => { + this.promiseResponseMap.set(submittedTask.id, { + resolve, + reject, + worker: workerNode.worker + }) + }) if ( this.opts.enableTasksQueue === true && - (this.busy || this.tasksQueueSize(workerNodeKey) > 0) + (this.busy || + this.workerNodes[workerNodeKey].tasksUsage.running > + ((this.opts.tasksQueueOptions as TasksQueueOptions) + .concurrency as number) - + 1) ) { - currentTask = this.enqueueDequeueTask( - workerNodeKey, - submittedTask - ) as Task + this.enqueueTask(workerNodeKey, submittedTask) + } else { + this.executeTask(workerNodeKey, submittedTask) } - this.sendToWorker(workerNode.worker, currentTask) this.checkAndEmitEvents() // eslint-disable-next-line @typescript-eslint/return-await return res @@ -260,8 +275,8 @@ export abstract class AbstractPool< /** @inheritDoc */ public async destroy (): Promise { await Promise.all( - this.workerNodes.map(async workerNode => { - this.flushTasksQueueByWorker(workerNode.worker) + this.workerNodes.map(async (workerNode, workerNodeKey) => { + this.flushTasksQueue(workerNodeKey) await this.destroyWorker(workerNode.worker) }) ) @@ -275,7 +290,7 @@ export abstract class AbstractPool< protected abstract destroyWorker (worker: Worker): void | Promise /** - * Setup hook to run code before worker node are created in the abstract constructor. + * Setup hook to execute code before worker node are created in the abstract constructor. * Can be overridden * * @virtual @@ -290,23 +305,23 @@ export abstract class AbstractPool< protected abstract isMain (): boolean /** - * Hook executed before the worker task promise resolution. + * Hook executed before the worker task execution. * Can be overridden. * * @param workerNodeKey - The worker node key. */ - protected beforePromiseResponseHook (workerNodeKey: number): void { + protected beforeTaskExecutionHook (workerNodeKey: number): void { ++this.workerNodes[workerNodeKey].tasksUsage.running } /** - * Hook executed after the worker task promise resolution. + * Hook executed after the worker task execution. * Can be overridden. * * @param worker - The worker. * @param message - The received message. */ - protected afterPromiseResponseHook ( + protected afterTaskExecutionHook ( worker: Worker, message: MessageValue ): void { @@ -341,11 +356,7 @@ export abstract class AbstractPool< */ protected chooseWorkerNode (): [number, WorkerNode] { let workerNodeKey: number - if ( - this.type === PoolType.DYNAMIC && - !this.full && - this.findFreeWorkerNodeKey() === -1 - ) { + if (this.type === PoolType.DYNAMIC && !this.full && this.internalBusy()) { const workerCreated = this.createAndSetupWorker() this.registerWorkerMessageListener(workerCreated, message => { if ( @@ -431,7 +442,7 @@ export abstract class AbstractPool< protected workerListener (): (message: MessageValue) => void { return message => { if (message.id != null) { - // Task response received + // Task execution response received const promiseResponse = this.promiseResponseMap.get(message.id) if (promiseResponse != null) { if (message.error != null) { @@ -439,15 +450,15 @@ export abstract class AbstractPool< } else { promiseResponse.resolve(message.data as Response) } - this.afterPromiseResponseHook(promiseResponse.worker, message) + 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.sendToWorker( - promiseResponse.worker, + this.executeTask( + workerNodeKey, this.dequeueTask(workerNodeKey) as Task ) } @@ -456,21 +467,6 @@ export abstract class AbstractPool< } } - private async internalExecute ( - workerNodeKey: number, - workerNode: WorkerNode, - task: Task - ): Promise { - this.beforePromiseResponseHook(workerNodeKey) - return await new Promise((resolve, reject) => { - this.promiseResponseMap.set(task.id, { - resolve, - reject, - worker: workerNode.worker - }) - }) - } - private checkAndEmitEvents (): void { if (this.opts.enableEvents === true) { if (this.busy) { @@ -482,6 +478,19 @@ export abstract class AbstractPool< } } + /** + * 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, + tasksUsage: TasksUsage + ): void { + workerNode.tasksUsage = tasksUsage + } + /** * Gets the given worker its tasks usage in the pool. * @@ -550,16 +559,13 @@ export abstract class AbstractPool< this.workerChoiceStrategyContext.remove(workerNodeKey) } - private enqueueDequeueTask ( - workerNodeKey: number, - task: Task - ): Task | undefined { - this.enqueueTask(workerNodeKey, task) - return this.dequeueTask(workerNodeKey) + private executeTask (workerNodeKey: number, task: Task): void { + this.beforeTaskExecutionHook(workerNodeKey) + this.sendToWorker(this.workerNodes[workerNodeKey].worker, task) } - private enqueueTask (workerNodeKey: number, task: Task): void { - this.workerNodes[workerNodeKey].tasksQueue.push(task) + private enqueueTask (workerNodeKey: number, task: Task): number { + return this.workerNodes[workerNodeKey].tasksQueue.push(task) } private dequeueTask (workerNodeKey: number): Task | undefined { @@ -573,9 +579,8 @@ export abstract class AbstractPool< private flushTasksQueue (workerNodeKey: number): void { if (this.tasksQueueSize(workerNodeKey) > 0) { for (const task of this.workerNodes[workerNodeKey].tasksQueue) { - this.sendToWorker(this.workerNodes[workerNodeKey].worker, task) + this.executeTask(workerNodeKey, task) } - this.workerNodes[workerNodeKey].tasksQueue = [] } }