X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=1a8ea298198d842bd8cd622f74abb6a30f7b28fc;hb=b358c8aca5934f7d5dc4bd234d1909ba13850ea9;hp=d132c877fc6f9d8d25010206922e516cdb259168;hpb=c93c0a1bcdf41b33f90a654e55d71f4cc14ab963;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index d132c877..1a8ea298 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -1,19 +1,31 @@
 /**
  * Enumeration of worker choice strategies.
  */
-export const WorkerChoiceStrategies = Object.freeze({
+export const WorkerChoiceStrategies: Readonly<{
+  ROUND_ROBIN: 'ROUND_ROBIN'
+  LEAST_USED: 'LEAST_USED'
+  LEAST_BUSY: 'LEAST_BUSY'
+  LEAST_ELU: 'LEAST_ELU'
+  FAIR_SHARE: 'FAIR_SHARE'
+  WEIGHTED_ROUND_ROBIN: 'WEIGHTED_ROUND_ROBIN'
+  INTERLEAVED_WEIGHTED_ROUND_ROBIN: 'INTERLEAVED_WEIGHTED_ROUND_ROBIN'
+}> = Object.freeze({
   /**
    * Round robin worker selection strategy.
    */
   ROUND_ROBIN: 'ROUND_ROBIN',
   /**
-   * Less used worker selection strategy.
+   * Least used worker selection strategy.
+   */
+  LEAST_USED: 'LEAST_USED',
+  /**
+   * Least busy worker selection strategy.
    */
-  LESS_USED: 'LESS_USED',
+  LEAST_BUSY: 'LEAST_BUSY',
   /**
-   * Less busy worker selection strategy.
+   * Least ELU worker selection strategy.
    */
-  LESS_BUSY: 'LESS_BUSY',
+  LEAST_ELU: 'LEAST_ELU',
   /**
    * Fair share worker selection strategy.
    */
@@ -21,7 +33,13 @@ export const WorkerChoiceStrategies = Object.freeze({
   /**
    * 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)
 
 /**
@@ -29,100 +47,171 @@ export const WorkerChoiceStrategies = Object.freeze({
  */
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
+/**
+ * Enumeration of measurements.
+ */
+export const Measurements: Readonly<{
+  runTime: 'runTime'
+  waitTime: 'waitTime'
+  elu: 'elu'
+}> = 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 runtime instead of average runtime.
+   * Measurement to use in worker choice strategy supporting it.
+   */
+  readonly measurement?: Measurement
+  /**
+   * Runtime options.
    *
-   * @defaultValue false
+   * @defaultValue \{ median: false \}
    */
-  medRunTime?: boolean
+  readonly runTime?: MeasurementOptions
   /**
-   * Use tasks median wait time instead of average runtime.
+   * Wait time options.
    *
-   * @defaultValue false
+   * @defaultValue \{ median: false \}
    */
-  medWaitTime?: boolean
+  readonly waitTime?: MeasurementOptions
   /**
-   * Worker weights to use for weighted round robin worker selection strategy.
-   * Weight is the tasks maximum average or median runtime in milliseconds.
+   * Event loop utilization options.
    *
-   * @defaultValue Computed worker weights automatically given the CPU performance.
+   * @defaultValue \{ median: false \}
+   */
+  readonly elu?: MeasurementOptions
+  /**
+   * Worker weights to use for weighted round robin worker selection strategies.
+   * A weight is tasks maximum execution time in milliseconds for a worker node.
+   *
+   * @defaultValue Weights computed automatically given the CPU performance.
    */
   weights?: Record<number, number>
 }
 
 /**
- * Pool worker tasks usage statistics requirements.
+ * Measurement statistics requirements.
  *
  * @internal
  */
-export interface RequiredStatistics {
+export interface MeasurementStatisticsRequirements {
+  /**
+   * Requires measurement aggregate.
+   */
+  aggregate: boolean
+  /**
+   * Requires measurement average.
+   */
+  average: boolean
   /**
-   * Require tasks runtime.
+   * Requires measurement median.
    */
-  runTime: boolean
+  median: boolean
+}
+
+/**
+ * Pool worker node worker usage statistics requirements.
+ *
+ * @internal
+ */
+export interface TaskStatisticsRequirements {
   /**
-   * Require tasks average runtime.
+   * Tasks runtime requirements.
    */
-  avgRunTime: boolean
+  readonly runTime: MeasurementStatisticsRequirements
   /**
-   * Require tasks median runtime.
+   * Tasks wait time requirements.
    */
-  medRunTime: boolean
+  readonly waitTime: MeasurementStatisticsRequirements
   /**
-   * Require tasks wait time.
+   * Tasks event loop utilization requirements.
    */
-  waitTime: boolean
+  readonly elu: MeasurementStatisticsRequirements
+}
+
+/**
+ * Strategy policy.
+ *
+ * @internal
+ */
+export interface StrategyPolicy {
   /**
-   * Require tasks average wait time.
+   * Expects tasks execution on the newly created dynamic worker.
    */
-  avgWaitTime: boolean
+  readonly dynamicWorkerUsage: boolean
   /**
-   * Require tasks median wait time.
+   * Expects the newly created dynamic worker to be flagged as ready.
    */
-  medWaitTime: boolean
+  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.
+   * This is called after a task has been executed on a worker node.
    *
    * @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 no worker nodes are not eligible, `undefined` is returned.
+   * If `undefined` is returned, the caller retry.
    *
-   * @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 | undefined) => void
 }