perf: improve node eligibility branching on worker choice strategies

[poolifier.git] / src / pools / selection-strategies / fair-share-worker-choice-strategy.ts

diff --git a/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts b/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
index f0bc8787a6005e4d896140a220f49ae89b8c391c..fc4bd1fd4de4f281c8dbae20fcf3014ca0a5565f 100644 (file)
--- a/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
@@ -1,28 +1,24 @@
-import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
+import {
+  DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+  DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+} from '../../utils'
 import type { IPool } from '../pool'
 import type { IWorker } from '../worker'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
-import type {
-  IWorkerChoiceStrategy,
-  RequiredStatistics,
-  WorkerChoiceStrategyOptions
+import {
+  type IWorkerChoiceStrategy,
+  Measurements,
+  type TaskStatisticsRequirements,
+  type WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
 
-/**
- * Worker virtual task timestamp.
- */
-interface WorkerVirtualTaskTimestamp {
-  start: number
-  end: number
-}
-
 /**
  * Selects the next worker with a fair share scheduling algorithm.
  * Loosely modeled after the fair queueing algorithm: https://en.wikipedia.org/wiki/Fair_queuing.
  *
  * @typeParam Worker - Type of worker which manages the strategy.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @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.
  */
 export class FairShareWorkerChoiceStrategy<
     Worker extends IWorker,
@@ -32,16 +28,24 @@ export class FairShareWorkerChoiceStrategy<
   extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
   /** @inheritDoc */
-  public readonly requiredStatistics: RequiredStatistics = {
-    runTime: true,
-    avgRunTime: true,
-    medRunTime: false
+  public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+    runTime: {
+      aggregate: true,
+      average: true,
+      median: false
+    },
+    waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+    elu: {
+      aggregate: true,
+      average: true,
+      median: false
+    }
   }
 
   /**
-   * Workers' virtual task execution timestamp.
+   * Workers' virtual task end execution timestamp.
    */
-  private workersVirtualTaskTimestamp: WorkerVirtualTaskTimestamp[] = []
+  private workersVirtualTaskEndTimestamp: number[] = []
 
   /** @inheritDoc */
   public constructor (
@@ -49,23 +53,45 @@ export class FairShareWorkerChoiceStrategy<
     opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
   ) {
     super(pool, opts)
-    this.checkOptions(this.opts)
+    this.setTaskStatisticsRequirements(this.opts)
   }
 
   /** @inheritDoc */
   public reset (): boolean {
-    this.workersVirtualTaskTimestamp = []
+    this.workersVirtualTaskEndTimestamp = []
+    return true
+  }
+
+  /** @inheritDoc */
+  public update (workerNodeKey: number): boolean {
+    this.computeWorkerVirtualTaskEndTimestamp(workerNodeKey)
     return true
   }
 
   /** @inheritDoc */
-  public choose (): number {
+  public choose (): number | undefined {
+    this.nextWorkerNodeKey = this.fairShareNextWorkerNodeKey()
+    return this.nextWorkerNodeKey
+  }
+
+  /** @inheritDoc */
+  public remove (workerNodeKey: number): boolean {
+    this.workersVirtualTaskEndTimestamp.splice(workerNodeKey, 1)
+    return true
+  }
+
+  private fairShareNextWorkerNodeKey (): number | undefined {
     let minWorkerVirtualTaskEndTimestamp = Infinity
-    let chosenWorkerNodeKey!: number
+    let chosenWorkerNodeKey: number | undefined
     for (const [workerNodeKey] of this.pool.workerNodes.entries()) {
-      this.computeWorkerVirtualTaskTimestamp(workerNodeKey)
+      if (!this.isWorkerNodeEligible(workerNodeKey)) {
+        continue
+      }
+      if (this.workersVirtualTaskEndTimestamp[workerNodeKey] == null) {
+        this.computeWorkerVirtualTaskEndTimestamp(workerNodeKey)
+      }
       const workerVirtualTaskEndTimestamp =
-        this.workersVirtualTaskTimestamp[workerNodeKey]?.end ?? 0
+        this.workersVirtualTaskEndTimestamp[workerNodeKey]
       if (workerVirtualTaskEndTimestamp < minWorkerVirtualTaskEndTimestamp) {
         minWorkerVirtualTaskEndTimestamp = workerVirtualTaskEndTimestamp
         chosenWorkerNodeKey = workerNodeKey
@@ -74,28 +100,34 @@ export class FairShareWorkerChoiceStrategy<
     return chosenWorkerNodeKey
   }
 
-  /** @inheritDoc */
-  public remove (workerNodeKey: number): boolean {
-    this.workersVirtualTaskTimestamp.splice(workerNodeKey, 1)
-    return true
-  }
-
   /**
-   * Computes worker virtual task timestamp.
+   * Computes the worker node key virtual task end timestamp.
    *
    * @param workerNodeKey - The worker node key.
    */
-  private computeWorkerVirtualTaskTimestamp (workerNodeKey: number): void {
-    const workerVirtualTaskStartTimestamp = Math.max(
+  private computeWorkerVirtualTaskEndTimestamp (workerNodeKey: number): void {
+    this.workersVirtualTaskEndTimestamp[workerNodeKey] =
+      this.getWorkerVirtualTaskEndTimestamp(
+        workerNodeKey,
+        this.getWorkerVirtualTaskStartTimestamp(workerNodeKey)
+      )
+  }
+
+  private getWorkerVirtualTaskEndTimestamp (
+    workerNodeKey: number,
+    workerVirtualTaskStartTimestamp: number
+  ): number {
+    const workerTaskRunTime =
+      this.opts.measurement === Measurements.elu
+        ? this.getWorkerTaskElu(workerNodeKey)
+        : this.getWorkerTaskRunTime(workerNodeKey)
+    return workerVirtualTaskStartTimestamp + workerTaskRunTime
+  }
+
+  private getWorkerVirtualTaskStartTimestamp (workerNodeKey: number): number {
+    return Math.max(
       performance.now(),
-      this.workersVirtualTaskTimestamp[workerNodeKey]?.end ?? -Infinity
+      this.workersVirtualTaskEndTimestamp[workerNodeKey] ?? -Infinity
     )
-    const workerVirtualTaskTRunTime = this.requiredStatistics.medRunTime
-      ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
-      : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
-    this.workersVirtualTaskTimestamp[workerNodeKey] = {
-      start: workerVirtualTaskStartTimestamp,
-      end: workerVirtualTaskStartTimestamp + (workerVirtualTaskTRunTime ?? 0)
-    }
   }
 }