docs: fix CoC link
[poolifier.git] / src / pools / selection-strategies / interleaved-weighted-round-robin-worker-choice-strategy.ts
index 40522c72741e67fd6303874f80467e14748d718f..15a6c7f48eaac7f0a81e5a30bfd74762a426435d 100644 (file)
@@ -1,10 +1,13 @@
 import type { IWorker } from '../worker'
 import type { IPool } from '../pool'
-import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
+import {
+  DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+  DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+} from '../../utils'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
 import type {
   IWorkerChoiceStrategy,
-  StrategyPolicy,
+  TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
 
@@ -23,23 +26,36 @@ export class InterleavedWeightedRoundRobinWorkerChoiceStrategy<
   extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
   /** @inheritDoc */
-  public readonly strategyPolicy: StrategyPolicy = {
-    useDynamicWorker: true
+  public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+    runTime: {
+      aggregate: true,
+      average: true,
+      median: false
+    },
+    waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+    elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
   }
 
   /**
    * Round id.
-   * This is used to determine the current round weight.
    */
   private roundId: number = 0
+  /**
+   * Default worker weight.
+   */
+  private readonly defaultWorkerWeight: number
   /**
    * Round weights.
    */
   private roundWeights: number[]
   /**
-   * Default worker weight.
+   * Worker node id.
    */
-  private readonly defaultWorkerWeight: number
+  private workerNodeId: number = 0
+  /**
+   * Worker node virtual task runtime.
+   */
+  private workerNodeVirtualTaskRunTime: number = 0
 
   /** @inheritDoc */
   public constructor (
@@ -54,8 +70,10 @@ export class InterleavedWeightedRoundRobinWorkerChoiceStrategy<
 
   /** @inheritDoc */
   public reset (): boolean {
-    this.nextWorkerNodeId = 0
+    this.resetWorkerNodeKeyProperties()
     this.roundId = 0
+    this.workerNodeId = 0
+    this.workerNodeVirtualTaskRunTime = 0
     return true
   }
 
@@ -65,51 +83,77 @@ export class InterleavedWeightedRoundRobinWorkerChoiceStrategy<
   }
 
   /** @inheritDoc */
-  public choose (): number {
-    let roundId: number | undefined
-    let workerNodeId: number | undefined
+  public choose (): number | undefined {
     for (
       let roundIndex = this.roundId;
       roundIndex < this.roundWeights.length;
       roundIndex++
     ) {
+      this.roundId = roundIndex
       for (
-        let workerNodeKey = this.nextWorkerNodeId;
+        let workerNodeKey = this.workerNodeId;
         workerNodeKey < this.pool.workerNodes.length;
         workerNodeKey++
       ) {
+        this.workerNodeId = workerNodeKey
+        if (
+          this.workerNodeId !== this.nextWorkerNodeKey &&
+          this.workerNodeVirtualTaskRunTime !== 0
+        ) {
+          this.workerNodeVirtualTaskRunTime = 0
+        }
         const workerWeight =
           this.opts.weights?.[workerNodeKey] ?? this.defaultWorkerWeight
-        if (workerWeight >= this.roundWeights[roundIndex]) {
-          roundId = roundIndex
-          workerNodeId = workerNodeKey
-          break
+        if (
+          this.isWorkerNodeReady(workerNodeKey) &&
+          workerWeight >= this.roundWeights[roundIndex] &&
+          this.workerNodeVirtualTaskRunTime < workerWeight
+        ) {
+          this.workerNodeVirtualTaskRunTime =
+            this.workerNodeVirtualTaskRunTime +
+            this.getWorkerNodeTaskRunTime(workerNodeKey)
+          this.setPreviousWorkerNodeKey(this.nextWorkerNodeKey)
+          this.nextWorkerNodeKey = workerNodeKey
+          return this.nextWorkerNodeKey
         }
       }
     }
-    this.roundId = roundId ?? 0
-    this.nextWorkerNodeId = workerNodeId ?? 0
-    const chosenWorkerNodeKey = this.nextWorkerNodeId
-    if (this.nextWorkerNodeId === this.pool.workerNodes.length - 1) {
-      this.nextWorkerNodeId = 0
-      this.roundId =
-        this.roundId === this.roundWeights.length - 1 ? 0 : this.roundId + 1
-    } else {
-      this.nextWorkerNodeId = this.nextWorkerNodeId + 1
-    }
-    return chosenWorkerNodeKey
+    this.interleavedWeightedRoundRobinNextWorkerNodeId()
+  }
+
+  private interleavedWeightedRoundRobinNextWorkerNodeId (): void {
+    do {
+      if (
+        this.roundId === this.roundWeights.length - 1 &&
+        this.workerNodeId === this.pool.workerNodes.length - 1
+      ) {
+        this.roundId = 0
+        this.workerNodeId = 0
+      } else if (this.workerNodeId === this.pool.workerNodes.length - 1) {
+        this.roundId = this.roundId + 1
+        this.workerNodeId = 0
+      } else {
+        this.workerNodeId = this.workerNodeId + 1
+      }
+    } while (!this.isWorkerNodeReady(this.workerNodeId))
   }
 
   /** @inheritDoc */
   public remove (workerNodeKey: number): boolean {
-    if (this.nextWorkerNodeId === workerNodeKey) {
-      if (this.pool.workerNodes.length === 0) {
-        this.nextWorkerNodeId = 0
-      } else if (this.nextWorkerNodeId > this.pool.workerNodes.length - 1) {
-        this.nextWorkerNodeId = this.pool.workerNodes.length - 1
-        this.roundId =
-          this.roundId === this.roundWeights.length - 1 ? 0 : this.roundId + 1
-      }
+    if (this.pool.workerNodes.length === 0) {
+      this.reset()
+    }
+    if (
+      this.workerNodeId === workerNodeKey &&
+      this.workerNodeId > this.pool.workerNodes.length - 1
+    ) {
+      this.workerNodeId = this.pool.workerNodes.length - 1
+    }
+    if (
+      this.previousWorkerNodeKey === workerNodeKey &&
+      this.previousWorkerNodeKey > this.pool.workerNodes.length - 1
+    ) {
+      this.previousWorkerNodeKey = this.pool.workerNodes.length - 1
     }
     return true
   }