chore(deps-dev): apply updates
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
index 5ec7cedc0f9dc0f2f4a1079302a94d515c5d4281..f4273dcd9d17bc3e20f56795f0891a0dbf4b2d56 100644 (file)
@@ -1,21 +1,19 @@
-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'
+import type { IPool } from '../pool.js'
+import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS } from '../utils.js'
+import type { IWorker } from '../worker.js'
 import type {
   IWorkerChoiceStrategy,
-  MeasurementStatisticsRequirements,
   StrategyPolicy,
   TaskStatisticsRequirements,
-  WorkerChoiceStrategyOptions
-} from './selection-strategies-types'
+  WorkerChoiceStrategyOptions,
+} from './selection-strategies-types.js'
+import {
+  buildWorkerChoiceStrategyOptions,
+  toggleMedianMeasurementStatisticsRequirements,
+} from './selection-strategies-utils.js'
 
 /**
  * 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 structured-cloneable data.
  * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
@@ -33,66 +31,54 @@ export abstract class AbstractWorkerChoiceStrategy<
   /**
    * The previous worker node key.
    */
-  protected previousWorkerNodeKey: number = 0
+  protected previousWorkerNodeKey = 0
 
   /** @inheritDoc */
   public readonly strategyPolicy: StrategyPolicy = {
     dynamicWorkerUsage: false,
-    dynamicWorkerReady: true
+    dynamicWorkerReady: true,
   }
 
   /** @inheritDoc */
   public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
     runTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
     waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
-    elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
+    elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
   }
 
   /**
    * Constructs a worker choice strategy bound to the pool.
-   *
    * @param pool - The pool instance.
    * @param opts - The worker choice strategy options.
    */
   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.choose = this.choose.bind(this)
+    this.setOptions(this.opts)
   }
 
   protected setTaskStatisticsRequirements (
-    opts: WorkerChoiceStrategyOptions
+    opts: WorkerChoiceStrategyOptions | undefined
   ): void {
-    this.toggleMedianMeasurementStatisticsRequirements(
+    toggleMedianMeasurementStatisticsRequirements(
       this.taskStatisticsRequirements.runTime,
-      opts.runTime?.median as boolean
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      opts!.runTime!.median
     )
-    this.toggleMedianMeasurementStatisticsRequirements(
+    toggleMedianMeasurementStatisticsRequirements(
       this.taskStatisticsRequirements.waitTime,
-      opts.waitTime?.median as boolean
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      opts!.waitTime!.median
     )
-    this.toggleMedianMeasurementStatisticsRequirements(
+    toggleMedianMeasurementStatisticsRequirements(
       this.taskStatisticsRequirements.elu,
-      opts.elu?.median as boolean
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      opts!.elu!.median
     )
   }
 
-  private toggleMedianMeasurementStatisticsRequirements (
-    measurementStatisticsRequirements: MeasurementStatisticsRequirements,
-    toggleMedian: boolean
-  ): void {
-    if (measurementStatisticsRequirements.average && toggleMedian) {
-      measurementStatisticsRequirements.average = false
-      measurementStatisticsRequirements.median = toggleMedian
-    }
-    if (measurementStatisticsRequirements.median && !toggleMedian) {
-      measurementStatisticsRequirements.average = true
-      measurementStatisticsRequirements.median = toggleMedian
-    }
-  }
-
   protected resetWorkerNodeKeyProperties (): void {
     this.nextWorkerNodeKey = 0
     this.previousWorkerNodeKey = 0
@@ -111,52 +97,40 @@ 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
-  }
-
-  /**
-   * 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.
-   */
-  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 key.
    */
-  protected isWorkerNodeEligible (workerNodeKey: number): boolean {
-    return (
-      this.isWorkerNodeReady(workerNodeKey) &&
-      !this.hasWorkerNodeBackPressure(workerNodeKey)
-    )
+  protected checkNextWorkerNodeKey (): void {
+    if (
+      this.nextWorkerNodeKey != null &&
+      (this.nextWorkerNodeKey < 0 ||
+        !this.isWorkerNodeReady(this.nextWorkerNodeKey))
+    ) {
+      delete this.nextWorkerNodeKey
+    }
   }
 
   /**
    * 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.
-   *
+   * If the task statistics require the median runtime, the median runtime is returned.
    * @param workerNodeKey - The worker node key.
    * @returns The worker node task runtime.
    */
@@ -170,7 +144,6 @@ export abstract class AbstractWorkerChoiceStrategy<
    * 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 node task wait time.
    */
@@ -184,7 +157,6 @@ export abstract class AbstractWorkerChoiceStrategy<
    * 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 node task ELU.
    */
@@ -196,30 +168,12 @@ export abstract class AbstractWorkerChoiceStrategy<
 
   /**
    * Sets safely the previous worker node key.
-   *
    * @param workerNodeKey - The worker node key.
    */
   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)) {
-      this.nextWorkerNodeKey = undefined
-    }
-  }
-
-  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)
+    this.previousWorkerNodeKey =
+      workerNodeKey != null && workerNodeKey >= 0
+        ? workerNodeKey
+        : this.previousWorkerNodeKey
   }
 }