X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fweighted-round-robin-worker-choice-strategy.ts;h=78ad7485dcc58ddb8c65ebb946fcdc6a34b92f5d;hb=f6bc9f26d8a0246bbee14b2b03d0bcc41b8aeb52;hp=e1325865eaba7df03f0d36b277599bd828be5b34;hpb=78ab25556596c9ca877bb08407559b8156abc819;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 e1325865..78ad7485 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,158 +1,117 @@
-import { cpus } from 'node:os'
-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
+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
+  TaskStatisticsRequirements,
+  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 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 IPoolWorker,
+    Worker extends IWorker,
     Data = unknown,
     Response = unknown
   >
   extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
-  implements IWorkerChoiceStrategy<Worker, Data, Response> {
-  /** {@inheritDoc} */
-  public readonly requiredStatistics: RequiredStatistics = {
-    runTime: true,
-    avgRunTime: true
+  implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+    runTime: {
+      aggregate: true,
+      average: true,
+      median: false
+    },
+    waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+    elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
   }
 
-  /**
-   * Worker id where the current task will be submitted.
-   */
-  private currentWorkerId: number = 0
   /**
    * Default worker weight.
    */
   private readonly defaultWorkerWeight: number
   /**
-   * Per worker virtual task runtime map.
+   * 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.setTaskStatisticsRequirements(this.opts)
+    this.defaultWorkerWeight = this.computeDefaultWorkerWeight()
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public reset (): boolean {
-    this.currentWorkerId = 0
-    this.workersTaskRunTime.clear()
-    this.initWorkersTaskRunTime()
+    this.nextWorkerNodeKey = 0
+    this.workerVirtualTaskRunTime = 0
     return true
   }
 
-  /** {@inheritDoc} */
-  public choose (): number {
-    const chosenWorkerKey = this.currentWorkerId
-    if (this.isDynamicPool && !this.workersTaskRunTime.has(chosenWorkerKey)) {
-      this.initWorkerTaskRunTime(chosenWorkerKey)
-    }
-    const workerTaskRunTime =
-      this.workersTaskRunTime.get(chosenWorkerKey)?.runTime ?? 0
-    const workerTaskWeight =
-      this.workersTaskRunTime.get(chosenWorkerKey)?.weight ??
-      this.defaultWorkerWeight
-    if (workerTaskRunTime < workerTaskWeight) {
-      this.setWorkerTaskRunTime(
-        chosenWorkerKey,
-        workerTaskWeight,
-        workerTaskRunTime +
-          (this.getWorkerVirtualTaskRunTime(chosenWorkerKey) ?? 0)
-      )
-    } else {
-      this.currentWorkerId =
-        this.currentWorkerId === this.pool.workers.length - 1
-          ? 0
-          : this.currentWorkerId + 1
-      this.setWorkerTaskRunTime(this.currentWorkerId, workerTaskWeight, 0)
-    }
-    return chosenWorkerKey
+  /** @inheritDoc */
+  public update (): boolean {
+    return true
   }
 
-  /** {@inheritDoc} */
-  public remove (workerKey: number): boolean {
-    if (this.currentWorkerId === workerKey) {
-      if (this.pool.workers.length === 0) {
-        this.currentWorkerId = 0
-      } else {
-        this.currentWorkerId =
-          this.currentWorkerId > this.pool.workers.length - 1
-            ? this.pool.workers.length - 1
-            : this.currentWorkerId
-      }
-    }
-    const workerDeleted = this.workersTaskRunTime.delete(workerKey)
-    for (const [key, value] of this.workersTaskRunTime) {
-      if (key > workerKey) {
-        this.workersTaskRunTime.set(key - 1, value)
-      }
+  /** @inheritDoc */
+  public choose (): number | undefined {
+    const chosenWorkerNodeKey = this.nextWorkerNodeKey
+    this.weightedRoundRobinNextWorkerNodeKey()
+    if (!this.isWorkerNodeEligible(this.nextWorkerNodeKey as number)) {
+      this.nextWorkerNodeKey = undefined
+      this.previousWorkerNodeKey =
+        chosenWorkerNodeKey ?? this.previousWorkerNodeKey
     }
-    return workerDeleted
+    return chosenWorkerNodeKey
   }
 
-  private initWorkersTaskRunTime (): void {
-    for (const [index] of this.pool.workers.entries()) {
-      this.initWorkerTaskRunTime(index)
+  /** @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.workerVirtualTaskRunTime = 0
     }
+    return true
   }
 
-  private initWorkerTaskRunTime (workerKey: number): void {
-    this.setWorkerTaskRunTime(workerKey, this.defaultWorkerWeight, 0)
-  }
-
-  private setWorkerTaskRunTime (
-    workerKey: number,
-    weight: number,
-    runTime: number
-  ): void {
-    this.workersTaskRunTime.set(workerKey, {
-      weight,
-      runTime
-    })
-  }
-
-  private getWorkerVirtualTaskRunTime (workerKey: number): number {
-    return this.pool.workers[workerKey].tasksUsage.avgRunTime
-  }
-
-  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 (): number | undefined {
+    const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime
+    const workerWeight =
+      this.opts.weights?.[
+        this.nextWorkerNodeKey ?? this.previousWorkerNodeKey
+      ] ?? this.defaultWorkerWeight
+    if (workerVirtualTaskRunTime < workerWeight) {
+      this.workerVirtualTaskRunTime =
+        workerVirtualTaskRunTime +
+        this.getWorkerTaskRunTime(
+          this.nextWorkerNodeKey ?? this.previousWorkerNodeKey
+        )
+    } else {
+      this.nextWorkerNodeKey =
+        this.nextWorkerNodeKey === this.pool.workerNodes.length - 1
+          ? 0
+          : (this.nextWorkerNodeKey ?? this.previousWorkerNodeKey) + 1
+      this.workerVirtualTaskRunTime = 0
     }
-    return Math.round(cpusCycleTimeWeight / cpus().length)
+    return this.nextWorkerNodeKey
   }
 }