build(deps-dev): bump typescript
[poolifier.git] / src / pools / selection-strategies / interleaved-weighted-round-robin-worker-choice-strategy.ts
index cdbfbee5bb0b73e6436f5aad3d94b45e764d3713..b1abe98772d88ce295b17aa6be653a332dd11b04 100644 (file)
@@ -1,12 +1,12 @@
-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 { IPool } from '../pool.js'
+import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS } from '../utils.js'
+import type { IWorker } from '../worker.js'
+import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.js'
 import type {
   IWorkerChoiceStrategy,
-  StrategyPolicy,
+  TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
-} from './selection-strategies-types'
+} from './selection-strategies-types.js'
 
 /**
  * Selects the next worker with an interleaved weighted round robin scheduling algorithm.
@@ -23,40 +23,49 @@ export class InterleavedWeightedRoundRobinWorkerChoiceStrategy<
   extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
   /** @inheritDoc */
-  public readonly strategyPolicy: StrategyPolicy = {
-    dynamicWorkerUsage: false,
-    dynamicWorkerReady: 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
+  private roundId = 0
   /**
    * Round weights.
    */
   private roundWeights: number[]
   /**
-   * Default worker weight.
+   * Worker node id.
    */
-  private readonly defaultWorkerWeight: number
+  private workerNodeId = 0
+  /**
+   * Worker node virtual task runtime.
+   */
+  private workerNodeVirtualTaskRunTime = 0
 
   /** @inheritDoc */
   public constructor (
     pool: IPool<Worker, Data, Response>,
-    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+    opts?: WorkerChoiceStrategyOptions
   ) {
     super(pool, opts)
     this.setTaskStatisticsRequirements(this.opts)
-    this.defaultWorkerWeight = this.computeDefaultWorkerWeight()
     this.roundWeights = this.getRoundWeights()
   }
 
   /** @inheritDoc */
   public reset (): boolean {
-    this.nextWorkerNodeKey = 0
+    this.resetWorkerNodeKeyProperties()
     this.roundId = 0
+    this.workerNodeId = 0
+    this.workerNodeVirtualTaskRunTime = 0
     return true
   }
 
@@ -67,70 +76,94 @@ export class InterleavedWeightedRoundRobinWorkerChoiceStrategy<
 
   /** @inheritDoc */
   public choose (): number | undefined {
-    let roundId: number | undefined
-    let workerNodeId: number | undefined
     for (
       let roundIndex = this.roundId;
       roundIndex < this.roundWeights.length;
       roundIndex++
     ) {
+      this.roundId = roundIndex
       for (
-        let workerNodeKey = this.nextWorkerNodeKey ?? 0;
+        let workerNodeKey = this.workerNodeId;
         workerNodeKey < this.pool.workerNodes.length;
         workerNodeKey++
       ) {
-        const workerWeight =
-          this.opts.weights?.[workerNodeKey] ?? this.defaultWorkerWeight
+        this.workerNodeId = workerNodeKey
         if (
-          this.isWorkerNodeEligible(workerNodeKey) &&
-          workerWeight >= this.roundWeights[roundIndex]
+          this.workerNodeId !== this.nextWorkerNodeKey &&
+          this.workerNodeVirtualTaskRunTime !== 0
         ) {
-          roundId = roundIndex
-          workerNodeId = workerNodeKey
-          break
+          this.workerNodeVirtualTaskRunTime = 0
+        }
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const workerWeight = this.opts!.weights![workerNodeKey]
+        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 as number
-    this.nextWorkerNodeKey = workerNodeId
-    const chosenWorkerNodeKey = this.nextWorkerNodeKey
-    if (this.nextWorkerNodeKey === this.pool.workerNodes.length - 1) {
-      this.nextWorkerNodeKey = 0
-      this.roundId =
-        this.roundId === this.roundWeights.length - 1 ? 0 : this.roundId + 1
+    this.interleavedWeightedRoundRobinNextWorkerNodeId()
+  }
+
+  private interleavedWeightedRoundRobinNextWorkerNodeId (): void {
+    if (this.pool.workerNodes.length === 0) {
+      this.workerNodeId = 0
+    } else 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.nextWorkerNodeKey = (this.nextWorkerNodeKey ?? 0) + 1
+      this.workerNodeId = this.workerNodeId + 1
     }
-    return chosenWorkerNodeKey
   }
 
   /** @inheritDoc */
   public remove (workerNodeKey: number): boolean {
-    if (this.nextWorkerNodeKey === workerNodeKey) {
-      if (this.pool.workerNodes.length === 0) {
-        this.nextWorkerNodeKey = 0
-      } else if (this.nextWorkerNodeKey > this.pool.workerNodes.length - 1) {
-        this.nextWorkerNodeKey = this.pool.workerNodes.length - 1
-        this.roundId =
-          this.roundId === this.roundWeights.length - 1 ? 0 : this.roundId + 1
-      }
+    if (this.pool.workerNodes.length === 0) {
+      this.resetWorkerNodeKeyProperties()
+      this.workerNodeId = 0
+      this.workerNodeVirtualTaskRunTime = 0
+      return true
+    }
+    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
   }
 
   /** @inheritDoc */
-  public setOptions (opts: WorkerChoiceStrategyOptions): void {
+  public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void {
     super.setOptions(opts)
     this.roundWeights = this.getRoundWeights()
   }
 
   private getRoundWeights (): number[] {
-    if (this.opts.weights == null) {
-      return [this.defaultWorkerWeight]
-    }
     return [
       ...new Set(
-        Object.values(this.opts.weights)
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        Object.values(this.opts!.weights!)
           .slice()
           .sort((a, b) => a - b)
       )