fix: ensure worker choice is retried at least the pool max size

[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 563b04b00086a7a31a68f7cb25ca4bde6b513c92..59b6a84f90e29dbd05a08dec2020428b7e2fe436 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',
   /**
@@ -70,7 +68,7 @@ export interface MeasurementOptions {
  */
 export interface WorkerChoiceStrategyOptions {
   /**
-   * Measurement to use for worker choice strategy.
+   * Measurement to use in worker choice strategy supporting it.
    */
   readonly measurement?: Measurement
   /**
@@ -92,14 +90,29 @@ export interface WorkerChoiceStrategyOptions {
    */
   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.
    */
   readonly weights?: Record<number, number>
 }
 
+/**
+ * Worker choice strategy internal options.
+ *
+ * @internal
+ */
+export interface InternalWorkerChoiceStrategyOptions
+  extends WorkerChoiceStrategyOptions {
+  /**
+   * Number of worker choice retries to perform if no worker is eligible.
+   *
+   * @defaultValue pool maximum size
+   */
+  readonly retries?: number
+}
+
 /**
  * Measurement statistics requirements.
  *
@@ -147,9 +160,13 @@ export interface TaskStatisticsRequirements {
  */
 export interface StrategyPolicy {
   /**
-   * Expects direct usage of the newly created dynamic worker.
+   * Expects tasks execution on the newly created dynamic worker.
+   */
+  readonly dynamicWorkerUsage: boolean
+  /**
+   * Expects the newly created dynamic worker to be flagged as ready.
    */
-  readonly useDynamicWorker: boolean
+  readonly dynamicWorkerReady: boolean
 }
 
 /**
@@ -174,16 +191,19 @@ export interface IWorkerChoiceStrategy {
   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.
    */
   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`.
    */
-  readonly choose: () => number
+  readonly choose: () => number | undefined
   /**
    * Removes the worker node key from strategy internals.
    *
@@ -197,4 +217,10 @@ export interface IWorkerChoiceStrategy {
    * @param opts - The worker choice strategy options.
    */
   readonly setOptions: (opts: WorkerChoiceStrategyOptions) => void
+  /**
+   * Whether the pool has worker nodes ready or not.
+   *
+   * @returns Whether the pool has worker nodes ready or not.
+   */
+  readonly hasPoolWorkerNodesReady: () => boolean
 }