X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fweighted-round-robin-worker-choice-strategy.ts;h=ed38aa1497176ba88751e83a850e1794b3aaa9fd;hb=9b1068374b1a52479b07e1e22b692289d5579237;hp=dc2e5df3f170a1c8d65118e705d6b0754cebf56b;hpb=2fc5cae38554901a21435ef087036a062c9d1632;p=poolifier.git

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 dc2e5df3..ed38aa14 100644
--- 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,29 +1,24 @@
-import { cpus } from 'node:os'
 import type { IWorker } from '../worker'
+import type { IPool } from '../pool'
+import {
+  DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+  DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+} from '../../utils'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
 import type {
   IWorkerChoiceStrategy,
-  RequiredStatistics,
+  StrategyPolicy,
+  TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
-import type { IPool } from '../pool'
-import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
-
-/**
- * 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 execution response. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  */
 export class WeightedRoundRobinWorkerChoiceStrategy<
     Worker extends IWorker,
@@ -33,27 +28,29 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
   extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
   /** @inheritDoc */
-  public readonly requiredStatistics: RequiredStatistics = {
-    runTime: true,
-    avgRunTime: true,
-    medRunTime: false
+  public readonly strategyPolicy: StrategyPolicy = {
+    useDynamicWorker: true
+  }
+
+  /** @inheritDoc */
+  public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+    runTime: {
+      aggregate: true,
+      average: true,
+      median: false
+    },
+    waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+    elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
   }
 
-  /**
-   * Worker node id where the current task will be submitted.
-   */
-  private currentWorkerNodeId: number = 0
   /**
    * Default worker weight.
    */
   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
 
   /** @inheritDoc */
   public constructor (
@@ -61,106 +58,56 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
     opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
   ) {
     super(pool, opts)
-    this.checkOptions(opts)
-    this.defaultWorkerWeight = this.computeWorkerWeight()
-    this.initWorkersTaskRunTime()
+    this.setTaskStatisticsRequirements(this.opts)
+    this.defaultWorkerWeight = this.computeDefaultWorkerWeight()
   }
 
   /** @inheritDoc */
   public reset (): boolean {
-    this.currentWorkerNodeId = 0
-    this.workersTaskRunTime.clear()
-    this.initWorkersTaskRunTime()
+    this.nextWorkerNodeKey = 0
+    this.workerVirtualTaskRunTime = 0
+    return true
+  }
+
+  /** @inheritDoc */
+  public update (): boolean {
     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 workerTaskWeight =
-      this.workersTaskRunTime.get(chosenWorkerNodeKey)?.weight ??
-      this.defaultWorkerWeight
-    if (workerTaskRunTime < workerTaskWeight) {
-      this.setWorkerTaskRunTime(
-        chosenWorkerNodeKey,
-        workerTaskWeight,
-        workerTaskRunTime +
-          (this.getWorkerVirtualTaskRunTime(chosenWorkerNodeKey) ?? 0)
-      )
-    } else {
-      this.currentWorkerNodeId =
-        this.currentWorkerNodeId === this.pool.workerNodes.length - 1
-          ? 0
-          : this.currentWorkerNodeId + 1
-      this.setWorkerTaskRunTime(this.currentWorkerNodeId, workerTaskWeight, 0)
-    }
+    const chosenWorkerNodeKey = this.nextWorkerNodeKey
+    this.weightedRoundRobinNextWorkerNodeKey()
     return chosenWorkerNodeKey
   }
 
   /** @inheritDoc */
   public remove (workerNodeKey: number): boolean {
-    if (this.currentWorkerNodeId === workerNodeKey) {
+    if (this.nextWorkerNodeKey === workerNodeKey) {
       if (this.pool.workerNodes.length === 0) {
-        this.currentWorkerNodeId = 0
-      } else {
-        this.currentWorkerNodeId =
-          this.currentWorkerNodeId > this.pool.workerNodes.length - 1
-            ? this.pool.workerNodes.length - 1
-            : this.currentWorkerNodeId
-      }
-    }
-    const deleted = this.workersTaskRunTime.delete(workerNodeKey)
-    for (const [key, value] of this.workersTaskRunTime) {
-      if (key > workerNodeKey) {
-        this.workersTaskRunTime.set(key - 1, value)
+        this.nextWorkerNodeKey = 0
+      } else if (this.nextWorkerNodeKey > this.pool.workerNodes.length - 1) {
+        this.nextWorkerNodeKey = this.pool.workerNodes.length - 1
       }
+      this.workerVirtualTaskRunTime = 0
     }
-    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
-    })
-  }
-
-  private getWorkerVirtualTaskRunTime (workerNodeKey: number): number {
-    return this.requiredStatistics.medRunTime
-      ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
-      : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
+    return true
   }
 
-  private computeWorkerWeight (): number {
-    let cpusCycleTimeWeight = 0
-    for (const cpu of cpus()) {
-      // CPU estimated cycle time
-      const numberOfDigits = cpu.speed.toString().length - 1
-      const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigits))
-      cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigits)
+  private weightedRoundRobinNextWorkerNodeKey (): void {
+    const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime
+    const workerWeight =
+      this.opts.weights?.[this.nextWorkerNodeKey] ?? this.defaultWorkerWeight
+    if (workerVirtualTaskRunTime < workerWeight) {
+      this.workerVirtualTaskRunTime =
+        workerVirtualTaskRunTime +
+        this.getWorkerTaskRunTime(this.nextWorkerNodeKey)
+    } else {
+      this.nextWorkerNodeKey =
+        this.nextWorkerNodeKey === this.pool.workerNodes.length - 1
+          ? 0
+          : this.nextWorkerNodeKey + 1
+      this.workerVirtualTaskRunTime = 0
     }
-    return Math.round(cpusCycleTimeWeight / cpus().length)
   }
 }