X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fworker-choice-strategy-context.ts;h=a0ba25838dc524ea678c97701e20ac7aa1f7b413;hb=4eb9e75a6d47a08541d38b70505e5ba1126aa2f1;hp=2d33738731c661e0df84a74a0ffa043e9e3b4e69;hpb=b529c323958350e8b54ccfb4096d0c661c975b71;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 2d337387..a0ba2583 100644 --- a/src/pools/selection-strategies/worker-choice-strategy-context.ts +++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts @@ -1,13 +1,17 @@ -import type { IPoolInternal } from '../pool-internal' -import type { IPoolWorker } from '../pool-worker' +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 { LessBusyWorkerChoiceStrategy } from './less-busy-worker-choice-strategy' -import { LessUsedWorkerChoiceStrategy } from './less-used-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 { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy' @@ -17,69 +21,100 @@ import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-w * * @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, + Worker extends IWorker, Data = unknown, Response = unknown > { private readonly workerChoiceStrategies: Map< WorkerChoiceStrategy, - IWorkerChoiceStrategy + 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 ( - pool: IPoolInternal, - private readonly createWorkerCallback: () => number, - private workerChoiceStrategyType: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN + pool: IPool, + private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN, + opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS ) { - this.execute.bind(this) + this.execute = this.execute.bind(this) this.workerChoiceStrategies = new Map< WorkerChoiceStrategy, - IWorkerChoiceStrategy + IWorkerChoiceStrategy >([ [ WorkerChoiceStrategies.ROUND_ROBIN, - new RoundRobinWorkerChoiceStrategy(pool) + new (RoundRobinWorkerChoiceStrategy.bind(this))( + pool, + opts + ) + ], + [ + WorkerChoiceStrategies.LEAST_USED, + new (LeastUsedWorkerChoiceStrategy.bind(this))( + pool, + opts + ) ], [ - WorkerChoiceStrategies.LESS_USED, - new LessUsedWorkerChoiceStrategy(pool) + WorkerChoiceStrategies.LEAST_BUSY, + new (LeastBusyWorkerChoiceStrategy.bind(this))( + pool, + opts + ) ], [ - WorkerChoiceStrategies.LESS_BUSY, - new LessBusyWorkerChoiceStrategy(pool) + WorkerChoiceStrategies.LEAST_ELU, + new (LeastEluWorkerChoiceStrategy.bind(this))( + pool, + opts + ) ], [ WorkerChoiceStrategies.FAIR_SHARE, - new FairShareWorkerChoiceStrategy(pool) + new (FairShareWorkerChoiceStrategy.bind(this))( + pool, + opts + ) ], [ WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN, - new WeightedRoundRobinWorkerChoiceStrategy(pool) + 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 in the context required statistics. + * Gets the worker choice strategy task statistics requirements in the context. * - * @returns The required statistics. + * @returns The task statistics requirements. */ - public getRequiredStatistics (): RequiredStatistics { + public getTaskStatisticsRequirements (): TaskStatisticsRequirements { return ( this.workerChoiceStrategies.get( - this.workerChoiceStrategyType - ) as IWorkerChoiceStrategy - ).requiredStatistics + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).taskStatisticsRequirements } /** @@ -88,46 +123,67 @@ export class WorkerChoiceStrategyContext< * @param workerChoiceStrategy - The worker choice strategy to set. */ public setWorkerChoiceStrategy ( - pool: IPoolInternal, workerChoiceStrategy: WorkerChoiceStrategy ): void { - if (this.workerChoiceStrategyType === workerChoiceStrategy) { - this.workerChoiceStrategies.get(workerChoiceStrategy)?.reset() - } else { - this.workerChoiceStrategyType = workerChoiceStrategy + if (this.workerChoiceStrategy !== workerChoiceStrategy) { + this.workerChoiceStrategy = workerChoiceStrategy } + this.workerChoiceStrategies.get(this.workerChoiceStrategy)?.reset() + } + + /** + * Updates the worker node key in the worker choice strategy internals in the context. + * + * @returns `true` if the update is successful, `false` otherwise. + */ + public update (workerNodeKey: number): boolean { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).update(workerNodeKey) } /** * Executes the worker choice strategy algorithm in the context. * - * @returns The key of the chosen one. + * @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 execute (): number { - const workerChoiceStrategy = this.workerChoiceStrategies.get( - this.workerChoiceStrategyType - ) as IWorkerChoiceStrategy - if ( - workerChoiceStrategy.isDynamicPool && - !workerChoiceStrategy.pool.full && - workerChoiceStrategy.pool.findFreeWorkerKey() === -1 - ) { - return this.createWorkerCallback() + 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 workerChoiceStrategy.choose() + return workerNodeKey } /** - * Removes a worker from the worker choice strategy in the context. + * Removes the worker node key from the worker choice strategy in the context. * - * @param workerKey - The key of the worker to remove. + * @param workerNodeKey - The key of the worker node. * @returns `true` if the removal is successful, `false` otherwise. */ - public remove (workerKey: number): boolean { + public remove (workerNodeKey: number): boolean { return ( this.workerChoiceStrategies.get( - this.workerChoiceStrategyType - ) as IWorkerChoiceStrategy - ).remove(workerKey) + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).remove(workerNodeKey) + } + + /** + * Sets the worker choice strategies in the context options. + * + * @param opts - The worker choice strategy options. + */ + public setOptions (opts: WorkerChoiceStrategyOptions): void { + for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) { + workerChoiceStrategy.setOptions(opts) + } } }