X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fworker-choice-strategy-context.ts;h=9a015347bc2a430172855116224da8cfc89f2800;hb=00e1bdeb5c50b0eede8fe2f72d47bf8992e4aede;hp=7862fb38536b702e850843dc77d6303b637eada4;hpb=3ef87592f37b293b9593bfeefc77c78a8ddbabb3;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 7862fb38..9a015347 100644 --- a/src/pools/selection-strategies/worker-choice-strategy-context.ts +++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts @@ -1,4 +1,4 @@ -import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils' +import { buildInternalWorkerChoiceStrategyOptions } from '../../utils' import type { IPool } from '../pool' import type { IWorker } from '../worker' import { FairShareWorkerChoiceStrategy } from './fair-share-worker-choice-strategy' @@ -9,9 +9,10 @@ import { LeastEluWorkerChoiceStrategy } from './least-elu-worker-choice-strategy import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-strategy' import type { IWorkerChoiceStrategy, - TaskStatistics, - WorkerChoiceStrategy, - WorkerChoiceStrategyOptions + InternalWorkerChoiceStrategyOptions, + StrategyPolicy, + TaskStatisticsRequirements, + WorkerChoiceStrategy } from './selection-strategies-types' import { WorkerChoiceStrategies } from './selection-strategies-types' import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy' @@ -20,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, @@ -43,8 +44,12 @@ export class WorkerChoiceStrategyContext< public constructor ( pool: IPool, private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN, - opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS + private opts?: InternalWorkerChoiceStrategyOptions ) { + this.opts = buildInternalWorkerChoiceStrategyOptions( + pool.info.maxSize, + this.opts + ) this.execute = this.execute.bind(this) this.workerChoiceStrategies = new Map< WorkerChoiceStrategy, @@ -54,35 +59,35 @@ export class WorkerChoiceStrategyContext< WorkerChoiceStrategies.ROUND_ROBIN, new (RoundRobinWorkerChoiceStrategy.bind(this))( pool, - opts + this.opts ) ], [ WorkerChoiceStrategies.LEAST_USED, new (LeastUsedWorkerChoiceStrategy.bind(this))( pool, - opts + this.opts ) ], [ WorkerChoiceStrategies.LEAST_BUSY, new (LeastBusyWorkerChoiceStrategy.bind(this))( pool, - opts + this.opts ) ], [ WorkerChoiceStrategies.LEAST_ELU, new (LeastEluWorkerChoiceStrategy.bind(this))( pool, - opts + this.opts ) ], [ WorkerChoiceStrategies.FAIR_SHARE, new (FairShareWorkerChoiceStrategy.bind(this))( pool, - opts + this.opts ) ], [ @@ -91,7 +96,7 @@ export class WorkerChoiceStrategyContext< Worker, Data, Response - >(pool, opts) + >(pool, this.opts) ], [ WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN, @@ -99,22 +104,35 @@ export class WorkerChoiceStrategyContext< Worker, Data, Response - >(pool, opts) + >(pool, this.opts) ] ]) } /** - * Gets the worker choice strategy task statistics in the context. + * Gets the strategy policy in the context. + * + * @returns The strategy policy. + */ + public getStrategyPolicy (): StrategyPolicy { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).strategyPolicy + } + + /** + * Gets the worker choice strategy in the context task statistics requirements. * - * @returns The task statistics. + * @returns The task statistics requirements. */ - public getTaskStatistics (): TaskStatistics { + public getTaskStatisticsRequirements (): TaskStatisticsRequirements { return ( this.workerChoiceStrategies.get( this.workerChoiceStrategy ) as IWorkerChoiceStrategy - ).taskStatistics + ).taskStatisticsRequirements } /** @@ -132,7 +150,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. */ @@ -145,19 +163,46 @@ 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. */ public execute (): number { - const workerNodeKey = ( - this.workerChoiceStrategies.get( - this.workerChoiceStrategy - ) as IWorkerChoiceStrategy - ).choose() + const workerChoiceStrategy = this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + if (!workerChoiceStrategy.hasPoolWorkerNodesReady()) { + return this.execute() + } + 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') + throw new Error( + `Worker node key chosen is null or undefined after ${retriesCount} retries` + ) } return workerNodeKey } @@ -165,7 +210,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 { @@ -179,11 +224,19 @@ export class WorkerChoiceStrategyContext< /** * Sets the worker choice strategies in the context options. * + * @param pool - The pool instance. * @param opts - The worker choice strategy options. */ - public setOptions (opts: WorkerChoiceStrategyOptions): void { + public setOptions ( + pool: IPool, + opts?: InternalWorkerChoiceStrategyOptions + ): void { + this.opts = buildInternalWorkerChoiceStrategyOptions( + pool.info.maxSize, + opts + ) for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) { - workerChoiceStrategy.setOptions(opts) + workerChoiceStrategy.setOptions(this.opts) } } }