docs: merge pool internal interface to public

[poolifier.git] / src / pools / selection-strategies / weighted-round-robin-worker-choice-strategy.ts

diff --git a/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts b/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts
index fc9b069522c8366226836a28bac08518dc23b969..f4bac5d76c4e3b669bb5720b99c03b07eabc577d 100644 (file)
--- a/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts
@@ -1,8 +1,12 @@
-import { cpus } from 'os'
-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
+import { cpus } from 'node:os'
+import type { IWorker } from '../worker'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
-import type { RequiredStatistics } from './selection-strategies-types'
+import type {
+  IWorkerChoiceStrategy,
+  RequiredStatistics,
+  WorkerChoiceStrategyOptions
+} from './selection-strategies-types'
+import type { IPool } from '../pool'
 
 /**
  * Virtual task runtime.
@@ -21,28 +25,32 @@ interface TaskRunTime {
  * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export class WeightedRoundRobinWorkerChoiceStrategy<
-  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
   }
 
   /**
-   * Worker id where the current task will be submitted.
+   * Worker node id where the current task will be submitted.
    */
-  private currentWorkerId: number = 0
+  private currentWorkerNodeId: number = 0
   /**
    * Default worker weight.
    */
   private readonly defaultWorkerWeight: number
   /**
-   * Per worker virtual task runtime map.
+   * Workers' virtual task runtime.
    */
-  private readonly workersTaskRunTime: Map<Worker, TaskRunTime> = new Map<
-  Worker,
+  private readonly workersTaskRunTime: Map<number, TaskRunTime> = new Map<
+  number,
   TaskRunTime
   >()
 
@@ -50,77 +58,102 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
    * Constructs a worker choice strategy that selects with a weighted round robin scheduling algorithm.
    *
    * @param pool - The pool instance.
+   * @param opts - The worker choice strategy options.
    */
-  public constructor (pool: IPoolInternal<Worker, Data, Response>) {
-    super(pool)
+  public constructor (
+    pool: IPool<Worker, Data, Response>,
+    opts?: WorkerChoiceStrategyOptions
+  ) {
+    super(pool, opts)
     this.defaultWorkerWeight = this.computeWorkerWeight()
     this.initWorkersTaskRunTime()
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public reset (): boolean {
-    this.currentWorkerId = 0
+    this.currentWorkerNodeId = 0
     this.workersTaskRunTime.clear()
     this.initWorkersTaskRunTime()
     return true
   }
 
-  /** {@inheritDoc} */
-  public choose (): Worker {
-    const chosenWorker = this.pool.workers.get(this.currentWorkerId)
-      ?.worker as Worker
-    if (this.isDynamicPool && !this.workersTaskRunTime.has(chosenWorker)) {
-      this.initWorkerTaskRunTime(chosenWorker)
+  /** @inheritDoc */
+  public choose (): number {
+    const chosenWorkerNodeKey = this.currentWorkerNodeId
+    if (
+      this.isDynamicPool &&
+      !this.workersTaskRunTime.has(chosenWorkerNodeKey)
+    ) {
+      this.initWorkerTaskRunTime(chosenWorkerNodeKey)
     }
     const workerTaskRunTime =
-      this.workersTaskRunTime.get(chosenWorker)?.runTime ?? 0
+      this.workersTaskRunTime.get(chosenWorkerNodeKey)?.runTime ?? 0
     const workerTaskWeight =
-      this.workersTaskRunTime.get(chosenWorker)?.weight ??
+      this.workersTaskRunTime.get(chosenWorkerNodeKey)?.weight ??
       this.defaultWorkerWeight
     if (workerTaskRunTime < workerTaskWeight) {
       this.setWorkerTaskRunTime(
-        chosenWorker,
+        chosenWorkerNodeKey,
         workerTaskWeight,
         workerTaskRunTime +
-          (this.getWorkerVirtualTaskRunTime(chosenWorker) ?? 0)
+          (this.getWorkerVirtualTaskRunTime(chosenWorkerNodeKey) ?? 0)
       )
     } else {
-      this.currentWorkerId =
-        this.currentWorkerId === this.pool.workers.size - 1
+      this.currentWorkerNodeId =
+        this.currentWorkerNodeId === this.pool.workerNodes.length - 1
           ? 0
-          : this.currentWorkerId + 1
-      this.setWorkerTaskRunTime(
-        this.pool.workers.get(this.currentWorkerId)?.worker as Worker,
-        workerTaskWeight,
-        0
-      )
+          : this.currentWorkerNodeId + 1
+      this.setWorkerTaskRunTime(this.currentWorkerNodeId, workerTaskWeight, 0)
+    }
+    return chosenWorkerNodeKey
+  }
+
+  /** @inheritDoc */
+  public remove (workerNodeKey: number): boolean {
+    if (this.currentWorkerNodeId === workerNodeKey) {
+      if (this.pool.workerNodes.length === 0) {
+        this.currentWorkerNodeId = 0
+      } else {
+        this.currentWorkerNodeId =
+          this.currentWorkerNodeId > this.pool.workerNodes.length - 1
+            ? this.pool.workerNodes.length - 1
+            : this.currentWorkerNodeId
+      }
+    }
+    const deleted = this.workersTaskRunTime.delete(workerNodeKey)
+    for (const [key, value] of this.workersTaskRunTime) {
+      if (key > workerNodeKey) {
+        this.workersTaskRunTime.set(key - 1, value)
+      }
     }
-    return chosenWorker
+    return deleted
   }
 
   private initWorkersTaskRunTime (): void {
-    for (const value of this.pool.workers.values()) {
-      this.initWorkerTaskRunTime(value.worker)
+    for (const [index] of this.pool.workerNodes.entries()) {
+      this.initWorkerTaskRunTime(index)
     }
   }
 
-  private initWorkerTaskRunTime (worker: Worker): void {
-    this.setWorkerTaskRunTime(worker, this.defaultWorkerWeight, 0)
+  private initWorkerTaskRunTime (workerNodeKey: number): void {
+    this.setWorkerTaskRunTime(workerNodeKey, this.defaultWorkerWeight, 0)
   }
 
   private setWorkerTaskRunTime (
-    worker: Worker,
+    workerNodeKey: number,
     weight: number,
     runTime: number
   ): void {
-    this.workersTaskRunTime.set(worker, {
+    this.workersTaskRunTime.set(workerNodeKey, {
       weight,
       runTime
     })
   }
 
-  private getWorkerVirtualTaskRunTime (worker: Worker): number | undefined {
-    return this.pool.getWorkerAverageTasksRunTime(worker)
+  private getWorkerVirtualTaskRunTime (workerNodeKey: number): number {
+    return this.requiredStatistics.medRunTime
+      ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
+      : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
   }
 
   private computeWorkerWeight (): number {