refactor: apply stricter strategy design pattern requirements on worker

[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 f875c2906ee3a173ffab6790d93aece511b2a0ef..4fb2f3584aadffcc0f5224fdfb8ce6521a2979a8 100644 (file)
--- a/src/pools/selection-strategies/selection-strategies-types.ts
+++ b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -1,3 +1,4 @@
+import type { IPoolInternal } from '../pool-internal'
 import type { IPoolWorker } from '../pool-worker'
 
 /**
@@ -9,9 +10,13 @@ export const WorkerChoiceStrategies = Object.freeze({
    */
   ROUND_ROBIN: 'ROUND_ROBIN',
   /**
-   * Less recently used worker selection strategy.
+   * Less used worker selection strategy.
    */
-  LESS_RECENTLY_USED: 'LESS_RECENTLY_USED',
+  LESS_USED: 'LESS_USED',
+  /**
+   * Less busy worker selection strategy.
+   */
+  LESS_BUSY: 'LESS_BUSY',
   /**
    * Fair share worker selection strategy.
    */
@@ -28,32 +33,48 @@ export const WorkerChoiceStrategies = Object.freeze({
 export type WorkerChoiceStrategy = keyof typeof WorkerChoiceStrategies
 
 /**
- * Pool tasks usage statistics requirements.
+ * Pool worker tasks usage statistics requirements.
  */
-export type RequiredStatistics = {
+export interface RequiredStatistics {
   runTime: boolean
+  avgRunTime: boolean
 }
 
 /**
  * Worker choice strategy interface.
- *
- * @template Worker Type of worker which manages the strategy.
  */
-export interface IWorkerChoiceStrategy<Worker extends IPoolWorker> {
+export interface IWorkerChoiceStrategy<
+  Worker extends IPoolWorker,
+  Data = unknown,
+  Response = unknown
+> {
+  /**
+   * The pool instance.
+   * @readonly
+   */
+  readonly pool: IPoolInternal<Worker, Data, Response>
   /**
    * Is the pool attached to the strategy dynamic?.
+   * @readonly
    */
   readonly isDynamicPool: boolean
   /**
    * Required pool tasks usage statistics.
+   * @readonly
    */
   readonly requiredStatistics: RequiredStatistics
   /**
-   * Resets strategy internal statistics.
+   * Resets strategy internals (counters, statistics, etc.).
+   */
+  reset: () => boolean
+  /**
+   * Chooses a worker in the pool and returns its key.
    */
-  resetStatistics(): boolean
+  choose: () => number
   /**
-   * Chooses a worker in the pool.
+   * Removes a worker reference from strategy internals.
+   *
+   * @param workerKey - The worker key.
    */
-  choose(): Worker
+  remove: (workerKey: number) => boolean
 }