refactor: forEach -> for ... of on collections

[poolifier.git] / src / pools / selection-strategies / worker-choice-strategy-context.ts

diff --git a/src/pools/selection-strategies/worker-choice-strategy-context.ts b/src/pools/selection-strategies/worker-choice-strategy-context.ts
index 0e5fd5468e32195fce4589562c97f3bc15e8aefd..e07808bcefe837ef5289be98db46ac3664607219 100644 (file)
--- a/src/pools/selection-strategies/worker-choice-strategy-context.ts
+++ b/src/pools/selection-strategies/worker-choice-strategy-context.ts
@@ -1,4 +1,5 @@
-import type { IPoolInternal } from '../pool-internal'
+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'
@@ -7,7 +8,8 @@ import { RoundRobinWorkerChoiceStrategy } from './round-robin-worker-choice-stra
 import type {
   IWorkerChoiceStrategy,
   RequiredStatistics,
-  WorkerChoiceStrategy
+  WorkerChoiceStrategy,
+  WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
 import { WorkerChoiceStrategies } from './selection-strategies-types'
 import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-worker-choice-strategy'
@@ -17,7 +19,7 @@ import { WeightedRoundRobinWorkerChoiceStrategy } from './weighted-round-robin-w
  *
  * @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 IWorker,
@@ -33,36 +35,54 @@ export class WorkerChoiceStrategyContext<
    * Worker choice strategy context constructor.
    *
    * @param pool - The pool instance.
-   * @param workerChoiceStrategyType - The worker choice strategy.
+   * @param workerChoiceStrategy - The worker choice strategy.
+   * @param opts - The worker choice strategy options.
    */
   public constructor (
-    pool: IPoolInternal<Worker, Data, Response>,
-    private workerChoiceStrategyType: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN
+    pool: IPool<Worker, Data, Response>,
+    private workerChoiceStrategy: WorkerChoiceStrategy = WorkerChoiceStrategies.ROUND_ROBIN,
+    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
   ) {
-    this.execute.bind(this)
+    this.execute = this.execute.bind(this)
     this.workerChoiceStrategies = new Map<
     WorkerChoiceStrategy,
     IWorkerChoiceStrategy
     >([
       [
         WorkerChoiceStrategies.ROUND_ROBIN,
-        new RoundRobinWorkerChoiceStrategy<Worker, Data, Response>(pool)
+        new (RoundRobinWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+          pool,
+          opts
+        )
       ],
       [
         WorkerChoiceStrategies.LESS_USED,
-        new LessUsedWorkerChoiceStrategy<Worker, Data, Response>(pool)
+        new (LessUsedWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+          pool,
+          opts
+        )
       ],
       [
         WorkerChoiceStrategies.LESS_BUSY,
-        new LessBusyWorkerChoiceStrategy<Worker, Data, Response>(pool)
+        new (LessBusyWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+          pool,
+          opts
+        )
       ],
       [
         WorkerChoiceStrategies.FAIR_SHARE,
-        new FairShareWorkerChoiceStrategy<Worker, Data, Response>(pool)
+        new (FairShareWorkerChoiceStrategy.bind(this))<Worker, Data, Response>(
+          pool,
+          opts
+        )
       ],
       [
         WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN,
-        new WeightedRoundRobinWorkerChoiceStrategy<Worker, Data, Response>(pool)
+        new (WeightedRoundRobinWorkerChoiceStrategy.bind(this))<
+        Worker,
+        Data,
+        Response
+        >(pool, opts)
       ]
     ])
   }
@@ -75,7 +95,7 @@ export class WorkerChoiceStrategyContext<
   public getRequiredStatistics (): RequiredStatistics {
     return (
       this.workerChoiceStrategies.get(
-        this.workerChoiceStrategyType
+        this.workerChoiceStrategy
       ) as IWorkerChoiceStrategy
     ).requiredStatistics
   }
@@ -88,27 +108,45 @@ export class WorkerChoiceStrategyContext<
   public setWorkerChoiceStrategy (
     workerChoiceStrategy: WorkerChoiceStrategy
   ): void {
-    if (this.workerChoiceStrategyType !== workerChoiceStrategy) {
-      this.workerChoiceStrategyType = workerChoiceStrategy
+    if (this.workerChoiceStrategy !== workerChoiceStrategy) {
+      this.workerChoiceStrategy = workerChoiceStrategy
     }
-    this.workerChoiceStrategies.get(this.workerChoiceStrategyType)?.reset()
+    this.workerChoiceStrategies.get(this.workerChoiceStrategy)?.reset()
+  }
+
+  /**
+   * Updates the worker node key in the worker choice strategy internals in the context.
+   *
+   * @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 algorithm in the context.
    *
    * @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 execute (): number {
-    return (
+    const workerNodeKey = (
       this.workerChoiceStrategies.get(
-        this.workerChoiceStrategyType
+        this.workerChoiceStrategy
       ) as IWorkerChoiceStrategy
     ).choose()
+    if (workerNodeKey == null) {
+      throw new Error('Worker node key chosen is null or undefined')
+    }
+    return workerNodeKey
   }
 
   /**
-   * Removes a worker node key from the worker choice strategy in the context.
+   * Removes the worker node key from the worker choice strategy in the context.
    *
    * @param workerNodeKey - The key of the worker node.
    * @returns `true` if the removal is successful, `false` otherwise.
@@ -116,8 +154,19 @@ export class WorkerChoiceStrategyContext<
   public remove (workerNodeKey: number): boolean {
     return (
       this.workerChoiceStrategies.get(
-        this.workerChoiceStrategyType
+        this.workerChoiceStrategy
       ) as IWorkerChoiceStrategy
     ).remove(workerNodeKey)
   }
+
+  /**
+   * Sets the worker choice strategies in the context options.
+   *
+   * @param opts - The worker choice strategy options.
+   */
+  public setOptions (opts: WorkerChoiceStrategyOptions): void {
+    for (const workerChoiceStrategy of this.workerChoiceStrategies.values()) {
+      workerChoiceStrategy.setOptions(opts)
+    }
+  }
 }