refactor: remove unneeded encapsulation around tasks usage handling

[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 e05b6fae22a9e35ddb702165c779e7e3ae319635..1af7e6568f19a0705df40014ff404e91645dfd09 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,13 +1,13 @@
-import { cpus } from 'os'
-import type { AbstractPoolWorker } from '../abstract-pool-worker'
+import { cpus } from 'node:os'
 import type { IPoolInternal } from '../pool-internal'
+import type { IPoolWorker } from '../pool-worker'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
 import type { RequiredStatistics } from './selection-strategies-types'
 
 /**
  * Virtual task runtime.
  */
-type TaskRunTime = {
+interface TaskRunTime {
   weight: number
   runTime: number
 }
@@ -16,44 +16,40 @@ type TaskRunTime = {
  * 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.
  *
- * @template Worker Type of worker which manages the strategy.
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @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.
  */
 export class WeightedRoundRobinWorkerChoiceStrategy<
-  Worker extends AbstractPoolWorker,
+  Worker extends IPoolWorker,
   Data,
   Response
 > extends AbstractWorkerChoiceStrategy<Worker, Data, Response> {
-  /** @inheritDoc */
-  public requiredStatistics: RequiredStatistics = {
+  /** {@inheritDoc} */
+  public readonly requiredStatistics: RequiredStatistics = {
     runTime: true
   }
 
   /**
-   * Worker index where the previous task was submitted.
+   * Worker id where the current task will be submitted.
    */
-  private previousWorkerIndex: number = 0
-  /**
-   * Worker index where the current task will be submitted.
-   */
-  private currentWorkerIndex: number = 0
+  private currentWorkerId: number = 0
   /**
    * Default worker weight.
    */
-  private defaultWorkerWeight: number
+  private readonly defaultWorkerWeight: number
   /**
    * Per worker virtual task runtime map.
    */
-  private workersTaskRunTime: Map<Worker, TaskRunTime> = new Map<
-    Worker,
-    TaskRunTime
+  private readonly workersTaskRunTime: Map<Worker, TaskRunTime> = new Map<
+  Worker,
+  TaskRunTime
   >()
 
   /**
    * Constructs a worker choice strategy that selects with a weighted round robin scheduling algorithm.
    *
-   * @param pool The pool instance.
+   * @param pool - The pool instance.
    */
   public constructor (pool: IPoolInternal<Worker, Data, Response>) {
     super(pool)
@@ -61,51 +57,50 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
     this.initWorkersTaskRunTime()
   }
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
+  public reset (): boolean {
+    this.currentWorkerId = 0
+    this.workersTaskRunTime.clear()
+    this.initWorkersTaskRunTime()
+    return true
+  }
+
+  /** {@inheritDoc} */
   public choose (): Worker {
-    const currentWorker = this.pool.workers[this.currentWorkerIndex]
-    if (
-      this.isDynamicPool === true &&
-      this.workersTaskRunTime.has(currentWorker) === false
-    ) {
-      this.initWorkerTaskRunTime(currentWorker)
+    const chosenWorker = this.pool.workers.get(this.currentWorkerId)
+      ?.worker as Worker
+    if (this.isDynamicPool && !this.workersTaskRunTime.has(chosenWorker)) {
+      this.initWorkerTaskRunTime(chosenWorker)
     }
-    const workerVirtualTaskRunTime =
-      this.getWorkerVirtualTaskRunTime(currentWorker) ?? 0
+    const workerTaskRunTime =
+      this.workersTaskRunTime.get(chosenWorker)?.runTime ?? 0
     const workerTaskWeight =
-      this.workersTaskRunTime.get(currentWorker)?.weight ??
+      this.workersTaskRunTime.get(chosenWorker)?.weight ??
       this.defaultWorkerWeight
-    if (this.currentWorkerIndex === this.previousWorkerIndex) {
-      const workerTaskRunTime =
-        (this.workersTaskRunTime.get(currentWorker)?.runTime ?? 0) +
-        workerVirtualTaskRunTime
+    if (workerTaskRunTime < workerTaskWeight) {
       this.setWorkerTaskRunTime(
-        currentWorker,
+        chosenWorker,
         workerTaskWeight,
-        workerTaskRunTime
+        workerTaskRunTime +
+          (this.getWorkerVirtualTaskRunTime(chosenWorker) ?? 0)
       )
     } else {
-      this.setWorkerTaskRunTime(currentWorker, workerTaskWeight, 0)
-    }
-    if (
-      workerVirtualTaskRunTime <
-      (this.workersTaskRunTime.get(currentWorker)?.weight ??
-        this.defaultWorkerWeight)
-    ) {
-      this.previousWorkerIndex = this.currentWorkerIndex
-    } else {
-      this.previousWorkerIndex = this.currentWorkerIndex
-      this.currentWorkerIndex =
-        this.pool.workers.length - 1 === this.currentWorkerIndex
+      this.currentWorkerId =
+        this.currentWorkerId === this.pool.workers.size - 1
           ? 0
-          : this.currentWorkerIndex + 1
+          : this.currentWorkerId + 1
+      this.setWorkerTaskRunTime(
+        this.pool.workers.get(this.currentWorkerId)?.worker as Worker,
+        workerTaskWeight,
+        0
+      )
     }
-    return this.pool.workers[this.currentWorkerIndex]
+    return chosenWorker
   }
 
   private initWorkersTaskRunTime (): void {
-    for (const worker of this.pool.workers) {
-      this.initWorkerTaskRunTime(worker)
+    for (const value of this.pool.workers.values()) {
+      this.initWorkerTaskRunTime(value.worker)
     }
   }
 
@@ -125,17 +120,17 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
   }
 
   private getWorkerVirtualTaskRunTime (worker: Worker): number | undefined {
-    return this.pool.getWorkerAverageTasksRunTime(worker)
+    return this.pool.getWorkerTasksUsage(worker)?.avgRunTime
   }
 
   private computeWorkerWeight (): number {
     let cpusCycleTimeWeight = 0
     for (const cpu of cpus()) {
       // CPU estimated cycle time
-      const numberOfDigit = cpu.speed.toString().length - 1
-      const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigit))
-      cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigit)
+      const numberOfDigits = cpu.speed.toString().length - 1
+      const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigits))
+      cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigits)
     }
-    return cpusCycleTimeWeight / cpus().length
+    return Math.round(cpusCycleTimeWeight / cpus().length)
   }
 }