X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=3be40e6d9cc8dd2634ab02569abd6261dca6f326;hb=f82cd3579677f83c17289218d4ae8242e7d0a8d7;hp=41ce6aa019a5269a0a47e338934c093aa2a3ee6d;hpb=0ebe2a9f266a9cfd426a5faec1743cb9cfe59ffd;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 41ce6aa0..3be40e6d 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,11 +1,19 @@ 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, @@ -19,13 +27,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 +84,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 +140,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 ( @@ -207,17 +227,22 @@ export abstract class AbstractPool< ) } - /** @inheritDoc */ - public abstract get full (): boolean + /** + * Whether the pool is full or not. + * + * The pool filling boolean status. + */ + protected abstract get full (): boolean - /** @inheritDoc */ - public abstract get busy (): 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 */ @@ -235,18 +260,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 @@ -255,8 +286,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) }) ) @@ -270,7 +301,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 @@ -285,23 +316,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 { @@ -336,11 +367,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 ( @@ -434,15 +461,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 ) } @@ -451,21 +478,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) { @@ -494,6 +506,7 @@ export abstract class AbstractPool< * Gets the given worker its tasks usage in the pool. * * @param worker - The worker. + * @throws {@link Error} if the worker is not found in the pool worker nodes. * @returns The worker tasks usage. */ private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined { @@ -558,16 +571,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 { @@ -581,9 +591,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 = [] } }