X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=9ba4fbf9c6dcc6d4d152891a3c19ad0fa01715a4;hb=e2473f60d4484d8ba10f972b7099550cd61c1730;hp=f4f3e8337056a1cb47edba30e0b4982ef339f5e0;hpb=a34454964733f585af19a04f21f9e35eb18c77b1;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index f4f3e833..9ba4fbf9 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,15 +1,24 @@ 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 IPool, + type PoolOptions, + type TasksQueueOptions, + PoolType +} 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 + type WorkerChoiceStrategy, + type WorkerChoiceStrategyOptions } from './selection-strategies/selection-strategies-types' import { WorkerChoiceStrategyContext } from './selection-strategies/worker-choice-strategy-context' import { CircularArray } from '../circular-array' @@ -19,13 +28,13 @@ import { CircularArray } from '../circular-array' * * @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. + * @typeParam Response - Type of execution response. This can only be serializable data. */ export abstract class AbstractPool< Worker extends IWorker, Data = unknown, Response = unknown -> implements IPoolInternal { +> implements IPool { /** @inheritDoc */ public readonly workerNodes: Array> = [] @@ -76,9 +85,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 +141,17 @@ 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) { + this.checkValidTasksQueueOptions( + opts.tasksQueueOptions as TasksQueueOptions + ) + this.opts.tasksQueueOptions = this.buildTasksQueueOptions( + opts.tasksQueueOptions as TasksQueueOptions + ) + } } private checkValidWorkerChoiceStrategy ( @@ -147,6 +164,18 @@ export abstract class AbstractPool< } } + private checkValidTasksQueueOptions ( + tasksQueueOptions: TasksQueueOptions + ): void { + if ((tasksQueueOptions?.concurrency as number) <= 0) { + throw new Error( + `Invalid worker tasks concurrency '${ + tasksQueueOptions.concurrency as number + }'` + ) + } + } + /** @inheritDoc */ public abstract get type (): PoolType @@ -187,42 +216,85 @@ export abstract class AbstractPool< /** @inheritDoc */ public setWorkerChoiceStrategy ( - workerChoiceStrategy: WorkerChoiceStrategy + workerChoiceStrategy: WorkerChoiceStrategy, + workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions ): 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 + this.opts.workerChoiceStrategy + ) + if (workerChoiceStrategyOptions != null) { + this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) + } + } + + /** @inheritDoc */ + public setWorkerChoiceStrategyOptions ( + workerChoiceStrategyOptions: WorkerChoiceStrategyOptions + ): void { + this.opts.workerChoiceStrategyOptions = workerChoiceStrategyOptions + this.workerChoiceStrategyContext.setOptions( + this.opts.workerChoiceStrategyOptions ) } /** @inheritDoc */ - public abstract get full (): boolean + public enableTasksQueue (enable: boolean, opts?: TasksQueueOptions): void { + if (this.opts.enableTasksQueue === true && !enable) { + for (const [workerNodeKey] of this.workerNodes.entries()) { + this.flushTasksQueue(workerNodeKey) + } + } + this.opts.enableTasksQueue = enable + this.setTasksQueueOptions(opts as TasksQueueOptions) + } /** @inheritDoc */ - public abstract get busy (): boolean + public setTasksQueueOptions (opts: TasksQueueOptions): void { + if (this.opts.enableTasksQueue === true) { + this.checkValidTasksQueueOptions(opts) + this.opts.tasksQueueOptions = this.buildTasksQueueOptions(opts) + } else { + delete this.opts.tasksQueueOptions + } + } + + private buildTasksQueueOptions ( + tasksQueueOptions: TasksQueueOptions + ): TasksQueueOptions { + return { + concurrency: tasksQueueOptions?.concurrency ?? 1 + } + } + + /** + * Whether the pool is full or not. + * + * The pool filling boolean status. + */ + protected abstract get full (): boolean + + /** + * Whether the pool is busy or not. + * + * The pool busyness boolean status. + */ + protected abstract get busy (): boolean protected internalBusy (): boolean { - return ( - this.numberOfRunningTasks >= this.numberOfWorkers && - this.findFreeWorkerNodeKey() === -1 - ) + return this.findFreeWorkerNodeKey() === -1 } /** @inheritDoc */ @@ -240,18 +312,24 @@ 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 as string, { + 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)) ) { - 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 +338,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 +353,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 +368,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 +419,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 ( @@ -439,15 +513,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 +530,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,10 +541,24 @@ 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. * * @param worker - The worker. + * @throws Error if the worker is not found in the pool worker nodes. * @returns The worker tasks usage. */ private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined { @@ -550,16 +623,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 +643,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 = [] } }