refactor: code cleanups

[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 dc1748140a8a3db121b4f904ccafda718a14411e..f499da7fc9d58458f9977910a18cc9246870ba7b 100644 (file)
--- 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',
   /**
@@ -62,7 +60,7 @@ export interface MeasurementOptions {
   /**
    * Set measurement median.
    */
-  median: boolean
+  readonly median: boolean
 }
 
 /**
@@ -70,32 +68,32 @@ export interface MeasurementOptions {
  */
 export interface WorkerChoiceStrategyOptions {
   /**
-   * Measurement to use for worker choice strategy.
+   * Measurement to use in worker choice strategy supporting it.
    */
-  measurement?: Measurement
+  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 \}
    */
-  elu?: MeasurementOptions
+  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>
 }
@@ -129,15 +127,15 @@ export interface TaskStatisticsRequirements {
   /**
    * Tasks runtime requirements.
    */
-  runTime: MeasurementStatisticsRequirements
+  readonly runTime: MeasurementStatisticsRequirements
   /**
    * Tasks wait time requirements.
    */
-  waitTime: MeasurementStatisticsRequirements
+  readonly waitTime: MeasurementStatisticsRequirements
   /**
    * Tasks event loop utilization requirements.
    */
-  elu: MeasurementStatisticsRequirements
+  readonly elu: MeasurementStatisticsRequirements
 }
 
 /**
@@ -147,13 +145,19 @@ export interface TaskStatisticsRequirements {
  */
 export interface StrategyPolicy {
   /**
-   * Expects direct usage of dynamic worker.
+   * Expects tasks execution on the newly created dynamic worker.
    */
-  useDynamicWorker: boolean
+  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 {
   /**
@@ -169,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
 }