X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=b9a7cd398920fc77a754d3d4047414beae94ba46;hb=80662c0aec09419d198a5daba024674922ca5945;hp=41ce6aa019a5269a0a47e338934c093aa2a3ee6d;hpb=6c9d7004857091d1d46e65cb7a9871bb271a2516;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 41ce6aa0..b9a7cd39 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -1,31 +1,42 @@ 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, + isPlainObject, + median +} from '../utils' import { KillBehaviors, isKillBehavior } from '../worker/worker-options' -import { PoolEvents, type PoolOptions } from './pool' -import { PoolEmitter } from './pool' -import type { IPoolInternal } from './pool-internal' -import { PoolType } from './pool-internal' +import { CircularArray } from '../circular-array' +import { Queue } from '../queue' +import { + type IPool, + PoolEmitter, + PoolEvents, + type PoolOptions, + PoolType, + type TasksQueueOptions +} from './pool' 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' /** * Base class that implements some shared logic for all poolifier pools. * * @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> = [] @@ -60,7 +71,7 @@ export abstract class AbstractPool< * Constructs a new poolifier pool. * * @param numberOfWorkers - Number of workers that this pool should manage. - * @param filePath - Path to the worker-file. + * @param filePath - Path to the worker file. * @param opts - Options for the pool. */ public constructor ( @@ -75,10 +86,10 @@ export abstract class AbstractPool< this.checkFilePath(this.filePath) this.checkPoolOptions(this.opts) - this.chooseWorkerNode.bind(this) - this.internalExecute.bind(this) - this.checkAndEmitEvents.bind(this) - this.sendToWorker.bind(this) + this.chooseWorkerNode = this.chooseWorkerNode.bind(this) + this.executeTask = this.executeTask.bind(this) + this.enqueueTask = this.enqueueTask.bind(this) + this.checkAndEmitEvents = this.checkAndEmitEvents.bind(this) this.setupHook() @@ -116,7 +127,7 @@ export abstract class AbstractPool< ) } else if (!Number.isSafeInteger(numberOfWorkers)) { throw new TypeError( - 'Cannot instantiate a pool with a non integer number of workers' + 'Cannot instantiate a pool with a non safe integer number of workers' ) } else if (numberOfWorkers < 0) { throw new RangeError( @@ -128,13 +139,29 @@ export abstract class AbstractPool< } private checkPoolOptions (opts: PoolOptions): void { - this.opts.workerChoiceStrategy = - opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN - this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy) - this.opts.workerChoiceStrategyOptions = - opts.workerChoiceStrategyOptions ?? { medRunTime: false } - this.opts.enableEvents = opts.enableEvents ?? true - this.opts.enableTasksQueue = opts.enableTasksQueue ?? false + if (isPlainObject(opts)) { + this.opts.workerChoiceStrategy = + opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN + this.checkValidWorkerChoiceStrategy(this.opts.workerChoiceStrategy) + this.opts.workerChoiceStrategyOptions = + opts.workerChoiceStrategyOptions ?? + DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + this.checkValidWorkerChoiceStrategyOptions( + this.opts.workerChoiceStrategyOptions + ) + 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 + ) + } + } else { + throw new TypeError('Invalid pool options: must be a plain object') + } } private checkValidWorkerChoiceStrategy ( @@ -147,9 +174,45 @@ export abstract class AbstractPool< } } + private checkValidWorkerChoiceStrategyOptions ( + workerChoiceStrategyOptions: WorkerChoiceStrategyOptions + ): void { + if (!isPlainObject(workerChoiceStrategyOptions)) { + throw new TypeError( + 'Invalid worker choice strategy options: must be a plain object' + ) + } + if ( + workerChoiceStrategyOptions.weights != null && + Object.keys(workerChoiceStrategyOptions.weights).length !== this.size + ) { + throw new Error( + 'Invalid worker choice strategy options: must have a weight for each worker node' + ) + } + } + + private checkValidTasksQueueOptions ( + tasksQueueOptions: TasksQueueOptions + ): void { + if (tasksQueueOptions != null && !isPlainObject(tasksQueueOptions)) { + throw new TypeError('Invalid tasks queue options: must be a plain object') + } + if ((tasksQueueOptions?.concurrency as number) <= 0) { + throw new Error( + `Invalid worker tasks concurrency '${ + tasksQueueOptions.concurrency as number + }'` + ) + } + } + /** @inheritDoc */ public abstract get type (): PoolType + /** @inheritDoc */ + public abstract get size (): number + /** * Number of tasks running in the pool. */ @@ -168,7 +231,7 @@ export abstract class AbstractPool< return 0 } return this.workerNodes.reduce( - (accumulator, workerNode) => accumulator + workerNode.tasksQueue.length, + (accumulator, workerNode) => accumulator + workerNode.tasksQueue.size, 0 ) } @@ -187,7 +250,8 @@ export abstract class AbstractPool< /** @inheritDoc */ public setWorkerChoiceStrategy ( - workerChoiceStrategy: WorkerChoiceStrategy + workerChoiceStrategy: WorkerChoiceStrategy, + workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions ): void { this.checkValidWorkerChoiceStrategy(workerChoiceStrategy) this.opts.workerChoiceStrategy = workerChoiceStrategy @@ -203,50 +267,105 @@ export abstract class AbstractPool< }) } this.workerChoiceStrategyContext.setWorkerChoiceStrategy( - workerChoiceStrategy + this.opts.workerChoiceStrategy + ) + if (workerChoiceStrategyOptions != null) { + this.setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) + } + } + + /** @inheritDoc */ + public setWorkerChoiceStrategyOptions ( + workerChoiceStrategyOptions: WorkerChoiceStrategyOptions + ): void { + this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) + this.opts.workerChoiceStrategyOptions = workerChoiceStrategyOptions + this.workerChoiceStrategyContext.setOptions( + this.opts.workerChoiceStrategyOptions ) } /** @inheritDoc */ - public abstract get full (): boolean + public enableTasksQueue ( + enable: boolean, + tasksQueueOptions?: TasksQueueOptions + ): void { + if (this.opts.enableTasksQueue === true && !enable) { + this.flushTasksQueues() + } + this.opts.enableTasksQueue = enable + this.setTasksQueueOptions(tasksQueueOptions as TasksQueueOptions) + } /** @inheritDoc */ - public abstract get busy (): boolean + public setTasksQueueOptions (tasksQueueOptions: TasksQueueOptions): void { + if (this.opts.enableTasksQueue === true) { + this.checkValidTasksQueueOptions(tasksQueueOptions) + this.opts.tasksQueueOptions = + this.buildTasksQueueOptions(tasksQueueOptions) + } 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 + this.workerNodes.findIndex(workerNode => { + return workerNode.tasksUsage.running === 0 + }) === -1 ) } /** @inheritDoc */ - public findFreeWorkerNodeKey (): number { - return this.workerNodes.findIndex(workerNode => { - return workerNode.tasksUsage?.running === 0 - }) - } - - /** @inheritDoc */ - public async execute (data: Data): Promise { + public async execute (data?: Data, name?: string): Promise { const [workerNodeKey, workerNode] = this.chooseWorkerNode() const submittedTask: Task = { + name, // eslint-disable-next-line @typescript-eslint/consistent-type-assertions 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.workerChoiceStrategyContext.update(workerNodeKey) this.checkAndEmitEvents() // eslint-disable-next-line @typescript-eslint/return-await return res @@ -255,8 +374,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 +389,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,27 +404,28 @@ 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 { - const workerTasksUsage = this.getWorkerTasksUsage(worker) as TasksUsage + const workerNodeKey = this.getWorkerNodeKey(worker) + const workerTasksUsage = this.workerNodes[workerNodeKey].tasksUsage --workerTasksUsage.running ++workerTasksUsage.run if (message.error != null) { @@ -320,8 +440,11 @@ export abstract class AbstractPool< workerTasksUsage.avgRunTime = workerTasksUsage.runTime / workerTasksUsage.run } - if (this.workerChoiceStrategyContext.getRequiredStatistics().medRunTime) { - workerTasksUsage.runTimeHistory.push(message.runTime ?? 0) + if ( + this.workerChoiceStrategyContext.getRequiredStatistics().medRunTime && + message.runTime != null + ) { + workerTasksUsage.runTimeHistory.push(message.runTime) workerTasksUsage.medRunTime = median(workerTasksUsage.runTimeHistory) } } @@ -336,21 +459,18 @@ 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 => { + const currentWorkerNodeKey = this.getWorkerNodeKey(workerCreated) if ( isKillBehavior(KillBehaviors.HARD, message.kill) || (message.kill != null && - this.getWorkerTasksUsage(workerCreated)?.running === 0) + this.workerNodes[currentWorkerNodeKey].tasksUsage.running === 0) ) { // Kill message received from the worker: no new tasks are submitted to that worker for a while ( > maxInactiveTime) - this.flushTasksQueueByWorker(workerCreated) - void this.destroyWorker(workerCreated) + this.flushTasksQueue(currentWorkerNodeKey) + void (this.destroyWorker(workerCreated) as Promise) } }) workerNodeKey = this.getWorkerNodeKey(workerCreated) @@ -434,15 +554,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 +571,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) { @@ -490,20 +595,6 @@ export abstract class AbstractPool< workerNode.tasksUsage = tasksUsage } - /** - * Gets the given worker its tasks usage in the pool. - * - * @param worker - The worker. - * @returns The worker tasks usage. - */ - private getWorkerTasksUsage (worker: Worker): TasksUsage | undefined { - const workerNodeKey = this.getWorkerNodeKey(worker) - if (workerNodeKey !== -1) { - return this.workerNodes[workerNodeKey].tasksUsage - } - throw new Error('Worker could not be found in the pool worker nodes') - } - /** * Pushes the given worker in the pool worker nodes. * @@ -522,7 +613,7 @@ export abstract class AbstractPool< medRunTime: 0, error: 0 }, - tasksQueue: [] + tasksQueue: new Queue>() }) } @@ -538,7 +629,7 @@ export abstract class AbstractPool< workerNodeKey: number, worker: Worker, tasksUsage: TasksUsage, - tasksQueue: Array> + tasksQueue: Queue> ): void { this.workerNodes[workerNodeKey] = { worker, @@ -558,37 +649,37 @@ 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.enqueue(task) } private dequeueTask (workerNodeKey: number): Task | undefined { - return this.workerNodes[workerNodeKey].tasksQueue.shift() + return this.workerNodes[workerNodeKey].tasksQueue.dequeue() } private tasksQueueSize (workerNodeKey: number): number { - return this.workerNodes[workerNodeKey].tasksQueue.length + return this.workerNodes[workerNodeKey].tasksQueue.size } 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) + for (let i = 0; i < this.tasksQueueSize(workerNodeKey); i++) { + this.executeTask( + workerNodeKey, + this.dequeueTask(workerNodeKey) as Task + ) } - this.workerNodes[workerNodeKey].tasksQueue = [] } } - private flushTasksQueueByWorker (worker: Worker): void { - const workerNodeKey = this.getWorkerNodeKey(worker) - this.flushTasksQueue(workerNodeKey) + private flushTasksQueues (): void { + for (const [workerNodeKey] of this.workerNodes.entries()) { + this.flushTasksQueue(workerNodeKey) + } } }