X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fworker-choice-strategy-context.ts;h=1de78aba9f15f1ca2cddb1cdac474c8470e7991f;hb=af7f2788b6fcc39343d544551cf17c8f0dc5b757;hp=42e6735e658ac76a9a338e389404f784a6265560;hpb=78cea37e264d5ca527bc42eb056f3b9579a2b2c4;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 42e6735e..1de78aba 100644 --- a/src/pools/selection-strategies/worker-choice-strategy-context.ts +++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts @@ -1,90 +1,242 @@ -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 { getDefaultInternalWorkerChoiceStrategyOptions } 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 { LeastEluWorkerChoiceStrategy } from './least-elu-worker-choice-strategy' +import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-strategy' import type { IWorkerChoiceStrategy, + InternalWorkerChoiceStrategyOptions, + StrategyPolicy, + TaskStatisticsRequirements, WorkerChoiceStrategy } from './selection-strategies-types' import { WorkerChoiceStrategies } from './selection-strategies-types' -import { getWorkerChoiceStrategy } from './selection-strategies-utils' +import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy' /** * The worker choice strategy context. * - * @template Worker Type of worker. - * @template Data Type of data sent to the worker. This can only be serializable data. - * @template Response Type of response of execution. This can only be serializable data. + * @typeParam Worker - Type of worker. + * @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 + private readonly workerChoiceStrategies: Map< + WorkerChoiceStrategy, + IWorkerChoiceStrategy + > /** * Worker choice strategy context constructor. * - * @param pool The pool instance. - * @param createDynamicallyWorkerCallback The worker creation callback for dynamic pool. - * @param workerChoiceStrategy The worker choice strategy. + * @param pool - The pool instance. + * @param workerChoiceStrategy - The worker choice strategy. + * @param opts - The worker choice strategy options. */ public constructor ( - private readonly pool: IPoolInternal, - private readonly createDynamicallyWorkerCallback: () => Worker, - workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN + pool: IPool, + private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN, + private opts?: InternalWorkerChoiceStrategyOptions ) { - this.setWorkerChoiceStrategy(workerChoiceStrategy) + this.opts = { + ...getDefaultInternalWorkerChoiceStrategyOptions(pool.info.maxSize), + ...this.opts + } + this.execute = this.execute.bind(this) + this.workerChoiceStrategies = new Map< + WorkerChoiceStrategy, + IWorkerChoiceStrategy + >([ + [ + WorkerChoiceStrategies.ROUND_ROBIN, + new (RoundRobinWorkerChoiceStrategy.bind(this))( + pool, + this.opts + ) + ], + [ + WorkerChoiceStrategies.LEAST_USED, + new (LeastUsedWorkerChoiceStrategy.bind(this))( + pool, + this.opts + ) + ], + [ + WorkerChoiceStrategies.LEAST_BUSY, + new (LeastBusyWorkerChoiceStrategy.bind(this))( + pool, + this.opts + ) + ], + [ + WorkerChoiceStrategies.LEAST_ELU, + new (LeastEluWorkerChoiceStrategy.bind(this))( + pool, + this.opts + ) + ], + [ + WorkerChoiceStrategies.FAIR_SHARE, + new (FairShareWorkerChoiceStrategy.bind(this))( + pool, + this.opts + ) + ], + [ + WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN, + new (WeightedRoundRobinWorkerChoiceStrategy.bind(this))< + Worker, + Data, + Response + >(pool, this.opts) + ], + [ + WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN, + new (InterleavedWeightedRoundRobinWorkerChoiceStrategy.bind(this))< + Worker, + Data, + Response + >(pool, this.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.createDynamicallyWorkerCallback, - workerChoiceStrategy - ) - } - return getWorkerChoiceStrategy(this.pool, workerChoiceStrategy) + public getStrategyPolicy (): StrategyPolicy { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).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. + * @returns The task statistics requirements. */ - public getWorkerChoiceStrategy (): IWorkerChoiceStrategy { - return this.workerChoiceStrategy + public getTaskStatisticsRequirements (): TaskStatisticsRequirements { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).taskStatisticsRequirements } /** * Sets the worker choice strategy to use in the context. * - * @param workerChoiceStrategy The worker choice strategy to set. + * @param workerChoiceStrategy - The worker choice strategy to set. */ 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 { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).update(workerNodeKey) + } + + /** + * 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 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()) { + return this.execute() + } + return this.executeStrategy(workerChoiceStrategy) } /** - * Chooses a worker with the underlying selection strategy. + * Executes the given worker choice strategy. * - * @returns The chosen one. + * @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. */ - public execute (): Worker { - return this.workerChoiceStrategy.choose() + 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 (workerNodeKey: number): boolean { + return ( + this.workerChoiceStrategies.get( + this.workerChoiceStrategy + ) as IWorkerChoiceStrategy + ).remove(workerNodeKey) + } + + /** + * Sets the worker choice strategies in the context options. + * + * @param pool - The pool instance. + * @param opts - The worker choice strategy options. + */ + public setOptions ( + pool: IPool, + opts?: InternalWorkerChoiceStrategyOptions + ): void { + this.opts = { + ...getDefaultInternalWorkerChoiceStrategyOptions(pool.info.maxSize), + ...opts + } + for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) { + workerChoiceStrategy.setOptions(this.opts) + } } }