feat: add statistics accounting to ELU fields

[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 b5b77ff6e261519d2bbef3154ca701e059d77a16..8f71b502fd9ee32aa46b4cb9190909ecabc2ff58 100644 (file)
--- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -26,13 +26,21 @@ export abstract class AbstractWorkerChoiceStrategy<
   private toggleFindLastFreeWorkerNodeKey: boolean = false
   /** @inheritDoc */
   public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
-    runTime: false,
-    avgRunTime: false,
-    medRunTime: false,
-    waitTime: false,
-    avgWaitTime: false,
-    medWaitTime: false,
-    elu: false
+    runTime: {
+      aggregate: false,
+      average: false,
+      median: false
+    },
+    waitTime: {
+      aggregate: false,
+      average: false,
+      median: false
+    },
+    elu: {
+      aggregate: false,
+      average: false,
+      median: false
+    }
   }
 
   /**
@@ -48,34 +56,54 @@ export abstract class AbstractWorkerChoiceStrategy<
     this.choose = this.choose.bind(this)
   }
 
-  protected setTaskStatistics (opts: WorkerChoiceStrategyOptions): void {
+  protected setTaskStatisticsRequirements (
+    opts: WorkerChoiceStrategyOptions
+  ): void {
+    if (
+      this.taskStatisticsRequirements.runTime.average &&
+      opts.runTime?.median === true
+    ) {
+      this.taskStatisticsRequirements.runTime.average = false
+      this.taskStatisticsRequirements.runTime.median = opts.runTime
+        .median as boolean
+    }
+    if (
+      this.taskStatisticsRequirements.runTime.median &&
+      opts.runTime?.median === false
+    ) {
+      this.taskStatisticsRequirements.runTime.average = true
+      this.taskStatisticsRequirements.runTime.median = opts.runTime
+        .median as boolean
+    }
     if (
-      this.taskStatisticsRequirements.avgRunTime &&
-      opts.medRunTime === true
+      this.taskStatisticsRequirements.waitTime.average &&
+      opts.waitTime?.median === true
     ) {
-      this.taskStatisticsRequirements.avgRunTime = false
-      this.taskStatisticsRequirements.medRunTime = opts.medRunTime as boolean
+      this.taskStatisticsRequirements.waitTime.average = false
+      this.taskStatisticsRequirements.waitTime.median = opts.waitTime
+        .median as boolean
     }
     if (
-      this.taskStatisticsRequirements.medRunTime &&
-      opts.medRunTime === false
+      this.taskStatisticsRequirements.waitTime.median &&
+      opts.waitTime?.median === false
     ) {
-      this.taskStatisticsRequirements.avgRunTime = true
-      this.taskStatisticsRequirements.medRunTime = opts.medRunTime as boolean
+      this.taskStatisticsRequirements.waitTime.average = true
+      this.taskStatisticsRequirements.waitTime.median = opts.waitTime
+        .median as boolean
     }
     if (
-      this.taskStatisticsRequirements.avgWaitTime &&
-      opts.medWaitTime === true
+      this.taskStatisticsRequirements.elu.average &&
+      opts.elu?.median === true
     ) {
-      this.taskStatisticsRequirements.avgWaitTime = false
-      this.taskStatisticsRequirements.medWaitTime = opts.medWaitTime as boolean
+      this.taskStatisticsRequirements.elu.average = false
+      this.taskStatisticsRequirements.elu.median = opts.elu.median as boolean
     }
     if (
-      this.taskStatisticsRequirements.medWaitTime &&
-      opts.medWaitTime === false
+      this.taskStatisticsRequirements.elu.median &&
+      opts.elu?.median === false
     ) {
-      this.taskStatisticsRequirements.avgWaitTime = true
-      this.taskStatisticsRequirements.medWaitTime = opts.medWaitTime as boolean
+      this.taskStatisticsRequirements.elu.average = true
+      this.taskStatisticsRequirements.elu.median = opts.elu.median as boolean
     }
   }
 
@@ -94,7 +122,7 @@ export abstract class AbstractWorkerChoiceStrategy<
   /** @inheritDoc */
   public setOptions (opts: WorkerChoiceStrategyOptions): void {
     opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
-    this.setTaskStatistics(opts)
+    this.setTaskStatisticsRequirements(opts)
     this.opts = opts
   }
 
@@ -114,32 +142,46 @@ export abstract class AbstractWorkerChoiceStrategy<
 
   /**
    * Gets the worker task runtime.
-   * If the task statistics require `avgRunTime`, the average runtime is returned.
-   * If the task statistics require `medRunTime`, the median runtime is returned.
+   * If the task statistics require the average runtime, the average runtime is returned.
+   * If the task statistics require the median runtime , the median runtime is returned.
    *
    * @param workerNodeKey - The worker node key.
    * @returns The worker task runtime.
    */
   protected getWorkerTaskRunTime (workerNodeKey: number): number {
-    return this.taskStatisticsRequirements.medRunTime
+    return this.taskStatisticsRequirements.runTime.median
       ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
       : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
   }
 
   /**
    * Gets the worker task wait time.
-   * If the task statistics require `avgWaitTime`, the average wait time is returned.
-   * If the task statistics require `medWaitTime`, the median wait time is returned.
+   * If the task statistics require the average wait time, the average wait time is returned.
+   * If the task statistics require the median wait time, 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.taskStatisticsRequirements.medWaitTime
+  protected getWorkerTaskWaitTime (workerNodeKey: number): number {
+    return this.taskStatisticsRequirements.waitTime.median
       ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
       : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
   }
 
+  /**
+   * Gets the worker task ELU.
+   * If the task statistics require the ELU, the average ELU is returned.
+   * If the task statistics require the ELU, the median ELU is returned.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns The worker task ELU.
+   */
+  protected getWorkerTaskElu (workerNodeKey: number): number {
+    return this.taskStatisticsRequirements.elu.median
+      ? this.pool.workerNodes[workerNodeKey].workerUsage.elu.active.median
+      : this.pool.workerNodes[workerNodeKey].workerUsage.elu.active.average
+  }
+
   protected computeDefaultWorkerWeight (): number {
     let cpusCycleTimeWeight = 0
     for (const cpu of cpus()) {
@@ -154,7 +196,7 @@ export abstract class AbstractWorkerChoiceStrategy<
   /**
    * Finds the first free worker node key based on the number of tasks the worker has applied.
    *
-   * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
+   * If a worker is found with `0` executing tasks, it is detected as free and its worker node key is returned.
    *
    * If no free worker is found, `-1` is returned.
    *
@@ -169,7 +211,7 @@ export abstract class AbstractWorkerChoiceStrategy<
   /**
    * Finds the last free worker node key based on the number of tasks the worker has applied.
    *
-   * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned.
+   * If a worker is found with `0` executing tasks, it is detected as free and its worker node key is returned.
    *
    * If no free worker is found, `-1` is returned.
    *