X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fworker-choice-strategy-context.ts;h=9e18fdc4315fc322f7aabc5e49c92bdaa3a46767;hb=ce63d9e2f3d895bd2ae5aafc40769ff4dda3c887;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..9e18fdc4 100644 --- a/src/pools/selection-strategies/worker-choice-strategy-context.ts +++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts @@ -1,80 +1,139 @@ -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 type { IPool } from '../pool.js' +import type { IWorker } from '../worker.js' +import { getWorkerChoiceStrategyRetries } from '../../utils.js' +import { FairShareWorkerChoiceStrategy } from './fair-share-worker-choice-strategy.js' +import { InterleavedWeightedRoundRobinWorkerChoiceStrategy } from './interleaved-weighted-round-robin-worker-choice-strategy.js' +import { LeastBusyWorkerChoiceStrategy } from './least-busy-worker-choice-strategy.js' +import { LeastUsedWorkerChoiceStrategy } from './least-used-worker-choice-strategy.js' +import { LeastEluWorkerChoiceStrategy } from './least-elu-worker-choice-strategy.js' +import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-strategy.js' import type { IWorkerChoiceStrategy, - RequiredStatistics, - WorkerChoiceStrategy -} from './selection-strategies-types' -import { WorkerChoiceStrategies } from './selection-strategies-types' -import { getWorkerChoiceStrategy } from './selection-strategies-utils' + StrategyPolicy, + TaskStatisticsRequirements, + WorkerChoiceStrategy, + WorkerChoiceStrategyOptions +} from './selection-strategies-types.js' +import { WorkerChoiceStrategies } from './selection-strategies-types.js' +import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy.js' /** * 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, - Data, - Response + Worker extends IWorker, + Data = unknown, + Response = unknown > { - private workerChoiceStrategy!: IWorkerChoiceStrategy + /** + * The worker choice strategy instances registered in the context. + */ + private readonly workerChoiceStrategies: Map< + WorkerChoiceStrategy, + IWorkerChoiceStrategy + > + + /** + * The number of worker choice strategy execution retries. + */ + private readonly retries: number /** * 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 ) { - 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) + ] + ]) + this.retries = getWorkerChoiceStrategyRetries(pool, opts) } /** - * Gets the worker choice strategy instance specific to the pool type. + * Gets the strategy policy in the context. * - * @param workerChoiceStrategy - The worker choice strategy. - * @returns The worker choice strategy instance for the pool type. + * @returns The strategy policy. */ - 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 getStrategyPolicy (): StrategyPolicy { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.workerChoiceStrategies.get(this.workerChoiceStrategy)! + .strategyPolicy } /** - * Gets the worker choice strategy used in the context. + * Gets the worker choice strategy in the context task statistics requirements. * - * @returns The worker choice strategy. - * @deprecated Scheduled removal. + * @returns The task statistics requirements. */ - public getWorkerChoiceStrategy (): IWorkerChoiceStrategy { - return this.workerChoiceStrategy - } - - /** - * Gets the worker choice strategy required statistics. - * - * @returns The required statistics. - */ - public getRequiredStatistics (): RequiredStatistics { - return this.workerChoiceStrategy.requiredStatistics + public getTaskStatisticsRequirements (): TaskStatisticsRequirements { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.workerChoiceStrategies.get(this.workerChoiceStrategy)! + .taskStatisticsRequirements } /** @@ -85,27 +144,88 @@ export class WorkerChoiceStrategyContext< public setWorkerChoiceStrategy ( workerChoiceStrategy: WorkerChoiceStrategy ): void { - this.workerChoiceStrategy?.reset() - this.workerChoiceStrategy = - this.getPoolWorkerChoiceStrategy(workerChoiceStrategy) + if (this.workerChoiceStrategy !== workerChoiceStrategy) { + this.workerChoiceStrategy = workerChoiceStrategy + } + this.workerChoiceStrategies.get(this.workerChoiceStrategy)?.reset() + } + + /** + * Updates the worker node key in the worker choice strategy in the context internals. + * + * @returns `true` if the update is successful, `false` otherwise. + */ + public update (workerNodeKey: number): boolean { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.workerChoiceStrategies + .get(this.workerChoiceStrategy)! + .update(workerNodeKey) } /** - * Chooses a worker with the underlying selection strategy. + * Executes the worker choice strategy in the context algorithm. * - * @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 after configured retries the worker node key is null or undefined. */ public execute (): number { - return this.workerChoiceStrategy.choose() + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + const workerChoiceStrategy = this.workerChoiceStrategies.get( + this.workerChoiceStrategy + )! + if (!workerChoiceStrategy.hasPoolWorkerNodesReady()) { + return this.execute() + } + return this.executeStrategy(workerChoiceStrategy) } /** - * Removes a worker in the underlying selection strategy internals. + * Executes the given worker choice strategy. * - * @param workerKey - The key of the worker to remove. + * @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.retries) + 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 { - return this.workerChoiceStrategy.remove(workerKey) + public remove (workerNodeKey: number): boolean { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.workerChoiceStrategies + .get(this.workerChoiceStrategy)! + .remove(workerNodeKey) + } + + /** + * Sets the worker choice strategies in the context options. + * + * @param opts - The worker choice strategy options. + */ + public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void { + for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) { + workerChoiceStrategy.setOptions(opts) + } } }