refactor: prepare worker choice strategies code for worker readiness

[poolifier.git] / src / pools / selection-strategies / weighted-round-robin-worker-choice-strategy.ts

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 1ce6041920cfa634071093561eabc32e405272d2..ed38aa1497176ba88751e83a850e1794b3aaa9fd 100644 (file)
--- 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,9 +1,13 @@
 import type { IWorker } from '../worker'
 import type { IPool } from '../pool'
-import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
+import {
+  DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+  DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+} from '../../utils'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
 import type {
   IWorkerChoiceStrategy,
+  StrategyPolicy,
   TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
@@ -13,8 +17,8 @@ import type {
  * 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,
@@ -23,6 +27,11 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
   >
   extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  public readonly strategyPolicy: StrategyPolicy = {
+    useDynamicWorker: true
+  }
+
   /** @inheritDoc */
   public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
     runTime: {
@@ -30,22 +39,10 @@ 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
   }
 
-  /**
-   * Worker node id where the current task will be submitted.
-   */
-  private currentWorkerNodeId: number = 0
   /**
    * Default worker weight.
    */
@@ -67,7 +64,7 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
 
   /** @inheritDoc */
   public reset (): boolean {
-    this.currentWorkerNodeId = 0
+    this.nextWorkerNodeKey = 0
     this.workerVirtualTaskRunTime = 0
     return true
   }
@@ -79,34 +76,38 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
 
   /** @inheritDoc */
   public choose (): number {
-    const chosenWorkerNodeKey = this.currentWorkerNodeId
-    const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime
-    const workerWeight =
-      this.opts.weights?.[chosenWorkerNodeKey] ?? this.defaultWorkerWeight
-    if (workerVirtualTaskRunTime < workerWeight) {
-      this.workerVirtualTaskRunTime =
-        workerVirtualTaskRunTime +
-        this.getWorkerTaskRunTime(chosenWorkerNodeKey)
-    } else {
-      this.currentWorkerNodeId =
-        this.currentWorkerNodeId === this.pool.workerNodes.length - 1
-          ? 0
-          : this.currentWorkerNodeId + 1
-      this.workerVirtualTaskRunTime = 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 if (this.currentWorkerNodeId > this.pool.workerNodes.length - 1) {
-        this.currentWorkerNodeId = this.pool.workerNodes.length - 1
+        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 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
+    }
+  }
 }