feat: expose the number of strategy retries in pool info
[poolifier.git] / src / pools / selection-strategies / worker-choice-strategy-context.ts
index 59c09e77b8835cacb113b6220e5df20dcde3fbbf..d3d2ae56004c37698c5c7b0e055e27b3725f4c7e 100644 (file)
@@ -1,21 +1,21 @@
-import { buildInternalWorkerChoiceStrategyOptions } 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 { 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,
-  InternalWorkerChoiceStrategyOptions,
   StrategyPolicy,
   TaskStatisticsRequirements,
-  WorkerChoiceStrategy
-} from './selection-strategies-types'
-import { WorkerChoiceStrategies } from './selection-strategies-types'
-import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy'
+  WorkerChoiceStrategy,
+  WorkerChoiceStrategyOptions
+} 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.
@@ -29,11 +29,24 @@ export class WorkerChoiceStrategyContext<
   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.
    *
@@ -44,12 +57,8 @@ export class WorkerChoiceStrategyContext<
   public constructor (
     pool: IPool<Worker, Data, Response>,
     private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN,
-    private opts?: InternalWorkerChoiceStrategyOptions
+    opts?: WorkerChoiceStrategyOptions
   ) {
-    this.opts = buildInternalWorkerChoiceStrategyOptions(
-      pool.info.maxSize,
-      this.opts
-    )
     this.execute = this.execute.bind(this)
     this.workerChoiceStrategies = new Map<
     WorkerChoiceStrategy,
@@ -59,35 +68,35 @@ export class WorkerChoiceStrategyContext<
         WorkerChoiceStrategies.ROUND_ROBIN,
         new (RoundRobinWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
           pool,
-          this.opts
+          opts
         )
       ],
       [
         WorkerChoiceStrategies.LEAST_USED,
         new (LeastUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
           pool,
-          this.opts
+          opts
         )
       ],
       [
         WorkerChoiceStrategies.LEAST_BUSY,
         new (LeastBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
           pool,
-          this.opts
+          opts
         )
       ],
       [
         WorkerChoiceStrategies.LEAST_ELU,
         new (LeastEluWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
           pool,
-          this.opts
+          opts
         )
       ],
       [
         WorkerChoiceStrategies.FAIR_SHARE,
         new (FairShareWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
           pool,
-          this.opts
+          opts
         )
       ],
       [
@@ -96,7 +105,7 @@ export class WorkerChoiceStrategyContext<
         Worker,
         Data,
         Response
-        >(pool, this.opts)
+        >(pool, opts)
       ],
       [
         WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN,
@@ -104,10 +113,11 @@ export class WorkerChoiceStrategyContext<
         Worker,
         Data,
         Response
-        >(pool, this.opts)
+        >(pool, opts)
       ]
     ])
-    this.setOptions(pool, this.opts)
+    this.retriesCount = 0
+    this.retries = getWorkerChoiceStrategyRetries(pool, opts)
   }
 
   /**
@@ -116,11 +126,9 @@ export class WorkerChoiceStrategyContext<
    * @returns The strategy policy.
    */
   public getStrategyPolicy (): StrategyPolicy {
-    return (
-      this.workerChoiceStrategies.get(
-        this.workerChoiceStrategy
-      ) as IWorkerChoiceStrategy
-    ).strategyPolicy
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return this.workerChoiceStrategies.get(this.workerChoiceStrategy)!
+      .strategyPolicy
   }
 
   /**
@@ -129,11 +137,9 @@ export class WorkerChoiceStrategyContext<
    * @returns The task statistics requirements.
    */
   public getTaskStatisticsRequirements (): TaskStatisticsRequirements {
-    return (
-      this.workerChoiceStrategies.get(
-        this.workerChoiceStrategy
-      ) as IWorkerChoiceStrategy
-    ).taskStatisticsRequirements
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return this.workerChoiceStrategies.get(this.workerChoiceStrategy)!
+      .taskStatisticsRequirements
   }
 
   /**
@@ -156,27 +162,23 @@ export class WorkerChoiceStrategyContext<
    * @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 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.
+   * @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 workerChoiceStrategy = this.workerChoiceStrategies.get(
-      this.workerChoiceStrategy
-    ) as IWorkerChoiceStrategy
-    if (!workerChoiceStrategy.hasPoolWorkerNodesReady()) {
-      return this.execute()
-    }
-    return this.executeStrategy(workerChoiceStrategy)
+    return this.executeStrategy(
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      this.workerChoiceStrategies.get(this.workerChoiceStrategy)!
+    )
   }
 
   /**
@@ -184,7 +186,7 @@ export class WorkerChoiceStrategyContext<
    *
    * @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.
+   * @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
@@ -193,13 +195,11 @@ export class WorkerChoiceStrategyContext<
     do {
       workerNodeKey = workerChoiceStrategy.choose()
       if (workerNodeKey == null && chooseCount > 0) {
-        retriesCount++
+        ++retriesCount
+        ++this.retriesCount
       }
       chooseCount++
-    } while (
-      workerNodeKey == null &&
-      retriesCount < (this.opts?.retries as number)
-    )
+    } while (workerNodeKey == null && retriesCount < this.retries)
     if (workerNodeKey == null) {
       throw new Error(
         `Worker node key chosen is null or undefined after ${retriesCount} retries`
@@ -215,29 +215,20 @@ export class WorkerChoiceStrategyContext<
    * @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)
   }
 
   /**
    * 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<Worker, Data, Response>,
-    opts?: InternalWorkerChoiceStrategyOptions
-  ): void {
-    this.opts = buildInternalWorkerChoiceStrategyOptions(
-      pool.info.maxSize,
-      opts
-    )
+  public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void {
     for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) {
-      workerChoiceStrategy.setOptions(this.opts)
+      workerChoiceStrategy.setOptions(opts)
     }
   }
 }