X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fworker-choice-strategy-context.ts;h=d6a6e26d27e87fbb263a9ef5b61e5c1745b60950;hb=613a91dc3e9745e9f4ae53f589fe0ee6d2b594cd;hp=192cf005805ecfd70c70a337c9a7ac078ce46abb;hpb=a22cdf86c993800ec9ea8ae32ef0d8dbda07ec61;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 192cf005..d6a6e26d 100644 --- a/src/pools/selection-strategies/worker-choice-strategy-context.ts +++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts @@ -1,13 +1,18 @@ -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 + StrategyPolicy, + TaskStatisticsRequirements, + WorkerChoiceStrategy, + WorkerChoiceStrategyOptions } from './selection-strategies-types' import { WorkerChoiceStrategies } from './selection-strategies-types' import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy' @@ -16,11 +21,11 @@ import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-w * 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 Data - Type of data sent to the worker. This can only be structured-cloneable data. + * @typeParam Response - Type of execution response. This can only be structured-cloneable data. */ export class WorkerChoiceStrategyContext< - Worker extends IPoolWorker, + Worker extends IWorker, Data = unknown, Response = unknown > { @@ -33,51 +38,98 @@ export class WorkerChoiceStrategyContext< * Worker choice strategy context constructor. * * @param pool - The pool instance. - * @param workerChoiceStrategyType - The worker choice strategy. + * @param workerChoiceStrategy - The worker choice strategy. + * @param opts - The worker choice strategy options. */ public constructor ( - pool: IPoolInternal, - private workerChoiceStrategyType: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN + pool: IPool, + private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN, + private opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS ) { - this.execute.bind(this) + this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts } + this.execute = this.execute.bind(this) this.workerChoiceStrategies = new Map< WorkerChoiceStrategy, 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 strategy policy in the context. * - * @returns The required statistics. + * @returns The strategy policy. */ - public getRequiredStatistics (): RequiredStatistics { + public getStrategyPolicy (): StrategyPolicy { return ( this.workerChoiceStrategies.get( - this.workerChoiceStrategyType + this.workerChoiceStrategy ) as IWorkerChoiceStrategy - ).requiredStatistics + ).strategyPolicy + } + + /** + * Gets the worker choice strategy in the context task statistics requirements. + * + * @returns The task statistics requirements. + */ + public getTaskStatisticsRequirements (): TaskStatisticsRequirements { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).taskStatisticsRequirements } /** @@ -88,36 +140,93 @@ export class WorkerChoiceStrategyContext< public setWorkerChoiceStrategy ( workerChoiceStrategy: WorkerChoiceStrategy ): void { - if (this.workerChoiceStrategyType !== workerChoiceStrategy) { - this.workerChoiceStrategyType = workerChoiceStrategy + if (this.workerChoiceStrategy !== workerChoiceStrategy) { + this.workerChoiceStrategy = workerChoiceStrategy } - this.workerChoiceStrategies.get(this.workerChoiceStrategyType)?.reset() + this.workerChoiceStrategies.get(this.workerChoiceStrategy)?.reset() } /** - * Executes the worker choice strategy algorithm in the context. + * Updates the worker node key in the worker choice strategy in the context internals. * - * @returns The key of the chosen one. + * @returns `true` if the update is successful, `false` otherwise. */ - public execute (): number { + public update (workerNodeKey: number): boolean { return ( this.workerChoiceStrategies.get( - this.workerChoiceStrategyType + this.workerChoiceStrategy ) as IWorkerChoiceStrategy - ).choose() + ).update(workerNodeKey) } /** - * Removes a worker from the worker choice strategy in the context. + * Executes the worker choice strategy in the context algorithm. * - * @param workerKey - The key of the worker to remove. + * @returns The key of the worker node. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If after configured retries the worker node key is null or undefined. + */ + public execute (): number { + const workerChoiceStrategy = this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + if (!workerChoiceStrategy.hasPoolWorkerNodesReady()) { + // wait for a worker node to be ready without blocking the event loop + } + return this.executeStrategy(workerChoiceStrategy) + } + + /** + * Executes the given worker choice strategy. + * + * @param workerChoiceStrategy - The worker choice strategy. + * @returns The key of the worker node. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If after configured retries the worker node key is null or undefined. + */ + private executeStrategy (workerChoiceStrategy: IWorkerChoiceStrategy): number { + let workerNodeKey: number | undefined + let chooseCount = 0 + let retriesCount = 0 + do { + workerNodeKey = workerChoiceStrategy.choose() + if (workerNodeKey == null && chooseCount > 0) { + retriesCount++ + } + chooseCount++ + } while ( + workerNodeKey == null && + retriesCount < (this.opts.retries as number) + ) + if (workerNodeKey == null) { + throw new Error( + `Worker node key chosen is null or undefined after ${retriesCount} retries` + ) + } + return workerNodeKey + } + + /** + * Removes the worker node key from the worker choice strategy in the context. + * + * @param workerNodeKey - The worker node key. * @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 + this.workerChoiceStrategy ) as IWorkerChoiceStrategy - ).remove(workerKey) + ).remove(workerNodeKey) + } + + /** + * Sets the worker choice strategies in the context options. + * + * @param opts - The worker choice strategy options. + */ + public setOptions (opts: WorkerChoiceStrategyOptions): void { + this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts } + for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) { + workerChoiceStrategy.setOptions(opts) + } } }