refactor: dedupe worker choice strategy options handling code
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
index d4fcd8d0a95bae029d23ef386fd7cbd2d17a7dde..d8d8f32d2f9dc2eee45f63c75f2aa0ece167b108 100644 (file)
@@ -1,17 +1,16 @@
-import { cpus } from 'node:os'
 import {
   DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
-  DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
-} from '../../utils'
-import type { IPool } from '../pool'
-import type { IWorker } from '../worker'
+  buildWorkerChoiceStrategyOptions
+} from '../../utils.js'
+import type { IPool } from '../pool.js'
+import type { IWorker } from '../worker.js'
 import type {
   IWorkerChoiceStrategy,
   MeasurementStatisticsRequirements,
   StrategyPolicy,
   TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
-} from './selection-strategies-types'
+} from './selection-strategies-types.js'
 
 /**
  * Worker choice strategy abstract base class.
@@ -28,11 +27,17 @@ export abstract class AbstractWorkerChoiceStrategy<
   /**
    * The next worker node key.
    */
-  protected nextWorkerNodeKey: number = 0
+  protected nextWorkerNodeKey: number | undefined = 0
+
+  /**
+   * The previous worker node key.
+   */
+  protected previousWorkerNodeKey: number = 0
 
   /** @inheritDoc */
   public readonly strategyPolicy: StrategyPolicy = {
-    useDynamicWorker: false
+    dynamicWorkerUsage: false,
+    dynamicWorkerReady: true
   }
 
   /** @inheritDoc */
@@ -50,25 +55,29 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   public constructor (
     protected readonly pool: IPool<Worker, Data, Response>,
-    protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+    protected opts?: WorkerChoiceStrategyOptions
   ) {
+    this.setOptions(this.opts)
     this.choose = this.choose.bind(this)
   }
 
   protected setTaskStatisticsRequirements (
-    opts: WorkerChoiceStrategyOptions
+    opts: WorkerChoiceStrategyOptions | undefined
   ): void {
     this.toggleMedianMeasurementStatisticsRequirements(
       this.taskStatisticsRequirements.runTime,
-      opts.runTime?.median as boolean
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      opts!.runTime!.median
     )
     this.toggleMedianMeasurementStatisticsRequirements(
       this.taskStatisticsRequirements.waitTime,
-      opts.waitTime?.median as boolean
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      opts!.waitTime!.median
     )
     this.toggleMedianMeasurementStatisticsRequirements(
       this.taskStatisticsRequirements.elu,
-      opts.elu?.median as boolean
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      opts!.elu!.median
     )
   }
 
@@ -86,6 +95,11 @@ export abstract class AbstractWorkerChoiceStrategy<
     }
   }
 
+  protected resetWorkerNodeKeyProperties (): void {
+    this.nextWorkerNodeKey = 0
+    this.previousWorkerNodeKey = 0
+  }
+
   /** @inheritDoc */
   public abstract reset (): boolean
 
@@ -93,17 +107,25 @@ export abstract class AbstractWorkerChoiceStrategy<
   public abstract update (workerNodeKey: number): boolean
 
   /** @inheritDoc */
-  public abstract choose (): number
+  public abstract choose (): number | undefined
 
   /** @inheritDoc */
   public abstract remove (workerNodeKey: number): boolean
 
   /** @inheritDoc */
-  public setOptions (opts: WorkerChoiceStrategyOptions): void {
-    this.opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+  public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void {
+    this.opts = buildWorkerChoiceStrategyOptions<Worker, Data, Response>(
+      this.pool,
+      opts
+    )
     this.setTaskStatisticsRequirements(this.opts)
   }
 
+  /** @inheritDoc */
+  public hasPoolWorkerNodesReady (): boolean {
+    return this.pool.workerNodes.some(workerNode => workerNode.info.ready)
+  }
+
   /**
    * Whether the worker node is ready or not.
    *
@@ -111,69 +133,67 @@ export abstract class AbstractWorkerChoiceStrategy<
    * @returns Whether the worker node is ready or not.
    */
   protected isWorkerNodeReady (workerNodeKey: number): boolean {
-    return this.pool.workerNodes[workerNodeKey].info.ready
+    return this.pool.workerNodes[workerNodeKey]?.info?.ready ?? false
   }
 
   /**
-   * Whether the worker node has back pressure or not (i.e. its tasks queue is full).
-   *
-   * @param workerNodeKey - The worker node key.
-   * @returns `true` if the worker node has back pressure, `false` otherwise.
+   * Check the next worker node readiness.
    */
-  protected hasWorkerNodeBackPressure (workerNodeKey: number): boolean {
-    return this.pool.hasWorkerNodeBackPressure(workerNodeKey)
+  protected checkNextWorkerNodeReadiness (): void {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    if (!this.isWorkerNodeReady(this.nextWorkerNodeKey!)) {
+      delete this.nextWorkerNodeKey
+    }
   }
 
   /**
-   * Gets the worker task runtime.
+   * Gets the worker node task runtime.
    * 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.
+   * @returns The worker node task runtime.
    */
-  protected getWorkerTaskRunTime (workerNodeKey: number): number {
+  protected getWorkerNodeTaskRunTime (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.runTime.median
-      ? this.pool.workerNodes[workerNodeKey].usage.runTime?.median ?? 0
-      : this.pool.workerNodes[workerNodeKey].usage.runTime?.average ?? 0
+      ? this.pool.workerNodes[workerNodeKey].usage.runTime.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.runTime.average ?? 0
   }
 
   /**
-   * Gets the worker task wait time.
+   * Gets the worker node task wait time.
    * 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.
+   * @returns The worker node task wait time.
    */
-  protected getWorkerTaskWaitTime (workerNodeKey: number): number {
+  protected getWorkerNodeTaskWaitTime (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.waitTime.median
-      ? this.pool.workerNodes[workerNodeKey].usage.waitTime?.median ?? 0
-      : this.pool.workerNodes[workerNodeKey].usage.waitTime?.average ?? 0
+      ? this.pool.workerNodes[workerNodeKey].usage.waitTime.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.waitTime.average ?? 0
   }
 
   /**
-   * Gets the worker task ELU.
+   * Gets the worker node 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.
+   * @returns The worker node task ELU.
    */
-  protected getWorkerTaskElu (workerNodeKey: number): number {
+  protected getWorkerNodeTaskElu (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.elu.median
-      ? this.pool.workerNodes[workerNodeKey].usage.elu.active?.median ?? 0
-      : this.pool.workerNodes[workerNodeKey].usage.elu.active?.average ?? 0
+      ? this.pool.workerNodes[workerNodeKey].usage.elu.active.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.elu.active.average ?? 0
   }
 
-  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)
+  /**
+   * Sets safely the previous worker node key.
+   *
+   * @param workerNodeKey - The worker node key.
+   */
+  protected setPreviousWorkerNodeKey (workerNodeKey: number | undefined): void {
+    this.previousWorkerNodeKey = workerNodeKey ?? this.previousWorkerNodeKey
   }
 }