X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fworker-choice-strategy-context.ts;h=a0ba25838dc524ea678c97701e20ac7aa1f7b413;hb=f0bbd436ca3a985f79cf530ba82805d8d617d509;hp=011e00db2060b08dffa193b28be907b35b2eb64c;hpb=97a2abc3c559695c4fae99c48d1a2dc636275ccb;p=poolifier.git diff --git a/src/pools/selection-strategies/worker-choice-strategy-context.ts b/src/pools/selection-strategies/worker-choice-strategy-context.ts index 011e00db..a0ba2583 100644 --- a/src/pools/selection-strategies/worker-choice-strategy-context.ts +++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts @@ -1,111 +1,189 @@ -import type { IPoolInternal } from '../pool-internal' -import { PoolType } from '../pool-internal' -import type { IPoolWorker } from '../pool-worker' -import { DynamicPoolWorkerChoiceStrategy } from './dynamic-pool-worker-choice-strategy' +import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils' +import type { IPool } from '../pool' +import type { IWorker } from '../worker' +import { FairShareWorkerChoiceStrategy } from './fair-share-worker-choice-strategy' +import { InterleavedWeightedRoundRobinWorkerChoiceStrategy } from './interleaved-weighted-round-robin-worker-choice-strategy' +import { LeastBusyWorkerChoiceStrategy } from './least-busy-worker-choice-strategy' +import { LeastUsedWorkerChoiceStrategy } from './least-used-worker-choice-strategy' +import { LeastEluWorkerChoiceStrategy } from './least-elu-worker-choice-strategy' +import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-strategy' import type { IWorkerChoiceStrategy, - RequiredStatistics, - WorkerChoiceStrategy + TaskStatisticsRequirements, + WorkerChoiceStrategy, + WorkerChoiceStrategyOptions } from './selection-strategies-types' import { WorkerChoiceStrategies } from './selection-strategies-types' -import { getWorkerChoiceStrategy } from './selection-strategies-utils' +import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy' /** * The worker choice strategy context. * * @typeParam Worker - Type of worker. * @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 class WorkerChoiceStrategyContext< - Worker extends IPoolWorker, - Data, - Response + Worker extends IWorker, + Data = unknown, + Response = unknown > { - private workerChoiceStrategy!: IWorkerChoiceStrategy + private readonly workerChoiceStrategies: Map< + WorkerChoiceStrategy, + IWorkerChoiceStrategy + > /** * Worker choice strategy context constructor. * * @param pool - The pool instance. - * @param createWorkerCallback - The worker creation callback for dynamic pool. * @param workerChoiceStrategy - The worker choice strategy. + * @param opts - The worker choice strategy options. */ public constructor ( - private readonly pool: IPoolInternal, - private readonly createWorkerCallback: () => number, - workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN + pool: IPool, + private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN, + opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS ) { - this.setWorkerChoiceStrategy(workerChoiceStrategy) + this.execute = this.execute.bind(this) + this.workerChoiceStrategies = new Map< + WorkerChoiceStrategy, + IWorkerChoiceStrategy + >([ + [ + WorkerChoiceStrategies.ROUND_ROBIN, + new (RoundRobinWorkerChoiceStrategy.bind(this))( + pool, + opts + ) + ], + [ + WorkerChoiceStrategies.LEAST_USED, + new (LeastUsedWorkerChoiceStrategy.bind(this))( + pool, + opts + ) + ], + [ + WorkerChoiceStrategies.LEAST_BUSY, + new (LeastBusyWorkerChoiceStrategy.bind(this))( + pool, + opts + ) + ], + [ + WorkerChoiceStrategies.LEAST_ELU, + new (LeastEluWorkerChoiceStrategy.bind(this))( + pool, + opts + ) + ], + [ + WorkerChoiceStrategies.FAIR_SHARE, + new (FairShareWorkerChoiceStrategy.bind(this))( + pool, + opts + ) + ], + [ + WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN, + new (WeightedRoundRobinWorkerChoiceStrategy.bind(this))< + Worker, + Data, + Response + >(pool, opts) + ], + [ + WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN, + new (InterleavedWeightedRoundRobinWorkerChoiceStrategy.bind(this))< + Worker, + Data, + Response + >(pool, opts) + ] + ]) } /** - * Gets the worker choice strategy instance specific to the pool type. + * Gets the worker choice strategy task statistics requirements in the context. * - * @param workerChoiceStrategy - The worker choice strategy. - * @returns The worker choice strategy instance for the pool type. + * @returns The task statistics requirements. */ - private getPoolWorkerChoiceStrategy ( - workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN - ): IWorkerChoiceStrategy { - if (this.pool.type === PoolType.DYNAMIC) { - return new DynamicPoolWorkerChoiceStrategy( - this.pool, - this.createWorkerCallback, - workerChoiceStrategy - ) - } - return getWorkerChoiceStrategy(this.pool, workerChoiceStrategy) + public getTaskStatisticsRequirements (): TaskStatisticsRequirements { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).taskStatisticsRequirements } /** - * Gets the worker choice strategy used in the context. + * Sets the worker choice strategy to use in the context. * - * @returns The worker choice strategy. - * @deprecated Scheduled removal. + * @param workerChoiceStrategy - The worker choice strategy to set. */ - public getWorkerChoiceStrategy (): IWorkerChoiceStrategy { - return this.workerChoiceStrategy + public setWorkerChoiceStrategy ( + workerChoiceStrategy: WorkerChoiceStrategy + ): void { + if (this.workerChoiceStrategy !== workerChoiceStrategy) { + this.workerChoiceStrategy = workerChoiceStrategy + } + this.workerChoiceStrategies.get(this.workerChoiceStrategy)?.reset() } /** - * Gets the worker choice strategy required statistics. + * Updates the worker node key in the worker choice strategy internals in the context. * - * @returns The required statistics. + * @returns `true` if the update is successful, `false` otherwise. */ - public getRequiredStatistics (): RequiredStatistics { - return this.workerChoiceStrategy.requiredStatistics + public update (workerNodeKey: number): boolean { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).update(workerNodeKey) } /** - * Sets the worker choice strategy to use in the context. + * Executes the worker choice strategy algorithm in the context. * - * @param workerChoiceStrategy - The worker choice strategy to set. + * @returns The key of the worker node. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If the worker node key is null or undefined. */ - public setWorkerChoiceStrategy ( - workerChoiceStrategy: WorkerChoiceStrategy - ): void { - this.workerChoiceStrategy?.reset() - this.workerChoiceStrategy = - this.getPoolWorkerChoiceStrategy(workerChoiceStrategy) + public execute (): number { + const workerNodeKey = ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).choose() + if (workerNodeKey == null) { + throw new Error('Worker node key chosen is null or undefined') + } + return workerNodeKey } /** - * Chooses a worker with the underlying selection strategy. + * Removes the worker node key from the worker choice strategy in the context. * - * @returns The key of the chosen one. + * @param workerNodeKey - The key of the worker node. + * @returns `true` if the removal is successful, `false` otherwise. */ - public execute (): number { - return this.workerChoiceStrategy.choose() + public remove (workerNodeKey: number): boolean { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).remove(workerNodeKey) } /** - * Removes a worker in the underlying selection strategy internals. + * Sets the worker choice strategies in the context options. * - * @param workerKey - The key of the worker to remove. - * @returns `true` if the removal is successful, `false` otherwise. + * @param opts - The worker choice strategy options. */ - public remove (workerKey: number): boolean { - return this.workerChoiceStrategy.remove(workerKey) + public setOptions (opts: WorkerChoiceStrategyOptions): void { + for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) { + workerChoiceStrategy.setOptions(opts) + } } }