refactor: factor out inputs type check

[poolifier.git] / src / pools / selection-strategies / weighted-round-robin-worker-choice-strategy.ts

diff --git a/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts b/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts
index 1bdc02fb189fcf5f21676af2593f2c24854c99dd..ad20db423826aa46a649da5512a3358e9f119572 100644 (file)
--- a/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts
@@ -1,27 +1,21 @@
 import { cpus } from 'node:os'
-import type { IPoolInternal } from '../pool-internal'
 import type { IWorker } from '../worker'
+import type { IPool } from '../pool'
+import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
 import type {
   IWorkerChoiceStrategy,
-  RequiredStatistics
+  RequiredStatistics,
+  WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
 
-/**
- * Virtual task runtime.
- */
-interface TaskRunTime {
-  weight: number
-  runTime: number
-}
-
 /**
  * Selects the next worker with a weighted round robin scheduling algorithm.
  * Loosely modeled after the weighted round robin queueing algorithm: https://en.wikipedia.org/wiki/Weighted_round_robin.
  *
  * @typeParam Worker - Type of worker which manages the strategy.
  * @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 WeightedRoundRobinWorkerChoiceStrategy<
     Worker extends IWorker,
@@ -46,59 +40,43 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
    */
   private readonly defaultWorkerWeight: number
   /**
-   * Workers' virtual task runtime.
+   * Worker virtual task runtime.
    */
-  private readonly workersTaskRunTime: Map<number, TaskRunTime> = new Map<
-  number,
-  TaskRunTime
-  >()
+  private workerVirtualTaskRunTime: number = 0
 
-  /**
-   * Constructs a worker choice strategy that selects with a weighted round robin scheduling algorithm.
-   *
-   * @param pool - The pool instance.
-   */
-  public constructor (pool: IPoolInternal<Worker, Data, Response>) {
-    super(pool)
-    this.defaultWorkerWeight = this.computeWorkerWeight()
-    this.initWorkersTaskRunTime()
+  /** @inheritDoc */
+  public constructor (
+    pool: IPool<Worker, Data, Response>,
+    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+  ) {
+    super(pool, opts)
+    this.checkOptions(this.opts)
+    this.defaultWorkerWeight = this.computeDefaultWorkerWeight()
   }
 
   /** @inheritDoc */
   public reset (): boolean {
     this.currentWorkerNodeId = 0
-    this.workersTaskRunTime.clear()
-    this.initWorkersTaskRunTime()
+    this.workerVirtualTaskRunTime = 0
     return true
   }
 
   /** @inheritDoc */
   public choose (): number {
     const chosenWorkerNodeKey = this.currentWorkerNodeId
-    if (
-      this.isDynamicPool &&
-      !this.workersTaskRunTime.has(chosenWorkerNodeKey)
-    ) {
-      this.initWorkerTaskRunTime(chosenWorkerNodeKey)
-    }
-    const workerTaskRunTime =
-      this.workersTaskRunTime.get(chosenWorkerNodeKey)?.runTime ?? 0
+    const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime ?? 0
     const workerTaskWeight =
-      this.workersTaskRunTime.get(chosenWorkerNodeKey)?.weight ??
-      this.defaultWorkerWeight
-    if (workerTaskRunTime < workerTaskWeight) {
-      this.setWorkerTaskRunTime(
-        chosenWorkerNodeKey,
-        workerTaskWeight,
-        workerTaskRunTime +
-          (this.getWorkerVirtualTaskRunTime(chosenWorkerNodeKey) ?? 0)
-      )
+      this.opts.weights?.[chosenWorkerNodeKey] ?? this.defaultWorkerWeight
+    if (workerVirtualTaskRunTime < workerTaskWeight) {
+      this.workerVirtualTaskRunTime =
+        workerVirtualTaskRunTime +
+        (this.getWorkerVirtualTaskRunTime(chosenWorkerNodeKey) ?? 0)
     } else {
       this.currentWorkerNodeId =
         this.currentWorkerNodeId === this.pool.workerNodes.length - 1
           ? 0
           : this.currentWorkerNodeId + 1
-      this.setWorkerTaskRunTime(this.currentWorkerNodeId, workerTaskWeight, 0)
+      this.workerVirtualTaskRunTime = 0
     }
     return chosenWorkerNodeKey
   }
@@ -114,42 +92,18 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
             ? this.pool.workerNodes.length - 1
             : this.currentWorkerNodeId
       }
+      this.workerVirtualTaskRunTime = 0
     }
-    const deleted = this.workersTaskRunTime.delete(workerNodeKey)
-    for (const [key, value] of this.workersTaskRunTime) {
-      if (key > workerNodeKey) {
-        this.workersTaskRunTime.set(key - 1, value)
-      }
-    }
-    return deleted
-  }
-
-  private initWorkersTaskRunTime (): void {
-    for (const [index] of this.pool.workerNodes.entries()) {
-      this.initWorkerTaskRunTime(index)
-    }
-  }
-
-  private initWorkerTaskRunTime (workerNodeKey: number): void {
-    this.setWorkerTaskRunTime(workerNodeKey, this.defaultWorkerWeight, 0)
-  }
-
-  private setWorkerTaskRunTime (
-    workerNodeKey: number,
-    weight: number,
-    runTime: number
-  ): void {
-    this.workersTaskRunTime.set(workerNodeKey, {
-      weight,
-      runTime
-    })
+    return true
   }
 
   private getWorkerVirtualTaskRunTime (workerNodeKey: number): number {
-    return this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
+    return this.requiredStatistics.medRunTime
+      ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
+      : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
   }
 
-  private computeWorkerWeight (): number {
+  private computeDefaultWorkerWeight (): number {
     let cpusCycleTimeWeight = 0
     for (const cpu of cpus()) {
       // CPU estimated cycle time