X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=ac2ee6c3ca6b97f96c0e16a8ccf04e9557246090;hb=3c93feb918b47943d801029fad82a61469e40127;hp=137c1be7562e50309818763f556651aed2034b04;hpb=6533c3e6b6a95daade8d20577d6b816512e2aeeb;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 137c1be7..ac2ee6c3 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -1,6 +1,3 @@
-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
-
 /**
  * Enumeration of worker choice strategies.
  */
@@ -10,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.
    */
@@ -24,7 +27,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)
 
 /**
@@ -33,45 +42,157 @@ export const WorkerChoiceStrategies = Object.freeze({
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
 /**
- * Pool worker tasks usage statistics requirements.
+ * Enumeration of measurements.
  */
-export interface RequiredStatistics {
-  runTime: boolean
-  avgRunTime: boolean
+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 interface.
+ * Worker choice strategy options.
+ */
+export interface WorkerChoiceStrategyOptions {
+  /**
+   * Measurement to use for worker choice strategy.
+   */
+  measurement?: Measurement
+  /**
+   * 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
+ */
+export interface MeasurementStatisticsRequirements {
+  /**
+   * Require measurement aggregate.
+   */
+  aggregate: boolean
+  /**
+   * Require measurement average.
+   */
+  average: boolean
+  /**
+   * Require measurement median.
+   */
+  median: boolean
+}
+
+/**
+ * Pool worker node worker usage statistics requirements.
+ *
+ * @internal
+ */
+export interface TaskStatisticsRequirements {
+  /**
+   * Tasks runtime requirements.
+   */
+  runTime: MeasurementStatisticsRequirements
+  /**
+   * Tasks wait time requirements.
+   */
+  waitTime: MeasurementStatisticsRequirements
+  /**
+   * Tasks event loop utilization requirements.
+   */
+  elu: MeasurementStatisticsRequirements
+}
+
+/**
+ * Strategy policy.
+ *
+ * @internal
  */
-export interface IWorkerChoiceStrategy<
-  Worker extends IPoolWorker,
-  Data = unknown,
-  Response = unknown
-> {
+export interface StrategyPolicy {
   /**
-   * The pool instance.
+   * Expects direct usage of dynamic worker.
    */
-  readonly pool: IPoolInternal<Worker, Data, Response>
+  useDynamicWorker: boolean
+}
+
+/**
+ * Worker choice strategy interface.
+ */
+export interface IWorkerChoiceStrategy {
   /**
-   * Is the pool bound to the strategy dynamic?.
+   * Strategy policy.
    */
-  readonly isDynamicPool: boolean
+  readonly strategyPolicy: StrategyPolicy
   /**
-   * Required pool tasks usage statistics.
+   * Tasks statistics requirements.
    */
-  readonly requiredStatistics: RequiredStatistics
+  readonly taskStatisticsRequirements: TaskStatisticsRequirements
   /**
-   * Resets strategy internals (counters, statistics, etc.).
+   * Resets strategy internals.
+   *
+   * @returns `true` if the reset is successful, `false` otherwise.
    */
   reset: () => boolean
   /**
-   * Chooses a worker in the pool and returns its key.
+   * 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
   /**
-   * Removes a worker reference from strategy internals.
+   * 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
+  /**
+   * Sets the worker choice strategy options.
    *
-   * @param workerKey - The worker key.
+   * @param opts - The worker choice strategy options.
    */
-  remove: (workerKey: number) => boolean
+  setOptions: (opts: WorkerChoiceStrategyOptions) => void
 }