X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fweighted-round-robin-worker-choice-strategy.ts;h=ad20db423826aa46a649da5512a3358e9f119572;hb=0d80593b9a7596645612087f687fc6f5cab3101a;hp=925f318c6cd24b124068c20791ca81c3a494e6f1;hpb=ea7a90d36354a4e1c833271571c6f3eb80428600;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 925f318c..ad20db42 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,143 +1,115 @@
-import { cpus } from 'os'
-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
+import { cpus } from 'node:os'
+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 { RequiredStatistics } from './selection-strategies-types'
-
-/**
- * Virtual task runtime.
- */
-type TaskRunTime = {
-  weight: number
-  runTime: number
-}
+import type {
+  IWorkerChoiceStrategy,
+  RequiredStatistics,
+  WorkerChoiceStrategyOptions
+} from './selection-strategies-types'
 
 /**
  * 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 execution response. This can only be serializable data.
  */
 export class WeightedRoundRobinWorkerChoiceStrategy<
-  Worker extends IPoolWorker,
-  Data,
-  Response
-> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> {
+    Worker extends IWorker,
+    Data = unknown,
+    Response = unknown
+  >
+  extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
+  implements IWorkerChoiceStrategy {
   /** @inheritDoc */
   public readonly requiredStatistics: RequiredStatistics = {
-    runTime: true
+    runTime: true,
+    avgRunTime: true,
+    medRunTime: false
   }
 
   /**
-   * Worker index where the previous task was submitted.
+   * Worker node 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 currentWorkerNodeId: number = 0
   /**
    * Default worker weight.
    */
-  private defaultWorkerWeight: number
+  private readonly defaultWorkerWeight: number
   /**
-   * Per worker virtual task runtime map.
+   * Worker virtual task runtime.
    */
-  private readonly workersTaskRunTime: Map<Worker, TaskRunTime> = new Map<
-    Worker,
-    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.checkOptions(this.opts)
+    this.defaultWorkerWeight = this.computeDefaultWorkerWeight()
   }
 
   /** @inheritDoc */
-  public resetStatistics (): boolean {
-    this.workersTaskRunTime.clear()
-    this.initWorkersTaskRunTime()
+  public reset (): boolean {
+    this.currentWorkerNodeId = 0
+    this.workerVirtualTaskRunTime = 0
     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 workerVirtualTaskRunTime =
-      this.getWorkerVirtualTaskRunTime(currentWorker) ?? 0
+  public choose (): number {
+    const chosenWorkerNodeKey = this.currentWorkerNodeId
+    const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime ?? 0
     const workerTaskWeight =
-      this.workersTaskRunTime.get(currentWorker)?.weight ??
-      this.defaultWorkerWeight
-    if (this.currentWorkerIndex === this.previousWorkerIndex) {
-      const workerTaskRunTime =
-        (this.workersTaskRunTime.get(currentWorker)?.runTime ?? 0) +
-        workerVirtualTaskRunTime
-      this.setWorkerTaskRunTime(
-        currentWorker,
-        workerTaskWeight,
-        workerTaskRunTime
-      )
-    } else {
-      this.setWorkerTaskRunTime(currentWorker, workerTaskWeight, 0)
-    }
+      this.opts.weights?.[chosenWorkerNodeKey] ?? this.defaultWorkerWeight
     if (workerVirtualTaskRunTime < workerTaskWeight) {
-      this.previousWorkerIndex = this.currentWorkerIndex
+      this.workerVirtualTaskRunTime =
+        workerVirtualTaskRunTime +
+        (this.getWorkerVirtualTaskRunTime(chosenWorkerNodeKey) ?? 0)
     } else {
-      this.previousWorkerIndex = this.currentWorkerIndex
-      this.currentWorkerIndex =
-        this.pool.workers.length - 1 === this.currentWorkerIndex
+      this.currentWorkerNodeId =
+        this.currentWorkerNodeId === this.pool.workerNodes.length - 1
           ? 0
-          : this.currentWorkerIndex + 1
+          : this.currentWorkerNodeId + 1
+      this.workerVirtualTaskRunTime = 0
     }
-    return this.pool.workers[this.currentWorkerIndex]
+    return chosenWorkerNodeKey
   }
 
-  private initWorkersTaskRunTime (): void {
-    for (const worker of this.pool.workers) {
-      this.initWorkerTaskRunTime(worker)
+  /** @inheritDoc */
+  public remove (workerNodeKey: number): boolean {
+    if (this.currentWorkerNodeId === 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
+      }
+      this.workerVirtualTaskRunTime = 0
     }
+    return true
   }
 
-  private initWorkerTaskRunTime (worker: Worker): void {
-    this.setWorkerTaskRunTime(worker, this.defaultWorkerWeight, 0)
-  }
-
-  private setWorkerTaskRunTime (
-    worker: Worker,
-    weight: number,
-    runTime: number
-  ): void {
-    this.workersTaskRunTime.set(worker, {
-      weight,
-      runTime
-    })
-  }
-
-  private getWorkerVirtualTaskRunTime (worker: Worker): number | undefined {
-    return this.pool.getWorkerAverageTasksRunTime(worker)
+  private getWorkerVirtualTaskRunTime (workerNodeKey: number): number {
+    return this.requiredStatistics.medRunTime
+      ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
+      : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
   }
 
-  private computeWorkerWeight (): number {
+  private computeDefaultWorkerWeight (): 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 Math.round(cpusCycleTimeWeight / cpus().length)
   }