Merge pull request #1063 from poolifier/dependabot/npm_and_yarn/examples/typescript...
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
index cd969ccd69d99fed15d08e9cca74450d424df5aa..3c41dd6ffee305c8eb2f51f593df022d8889745b 100644 (file)
@@ -7,6 +7,7 @@ import type { IPool } from '../pool'
 import type { IWorker } from '../worker'
 import type {
   IWorkerChoiceStrategy,
+  MeasurementStatisticsRequirements,
   StrategyPolicy,
   TaskStatisticsRequirements,
   WorkerChoiceStrategyOptions
@@ -24,19 +25,20 @@ export abstract class AbstractWorkerChoiceStrategy<
   Data = unknown,
   Response = unknown
 > implements IWorkerChoiceStrategy {
-  // /**
-  //  * Toggles finding the last free worker node key.
-  //  */
-  // private toggleFindLastFreeWorkerNodeKey: boolean = false
+  /**
+   * The next worker node key.
+   */
+  protected nextWorkerNodeKey: number | undefined = 0
 
   /**
-   * Id of the next worker node.
+   * The previous worker node key.
    */
-  protected nextWorkerNodeId: number = 0
+  protected previousWorkerNodeKey: number = 0
 
   /** @inheritDoc */
   public readonly strategyPolicy: StrategyPolicy = {
-    useDynamicWorker: false
+    dynamicWorkerUsage: false,
+    dynamicWorkerReady: true
   }
 
   /** @inheritDoc */
@@ -56,60 +58,46 @@ export abstract class AbstractWorkerChoiceStrategy<
     protected readonly pool: IPool<Worker, Data, Response>,
     protected opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
   ) {
+    this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts }
     this.choose = this.choose.bind(this)
   }
 
   protected setTaskStatisticsRequirements (
     opts: WorkerChoiceStrategyOptions
   ): void {
-    if (
-      this.taskStatisticsRequirements.runTime.average &&
-      opts.runTime?.median === true
-    ) {
-      this.taskStatisticsRequirements.runTime.average = false
-      this.taskStatisticsRequirements.runTime.median = opts.runTime
-        .median as boolean
-    }
-    if (
-      this.taskStatisticsRequirements.runTime.median &&
-      opts.runTime?.median === false
-    ) {
-      this.taskStatisticsRequirements.runTime.average = true
-      this.taskStatisticsRequirements.runTime.median = opts.runTime
-        .median as boolean
-    }
-    if (
-      this.taskStatisticsRequirements.waitTime.average &&
-      opts.waitTime?.median === true
-    ) {
-      this.taskStatisticsRequirements.waitTime.average = false
-      this.taskStatisticsRequirements.waitTime.median = opts.waitTime
-        .median as boolean
-    }
-    if (
-      this.taskStatisticsRequirements.waitTime.median &&
-      opts.waitTime?.median === false
-    ) {
-      this.taskStatisticsRequirements.waitTime.average = true
-      this.taskStatisticsRequirements.waitTime.median = opts.waitTime
-        .median as boolean
-    }
-    if (
-      this.taskStatisticsRequirements.elu.average &&
-      opts.elu?.median === true
-    ) {
-      this.taskStatisticsRequirements.elu.average = false
-      this.taskStatisticsRequirements.elu.median = opts.elu.median as boolean
+    this.toggleMedianMeasurementStatisticsRequirements(
+      this.taskStatisticsRequirements.runTime,
+      opts.runTime?.median as boolean
+    )
+    this.toggleMedianMeasurementStatisticsRequirements(
+      this.taskStatisticsRequirements.waitTime,
+      opts.waitTime?.median as boolean
+    )
+    this.toggleMedianMeasurementStatisticsRequirements(
+      this.taskStatisticsRequirements.elu,
+      opts.elu?.median as boolean
+    )
+  }
+
+  private toggleMedianMeasurementStatisticsRequirements (
+    measurementStatisticsRequirements: MeasurementStatisticsRequirements,
+    toggleMedian: boolean
+  ): void {
+    if (measurementStatisticsRequirements.average && toggleMedian) {
+      measurementStatisticsRequirements.average = false
+      measurementStatisticsRequirements.median = toggleMedian
     }
-    if (
-      this.taskStatisticsRequirements.elu.median &&
-      opts.elu?.median === false
-    ) {
-      this.taskStatisticsRequirements.elu.average = true
-      this.taskStatisticsRequirements.elu.median = opts.elu.median as boolean
+    if (measurementStatisticsRequirements.median && !toggleMedian) {
+      measurementStatisticsRequirements.average = true
+      measurementStatisticsRequirements.median = toggleMedian
     }
   }
 
+  protected resetWorkerNodeKeyProperties (): void {
+    this.nextWorkerNodeKey = 0
+    this.previousWorkerNodeKey = 0
+  }
+
   /** @inheritDoc */
   public abstract reset (): boolean
 
@@ -117,30 +105,52 @@ export abstract class AbstractWorkerChoiceStrategy<
   public abstract update (workerNodeKey: number): boolean
 
   /** @inheritDoc */
-  public abstract choose (): number
+  public abstract choose (): number | undefined
 
   /** @inheritDoc */
   public abstract remove (workerNodeKey: number): boolean
 
   /** @inheritDoc */
   public setOptions (opts: WorkerChoiceStrategyOptions): void {
-    this.opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+    this.opts = { ...DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS, ...opts }
     this.setTaskStatisticsRequirements(this.opts)
   }
 
-  // /**
-  //  * Finds a free worker node key.
-  //  *
-  //  * @returns The free worker node key or `-1` if there is no free worker node.
-  //  */
-  // protected findFreeWorkerNodeKey (): number {
-  //   if (this.toggleFindLastFreeWorkerNodeKey) {
-  //     this.toggleFindLastFreeWorkerNodeKey = false
-  //     return this.findLastFreeWorkerNodeKey()
-  //   }
-  //   this.toggleFindLastFreeWorkerNodeKey = true
-  //   return this.findFirstFreeWorkerNodeKey()
-  // }
+  /**
+   * Whether the worker node is ready or not.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns Whether the worker node is ready or not.
+   */
+  private isWorkerNodeReady (workerNodeKey: number): boolean {
+    return this.pool.workerNodes[workerNodeKey].info.ready
+  }
+
+  /**
+   * Whether the worker node has back pressure or not (i.e. its tasks queue is full).
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns `true` if the worker node has back pressure, `false` otherwise.
+   */
+  private hasWorkerNodeBackPressure (workerNodeKey: number): boolean {
+    return this.pool.hasWorkerNodeBackPressure(workerNodeKey)
+  }
+
+  /**
+   * Whether the worker node is eligible or not.
+   * A worker node is eligible if it is ready and does not have back pressure.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns `true` if the worker node is eligible, `false` otherwise.
+   * @see {@link isWorkerNodeReady}
+   * @see {@link hasWorkerNodeBackPressure}
+   */
+  protected isWorkerNodeEligible (workerNodeKey: number): boolean {
+    return (
+      this.isWorkerNodeReady(workerNodeKey) &&
+      !this.hasWorkerNodeBackPressure(workerNodeKey)
+    )
+  }
 
   /**
    * Gets the worker task runtime.
@@ -152,8 +162,8 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   protected getWorkerTaskRunTime (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.runTime.median
-      ? this.pool.workerNodes[workerNodeKey].usage.runTime.median
-      : this.pool.workerNodes[workerNodeKey].usage.runTime.average
+      ? this.pool.workerNodes[workerNodeKey].usage.runTime?.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.runTime?.average ?? 0
   }
 
   /**
@@ -166,8 +176,8 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   protected getWorkerTaskWaitTime (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.waitTime.median
-      ? this.pool.workerNodes[workerNodeKey].usage.waitTime.median
-      : this.pool.workerNodes[workerNodeKey].usage.waitTime.average
+      ? this.pool.workerNodes[workerNodeKey].usage.waitTime?.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.waitTime?.average ?? 0
   }
 
   /**
@@ -180,8 +190,26 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   protected getWorkerTaskElu (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.elu.median
-      ? this.pool.workerNodes[workerNodeKey].usage.elu.active.median
-      : this.pool.workerNodes[workerNodeKey].usage.elu.active.average
+      ? this.pool.workerNodes[workerNodeKey].usage.elu.active?.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.elu.active?.average ?? 0
+  }
+
+  /**
+   * Sets safely the previous worker node key.
+   *
+   * @param workerNodeKey - The worker node key.
+   */
+  protected setPreviousWorkerNodeKey (workerNodeKey: number | undefined): void {
+    this.previousWorkerNodeKey = workerNodeKey ?? this.previousWorkerNodeKey
+  }
+
+  /**
+   * Check the next worker node eligibility.
+   */
+  protected checkNextWorkerNodeEligibility (): void {
+    if (!this.isWorkerNodeEligible(this.nextWorkerNodeKey as number)) {
+      this.nextWorkerNodeKey = undefined
+    }
   }
 
   protected computeDefaultWorkerWeight (): number {
@@ -194,45 +222,4 @@ export abstract class AbstractWorkerChoiceStrategy<
     }
     return Math.round(cpusCycleTimeWeight / cpus().length)
   }
-
-  // /**
-  //  * Finds the first free worker node key based on the number of tasks the worker has applied.
-  //  *
-  //  * If a worker is found with `0` executing tasks, it is detected as free and its worker node key is returned.
-  //  *
-  //  * If no free worker is found, `-1` is returned.
-  //  *
-  //  * @returns A worker node key if there is one, `-1` otherwise.
-  //  */
-  // private findFirstFreeWorkerNodeKey (): number {
-  //   return this.pool.workerNodes.findIndex(workerNode => {
-  //     return workerNode.usage.tasks.executing === 0
-  //   })
-  // }
-
-  // /**
-  //  * Finds the last free worker node key based on the number of tasks the worker has applied.
-  //  *
-  //  * If a worker is found with `0` executing tasks, it is detected as free and its worker node key is returned.
-  //  *
-  //  * If no free worker is found, `-1` is returned.
-  //  *
-  //  * @returns A worker node key if there is one, `-1` otherwise.
-  //  */
-  // private findLastFreeWorkerNodeKey (): number {
-  //   // It requires node >= 18.0.0:
-  //   // return this.pool.workerNodes.findLastIndex(workerNode => {
-  //   //   return workerNode.usage.tasks.executing === 0
-  //   // })
-  //   for (
-  //     let workerNodeKey = this.pool.workerNodes.length - 1;
-  //     workerNodeKey >= 0;
-  //     workerNodeKey--
-  //   ) {
-  //     if (this.pool.workerNodes[workerNodeKey].usage.tasks.executing === 0) {
-  //       return workerNodeKey
-  //     }
-  //   }
-  //   return -1
-  // }
 }