fix: fix fair share algorithm implementation

[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 4fb2f3584aadffcc0f5224fdfb8ce6521a2979a8..114ae8c555141fd08bff0103fcf79d62a65b5f83 100644 (file)
--- 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.
  */
@@ -32,49 +29,82 @@ export const WorkerChoiceStrategies = Object.freeze({
  */
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
+/**
+ * Worker choice strategy options.
+ */
+export interface WorkerChoiceStrategyOptions {
+  /**
+   * Use tasks median run time instead of average run time.
+   *
+   * @defaultValue false
+   */
+  medRunTime?: boolean
+  /**
+   * 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>
+}
+
 /**
  * Pool worker tasks usage statistics requirements.
+ *
+ * @internal
  */
 export interface RequiredStatistics {
+  /**
+   * Require tasks run time.
+   */
   runTime: boolean
+  /**
+   * Require tasks average run time.
+   */
   avgRunTime: boolean
+  /**
+   * Require tasks median run time.
+   */
+  medRunTime: boolean
 }
 
 /**
  * Worker choice strategy interface.
  */
-export interface IWorkerChoiceStrategy<
-  Worker extends IPoolWorker,
-  Data = unknown,
-  Response = unknown
-> {
+export interface IWorkerChoiceStrategy {
   /**
-   * The pool instance.
-   * @readonly
+   * Required tasks usage statistics.
    */
-  readonly pool: IPoolInternal<Worker, Data, Response>
+  readonly requiredStatistics: RequiredStatistics
   /**
-   * Is the pool attached to the strategy dynamic?.
-   * @readonly
+   * Resets strategy internals.
+   *
+   * @returns `true` if the reset is successful, `false` otherwise.
    */
-  readonly isDynamicPool: boolean
+  reset: () => boolean
   /**
-   * Required pool tasks usage statistics.
-   * @readonly
+   * Updates worker node strategy internals.
+   *
+   * @returns `true` if the update is successful, `false` otherwise.
    */
-  readonly requiredStatistics: RequiredStatistics
+  update: (workerNodeKey: number) => boolean
   /**
-   * Resets strategy internals (counters, statistics, etc.).
+   * Chooses a worker node in the pool and returns its key.
+   *
+   * @returns The worker node key.
    */
-  reset: () => boolean
+  choose: () => number
   /**
-   * Chooses a worker in the pool and returns its key.
+   * Removes a worker node key from strategy internals.
+   *
+   * @param workerNodeKey - The worker node key.
+   * @returns `true` if the worker node key is removed, `false` otherwise.
    */
-  choose: () => number
+  remove: (workerNodeKey: number) => boolean
   /**
-   * Removes a worker reference from strategy internals.
+   * 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
 }