perf: improve node eligibility branching on worker choice strategies
[poolifier.git] / src / pools / selection-strategies / fair-share-worker-choice-strategy.ts
index 16d5a7be1dd60ca213a873c1571f8335948ac826..fc4bd1fd4de4f281c8dbae20fcf3014ca0a5565f 100644 (file)
-import type { IPoolWorker } from '../pool-worker'
+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
+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 response of execution. 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 IPoolWorker,
+    Worker extends IWorker,
     Data = unknown,
     Response = unknown
   >
   extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
   /** @inheritDoc */
-  public readonly requiredStatistics: RequiredStatistics = {
-    runTime: true,
-    avgRunTime: true
+  public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
+    runTime: {
+      aggregate: true,
+      average: true,
+      median: false
+    },
+    waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+    elu: {
+      aggregate: true,
+      average: true,
+      median: false
+    }
   }
 
   /**
-   *  Worker last virtual task execution timestamp.
+   * Workers' virtual task end execution timestamp.
    */
-  private readonly workerLastVirtualTaskTimestamp: Map<
-  number,
-  WorkerVirtualTaskTimestamp
-  > = new Map<number, WorkerVirtualTaskTimestamp>()
+  private workersVirtualTaskEndTimestamp: number[] = []
+
+  /** @inheritDoc */
+  public constructor (
+    pool: IPool<Worker, Data, Response>,
+    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+  ) {
+    super(pool, opts)
+    this.setTaskStatisticsRequirements(this.opts)
+  }
 
   /** @inheritDoc */
   public reset (): boolean {
-    this.workerLastVirtualTaskTimestamp.clear()
+    this.workersVirtualTaskEndTimestamp = []
     return true
   }
 
   /** @inheritDoc */
-  public choose (): number {
-    let minWorkerVirtualTaskEndTimestamp = Infinity
-    let chosenWorkerKey!: number
-    for (const [index] of this.pool.workers.entries()) {
-      this.computeWorkerLastVirtualTaskTimestamp(index)
-      const workerLastVirtualTaskEndTimestamp =
-        this.workerLastVirtualTaskTimestamp.get(index)?.end ?? 0
-      if (
-        workerLastVirtualTaskEndTimestamp < minWorkerVirtualTaskEndTimestamp
-      ) {
-        minWorkerVirtualTaskEndTimestamp = workerLastVirtualTaskEndTimestamp
-        chosenWorkerKey = index
-      }
-    }
-    return chosenWorkerKey
+  public update (workerNodeKey: number): boolean {
+    this.computeWorkerVirtualTaskEndTimestamp(workerNodeKey)
+    return true
   }
 
   /** @inheritDoc */
-  public remove (workerKey: number): boolean {
-    const workerDeleted = this.workerLastVirtualTaskTimestamp.delete(workerKey)
-    for (const [key, value] of this.workerLastVirtualTaskTimestamp.entries()) {
-      if (key > workerKey) {
-        this.workerLastVirtualTaskTimestamp.set(key - 1, value)
+  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 | undefined
+    for (const [workerNodeKey] of this.pool.workerNodes.entries()) {
+      if (!this.isWorkerNodeEligible(workerNodeKey)) {
+        continue
+      }
+      if (this.workersVirtualTaskEndTimestamp[workerNodeKey] == null) {
+        this.computeWorkerVirtualTaskEndTimestamp(workerNodeKey)
+      }
+      const workerVirtualTaskEndTimestamp =
+        this.workersVirtualTaskEndTimestamp[workerNodeKey]
+      if (workerVirtualTaskEndTimestamp < minWorkerVirtualTaskEndTimestamp) {
+        minWorkerVirtualTaskEndTimestamp = workerVirtualTaskEndTimestamp
+        chosenWorkerNodeKey = workerNodeKey
       }
     }
-    return workerDeleted
+    return chosenWorkerNodeKey
   }
 
   /**
-   * Computes worker last virtual task timestamp.
+   * Computes the worker node key virtual task end timestamp.
    *
-   * @param workerKey - The worker key.
+   * @param workerNodeKey - The worker node key.
    */
-  private computeWorkerLastVirtualTaskTimestamp (workerKey: number): void {
-    const workerVirtualTaskStartTimestamp = Math.max(
-      Date.now(),
-      this.workerLastVirtualTaskTimestamp.get(workerKey)?.end ?? -Infinity
+  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.workersVirtualTaskEndTimestamp[workerNodeKey] ?? -Infinity
     )
-    this.workerLastVirtualTaskTimestamp.set(workerKey, {
-      start: workerVirtualTaskStartTimestamp,
-      end:
-        workerVirtualTaskStartTimestamp +
-        (this.pool.workers[workerKey].tasksUsage.avgRunTime ?? 0)
-    })
   }
 }