build(deps-dev): apply updates
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
index a060cea3a5ba4486059fec1f6b45dac515f155e3..6bd4fe741ce403b282034ba4d3559a3faf93bbfa 100644 (file)
@@ -1,5 +1,8 @@
 import { cpus } from 'node:os'
-import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
+import {
+  DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+  DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+} from '../../utils'
 import type { IPool } from '../pool'
 import type { IWorker } from '../worker'
 import type {
@@ -13,8 +16,8 @@ import type {
  * Worker choice strategy abstract base class.
  *
  * @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 execution response. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  */
 export abstract class AbstractWorkerChoiceStrategy<
   Worker extends IWorker,
@@ -22,9 +25,9 @@ export abstract class AbstractWorkerChoiceStrategy<
   Response = unknown
 > implements IWorkerChoiceStrategy {
   /**
-   * Toggles finding the last free worker node key.
+   * The next worker node key.
    */
-  private toggleFindLastFreeWorkerNodeKey: boolean = false
+  protected nextWorkerNodeKey: number = 0
 
   /** @inheritDoc */
   public readonly strategyPolicy: StrategyPolicy = {
@@ -33,21 +36,9 @@ export abstract class AbstractWorkerChoiceStrategy<
 
   /** @inheritDoc */
   public readonly taskStatisticsRequirements: TaskStatisticsRequirements = {
-    runTime: {
-      aggregate: false,
-      average: false,
-      median: false
-    },
-    waitTime: {
-      aggregate: false,
-      average: false,
-      median: false
-    },
-    elu: {
-      aggregate: false,
-      average: false,
-      median: false
-    }
+    runTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+    waitTime: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
+    elu: DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS
   }
 
   /**
@@ -128,23 +119,18 @@ export abstract class AbstractWorkerChoiceStrategy<
 
   /** @inheritDoc */
   public setOptions (opts: WorkerChoiceStrategyOptions): void {
-    opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
-    this.setTaskStatisticsRequirements(opts)
-    this.opts = opts
+    this.opts = opts ?? DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+    this.setTaskStatisticsRequirements(this.opts)
   }
 
   /**
-   * Finds a free worker node key.
+   * Whether the worker node is ready or not.
    *
-   * @returns The free worker node key or `-1` if there is no free worker node.
+   * @param workerNodeKey - The worker node key.
+   * @returns Whether the worker node is ready or not.
    */
-  protected findFreeWorkerNodeKey (): number {
-    if (this.toggleFindLastFreeWorkerNodeKey) {
-      this.toggleFindLastFreeWorkerNodeKey = false
-      return this.findLastFreeWorkerNodeKey()
-    }
-    this.toggleFindLastFreeWorkerNodeKey = true
-    return this.findFirstFreeWorkerNodeKey()
+  protected isWorkerNodeReady (workerNodeKey: number): boolean {
+    return this.pool.workerNodes[workerNodeKey].info.ready
   }
 
   /**
@@ -157,8 +143,8 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   protected getWorkerTaskRunTime (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.runTime.median
-      ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
-      : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
+      ? this.pool.workerNodes[workerNodeKey].usage.runTime?.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.runTime?.average ?? 0
   }
 
   /**
@@ -171,8 +157,8 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   protected getWorkerTaskWaitTime (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.waitTime.median
-      ? this.pool.workerNodes[workerNodeKey].workerUsage.runTime.median
-      : this.pool.workerNodes[workerNodeKey].workerUsage.runTime.average
+      ? this.pool.workerNodes[workerNodeKey].usage.waitTime?.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.waitTime?.average ?? 0
   }
 
   /**
@@ -185,8 +171,8 @@ export abstract class AbstractWorkerChoiceStrategy<
    */
   protected getWorkerTaskElu (workerNodeKey: number): number {
     return this.taskStatisticsRequirements.elu.median
-      ? this.pool.workerNodes[workerNodeKey].workerUsage.elu.active.median
-      : this.pool.workerNodes[workerNodeKey].workerUsage.elu.active.average
+      ? this.pool.workerNodes[workerNodeKey].usage.elu.active?.median ?? 0
+      : this.pool.workerNodes[workerNodeKey].usage.elu.active?.average ?? 0
   }
 
   protected computeDefaultWorkerWeight (): number {
@@ -199,47 +185,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.workerUsage.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.workerNodes.findLastIndex(workerNode => {
-    //   return workerNode.workerUsage.tasks.executing === 0
-    // })
-    for (
-      let workerNodeKey = this.pool.workerNodes.length - 1;
-      workerNodeKey >= 0;
-      workerNodeKey--
-    ) {
-      if (
-        this.pool.workerNodes[workerNodeKey].workerUsage.tasks.executing === 0
-      ) {
-        return workerNodeKey
-      }
-    }
-    return -1
-  }
 }