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