X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fworker-choice-strategy-context.ts;h=d3d2ae56004c37698c5c7b0e055e27b3725f4c7e;hb=0e8587d2e6bc29e14158c01948c625df9b11d381;hp=43bcb3adee19a9aaedf072e526f0b59235e55b40;hpb=5a31b13c97c664f37f284960713e5261e6b04055;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 43bcb3ad..d3d2ae56 100644 --- a/src/pools/selection-strategies/worker-choice-strategy-context.ts +++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts @@ -1,37 +1,52 @@ -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 { RoundRobinWorkerChoiceStrategy } from './round-robin-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, + StrategyPolicy, + TaskStatisticsRequirements, WorkerChoiceStrategy, WorkerChoiceStrategyOptions -} from './selection-strategies-types' -import { WorkerChoiceStrategies } from './selection-strategies-types' -import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy' +} 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 execution response. 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 IWorker, Data = unknown, Response = unknown > { + /** + * The number of worker choice strategy execution retries. + */ + public retriesCount: number + + /** + * The worker choice strategy instances registered in the context. + */ private readonly workerChoiceStrategies: Map< WorkerChoiceStrategy, IWorkerChoiceStrategy > + /** + * The maximum number of worker choice strategy execution retries. + */ + private readonly retries: number + /** * Worker choice strategy context constructor. * @@ -42,7 +57,7 @@ export class WorkerChoiceStrategyContext< public constructor ( pool: IPool, private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN, - opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + opts?: WorkerChoiceStrategyOptions ) { this.execute = this.execute.bind(this) this.workerChoiceStrategies = new Map< @@ -70,6 +85,13 @@ export class WorkerChoiceStrategyContext< opts ) ], + [ + WorkerChoiceStrategies.LEAST_ELU, + new (LeastEluWorkerChoiceStrategy.bind(this))( + pool, + opts + ) + ], [ WorkerChoiceStrategies.FAIR_SHARE, new (FairShareWorkerChoiceStrategy.bind(this))( @@ -94,19 +116,30 @@ export class WorkerChoiceStrategyContext< >(pool, opts) ] ]) + this.retriesCount = 0 + this.retries = getWorkerChoiceStrategyRetries(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 { - return ( - this.workerChoiceStrategies.get( - this.workerChoiceStrategy - ) as IWorkerChoiceStrategy - ).requiredStatistics + 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 in the context task statistics requirements. + * + * @returns The task statistics requirements. + */ + public getTaskStatisticsRequirements (): TaskStatisticsRequirements { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.workerChoiceStrategies.get(this.workerChoiceStrategy)! + .taskStatisticsRequirements } /** @@ -124,32 +157,53 @@ export class WorkerChoiceStrategyContext< } /** - * Updates the worker node key in the worker choice strategy internals in the context. + * 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 { - return ( - this.workerChoiceStrategies.get( - this.workerChoiceStrategy - ) as IWorkerChoiceStrategy - ).update(workerNodeKey) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.workerChoiceStrategies + .get(this.workerChoiceStrategy)! + .update(workerNodeKey) } /** - * Executes the worker choice strategy algorithm in the context. + * Executes the worker choice strategy in the context algorithm. * * @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. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If after computed retries the worker node key is null or undefined. */ public execute (): number { - const workerNodeKey = ( - this.workerChoiceStrategies.get( - this.workerChoiceStrategy - ) as IWorkerChoiceStrategy - ).choose() + return this.executeStrategy( + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + this.workerChoiceStrategies.get(this.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 computed 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 + ++this.retriesCount + } + chooseCount++ + } while (workerNodeKey == null && retriesCount < this.retries) if (workerNodeKey == null) { - throw new Error('Worker node key chosen is null or undefined') + throw new Error( + `Worker node key chosen is null or undefined after ${retriesCount} retries` + ) } return workerNodeKey } @@ -157,15 +211,14 @@ export class WorkerChoiceStrategyContext< /** * Removes the worker node key from the worker choice strategy in the context. * - * @param workerNodeKey - The key of the worker node. + * @param workerNodeKey - The worker node key. * @returns `true` if the removal is successful, `false` otherwise. */ public remove (workerNodeKey: number): boolean { - return ( - this.workerChoiceStrategies.get( - this.workerChoiceStrategy - ) as IWorkerChoiceStrategy - ).remove(workerNodeKey) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + return this.workerChoiceStrategies + .get(this.workerChoiceStrategy)! + .remove(workerNodeKey) } /** @@ -173,7 +226,7 @@ export class WorkerChoiceStrategyContext< * * @param opts - The worker choice strategy options. */ - public setOptions (opts: WorkerChoiceStrategyOptions): void { + public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void { for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) { workerChoiceStrategy.setOptions(opts) }