docs: add changelog entry

[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts

diff --git a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
index fb3bf707386f8bdb2bb9aac23ccf6db9d851ac96..f1d7dcf405b2e565f150137aa87e4cab1a79bd6d 100644 (file)
--- a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -93,6 +93,11 @@ export abstract class AbstractWorkerChoiceStrategy<
     }
   }
 
+  protected resetWorkerNodeKeyProperties (): void {
+    this.nextWorkerNodeKey = 0
+    this.previousWorkerNodeKey = 0
+  }
+
   /** @inheritDoc */
   public abstract reset (): boolean
 
@@ -111,97 +116,79 @@ export abstract class AbstractWorkerChoiceStrategy<
     this.setTaskStatisticsRequirements(this.opts)
   }
 
-  /**
-   * 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
+  /** @inheritDoc */
+  public hasPoolWorkerNodesReady (): boolean {
+    return this.pool.workerNodes.some(workerNode => workerNode.info.ready)
   }
 
   /**
-   * Whether the worker node has back pressure or not (i.e. its tasks queue is full).
+   * Whether the worker node is ready or not.
    *
    * @param workerNodeKey - The worker node key.
-   * @returns `true` if the worker node has back pressure, `false` otherwise.
+   * @returns Whether the worker node is ready or not.
    */
-  private hasWorkerNodeBackPressure (workerNodeKey: number): boolean {
-    return this.pool.hasWorkerNodeBackPressure(workerNodeKey)
+  protected isWorkerNodeReady (workerNodeKey: number): boolean {
+    return this.pool.workerNodes[workerNodeKey]?.info?.ready ?? false
   }
 
   /**
-   * 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}
+   * Check the next worker node readiness.
    */
-  protected isWorkerNodeEligible (workerNodeKey: number): boolean {
-    return (
-      this.isWorkerNodeReady(workerNodeKey) &&
-      !this.hasWorkerNodeBackPressure(workerNodeKey)
-    )
+  protected checkNextWorkerNodeReadiness (): void {
+    if (!this.isWorkerNodeReady(this.nextWorkerNodeKey as number)) {
+      delete this.nextWorkerNodeKey
+    }
   }
 
   /**
-   * Gets the worker task runtime.
+   * Gets the worker node task runtime.
    * If the task statistics require the average runtime, the average runtime is returned.
    * If the task statistics require the median runtime , the median runtime is returned.
    *
    * @param workerNodeKey - The worker node key.
-   * @returns The worker task runtime.
+   * @returns The worker node task runtime.
    */
-  protected getWorkerTaskRunTime (workerNodeKey: number): number {
+  protected getWorkerNodeTaskRunTime (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.runTime.median
-      ? this.pool.workerNodes[workerNodeKey].usage.runTime?.median ?? 0
-      : this.pool.workerNodes[workerNodeKey].usage.runTime?.average ?? 0
+      ? this.pool.workerNodes[workerNodeKey].usage.runTime.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.runTime.average ?? 0
   }
 
   /**
-   * Gets the worker task wait time.
+   * Gets the worker node task wait time.
    * If the task statistics require the average wait time, the average wait time is returned.
    * If the task statistics require the median wait time, the median wait time is returned.
    *
    * @param workerNodeKey - The worker node key.
-   * @returns The worker task wait time.
+   * @returns The worker node task wait time.
    */
-  protected getWorkerTaskWaitTime (workerNodeKey: number): number {
+  protected getWorkerNodeTaskWaitTime (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.waitTime.median
-      ? this.pool.workerNodes[workerNodeKey].usage.waitTime?.median ?? 0
-      : this.pool.workerNodes[workerNodeKey].usage.waitTime?.average ?? 0
+      ? this.pool.workerNodes[workerNodeKey].usage.waitTime.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.waitTime.average ?? 0
   }
 
   /**
-   * Gets the worker task ELU.
+   * Gets the worker node task ELU.
    * If the task statistics require the average ELU, the average ELU is returned.
    * If the task statistics require the median ELU, the median ELU is returned.
    *
    * @param workerNodeKey - The worker node key.
-   * @returns The worker task ELU.
+   * @returns The worker node task ELU.
    */
-  protected getWorkerTaskElu (workerNodeKey: number): number {
+  protected getWorkerNodeTaskElu (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.elu.median
-      ? this.pool.workerNodes[workerNodeKey].usage.elu.active?.median ?? 0
-      : this.pool.workerNodes[workerNodeKey].usage.elu.active?.average ?? 0
+      ? this.pool.workerNodes[workerNodeKey].usage.elu.active.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.elu.active.average ?? 0
   }
 
   /**
-   * Assign to nextWorkerNodeKey property the chosen worker node key.
+   * Sets safely the previous worker node key.
    *
-   * @param chosenWorkerNodeKey - The chosen worker node key.
+   * @param workerNodeKey - The worker node key.
    */
-  protected assignChosenWorkerNodeKey (
-    chosenWorkerNodeKey: number | undefined
-  ): void {
-    if (chosenWorkerNodeKey != null) {
-      this.nextWorkerNodeKey = chosenWorkerNodeKey
-    } else {
-      this.nextWorkerNodeKey = undefined
-    }
+  protected setPreviousWorkerNodeKey (workerNodeKey: number | undefined): void {
+    this.previousWorkerNodeKey = workerNodeKey ?? this.previousWorkerNodeKey
   }
 
   protected computeDefaultWorkerWeight (): number {