X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=eab110d8ec4d2200ec78320383874abbf333562a;hb=c6f42dd6037d12056294ff89be8ebb2fb66b1c8e;hp=9290c2185e05f62137e7df7784f881988d02b022;hpb=53221c4e8cbcc585c670275e7c1c700c3d1b5f37;p=poolifier.git diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts index 9290c218..eab110d8 100644 --- a/src/pools/abstract-pool.ts +++ b/src/pools/abstract-pool.ts @@ -3,17 +3,20 @@ import type { MessageValue, PromiseResponseWrapper } from '../utility-types' import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, EMPTY_FUNCTION, + isPlainObject, median } from '../utils' import { KillBehaviors, isKillBehavior } from '../worker/worker-options' +import { CircularArray } from '../circular-array' +import { Queue } from '../queue' import { - PoolEvents, type IPool, + PoolEmitter, + PoolEvents, type PoolOptions, - type TasksQueueOptions, - PoolType + PoolType, + type TasksQueueOptions } from './pool' -import { PoolEmitter } from './pool' import type { IWorker, Task, TasksUsage, WorkerNode } from './worker' import { WorkerChoiceStrategies, @@ -21,7 +24,6 @@ import { 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. @@ -69,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 ( @@ -84,10 +86,10 @@ export abstract class AbstractPool< this.checkFilePath(this.filePath) this.checkPoolOptions(this.opts) - this.chooseWorkerNode.bind(this) - this.executeTask.bind(this) - this.enqueueTask.bind(this) - this.checkAndEmitEvents.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() @@ -125,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( @@ -137,20 +139,28 @@ 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 ?? 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 + 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') } } @@ -164,9 +174,30 @@ 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 '${ @@ -179,6 +210,9 @@ export abstract class AbstractPool< /** @inheritDoc */ public abstract get type (): PoolType + /** @inheritDoc */ + public abstract get size (): number + /** * Number of tasks running in the pool. */ @@ -197,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 ) } @@ -244,6 +278,7 @@ export abstract class AbstractPool< public setWorkerChoiceStrategyOptions ( workerChoiceStrategyOptions: WorkerChoiceStrategyOptions ): void { + this.checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions) this.opts.workerChoiceStrategyOptions = workerChoiceStrategyOptions this.workerChoiceStrategyContext.setOptions( this.opts.workerChoiceStrategyOptions @@ -251,21 +286,23 @@ export abstract class AbstractPool< } /** @inheritDoc */ - public enableTasksQueue (enable: boolean, opts?: TasksQueueOptions): void { + public enableTasksQueue ( + enable: boolean, + tasksQueueOptions?: TasksQueueOptions + ): void { if (this.opts.enableTasksQueue === true && !enable) { - for (const [workerNodeKey] of this.workerNodes.entries()) { - this.flushTasksQueue(workerNodeKey) - } + this.flushTasksQueues() } this.opts.enableTasksQueue = enable - this.setTasksQueueOptions(opts as TasksQueueOptions) + this.setTasksQueueOptions(tasksQueueOptions as TasksQueueOptions) } /** @inheritDoc */ - public setTasksQueueOptions (opts: TasksQueueOptions): void { + public setTasksQueueOptions (tasksQueueOptions: TasksQueueOptions): void { if (this.opts.enableTasksQueue === true) { - this.checkValidTasksQueueOptions(opts) - this.opts.tasksQueueOptions = this.buildTasksQueueOptions(opts) + this.checkValidTasksQueueOptions(tasksQueueOptions) + this.opts.tasksQueueOptions = + this.buildTasksQueueOptions(tasksQueueOptions) } else { delete this.opts.tasksQueueOptions } @@ -294,20 +331,18 @@ export abstract class AbstractPool< protected abstract get busy (): boolean protected internalBusy (): boolean { - return this.findFreeWorkerNodeKey() === -1 - } - - /** @inheritDoc */ - public findFreeWorkerNodeKey (): number { - return this.workerNodes.findIndex(workerNode => { - return workerNode.tasksUsage?.running === 0 - }) + return ( + this.workerNodes.findIndex(workerNode => { + return workerNode.tasksUsage.running === 0 + }) === -1 + ) } /** @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() @@ -330,6 +365,7 @@ export abstract class AbstractPool< } else { this.executeTask(workerNodeKey, submittedTask) } + this.workerChoiceStrategyContext.update(workerNodeKey) this.checkAndEmitEvents() // eslint-disable-next-line @typescript-eslint/return-await return res @@ -388,7 +424,8 @@ export abstract class AbstractPool< 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) { @@ -422,14 +459,15 @@ export abstract class AbstractPool< 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) @@ -554,21 +592,6 @@ export abstract class AbstractPool< workerNode.tasksUsage = tasksUsage } - /** - * 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 { - 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. * @@ -587,7 +610,7 @@ export abstract class AbstractPool< medRunTime: 0, error: 0 }, - tasksQueue: [] + tasksQueue: new Queue>() }) } @@ -603,7 +626,7 @@ export abstract class AbstractPool< workerNodeKey: number, worker: Worker, tasksUsage: TasksUsage, - tasksQueue: Array> + tasksQueue: Queue> ): void { this.workerNodes[workerNodeKey] = { worker, @@ -629,27 +652,31 @@ export abstract class AbstractPool< } private enqueueTask (workerNodeKey: number, task: Task): number { - return this.workerNodes[workerNodeKey].tasksQueue.push(task) + 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.executeTask(workerNodeKey, task) + for (let i = 0; i < this.tasksQueueSize(workerNodeKey); i++) { + this.executeTask( + workerNodeKey, + this.dequeueTask(workerNodeKey) as Task + ) } } } - 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) + } } }