X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fabstract-worker-choice-strategy.ts;h=b5b77ff6e261519d2bbef3154ca701e059d77a16;hb=9a0613e995004ae9e2faa287a8dd92c2854141f1;hp=ce7f9589ab5708975019706047b477f71007731f;hpb=027063571693f211b35c8851566a063201adb9af;p=poolifier.git

diff --git a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
index ce7f9589..b5b77ff6 100644
--- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -1,9 +1,10 @@
+import { cpus } from 'node:os'
 import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
-import { PoolType, type IPool } from '../pool'
+import type { IPool } from '../pool'
 import type { IWorker } from '../worker'
 import type {
   IWorkerChoiceStrategy,
-  RequiredStatistics,
+  TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
 
@@ -19,13 +20,19 @@ export abstract class AbstractWorkerChoiceStrategy<
   Data = unknown,
   Response = unknown
 > implements IWorkerChoiceStrategy {
+  /**
+   * Toggles finding the last free worker node key.
+   */
+  private toggleFindLastFreeWorkerNodeKey: boolean = false
   /** @inheritDoc */
-  protected readonly isDynamicPool: boolean
-  /** @inheritDoc */
-  public readonly requiredStatistics: RequiredStatistics = {
+  public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
     runTime: false,
     avgRunTime: false,
-    medRunTime: false
+    medRunTime: false,
+    waitTime: false,
+    avgWaitTime: false,
+    medWaitTime: false,
+    elu: false
   }
 
   /**
@@ -36,25 +43,154 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   public constructor (
     protected readonly pool: IPool<Worker, Data, Response>,
-    protected readonly opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+    protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
   ) {
-    this.checkOptions(this.opts)
-    this.isDynamicPool = this.pool.type === PoolType.DYNAMIC
-    this.choose.bind(this)
+    this.choose = this.choose.bind(this)
   }
 
-  private checkOptions (opts: WorkerChoiceStrategyOptions): void {
-    if (this.requiredStatistics.avgRunTime && opts.medRunTime === true) {
-      this.requiredStatistics.medRunTime = true
+  protected setTaskStatistics (opts: WorkerChoiceStrategyOptions): void {
+    if (
+      this.taskStatisticsRequirements.avgRunTime &&
+      opts.medRunTime === true
+    ) {
+      this.taskStatisticsRequirements.avgRunTime = false
+      this.taskStatisticsRequirements.medRunTime = opts.medRunTime as boolean
+    }
+    if (
+      this.taskStatisticsRequirements.medRunTime &&
+      opts.medRunTime === false
+    ) {
+      this.taskStatisticsRequirements.avgRunTime = true
+      this.taskStatisticsRequirements.medRunTime = opts.medRunTime as boolean
+    }
+    if (
+      this.taskStatisticsRequirements.avgWaitTime &&
+      opts.medWaitTime === true
+    ) {
+      this.taskStatisticsRequirements.avgWaitTime = false
+      this.taskStatisticsRequirements.medWaitTime = opts.medWaitTime as boolean
+    }
+    if (
+      this.taskStatisticsRequirements.medWaitTime &&
+      opts.medWaitTime === false
+    ) {
+      this.taskStatisticsRequirements.avgWaitTime = true
+      this.taskStatisticsRequirements.medWaitTime = opts.medWaitTime as boolean
     }
   }
 
   /** @inheritDoc */
   public abstract reset (): boolean
 
+  /** @inheritDoc */
+  public abstract update (workerNodeKey: number): boolean
+
   /** @inheritDoc */
   public abstract choose (): number
 
   /** @inheritDoc */
   public abstract remove (workerNodeKey: number): boolean
+
+  /** @inheritDoc */
+  public setOptions (opts: WorkerChoiceStrategyOptions): void {
+    opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+    this.setTaskStatistics(opts)
+    this.opts = 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()
+  }
+
+  /**
+   * 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.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns The worker task runtime.
+   */
+  protected getWorkerTaskRunTime (workerNodeKey: number): number {
+    return this.taskStatisticsRequirements.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 require `avgWaitTime`, the average wait time is returned.
+   * If the task statistics require `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.taskStatisticsRequirements.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)
+  }
+
+  /**
+   * 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 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
+  }
 }