refactor: cleanup
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
index d969f0c0ad5ca224de0d30356d517821b1e76c3c..f064c2e0838e0a68b1a809648c457308cf107eb4 100644 (file)
@@ -1,9 +1,10 @@
+import { cpus } from 'node:os'
 import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
 import type { IPool } from '../pool'
 import type { IWorker } from '../worker'
 import type {
   IWorkerChoiceStrategy,
-  RequiredStatistics,
+  TaskStatistics,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
 
@@ -24,10 +25,14 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   private toggleFindLastFreeWorkerNodeKey: boolean = false
   /** @inheritDoc */
-  public readonly requiredStatistics: RequiredStatistics = {
+  public readonly taskStatistics: TaskStatistics = {
     runTime: false,
     avgRunTime: false,
-    medRunTime: false
+    medRunTime: false,
+    waitTime: false,
+    avgWaitTime: false,
+    medWaitTime: false,
+    elu: false
   }
 
   /**
@@ -43,14 +48,22 @@ export abstract class AbstractWorkerChoiceStrategy<
     this.choose = this.choose.bind(this)
   }
 
-  protected setRequiredStatistics (opts: WorkerChoiceStrategyOptions): void {
-    if (this.requiredStatistics.avgRunTime && opts.medRunTime === true) {
-      this.requiredStatistics.avgRunTime = false
-      this.requiredStatistics.medRunTime = opts.medRunTime as boolean
+  protected setTaskStatistics (opts: WorkerChoiceStrategyOptions): void {
+    if (this.taskStatistics.avgRunTime && opts.medRunTime === true) {
+      this.taskStatistics.avgRunTime = false
+      this.taskStatistics.medRunTime = opts.medRunTime as boolean
     }
-    if (this.requiredStatistics.medRunTime && opts.medRunTime === false) {
-      this.requiredStatistics.avgRunTime = true
-      this.requiredStatistics.medRunTime = opts.medRunTime as boolean
+    if (this.taskStatistics.medRunTime && opts.medRunTime === false) {
+      this.taskStatistics.avgRunTime = true
+      this.taskStatistics.medRunTime = opts.medRunTime as boolean
+    }
+    if (this.taskStatistics.avgWaitTime && opts.medWaitTime === true) {
+      this.taskStatistics.avgWaitTime = false
+      this.taskStatistics.medWaitTime = opts.medWaitTime as boolean
+    }
+    if (this.taskStatistics.medWaitTime && opts.medWaitTime === false) {
+      this.taskStatistics.avgWaitTime = true
+      this.taskStatistics.medWaitTime = opts.medWaitTime as boolean
     }
   }
 
@@ -69,7 +82,7 @@ export abstract class AbstractWorkerChoiceStrategy<
   /** @inheritDoc */
   public setOptions (opts: WorkerChoiceStrategyOptions): void {
     opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
-    this.setRequiredStatistics(opts)
+    this.setTaskStatistics(opts)
     this.opts = opts
   }
 
@@ -89,16 +102,41 @@ export abstract class AbstractWorkerChoiceStrategy<
 
   /**
    * 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.
+   * If the task statistics wants `avgRunTime`, the average runtime is returned.
+   * If the task statistics wants `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
+    return this.taskStatistics.medRunTime
+      ? 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.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns The worker task wait time.
+   */
+  protected getWorkerWaitTime (workerNodeKey: number): number {
+    return this.taskStatistics.medWaitTime
+      ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
+      : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
+  }
+
+  protected computeDefaultWorkerWeight (): number {
+    let cpusCycleTimeWeight = 0
+    for (const cpu of cpus()) {
+      // CPU estimated cycle time
+      const numberOfDigits = cpu.speed.toString().length - 1
+      const cpuCycleTime = 1 / (cpu.speed / Math.pow(10, numberOfDigits))
+      cpusCycleTimeWeight += cpuCycleTime * Math.pow(10, numberOfDigits)
+    }
+    return Math.round(cpusCycleTimeWeight / cpus().length)
   }
 
   /**
@@ -112,7 +150,7 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   private findFirstFreeWorkerNodeKey (): number {
     return this.pool.workerNodes.findIndex(workerNode => {
-      return workerNode.tasksUsage.running === 0
+      return workerNode.workerUsage.tasks.executing === 0
     })
   }
 
@@ -128,14 +166,16 @@ export abstract class AbstractWorkerChoiceStrategy<
   private findLastFreeWorkerNodeKey (): number {
     // It requires node >= 18.0.0:
     // return this.workerNodes.findLastIndex(workerNode => {
-    //   return workerNode.tasksUsage.running === 0
+    //   return workerNode.workerUsage.tasks.executing === 0
     // })
     for (
       let workerNodeKey = this.pool.workerNodes.length - 1;
       workerNodeKey >= 0;
       workerNodeKey--
     ) {
-      if (this.pool.workerNodes[workerNodeKey].tasksUsage.running === 0) {
+      if (
+        this.pool.workerNodes[workerNodeKey].workerUsage.tasks.executing === 0
+      ) {
         return workerNodeKey
       }
     }