X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fselection-strategies%2Fselection-strategies-types.ts;h=f499da7fc9d58458f9977910a18cc9246870ba7b;hb=0e8587d2e6bc29e14158c01948c625df9b11d381;hp=0fbb4d4d43165737d3bd3c0c7378b2c55d7e03d2;hpb=4a59691c9f48b3a6602510aeece809e2a0fe14c1;p=poolifier.git

diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
index 0fbb4d4d..f499da7f 100644
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -16,8 +16,6 @@ export const WorkerChoiceStrategies = Object.freeze({
   LEAST_BUSY: 'LEAST_BUSY',
   /**
    * Least ELU worker selection strategy.
-   *
-   * @experimental
    */
   LEAST_ELU: 'LEAST_ELU',
   /**
@@ -41,37 +39,61 @@ 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.
  */
-interface MeasurementOptions {
+export interface MeasurementOptions {
   /**
    * Set measurement median.
    */
-  median: boolean
+  readonly median: boolean
 }
 
 /**
  * Worker choice strategy options.
  */
 export interface WorkerChoiceStrategyOptions {
+  /**
+   * Measurement to use in worker choice strategy supporting it.
+   */
+  readonly measurement?: Measurement
   /**
    * Runtime options.
    *
    * @defaultValue \{ median: false \}
    */
-  runTime?: MeasurementOptions
+  readonly runTime?: MeasurementOptions
   /**
    * Wait time options.
    *
    * @defaultValue \{ median: false \}
    */
-  waitTime?: MeasurementOptions
+  readonly waitTime?: MeasurementOptions
+  /**
+   * Event loop utilization options.
+   *
+   * @defaultValue \{ median: false \}
+   */
+  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.
+   * 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 Computed worker weights automatically given the CPU performance.
+   * @defaultValue Weights computed automatically given the CPU performance.
    */
   weights?: Record<number, number>
 }
@@ -81,17 +103,17 @@ export interface WorkerChoiceStrategyOptions {
  *
  * @internal
  */
-interface MeasurementStatisticsRequirements {
+export interface MeasurementStatisticsRequirements {
   /**
-   * Require measurement aggregate.
+   * Requires measurement aggregate.
    */
   aggregate: boolean
   /**
-   * Require measurement average.
+   * Requires measurement average.
    */
   average: boolean
   /**
-   * Require measurement median.
+   * Requires measurement median.
    */
   median: boolean
 }
@@ -105,21 +127,43 @@ export interface TaskStatisticsRequirements {
   /**
    * Tasks runtime requirements.
    */
-  runTime: MeasurementStatisticsRequirements
+  readonly runTime: MeasurementStatisticsRequirements
   /**
    * Tasks wait time requirements.
    */
-  waitTime: MeasurementStatisticsRequirements
+  readonly waitTime: MeasurementStatisticsRequirements
   /**
-   * Event loop utilization.
+   * Tasks event loop utilization requirements.
    */
-  elu: 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 {
+  /**
+   * Strategy policy.
+   */
+  readonly strategyPolicy: StrategyPolicy
   /**
    * Tasks statistics requirements.
    */
@@ -129,30 +173,33 @@ export interface IWorkerChoiceStrategy {
    *
    * @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
 }