refactor: factor out worker choice strategies options default
[poolifier.git] / src / pools / selection-strategies / abstract-worker-choice-strategy.ts
index 3a5d6e04a3ddd46e0e78e8d8a57062e8e9ba966c..d60d2905674e5b6fc5baa66616a63e9ab9f1fc85 100644 (file)
@@ -1,49 +1,61 @@
+import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
 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'
 
 /**
- * Abstract worker choice strategy class.
+ * Worker choice strategy abstract base class.
  *
  * @typeParam Worker - Type of worker which manages the strategy.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
  * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export abstract class AbstractWorkerChoiceStrategy<
-  Worker extends IPoolWorker,
-  Data,
-  Response
+  Worker extends IWorker,
+  Data = unknown,
+  Response = unknown
 > implements IWorkerChoiceStrategy {
-  /** {@inheritDoc} */
-  public readonly isDynamicPool: boolean
-  /** {@inheritDoc} */
-  public requiredStatistics: RequiredStatistics = {
+  /** @inheritDoc */
+  protected readonly isDynamicPool: boolean
+  /** @inheritDoc */
+  public readonly requiredStatistics: RequiredStatistics = {
     runTime: false,
-    avgRunTime: false
+    avgRunTime: false,
+    medRunTime: false
   }
 
   /**
-   * Constructs a worker choice strategy attached to the pool.
+   * Constructs a worker choice strategy bound to the pool.
    *
    * @param pool - The pool instance.
+   * @param opts - The worker choice strategy options.
    */
   public constructor (
-    protected readonly pool: IPoolInternal<Worker, Data, Response>
+    protected readonly pool: IPoolInternal<Worker, Data, Response>,
+    protected readonly opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
   ) {
+    this.checkOptions(this.opts)
     this.isDynamicPool = this.pool.type === PoolType.DYNAMIC
     this.choose.bind(this)
   }
 
-  /** {@inheritDoc} */
+  private checkOptions (opts: WorkerChoiceStrategyOptions): void {
+    if (this.requiredStatistics.avgRunTime && opts.medRunTime === true) {
+      this.requiredStatistics.medRunTime = true
+    }
+  }
+
+  /** @inheritDoc */
   public abstract reset (): boolean
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public abstract choose (): number
 
-  /** {@inheritDoc} */
-  public abstract remove (workerKey: number): boolean
+  /** @inheritDoc */
+  public abstract remove (workerNodeKey: number): boolean
 }