build(deps-dev): apply updates
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
index b5b77ff6e261519d2bbef3154ca701e059d77a16..5172a181a507fad13940216c933646c616ddb3fa 100644 (file)
@@ -4,6 +4,7 @@ import type { IPool } from '../pool'
 import type { IWorker } from '../worker'
 import type {
   IWorkerChoiceStrategy,
+  StrategyPolicy,
   TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
@@ -12,27 +13,46 @@ import type {
  * Worker choice strategy abstract base class.
  *
  * @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 abstract class AbstractWorkerChoiceStrategy<
   Worker extends IWorker,
   Data = unknown,
   Response = unknown
 > implements IWorkerChoiceStrategy {
+  // /**
+  //  * Toggles finding the last free worker node key.
+  //  */
+  // private toggleFindLastFreeWorkerNodeKey: boolean = false
+
   /**
-   * Toggles finding the last free worker node key.
+   * Id of the next worker node.
    */
-  private toggleFindLastFreeWorkerNodeKey: boolean = false
+  protected nextWorkerNodeId: number = 0
+
+  /** @inheritDoc */
+  public readonly strategyPolicy: StrategyPolicy = {
+    useDynamicWorker: 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 +68,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
     }
   }
 
@@ -93,51 +133,64 @@ export abstract class AbstractWorkerChoiceStrategy<
 
   /** @inheritDoc */
   public setOptions (opts: WorkerChoiceStrategyOptions): void {
-    opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
-    this.setTaskStatistics(opts)
-    this.opts = opts
+    this.opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+    this.setTaskStatisticsRequirements(this.opts)
   }
 
-  /**
-   * Finds a free worker node key.
-   *
-   * @returns The free worker node key or `-1` if there is no free worker node.
-   */
-  protected findFreeWorkerNodeKey (): number {
-    if (this.toggleFindLastFreeWorkerNodeKey) {
-      this.toggleFindLastFreeWorkerNodeKey = false
-      return this.findLastFreeWorkerNodeKey()
-    }
-    this.toggleFindLastFreeWorkerNodeKey = true
-    return this.findFirstFreeWorkerNodeKey()
-  }
+  // /**
+  //  * Finds a free worker node key.
+  //  *
+  //  * @returns The free worker node key or `-1` if there is no free worker node.
+  //  */
+  // protected findFreeWorkerNodeKey (): number {
+  //   if (this.toggleFindLastFreeWorkerNodeKey) {
+  //     this.toggleFindLastFreeWorkerNodeKey = false
+  //     return this.findLastFreeWorkerNodeKey()
+  //   }
+  //   this.toggleFindLastFreeWorkerNodeKey = true
+  //   return this.findFirstFreeWorkerNodeKey()
+  // }
 
   /**
    * 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
-      ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
-      : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
+  protected getWorkerTaskWaitTime (workerNodeKey: number): number {
+    return this.taskStatisticsRequirements.waitTime.median
+      ? this.pool.workerNodes[workerNodeKey].workerUsage.waitTime.median
+      : this.pool.workerNodes[workerNodeKey].workerUsage.waitTime.average
+  }
+
+  /**
+   * Gets the worker task ELU.
+   * If the task statistics require the average ELU, the average ELU is returned.
+   * If the task statistics require the median 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 {
@@ -151,46 +204,46 @@ export abstract class AbstractWorkerChoiceStrategy<
     return Math.round(cpusCycleTimeWeight / cpus().length)
   }
 
-  /**
-   * 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 no free worker is found, `-1` is returned.
-   *
-   * @returns A worker node key if there is one, `-1` otherwise.
-   */
-  private findFirstFreeWorkerNodeKey (): number {
-    return this.pool.workerNodes.findIndex(workerNode => {
-      return workerNode.workerUsage.tasks.executing === 0
-    })
-  }
+  // /**
+  //  * Finds the first free worker node key based on the number of tasks the worker has applied.
+  //  *
+  //  * 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.
+  //  *
+  //  * @returns A worker node key if there is one, `-1` otherwise.
+  //  */
+  // private findFirstFreeWorkerNodeKey (): number {
+  //   return this.pool.workerNodes.findIndex(workerNode => {
+  //     return workerNode.workerUsage.tasks.executing === 0
+  //   })
+  // }
 
-  /**
-   * 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 no free worker is found, `-1` is returned.
-   *
-   * @returns A worker node key if there is one, `-1` otherwise.
-   */
-  private findLastFreeWorkerNodeKey (): number {
-    // It requires node >= 18.0.0:
-    // return this.workerNodes.findLastIndex(workerNode => {
-    //   return workerNode.workerUsage.tasks.executing === 0
-    // })
-    for (
-      let workerNodeKey = this.pool.workerNodes.length - 1;
-      workerNodeKey >= 0;
-      workerNodeKey--
-    ) {
-      if (
-        this.pool.workerNodes[workerNodeKey].workerUsage.tasks.executing === 0
-      ) {
-        return workerNodeKey
-      }
-    }
-    return -1
-  }
+  // /**
+  //  * Finds the last free worker node key based on the number of tasks the worker has applied.
+  //  *
+  //  * 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.
+  //  *
+  //  * @returns A worker node key if there is one, `-1` otherwise.
+  //  */
+  // private findLastFreeWorkerNodeKey (): number {
+  //   // It requires node >= 18.0.0:
+  //   // return this.workerNodes.findLastIndex(workerNode => {
+  //   //   return workerNode.workerUsage.tasks.executing === 0
+  //   // })
+  //   for (
+  //     let workerNodeKey = this.pool.workerNodes.length - 1;
+  //     workerNodeKey >= 0;
+  //     workerNodeKey--
+  //   ) {
+  //     if (
+  //       this.pool.workerNodes[workerNodeKey].workerUsage.tasks.executing === 0
+  //     ) {
+  //       return workerNodeKey
+  //     }
+  //   }
+  //   return -1
+  // }
 }