docs: enhance worker choice strategy option
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
index 0d337b53191f4a991368ea66976761d95fda1027..31041f3a8783c605d237196f7e89920d04dd27bb 100644 (file)
@@ -1,9 +1,10 @@
 import type { IPoolInternal } from '../pool-internal'
 import { PoolType } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
+import type { IWorker } from '../worker'
 import type {
   IWorkerChoiceStrategy,
-  RequiredStatistics
+  RequiredStatistics,
+  WorkerChoiceStrategyOptions
 } from './selection-strategies-types'
 
 /**
@@ -14,30 +15,40 @@ import type {
  * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export abstract class AbstractWorkerChoiceStrategy<
-  Worker extends IPoolWorker,
+  Worker extends IWorker,
   Data = unknown,
   Response = unknown
-> implements IWorkerChoiceStrategy<Worker, Data, Response> {
+> implements IWorkerChoiceStrategy {
   /** @inheritDoc */
-  public readonly isDynamicPool: boolean
+  protected readonly isDynamicPool: boolean
   /** @inheritDoc */
-  public requiredStatistics: RequiredStatistics = {
+  public readonly requiredStatistics: RequiredStatistics = {
     runTime: false,
-    avgRunTime: false
+    avgRunTime: false,
+    medRunTime: false
   }
 
   /**
    * Constructs a worker choice strategy bound to the pool.
    *
    * @param pool - The pool instance.
+   * @param opts - The worker choice strategy options.
    */
   public constructor (
-    public readonly pool: IPoolInternal<Worker, Data, Response>
+    protected readonly pool: IPoolInternal<Worker, Data, Response>,
+    protected readonly opts: WorkerChoiceStrategyOptions = { medRunTime: false }
   ) {
+    this.checkOptions()
     this.isDynamicPool = this.pool.type === PoolType.DYNAMIC
     this.choose.bind(this)
   }
 
+  private checkOptions (): void {
+    if (this.requiredStatistics.avgRunTime && this.opts.medRunTime === true) {
+      this.requiredStatistics.medRunTime = true
+    }
+  }
+
   /** @inheritDoc */
   public abstract reset (): boolean
 
@@ -45,5 +56,5 @@ export abstract class AbstractWorkerChoiceStrategy<
   public abstract choose (): number
 
   /** @inheritDoc */
-  public abstract remove (workerKey: number): boolean
+  public abstract remove (workerNodeKey: number): boolean
 }