feat: add support for tasks ELU in fair share strategy

[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 b96bb029a0befe39ce438beb368e2c0dbecb87ab..b0b036ee9069893098507e91a6913e1948a2c82a 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -41,22 +41,56 @@ export const WorkerChoiceStrategies = Object.freeze({
  */
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
+/**
+ * Enumeration of measurements.
+ */
+export const Measurements = Object.freeze({
+  runTime: 'runTime',
+  waitTime: 'waitTime',
+  elu: 'elu'
+} as const)
+
+/**
+ * Measurement.
+ */
+export type Measurement = keyof typeof Measurements
+
+/**
+ * Measurement options.
+ */
+export interface MeasurementOptions {
+  /**
+   * Set measurement median.
+   */
+  median: boolean
+}
+
 /**
  * Worker choice strategy options.
  */
 export interface WorkerChoiceStrategyOptions {
   /**
-   * Use tasks median runtime instead of average runtime.
+   * Measurement to use for worker choice strategy.
+   */
+  measurement?: Measurement
+  /**
+   * Runtime options.
    *
-   * @defaultValue false
+   * @defaultValue \{ median: false \}
    */
-  medRunTime?: boolean
+  runTime?: MeasurementOptions
   /**
-   * Use tasks median wait time instead of average runtime.
+   * Wait time options.
    *
-   * @defaultValue false
+   * @defaultValue \{ median: false \}
    */
-  medWaitTime?: boolean
+  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.
@@ -67,39 +101,43 @@ export interface WorkerChoiceStrategyOptions {
 }
 
 /**
- * Pool worker tasks usage statistics requirements.
+ * Measurement statistics requirements.
  *
  * @internal
  */
-export interface TaskStatistics {
-  /**
-   * Require tasks runtime.
-   */
-  runTime: boolean
+export interface MeasurementStatisticsRequirements {
   /**
-   * Require tasks average runtime.
+   * Require measurement aggregate.
    */
-  avgRunTime: boolean
+  aggregate: boolean
   /**
-   * Require tasks median runtime.
+   * Require measurement average.
    */
-  medRunTime: boolean
+  average: boolean
   /**
-   * Require tasks wait time.
+   * Require measurement median.
    */
-  waitTime: boolean
+  median: boolean
+}
+
+/**
+ * Pool worker node worker usage statistics requirements.
+ *
+ * @internal
+ */
+export interface TaskStatisticsRequirements {
   /**
-   * Require tasks average wait time.
+   * Tasks runtime requirements.
    */
-  avgWaitTime: boolean
+  runTime: MeasurementStatisticsRequirements
   /**
-   * Require tasks median wait time.
+   * Tasks wait time requirements.
    */
-  medWaitTime: boolean
+  waitTime: MeasurementStatisticsRequirements
   /**
-   * Event loop utilization.
+   * Tasks event loop utilization requirements.
    */
-  elu: boolean
+  elu: MeasurementStatisticsRequirements
 }
 
 /**
@@ -107,9 +145,9 @@ export interface TaskStatistics {
  */
 export interface IWorkerChoiceStrategy {
   /**
-   * Required tasks statistics.
+   * Tasks statistics requirements.
    */
-  readonly taskStatistics: TaskStatistics
+  readonly taskStatisticsRequirements: TaskStatisticsRequirements
   /**
    * Resets strategy internals.
    *