refactor: align worker choice strategy options namespace

[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 f064c2e0838e0a68b1a809648c457308cf107eb4..18b47a1d9d38bcbb1ac4361dd4938d0106d47fe7 100644 (file)
--- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -4,7 +4,7 @@ import type { IPool } from '../pool'
 import type { IWorker } from '../worker'
 import type {
   IWorkerChoiceStrategy,
-  TaskStatistics,
+  TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
 
@@ -25,13 +25,17 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   private toggleFindLastFreeWorkerNodeKey: boolean = false
   /** @inheritDoc */
-  public readonly taskStatistics: TaskStatistics = {
-    runTime: false,
-    avgRunTime: false,
-    medRunTime: false,
-    waitTime: false,
-    avgWaitTime: false,
-    medWaitTime: false,
+  public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+    runTime: {
+      aggregate: false,
+      average: false,
+      median: false
+    },
+    waitTime: {
+      aggregate: false,
+      average: false,
+      median: false
+    },
     elu: false
   }
 
@@ -48,22 +52,40 @@ export abstract class AbstractWorkerChoiceStrategy<
     this.choose = this.choose.bind(this)
   }
 
-  protected setTaskStatistics (opts: WorkerChoiceStrategyOptions): void {
-    if (this.taskStatistics.avgRunTime && opts.medRunTime === true) {
-      this.taskStatistics.avgRunTime = false
-      this.taskStatistics.medRunTime = opts.medRunTime as boolean
+  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.taskStatistics.medRunTime && opts.medRunTime === false) {
-      this.taskStatistics.avgRunTime = true
-      this.taskStatistics.medRunTime = opts.medRunTime 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.taskStatistics.avgWaitTime && opts.medWaitTime === true) {
-      this.taskStatistics.avgWaitTime = false
-      this.taskStatistics.medWaitTime = opts.medWaitTime as boolean
+    if (
+      this.taskStatisticsRequirements.waitTime.average &&
+      opts.waitTime?.median === true
+    ) {
+      this.taskStatisticsRequirements.waitTime.average = false
+      this.taskStatisticsRequirements.waitTime.median = opts.waitTime
+        .median as boolean
     }
-    if (this.taskStatistics.medWaitTime && opts.medWaitTime === false) {
-      this.taskStatistics.avgWaitTime = true
-      this.taskStatistics.medWaitTime = opts.medWaitTime as boolean
+    if (
+      this.taskStatisticsRequirements.waitTime.median &&
+      opts.waitTime?.median === false
+    ) {
+      this.taskStatisticsRequirements.waitTime.average = true
+      this.taskStatisticsRequirements.waitTime.median = opts.waitTime
+        .median as boolean
     }
   }
 
@@ -82,7 +104,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
   }
 
@@ -102,28 +124,28 @@ export abstract class AbstractWorkerChoiceStrategy<
 
   /**
    * Gets the worker task runtime.
-   * If the task statistics wants `avgRunTime`, the average runtime is returned.
-   * If the task statistics wants `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.taskStatistics.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 wants `avgWaitTime`, the average wait time is returned.
-   * If the task statistics wants `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.taskStatistics.medWaitTime
+    return this.taskStatisticsRequirements.waitTime.median
       ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
       : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
   }
@@ -142,7 +164,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.
    *
@@ -157,7 +179,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.
    *