refactor: dedupe worker choice strategy options handling code

[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 630a2258be49a7ed725f12b1ac555d510dd0e257..d8d8f32d2f9dc2eee45f63c75f2aa0ece167b108 100644 (file)
--- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -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.
@@ -56,26 +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.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts }
+    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
     )
   }
 
@@ -111,45 +113,37 @@ export abstract class AbstractWorkerChoiceStrategy<
   public abstract remove (workerNodeKey: number): boolean
 
   /** @inheritDoc */
-  public setOptions (opts: WorkerChoiceStrategyOptions): void {
-    this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts }
+  public setOptions (opts: WorkerChoiceStrategyOptions | undefined): void {
+    this.opts = buildWorkerChoiceStrategyOptions<Worker, Data, Response>(
+      this.pool,
+      opts
+    )
     this.setTaskStatisticsRequirements(this.opts)
   }
 
-  /**
-   * Whether the worker node is ready or not.
-   *
-   * @param workerNodeKey - The worker node key.
-   * @returns Whether the worker node is ready or not.
-   */
-  private isWorkerNodeReady (workerNodeKey: number): boolean {
-    return this.pool.workerNodes[workerNodeKey].info.ready
+  /** @inheritDoc */
+  public hasPoolWorkerNodesReady (): boolean {
+    return this.pool.workerNodes.some(workerNode => workerNode.info.ready)
   }
 
   /**
-   * Whether the worker node has back pressure or not (i.e. its tasks queue is full).
+   * Whether the worker node is ready or not.
    *
    * @param workerNodeKey - The worker node key.
-   * @returns `true` if the worker node has back pressure, `false` otherwise.
+   * @returns Whether the worker node is ready or not.
    */
-  private hasWorkerNodeBackPressure (workerNodeKey: number): boolean {
-    return this.pool.hasWorkerNodeBackPressure(workerNodeKey)
+  protected isWorkerNodeReady (workerNodeKey: number): boolean {
+    return this.pool.workerNodes[workerNodeKey]?.info?.ready ?? false
   }
 
   /**
-   * Whether the worker node is eligible or not.
-   * A worker node is eligible if it is ready and does not have back pressure.
-   *
-   * @param workerNodeKey - The worker node key.
-   * @returns `true` if the worker node is eligible, `false` otherwise.
-   * @see {@link isWorkerNodeReady}
-   * @see {@link hasWorkerNodeBackPressure}
+   * Check the next worker node readiness.
    */
-  protected isWorkerNodeEligible (workerNodeKey: number): boolean {
-    return (
-      this.isWorkerNodeReady(workerNodeKey) &&
-      !this.hasWorkerNodeBackPressure(workerNodeKey)
-    )
+  protected checkNextWorkerNodeReadiness (): void {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    if (!this.isWorkerNodeReady(this.nextWorkerNodeKey!)) {
+      delete this.nextWorkerNodeKey
+    }
   }
 
   /**
@@ -202,24 +196,4 @@ export abstract class AbstractWorkerChoiceStrategy<
   protected setPreviousWorkerNodeKey (workerNodeKey: number | undefined): void {
     this.previousWorkerNodeKey = workerNodeKey ?? this.previousWorkerNodeKey
   }
-
-  /**
-   * Check the next worker node eligibility.
-   */
-  protected checkNextWorkerNodeEligibility (): void {
-    if (!this.isWorkerNodeEligible(this.nextWorkerNodeKey as number)) {
-      delete this.nextWorkerNodeKey
-    }
-  }
-
-  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)
-  }
 }