refactor: cleanup worker choice strategies options namespace
[poolifier.git] / src / pools / selection-strategies / worker-choice-strategy-context.ts
index acfee48adf0986d28e3209329cfc9a0b4aa8e158..e3aaaea36c4fbfaf628d4d1bea31c64bfbb0d6a3 100644 (file)
@@ -2,12 +2,15 @@ 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 { 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,
-  RequiredStatistics,
+  StrategyPolicy,
+  TaskStatisticsRequirements,
   WorkerChoiceStrategy,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
@@ -18,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,
@@ -31,6 +34,11 @@ export class WorkerChoiceStrategyContext<
   IWorkerChoiceStrategy
   >
 
+  /**
+   * The number of times the worker choice strategy in the context has been retried.
+   */
+  private retriesCount = 0
+
   /**
    * Worker choice strategy context constructor.
    *
@@ -41,8 +49,9 @@ export class WorkerChoiceStrategyContext<
   public constructor (
     pool: IPool<Worker, Data, Response>,
     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,
@@ -56,15 +65,22 @@ export class WorkerChoiceStrategyContext<
         )
       ],
       [
-        WorkerChoiceStrategies.LESS_USED,
-        new (LessUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+        WorkerChoiceStrategies.LEAST_USED,
+        new (LeastUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+          pool,
+          opts
+        )
+      ],
+      [
+        WorkerChoiceStrategies.LEAST_BUSY,
+        new (LeastBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
           pool,
           opts
         )
       ],
       [
-        WorkerChoiceStrategies.LESS_BUSY,
-        new (LessBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+        WorkerChoiceStrategies.LEAST_ELU,
+        new (LeastEluWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
           pool,
           opts
         )
@@ -83,21 +99,42 @@ export class WorkerChoiceStrategyContext<
         Data,
         Response
         >(pool, opts)
+      ],
+      [
+        WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN,
+        new (InterleavedWeightedRoundRobinWorkerChoiceStrategy.bind(this))<
+        Worker,
+        Data,
+        Response
+        >(pool, opts)
       ]
     ])
   }
 
   /**
-   * Gets the worker choice strategy in the context required statistics.
+   * 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 required statistics.
+   * @returns The task statistics requirements.
    */
-  public getRequiredStatistics (): RequiredStatistics {
+  public getTaskStatisticsRequirements (): TaskStatisticsRequirements {
     return (
       this.workerChoiceStrategies.get(
         this.workerChoiceStrategy
       ) as IWorkerChoiceStrategy
-    ).requiredStatistics
+    ).taskStatisticsRequirements
   }
 
   /**
@@ -115,7 +152,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.
    */
@@ -128,10 +165,10 @@ 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 @node/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 = (
@@ -139,16 +176,25 @@ export class WorkerChoiceStrategyContext<
         this.workerChoiceStrategy
       ) as IWorkerChoiceStrategy
     ).choose()
-    if (workerNodeKey == null) {
-      throw new Error('Worker node key chosen is null or undefined')
+    if (
+      workerNodeKey == null &&
+      this.retriesCount < (this.opts.retries as number)
+    ) {
+      this.retriesCount++
+      return this.execute()
+    } else if (workerNodeKey == null) {
+      throw new Error(
+        `Worker node key chosen is null or undefined after ${this.retriesCount} retries`
+      )
     }
+    this.retriesCount = 0
     return workerNodeKey
   }
 
   /**
    * 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 {
@@ -165,8 +211,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)
-    })
+    }
   }
 }