-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 { 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 { LessBusyWorkerChoiceStrategy } from './less-busy-worker-choice-strategy'
+import { LessUsedWorkerChoiceStrategy } from './less-used-worker-choice-strategy'
+import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-strategy'
import type {
IWorkerChoiceStrategy,
RequiredStatistics,
- WorkerChoiceStrategy
+ WorkerChoiceStrategy,
+ WorkerChoiceStrategyOptions
} 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.
*
* @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 Response - Type of execution response. This can only be serializable 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 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<Worker, Data, Response>,
- private readonly createWorkerCallback: () => number,
- workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN
+ pool: IPool<Worker, Data, Response>,
+ private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN,
+ opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
) {
- this.setWorkerChoiceStrategy(workerChoiceStrategy)
+ this.execute = this.execute.bind(this)
+ this.workerChoiceStrategies = new Map<
+ WorkerChoiceStrategy,
+ IWorkerChoiceStrategy
+ >([
+ [
+ WorkerChoiceStrategies.ROUND_ROBIN,
+ new (RoundRobinWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.LESS_USED,
+ new (LessUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.LESS_BUSY,
+ new (LessBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.FAIR_SHARE,
+ new (FairShareWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+ pool,
+ opts
+ )
+ ],
+ [
+ WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN,
+ new (WeightedRoundRobinWorkerChoiceStrategy.bind(this))<
+ Worker,
+ Data,
+ Response
+ >(pool, opts)
+ ]
+ ])
}
/**
- * Gets the worker choice strategy instance specific to the pool type.
+ * Gets the worker choice strategy in the context required statistics.
*
- * @param workerChoiceStrategy - The worker choice strategy.
- * @returns The worker choice strategy instance for the pool type.
+ * @returns The required statistics.
*/
- 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 getRequiredStatistics (): RequiredStatistics {
+ return (
+ this.workerChoiceStrategies.get(
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
+ ).requiredStatistics
}
/**
- * Gets the worker choice strategy used in the context.
+ * Sets the worker choice strategy to use in the context.
*
- * @returns The worker choice strategy.
- * @deprecated Scheduled removal.
+ * @param workerChoiceStrategy - The worker choice strategy to set.
*/
- public getWorkerChoiceStrategy (): IWorkerChoiceStrategy {
- return this.workerChoiceStrategy
+ public setWorkerChoiceStrategy (
+ workerChoiceStrategy: WorkerChoiceStrategy
+ ): void {
+ if (this.workerChoiceStrategy !== workerChoiceStrategy) {
+ this.workerChoiceStrategy = workerChoiceStrategy
+ }
+ this.workerChoiceStrategies.get(this.workerChoiceStrategy)?.reset()
}
/**
- * Gets the worker choice strategy required statistics.
+ * Updates the worker node key in the worker choice strategy internals in the context.
*
- * @returns The required statistics.
+ * @returns `true` if the update is successful, `false` otherwise.
*/
- public getRequiredStatistics (): RequiredStatistics {
- return this.workerChoiceStrategy.requiredStatistics
+ public update (workerNodeKey: number): boolean {
+ return (
+ this.workerChoiceStrategies.get(
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
+ ).update(workerNodeKey)
}
/**
- * Sets the worker choice strategy to use in the context.
+ * Executes the worker choice strategy algorithm in the context.
*
- * @param workerChoiceStrategy - The worker choice strategy to set.
+ * @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.
*/
- public setWorkerChoiceStrategy (
- workerChoiceStrategy: WorkerChoiceStrategy
- ): void {
- this.workerChoiceStrategy?.reset()
- this.workerChoiceStrategy =
- this.getPoolWorkerChoiceStrategy(workerChoiceStrategy)
+ public execute (): number {
+ const workerNodeKey = (
+ this.workerChoiceStrategies.get(
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
+ ).choose()
+ if (workerNodeKey == null) {
+ throw new Error('Worker node key chosen is null or undefined')
+ }
+ return workerNodeKey
}
/**
- * Chooses a worker with the underlying selection strategy.
+ * Removes the worker node key from the worker choice strategy in the context.
*
- * @returns The key of the chosen one.
+ * @param workerNodeKey - The key of the worker node.
+ * @returns `true` if the removal is successful, `false` otherwise.
*/
- public execute (): number {
- return this.workerChoiceStrategy.choose()
+ public remove (workerNodeKey: number): boolean {
+ return (
+ this.workerChoiceStrategies.get(
+ this.workerChoiceStrategy
+ ) as IWorkerChoiceStrategy
+ ).remove(workerNodeKey)
}
/**
- * Removes a worker in the underlying selection strategy internals.
+ * Sets the worker choice strategies in the context options.
*
- * @param workerKey - The key of the worker to remove.
- * @returns `true` if the removal is successful, `false` otherwise.
+ * @param opts - The worker choice strategy options.
*/
- public remove (workerKey: number): boolean {
- return this.workerChoiceStrategy.remove(workerKey)
+ public setOptions (opts: WorkerChoiceStrategyOptions): void {
+ for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) {
+ workerChoiceStrategy.setOptions(opts)
+ }
}
}
repositories / poolifier.git / blobdiff