feat: add tasks wait time account per worker

[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 00ed1c90aa53592ca1de2b067273f4e6f1de2693..56d9dc361fe6e70255877ec6c1e6be6f33b70a70 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,14 +1,12 @@
-import type { IPoolWorker } from '../pool-worker'
+import { 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 { RequiredStatistics } from './selection-strategies-types'
-
-/**
- * Worker virtual task timestamp.
- */
-interface WorkerVirtualTaskTimestamp {
-  start: number
-  end: number
-}
+import type {
+  IWorkerChoiceStrategy,
+  RequiredStatistics,
+  WorkerChoiceStrategyOptions
+} from './selection-strategies-types'
 
 /**
  * Selects the next worker with a fair share scheduling algorithm.
@@ -16,65 +14,101 @@ interface WorkerVirtualTaskTimestamp {
  *
  * @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 Response - Type of execution response. This can only be serializable data.
  */
 export class FairShareWorkerChoiceStrategy<
-  Worker extends IPoolWorker,
-  Data,
-  Response
-> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> {
-  /** {@inheritDoc} */
+    Worker extends IWorker,
+    Data = unknown,
+    Response = unknown
+  >
+  extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
+  implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
   public readonly requiredStatistics: RequiredStatistics = {
-    runTime: true
+    runTime: true,
+    avgRunTime: true,
+    medRunTime: false,
+    waitTime: false,
+    avgWaitTime: false,
+    medWaitTime: false
   }
 
   /**
-   *  Worker last virtual task execution timestamp.
+   * Workers' virtual task end execution timestamp.
    */
-  private readonly workerLastVirtualTaskTimestamp: Map<
-  Worker,
-  WorkerVirtualTaskTimestamp
-  > = new Map<Worker, WorkerVirtualTaskTimestamp>()
+  private workersVirtualTaskEndTimestamp: number[] = []
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
+  public constructor (
+    pool: IPool<Worker, Data, Response>,
+    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+  ) {
+    super(pool, opts)
+    this.setRequiredStatistics(this.opts)
+  }
+
+  /** @inheritDoc */
   public reset (): boolean {
-    this.workerLastVirtualTaskTimestamp.clear()
+    this.workersVirtualTaskEndTimestamp = []
+    return true
+  }
+
+  /** @inheritDoc */
+  public update (workerNodeKey: number): boolean {
+    this.computeWorkerVirtualTaskEndTimestamp(workerNodeKey)
     return true
   }
 
-  /** {@inheritDoc} */
-  public choose (): Worker {
+  /** @inheritDoc */
+  public choose (): number {
     let minWorkerVirtualTaskEndTimestamp = Infinity
-    let chosenWorker!: Worker
-    for (const worker of this.pool.workers) {
-      this.computeWorkerLastVirtualTaskTimestamp(worker)
-      const workerLastVirtualTaskEndTimestamp =
-        this.workerLastVirtualTaskTimestamp.get(worker)?.end ?? 0
-      if (
-        workerLastVirtualTaskEndTimestamp < minWorkerVirtualTaskEndTimestamp
-      ) {
-        minWorkerVirtualTaskEndTimestamp = workerLastVirtualTaskEndTimestamp
-        chosenWorker = worker
+    let chosenWorkerNodeKey!: number
+    for (const [workerNodeKey] of this.pool.workerNodes.entries()) {
+      if (this.workersVirtualTaskEndTimestamp[workerNodeKey] == null) {
+        this.computeWorkerVirtualTaskEndTimestamp(workerNodeKey)
+      }
+      const workerVirtualTaskEndTimestamp =
+        this.workersVirtualTaskEndTimestamp[workerNodeKey]
+      if (workerVirtualTaskEndTimestamp < minWorkerVirtualTaskEndTimestamp) {
+        minWorkerVirtualTaskEndTimestamp = workerVirtualTaskEndTimestamp
+        chosenWorkerNodeKey = workerNodeKey
       }
     }
-    return chosenWorker
+    return chosenWorkerNodeKey
+  }
+
+  /** @inheritDoc */
+  public remove (workerNodeKey: number): boolean {
+    this.workersVirtualTaskEndTimestamp.splice(workerNodeKey, 1)
+    return true
   }
 
   /**
-   * Computes worker last virtual task timestamp.
+   * Computes the worker node key virtual task end timestamp.
    *
-   * @param worker - The worker.
+   * @param workerNodeKey - The worker node key.
    */
-  private computeWorkerLastVirtualTaskTimestamp (worker: Worker): void {
-    const workerVirtualTaskStartTimestamp = Math.max(
-      Date.now(),
-      this.workerLastVirtualTaskTimestamp.get(worker)?.end ?? -Infinity
+  private computeWorkerVirtualTaskEndTimestamp (workerNodeKey: number): void {
+    this.workersVirtualTaskEndTimestamp[workerNodeKey] =
+      this.getWorkerVirtualTaskEndTimestamp(
+        workerNodeKey,
+        this.getWorkerVirtualTaskStartTimestamp(workerNodeKey)
+      )
+  }
+
+  private getWorkerVirtualTaskEndTimestamp (
+    workerNodeKey: number,
+    workerVirtualTaskStartTimestamp: number
+  ): number {
+    return (
+      workerVirtualTaskStartTimestamp + this.getWorkerTaskRunTime(workerNodeKey)
+    )
+  }
+
+  private getWorkerVirtualTaskStartTimestamp (workerNodeKey: number): number {
+    return Math.max(
+      performance.now(),
+      this.workersVirtualTaskEndTimestamp[workerNodeKey] ?? -Infinity
     )
-    this.workerLastVirtualTaskTimestamp.set(worker, {
-      start: workerVirtualTaskStartTimestamp,
-      end:
-        workerVirtualTaskStartTimestamp +
-        (this.pool.getWorkerAverageTasksRunTime(worker) ?? 0)
-    })
   }
 }