feat: add helper to get the worker wait time in worker choice strategies

[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts

diff --git a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
index bf67b80e84ef257bd8d10ffe86946a53b2433b8a..2026e67432170a39460c3de00d0f750b1595934d 100644 (file)
--- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -27,7 +27,10 @@ export abstract class AbstractWorkerChoiceStrategy<
   public readonly requiredStatistics: RequiredStatistics = {
     runTime: false,
     avgRunTime: false,
-    medRunTime: false
+    medRunTime: false,
+    waitTime: false,
+    avgWaitTime: false,
+    medWaitTime: false
   }
 
   /**
@@ -43,7 +46,7 @@ export abstract class AbstractWorkerChoiceStrategy<
     this.choose = this.choose.bind(this)
   }
 
-  protected checkOptions (opts: WorkerChoiceStrategyOptions): void {
+  protected setRequiredStatistics (opts: WorkerChoiceStrategyOptions): void {
     if (this.requiredStatistics.avgRunTime && opts.medRunTime === true) {
       this.requiredStatistics.avgRunTime = false
       this.requiredStatistics.medRunTime = opts.medRunTime as boolean
@@ -52,13 +55,13 @@ export abstract class AbstractWorkerChoiceStrategy<
       this.requiredStatistics.avgRunTime = true
       this.requiredStatistics.medRunTime = opts.medRunTime as boolean
     }
-    if (
-      opts.weights != null &&
-      Object.keys(opts.weights).length < this.pool.size
-    ) {
-      throw new Error(
-        'Worker choice strategy options must have a weight for each worker node.'
-      )
+    if (this.requiredStatistics.avgWaitTime && opts.medWaitTime === true) {
+      this.requiredStatistics.avgWaitTime = false
+      this.requiredStatistics.medWaitTime = opts.medWaitTime as boolean
+    }
+    if (this.requiredStatistics.medWaitTime && opts.medWaitTime === false) {
+      this.requiredStatistics.avgWaitTime = true
+      this.requiredStatistics.medWaitTime = opts.medWaitTime as boolean
     }
   }
 
@@ -77,7 +80,7 @@ export abstract class AbstractWorkerChoiceStrategy<
   /** @inheritDoc */
   public setOptions (opts: WorkerChoiceStrategyOptions): void {
     opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
-    this.checkOptions(opts)
+    this.setRequiredStatistics(opts)
     this.opts = opts
   }
 
@@ -95,6 +98,34 @@ export abstract class AbstractWorkerChoiceStrategy<
     return this.findFirstFreeWorkerNodeKey()
   }
 
+  /**
+   * Gets the worker task runtime.
+   * If the required statistics are `avgRunTime`, the average runtime is returned.
+   * If the required statistics are `medRunTime`, the median runtime is returned.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns The worker task runtime.
+   */
+  protected getWorkerTaskRunTime (workerNodeKey: number): number {
+    return this.requiredStatistics.medRunTime
+      ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
+      : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
+  }
+
+  /**
+   * Gets the worker task wait time.
+   * If the required statistics are `avgWaitTime`, the average wait time is returned.
+   * If the required statistics are `medWaitTime`, the median wait time is returned.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns The worker task wait time.
+   */
+  protected getWorkerWaitTime (workerNodeKey: number): number {
+    return this.requiredStatistics.medWaitTime
+      ? this.pool.workerNodes[workerNodeKey].tasksUsage.medWaitTime
+      : this.pool.workerNodes[workerNodeKey].tasksUsage.avgWaitTime
+  }
+
   /**
    * Finds the first free worker node key based on the number of tasks the worker has applied.
    *