X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=4377624e97a1d316dba60687870ac6308d44b158;hb=f6bc9f26d8a0246bbee14b2b03d0bcc41b8aeb52;hp=6ae695ca6dca6141d48cef31dd46c6be5cb08bbb;hpb=613889b35f00a9f80665bdfd3d021f53b74db43e;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 6ae695ca..4377624e 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -7,13 +7,19 @@ export const WorkerChoiceStrategies = Object.freeze({
    */
   ROUND_ROBIN: 'ROUND_ROBIN',
   /**
-   * Less used worker selection strategy.
+   * Least used worker selection strategy.
    */
-  LESS_USED: 'LESS_USED',
+  LEAST_USED: 'LEAST_USED',
   /**
-   * Less busy worker selection strategy.
+   * Least busy worker selection strategy.
    */
-  LESS_BUSY: 'LESS_BUSY',
+  LEAST_BUSY: 'LEAST_BUSY',
+  /**
+   * Least ELU worker selection strategy.
+   *
+   * @experimental
+   */
+  LEAST_ELU: 'LEAST_ELU',
   /**
    * Fair share worker selection strategy.
    */
@@ -35,82 +41,171 @@ 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.
+   */
+  readonly median: boolean
+}
+
 /**
  * Worker choice strategy options.
  */
 export interface WorkerChoiceStrategyOptions {
   /**
-   * Use tasks median run time instead of average run time.
+   * Number of worker choice retries to perform if no worker is eligible.
+   *
+   * @defaultValue 6
+   */
+  readonly choiceRetries?: number
+  /**
+   * Measurement to use in worker choice strategy supporting it.
+   */
+  readonly measurement?: Measurement
+  /**
+   * Runtime options.
+   *
+   * @defaultValue \{ median: false \}
+   */
+  readonly runTime?: MeasurementOptions
+  /**
+   * Wait time options.
+   *
+   * @defaultValue \{ median: false \}
+   */
+  readonly waitTime?: MeasurementOptions
+  /**
+   * Event loop utilization options.
    *
-   * @defaultValue false
+   * @defaultValue \{ median: false \}
    */
-  medRunTime?: boolean
+  readonly 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>
+  readonly weights?: Record<number, number>
+}
+
+/**
+ * Measurement statistics requirements.
+ *
+ * @internal
+ */
+export interface MeasurementStatisticsRequirements {
+  /**
+   * Requires measurement aggregate.
+   */
+  aggregate: boolean
+  /**
+   * Requires measurement average.
+   */
+  average: boolean
+  /**
+   * Requires measurement median.
+   */
+  median: boolean
 }
 
 /**
- * Pool worker tasks usage statistics requirements.
+ * Pool worker node worker usage statistics requirements.
  *
  * @internal
  */
-export interface RequiredStatistics {
+export interface TaskStatisticsRequirements {
   /**
-   * Require tasks run time.
+   * Tasks runtime requirements.
    */
-  runTime: boolean
+  readonly runTime: MeasurementStatisticsRequirements
   /**
-   * Require tasks average run time.
+   * Tasks wait time requirements.
    */
-  avgRunTime: boolean
+  readonly waitTime: MeasurementStatisticsRequirements
   /**
-   * Require tasks median run time.
+   * Tasks event loop utilization requirements.
    */
-  medRunTime: boolean
+  readonly elu: MeasurementStatisticsRequirements
+}
+
+/**
+ * Strategy policy.
+ *
+ * @internal
+ */
+export interface StrategyPolicy {
+  /**
+   * Expects tasks execution on the newly created dynamic worker.
+   */
+  readonly dynamicWorkerUsage: boolean
+  /**
+   * Expects the newly created dynamic worker to be flagged as ready.
+   */
+  readonly dynamicWorkerReady: boolean
 }
 
 /**
  * Worker choice strategy interface.
+ *
+ * @internal
  */
 export interface IWorkerChoiceStrategy {
   /**
-   * Required tasks usage statistics.
+   * Strategy policy.
+   */
+  readonly strategyPolicy: StrategyPolicy
+  /**
+   * Tasks statistics requirements.
    */
-  readonly requiredStatistics: RequiredStatistics
+  readonly taskStatisticsRequirements: TaskStatisticsRequirements
   /**
    * Resets strategy internals.
    *
    * @returns `true` if the reset is successful, `false` otherwise.
    */
-  reset: () => boolean
+  readonly reset: () => boolean
   /**
    * Updates the worker node key strategy internals.
    *
    * @returns `true` if the update is successful, `false` otherwise.
    */
-  update: (workerNodeKey: number) => boolean
+  readonly update: (workerNodeKey: number) => boolean
   /**
    * Chooses a worker node in the pool and returns its key.
+   * If the worker node is not eligible, `undefined` is returned.
    *
-   * @returns The worker node key.
+   * @returns The worker node key or `undefined`.
    */
-  choose: () => number
+  readonly choose: () => number | undefined
   /**
    * 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.
    */
-  remove: (workerNodeKey: number) => boolean
+  readonly remove: (workerNodeKey: number) => boolean
   /**
    * Sets the worker choice strategy options.
    *
    * @param opts - The worker choice strategy options.
    */
-  setOptions: (opts: WorkerChoiceStrategyOptions) => void
+  readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void
 }