Merge pull request #2164 from poolifier/dependabot/npm_and_yarn/tatami-ng-0.3.0
[poolifier.git] / src / pools / selection-strategies / weighted-round-robin-worker-choice-strategy.ts
index 926900800272fef430ddf68273dcb2992954a85a..f04847782f540e9edea4603b47afe4c70aa4e299 100644 (file)
@@ -1,13 +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 a weighted round robin scheduling algorithm.
@@ -24,11 +23,6 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
   >
   extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
-  /** @inheritDoc */
-  public readonly strategyPolicy: StrategyPolicy = {
-    useDynamicWorker: true
-  }
-
   /** @inheritDoc */
   public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
     runTime: {
@@ -36,41 +30,28 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
       average: true,
       median: false
     },
-    waitTime: {
-      aggregate: false,
-      average: false,
-      median: false
-    },
-    elu: {
-      aggregate: false,
-      average: false,
-      median: false
-    }
+    waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+    elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
   }
 
   /**
-   * Default worker weight.
-   */
-  private readonly defaultWorkerWeight: number
-  /**
-   * Worker virtual task runtime.
+   * Worker node virtual task runtime.
    */
-  private workerVirtualTaskRunTime: number = 0
+  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()
   }
 
   /** @inheritDoc */
   public reset (): boolean {
-    this.nextWorkerNodeId = 0
-    this.workerVirtualTaskRunTime = 0
+    this.resetWorkerNodeKeyProperties()
+    this.workerNodeVirtualTaskRunTime = 0
     return true
   }
 
@@ -80,35 +61,51 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
   }
 
   /** @inheritDoc */
-  public choose (): number {
-    const chosenWorkerNodeKey = this.nextWorkerNodeId
-    const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime
-    const workerWeight =
-      this.opts.weights?.[chosenWorkerNodeKey] ?? this.defaultWorkerWeight
-    if (workerVirtualTaskRunTime < workerWeight) {
-      this.workerVirtualTaskRunTime =
-        workerVirtualTaskRunTime +
-        this.getWorkerTaskRunTime(chosenWorkerNodeKey)
-    } else {
-      this.nextWorkerNodeId =
-        this.nextWorkerNodeId === this.pool.workerNodes.length - 1
-          ? 0
-          : this.nextWorkerNodeId + 1
-      this.workerVirtualTaskRunTime = 0
-    }
-    return chosenWorkerNodeKey
+  public choose (): number | undefined {
+    this.setPreviousWorkerNodeKey(this.nextWorkerNodeKey)
+    this.weightedRoundRobinNextWorkerNodeKey()
+    this.checkNextWorkerNodeKey()
+    return this.nextWorkerNodeKey
   }
 
   /** @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
+    if (this.pool.workerNodes.length === 0) {
+      this.reset()
+      return true
+    }
+    if (this.nextWorkerNodeKey === workerNodeKey) {
+      this.workerNodeVirtualTaskRunTime = 0
+      if (this.nextWorkerNodeKey > this.pool.workerNodes.length - 1) {
+        this.nextWorkerNodeKey = this.pool.workerNodes.length - 1
       }
-      this.workerVirtualTaskRunTime = 0
+    }
+    if (
+      this.previousWorkerNodeKey === workerNodeKey &&
+      this.previousWorkerNodeKey > this.pool.workerNodes.length - 1
+    ) {
+      this.previousWorkerNodeKey = this.pool.workerNodes.length - 1
     }
     return true
   }
+
+  private weightedRoundRobinNextWorkerNodeKey (): number | undefined {
+    const workerWeight =
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      this.opts!.weights![this.nextWorkerNodeKey ?? this.previousWorkerNodeKey]
+    if (this.workerNodeVirtualTaskRunTime < workerWeight) {
+      this.workerNodeVirtualTaskRunTime =
+        this.workerNodeVirtualTaskRunTime +
+        this.getWorkerNodeTaskRunTime(
+          this.nextWorkerNodeKey ?? this.previousWorkerNodeKey
+        )
+    } else {
+      this.nextWorkerNodeKey =
+        this.nextWorkerNodeKey === this.pool.workerNodes.length - 1
+          ? 0
+          : (this.nextWorkerNodeKey ?? this.previousWorkerNodeKey) + 1
+      this.workerNodeVirtualTaskRunTime = 0
+    }
+    return this.nextWorkerNodeKey
+  }
 }