Merge branch 'master' into interleaved-weighted-round-robin-worker-choice-strategy
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
index 9aabdfd29d3a512df229b7b28bcfe631eaae2804..d969f0c0ad5ca224de0d30356d517821b1e76c3c 100644 (file)
@@ -43,7 +43,7 @@ export abstract class AbstractWorkerChoiceStrategy<
     this.choose = this.choose.bind(this)
   }
 
-  protected checkOptions (opts: WorkerChoiceStrategyOptions): void {
+  protected setRequiredStatistics (opts: WorkerChoiceStrategyOptions): void {
     if (this.requiredStatistics.avgRunTime && opts.medRunTime === true) {
       this.requiredStatistics.avgRunTime = false
       this.requiredStatistics.medRunTime = opts.medRunTime as boolean
@@ -52,21 +52,13 @@ export abstract class AbstractWorkerChoiceStrategy<
       this.requiredStatistics.avgRunTime = true
       this.requiredStatistics.medRunTime = opts.medRunTime as boolean
     }
-    if (
-      opts.weights != null &&
-      Object.keys(opts.weights).length < this.pool.size
-    ) {
-      throw new Error(
-        'Worker choice strategy options must have a weight for each worker node.'
-      )
-    }
   }
 
   /** @inheritDoc */
   public abstract reset (): boolean
 
   /** @inheritDoc */
-  public abstract update (): boolean
+  public abstract update (workerNodeKey: number): boolean
 
   /** @inheritDoc */
   public abstract choose (): number
@@ -77,7 +69,7 @@ export abstract class AbstractWorkerChoiceStrategy<
   /** @inheritDoc */
   public setOptions (opts: WorkerChoiceStrategyOptions): void {
     opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
-    this.checkOptions(opts)
+    this.setRequiredStatistics(opts)
     this.opts = opts
   }
 
@@ -95,6 +87,20 @@ export abstract class AbstractWorkerChoiceStrategy<
     return this.findFirstFreeWorkerNodeKey()
   }
 
+  /**
+   * Gets the worker task runtime.
+   * If the required statistics are `avgRunTime`, the average runtime is returned.
+   * If the required statistics are `medRunTime`, the median runtime is returned.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns The worker task runtime.
+   */
+  protected getWorkerTaskRunTime (workerNodeKey: number): number {
+    return this.requiredStatistics.medRunTime
+      ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
+      : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
+  }
+
   /**
    * Finds the first free worker node key based on the number of tasks the worker has applied.
    *
@@ -106,7 +112,7 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   private findFirstFreeWorkerNodeKey (): number {
     return this.pool.workerNodes.findIndex(workerNode => {
-      return workerNode.tasksUsage?.running === 0
+      return workerNode.tasksUsage.running === 0
     })
   }
 
@@ -122,11 +128,15 @@ export abstract class AbstractWorkerChoiceStrategy<
   private findLastFreeWorkerNodeKey (): number {
     // It requires node >= 18.0.0:
     // return this.workerNodes.findLastIndex(workerNode => {
-    //   return workerNode.tasksUsage?.running === 0
+    //   return workerNode.tasksUsage.running === 0
     // })
-    for (let i = this.pool.workerNodes.length - 1; i >= 0; i--) {
-      if (this.pool.workerNodes[i].tasksUsage?.running === 0) {
-        return i
+    for (
+      let workerNodeKey = this.pool.workerNodes.length - 1;
+      workerNodeKey >= 0;
+      workerNodeKey--
+    ) {
+      if (this.pool.workerNodes[workerNodeKey].tasksUsage.running === 0) {
+        return workerNodeKey
       }
     }
     return -1