Merge branch 'master' into interleaved-weighted-round-robin-worker-choice-strategy
[poolifier.git] / src / pools / selection-strategies / round-robin-worker-choice-strategy.ts
index 76cdd4abac3ff7a2c5a5988cf76e66d87ab9be9b..be4fe3326b9585c8bd4f7261023cda4fe5af710e 100644 (file)
@@ -1,36 +1,70 @@
-import type { IPoolWorker } from '../pool-worker'
+import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
+import type { IPool } from '../pool'
+import type { IWorker } from '../worker'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
+import type {
+  IWorkerChoiceStrategy,
+  WorkerChoiceStrategyOptions
+} from './selection-strategies-types'
 
 /**
  * Selects the next worker in a round robin fashion.
  *
  * @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.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export class RoundRobinWorkerChoiceStrategy<
-  Worker extends IPoolWorker,
-  Data,
-  Response
-> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> {
+    Worker extends IWorker,
+    Data = unknown,
+    Response = unknown
+  >
+  extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
+  implements IWorkerChoiceStrategy {
   /**
-   * Index for the next worker.
+   * Id of the next worker node.
    */
-  private nextWorkerIndex: number = 0
+  private nextWorkerNodeId: number = 0
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
+  public constructor (
+    pool: IPool<Worker, Data, Response>,
+    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+  ) {
+    super(pool, opts)
+    this.setRequiredStatistics(this.opts)
+  }
+
+  /** @inheritDoc */
   public reset (): boolean {
-    this.nextWorkerIndex = 0
+    this.nextWorkerNodeId = 0
+    return true
+  }
+
+  /** @inheritDoc */
+  public update (): boolean {
     return true
   }
 
-  /** {@inheritDoc} */
-  public choose (): Worker {
-    const chosenWorker = this.pool.workers[this.nextWorkerIndex]
-    this.nextWorkerIndex =
-      this.nextWorkerIndex === this.pool.workers.length - 1
+  /** @inheritDoc */
+  public choose (): number {
+    const chosenWorkerNodeKey = this.nextWorkerNodeId
+    this.nextWorkerNodeId =
+      this.nextWorkerNodeId === this.pool.workerNodes.length - 1
         ? 0
-        : this.nextWorkerIndex + 1
-    return chosenWorker
+        : this.nextWorkerNodeId + 1
+    return chosenWorkerNodeKey
+  }
+
+  /** @inheritDoc */
+  public remove (workerNodeKey: number): boolean {
+    if (this.nextWorkerNodeId === workerNodeKey) {
+      if (this.pool.workerNodes.length === 0) {
+        this.nextWorkerNodeId = 0
+      } else if (this.nextWorkerNodeId > this.pool.workerNodes.length - 1) {
+        this.nextWorkerNodeId = this.pool.workerNodes.length - 1
+      }
+    }
+    return true
   }
 }