feat: add statistics accounting to ELU fields

[poolifier.git] / src / pools / selection-strategies / selection-strategies-types.ts

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 359cfb948c6334dc507a3d0894149790aef584f9..c578ddc3f9fb24e289f5caf8fa542ec402d63834 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -1,5 +1,3 @@
-import type { AbstractPoolWorker } from '../abstract-pool-worker'
-
 /**
  * Enumeration of worker choice strategies.
  */
@@ -9,13 +7,33 @@ export const WorkerChoiceStrategies = Object.freeze({
    */
   ROUND_ROBIN: 'ROUND_ROBIN',
   /**
-   * Less recently used worker selection strategy.
+   * Least used worker selection strategy.
+   */
+  LEAST_USED: 'LEAST_USED',
+  /**
+   * Least busy worker selection strategy.
+   */
+  LEAST_BUSY: 'LEAST_BUSY',
+  /**
+   * Least ELU worker selection strategy.
+   *
+   * @experimental
+   */
+  LEAST_ELU: 'LEAST_ELU',
+  /**
+   * Fair share worker selection strategy.
    */
-  LESS_RECENTLY_USED: 'LESS_RECENTLY_USED',
+  FAIR_SHARE: 'FAIR_SHARE',
   /**
    * Weighted round robin worker selection strategy.
    */
-  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
+  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN',
+  /**
+   * Interleaved weighted round robin worker selection strategy.
+   *
+   * @experimental
+   */
+  INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
 } as const)
 
 /**
@@ -24,17 +42,123 @@ export const WorkerChoiceStrategies = Object.freeze({
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
 /**
- * Worker choice strategy interface.
+ * Measurement options.
+ */
+interface MeasurementOptions {
+  /**
+   * Set measurement median.
+   */
+  median: boolean
+}
+
+/**
+ * Worker choice strategy options.
+ */
+export interface WorkerChoiceStrategyOptions {
+  /**
+   * Runtime options.
+   *
+   * @defaultValue \{ median: false \}
+   */
+  runTime?: MeasurementOptions
+  /**
+   * Wait time options.
+   *
+   * @defaultValue \{ median: false \}
+   */
+  waitTime?: MeasurementOptions
+  /**
+   * Event loop utilization options.
+   *
+   * @defaultValue \{ median: false \}
+   */
+  elu?: MeasurementOptions
+  /**
+   * Worker weights to use for weighted round robin worker selection strategy.
+   * Weight is the tasks maximum average or median runtime in milliseconds.
+   *
+   * @defaultValue Computed worker weights automatically given the CPU performance.
+   */
+  weights?: Record<number, number>
+}
+
+/**
+ * Measurement statistics requirements.
+ *
+ * @internal
+ */
+interface MeasurementStatisticsRequirements {
+  /**
+   * Require measurement aggregate.
+   */
+  aggregate: boolean
+  /**
+   * Require measurement average.
+   */
+  average: boolean
+  /**
+   * Require measurement median.
+   */
+  median: boolean
+}
+
+/**
+ * Pool worker node worker usage statistics requirements.
  *
- * @template Worker Type of worker which manages the strategy.
+ * @internal
  */
-export interface IWorkerChoiceStrategy<Worker extends AbstractPoolWorker> {
+export interface TaskStatisticsRequirements {
+  /**
+   * Tasks runtime requirements.
+   */
+  runTime: MeasurementStatisticsRequirements
+  /**
+   * Tasks wait time requirements.
+   */
+  waitTime: MeasurementStatisticsRequirements
+  /**
+   * Tasks event loop utilization requirements.
+   */
+  elu: MeasurementStatisticsRequirements
+}
+
+/**
+ * Worker choice strategy interface.
+ */
+export interface IWorkerChoiceStrategy {
+  /**
+   * Tasks statistics requirements.
+   */
+  readonly taskStatisticsRequirements: TaskStatisticsRequirements
+  /**
+   * Resets strategy internals.
+   *
+   * @returns `true` if the reset is successful, `false` otherwise.
+   */
+  reset: () => boolean
+  /**
+   * Updates the worker node key strategy internals.
+   *
+   * @returns `true` if the update is successful, `false` otherwise.
+   */
+  update: (workerNodeKey: number) => boolean
+  /**
+   * Chooses a worker node in the pool and returns its key.
+   *
+   * @returns The worker node key.
+   */
+  choose: () => number
   /**
-   * Is the pool attached to the strategy dynamic?.
+   * Removes the worker node key from strategy internals.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns `true` if the worker node key is removed, `false` otherwise.
    */
-  isDynamicPool: boolean
+  remove: (workerNodeKey: number) => boolean
   /**
-   * Choose a worker in the pool.
+   * Sets the worker choice strategy options.
+   *
+   * @param opts - The worker choice strategy options.
    */
-  choose(): Worker
+  setOptions: (opts: WorkerChoiceStrategyOptions) => void
 }