X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fweighted-round-robin-worker-choice-strategy.ts;h=53b2d64d923412e73ae11f9b8cbc23f892acdf4a;hb=65d7a1c9177d558c01570f4013b7aa23bbee952d;hp=4b1e5382af333d2edb59eb5ae41d1c5132f6ccb3;hpb=d354916afe83118073287bcd405dcdf6f4cd9b20;p=poolifier.git diff --git a/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts b/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts index 4b1e5382..53b2d64d 100644 --- a/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts +++ b/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts @@ -1,13 +1,18 @@ -import { cpus } from 'os' -import type { IPoolInternal } from '../pool-internal' -import type { IPoolWorker } from '../pool-worker' +import { cpus } from 'node:os' +import type { IWorker } from '../worker' +import type { IPool } from '../pool' +import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils' import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy' -import type { RequiredStatistics } from './selection-strategies-types' +import type { + IWorkerChoiceStrategy, + RequiredStatistics, + WorkerChoiceStrategyOptions +} from './selection-strategies-types' /** * Virtual task runtime. */ -type TaskRunTime = { +interface TaskRunTime { weight: number runTime: number } @@ -16,113 +21,136 @@ type TaskRunTime = { * Selects the next worker with a weighted round robin scheduling algorithm. * Loosely modeled after the weighted round robin queueing algorithm: https://en.wikipedia.org/wiki/Weighted_round_robin. * - * @template Worker Type of worker which manages the strategy. - * @template Data Type of data sent to the worker. This can only be serializable data. - * @template Response Type of response of execution. This can only be serializable data. + * @typeParam Worker - Type of worker which manages the strategy. + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Response - Type of execution response. This can only be serializable data. */ export class WeightedRoundRobinWorkerChoiceStrategy< - Worker extends IPoolWorker, - Data, - Response -> extends AbstractWorkerChoiceStrategy { + Worker extends IWorker, + Data = unknown, + Response = unknown + > + extends AbstractWorkerChoiceStrategy + implements IWorkerChoiceStrategy { /** @inheritDoc */ public readonly requiredStatistics: RequiredStatistics = { - runTime: true + runTime: true, + avgRunTime: true, + medRunTime: false } /** - * Worker index where the current task will be submitted. + * Worker node id where the current task will be submitted. */ - private currentWorkerIndex: number = 0 + private currentWorkerNodeId: number = 0 /** * Default worker weight. */ private readonly defaultWorkerWeight: number /** - * Per worker virtual task runtime map. + * Workers' virtual task runtime. */ - private readonly workersTaskRunTime: Map = new Map< - Worker, - TaskRunTime + private readonly workersTaskRunTime: Map = new Map< + number, + TaskRunTime >() - /** - * Constructs a worker choice strategy that selects with a weighted round robin scheduling algorithm. - * - * @param pool The pool instance. - */ - public constructor (pool: IPoolInternal) { - super(pool) + /** @inheritDoc */ + public constructor ( + pool: IPool, + opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + ) { + super(pool, opts) + this.checkOptions(this.opts) this.defaultWorkerWeight = this.computeWorkerWeight() this.initWorkersTaskRunTime() } /** @inheritDoc */ public reset (): boolean { - this.currentWorkerIndex = 0 + this.currentWorkerNodeId = 0 this.workersTaskRunTime.clear() this.initWorkersTaskRunTime() return true } /** @inheritDoc */ - public choose (): Worker { - const chosenWorker = this.pool.workers[this.currentWorkerIndex] + public choose (): number { + const chosenWorkerNodeKey = this.currentWorkerNodeId if ( - this.isDynamicPool === true && - this.workersTaskRunTime.has(chosenWorker) === false + this.isDynamicPool && + !this.workersTaskRunTime.has(chosenWorkerNodeKey) ) { - this.initWorkerTaskRunTime(chosenWorker) + this.initWorkerTaskRunTime(chosenWorkerNodeKey) } const workerTaskRunTime = - this.workersTaskRunTime.get(chosenWorker)?.runTime ?? 0 + this.workersTaskRunTime.get(chosenWorkerNodeKey)?.runTime ?? 0 const workerTaskWeight = - this.workersTaskRunTime.get(chosenWorker)?.weight ?? + this.workersTaskRunTime.get(chosenWorkerNodeKey)?.weight ?? this.defaultWorkerWeight if (workerTaskRunTime < workerTaskWeight) { this.setWorkerTaskRunTime( - chosenWorker, + chosenWorkerNodeKey, workerTaskWeight, workerTaskRunTime + - (this.getWorkerVirtualTaskRunTime(chosenWorker) ?? 0) + (this.getWorkerVirtualTaskRunTime(chosenWorkerNodeKey) ?? 0) ) } else { - this.currentWorkerIndex = - this.currentWorkerIndex === this.pool.workers.length - 1 + this.currentWorkerNodeId = + this.currentWorkerNodeId === this.pool.workerNodes.length - 1 ? 0 - : this.currentWorkerIndex + 1 - this.setWorkerTaskRunTime( - this.pool.workers[this.currentWorkerIndex], - workerTaskWeight, - 0 - ) + : this.currentWorkerNodeId + 1 + this.setWorkerTaskRunTime(this.currentWorkerNodeId, workerTaskWeight, 0) + } + return chosenWorkerNodeKey + } + + /** @inheritDoc */ + public remove (workerNodeKey: number): boolean { + if (this.currentWorkerNodeId === workerNodeKey) { + if (this.pool.workerNodes.length === 0) { + this.currentWorkerNodeId = 0 + } else { + this.currentWorkerNodeId = + this.currentWorkerNodeId > this.pool.workerNodes.length - 1 + ? this.pool.workerNodes.length - 1 + : this.currentWorkerNodeId + } + } + const deleted = this.workersTaskRunTime.delete(workerNodeKey) + for (const [key, value] of this.workersTaskRunTime) { + if (key > workerNodeKey) { + this.workersTaskRunTime.set(key - 1, value) + } } - return chosenWorker + return deleted } private initWorkersTaskRunTime (): void { - for (const worker of this.pool.workers) { - this.initWorkerTaskRunTime(worker) + for (const [index] of this.pool.workerNodes.entries()) { + this.initWorkerTaskRunTime(index) } } - private initWorkerTaskRunTime (worker: Worker): void { - this.setWorkerTaskRunTime(worker, this.defaultWorkerWeight, 0) + private initWorkerTaskRunTime (workerNodeKey: number): void { + this.setWorkerTaskRunTime(workerNodeKey, this.defaultWorkerWeight, 0) } private setWorkerTaskRunTime ( - worker: Worker, + workerNodeKey: number, weight: number, runTime: number ): void { - this.workersTaskRunTime.set(worker, { + this.workersTaskRunTime.set(workerNodeKey, { weight, runTime }) } - private getWorkerVirtualTaskRunTime (worker: Worker): number | undefined { - return this.pool.getWorkerAverageTasksRunTime(worker) + private getWorkerVirtualTaskRunTime (workerNodeKey: number): number { + return this.requiredStatistics.medRunTime + ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime + : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime } private computeWorkerWeight (): number {