X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fworker-choice-strategy-context.ts;h=157a61223a251aa1305be38555e67511b37798d6;hb=3c8a79b4b146fb20de682c19d8b409bfbdf05df4;hp=6758f2a68a0dfe2969c3a2e7f60a255597673dc8;hpb=5dd39e0fba309bb3af0ca64aea5205f57dfe5d24;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 6758f2a6..157a6122 100644 --- a/src/pools/selection-strategies/worker-choice-strategy-context.ts +++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts @@ -3,12 +3,14 @@ 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 { LessBusyWorkerChoiceStrategy } from './less-busy-worker-choice-strategy' -import { LessUsedWorkerChoiceStrategy } from './less-used-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, + StrategyPolicy, + TaskStatisticsRequirements, WorkerChoiceStrategy, WorkerChoiceStrategyOptions } from './selection-strategies-types' @@ -19,8 +21,8 @@ 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 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, @@ -42,8 +44,9 @@ export class WorkerChoiceStrategyContext< public constructor ( pool: IPool, private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN, - opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + private opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS ) { + this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts } this.execute = this.execute.bind(this) this.workerChoiceStrategies = new Map< WorkerChoiceStrategy, @@ -57,15 +60,22 @@ export class WorkerChoiceStrategyContext< ) ], [ - WorkerChoiceStrategies.LESS_USED, - new (LessUsedWorkerChoiceStrategy.bind(this))( + WorkerChoiceStrategies.LEAST_USED, + new (LeastUsedWorkerChoiceStrategy.bind(this))( pool, opts ) ], [ - WorkerChoiceStrategies.LESS_BUSY, - new (LessBusyWorkerChoiceStrategy.bind(this))( + WorkerChoiceStrategies.LEAST_BUSY, + new (LeastBusyWorkerChoiceStrategy.bind(this))( + pool, + opts + ) + ], + [ + WorkerChoiceStrategies.LEAST_ELU, + new (LeastEluWorkerChoiceStrategy.bind(this))( pool, opts ) @@ -97,16 +107,29 @@ export class WorkerChoiceStrategyContext< } /** - * 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.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 } /** @@ -124,7 +147,7 @@ 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. */ @@ -137,19 +160,44 @@ export class WorkerChoiceStrategyContext< } /** - * 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 configured retries the worker node key is null or undefined. + * @throws {@link https://nodejs.org/api/errors.html#class-rangeerror} If the maximum consecutive worker choice strategy executions has been reached. */ public execute (): number { - const workerNodeKey = ( - this.workerChoiceStrategies.get( - this.workerChoiceStrategy - ) as IWorkerChoiceStrategy - ).choose() + const workerChoiceStrategy = this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + let workerNodeKey: number | undefined + const maxExecutionCount = 10000 + let executionCount = 0 + let chooseCount = 0 + let retriesCount = 0 + do { + if (workerChoiceStrategy.hasPoolWorkerNodesReady()) { + workerNodeKey = workerChoiceStrategy.choose() + if (chooseCount > 0) { + retriesCount++ + } + chooseCount++ + } + executionCount++ + } while ( + executionCount < maxExecutionCount && + (!workerChoiceStrategy.hasPoolWorkerNodesReady() || + (workerNodeKey == null && retriesCount < (this.opts.retries as number))) + ) + if (executionCount >= maxExecutionCount) { + throw new RangeError( + `Worker choice strategy consecutive executions has exceeded the maximum of ${maxExecutionCount}` + ) + } 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,7 +205,7 @@ 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 { @@ -174,8 +222,9 @@ export class WorkerChoiceStrategyContext< * @param opts - The worker choice strategy options. */ public setOptions (opts: WorkerChoiceStrategyOptions): void { - this.workerChoiceStrategies.forEach(workerChoiceStrategy => { + this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts } + for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) { workerChoiceStrategy.setOptions(opts) - }) + } } }