refactor: apply stricter strategy design pattern requirements on worker

[poolifier.git] / src / pools / selection-strategies / round-robin-worker-choice-strategy.ts

diff --git a/src/pools/selection-strategies/round-robin-worker-choice-strategy.ts b/src/pools/selection-strategies/round-robin-worker-choice-strategy.ts
index 0a9fbb7b0a386e1f2ec2f7a78c8f0bf61a9d8572..5ee219202aff6c7ec44f1af67b1264cdd16e8b40 100644 (file)
--- a/src/pools/selection-strategies/round-robin-worker-choice-strategy.ts
+++ b/src/pools/selection-strategies/round-robin-worker-choice-strategy.ts
@@ -1,36 +1,50 @@
 import type { IPoolWorker } from '../pool-worker'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
+import type { IWorkerChoiceStrategy } from './selection-strategies-types'
 
 /**
  * Selects the next worker in a round robin fashion.
  *
- * @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 class RoundRobinWorkerChoiceStrategy<
-  Worker extends IPoolWorker,
-  Data,
-  Response
-> extends AbstractWorkerChoiceStrategy<Worker, Data, Response> {
+    Worker extends IPoolWorker,
+    Data,
+    Response
+  >
+  extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
+  implements IWorkerChoiceStrategy<Worker, Data, Response> {
   /**
-   * Index for the next worker.
+   * Id of the next worker.
    */
-  private nextWorkerIndex: number = 0
+  private nextWorkerId: number = 0
 
-  /** @inheritDoc */
+  /** {@inheritDoc} */
   public reset (): boolean {
-    this.nextWorkerIndex = 0
+    this.nextWorkerId = 0
     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 chosenWorkerKey = this.nextWorkerId
+    this.nextWorkerId =
+      this.nextWorkerId === this.pool.workers.length - 1
         ? 0
-        : this.nextWorkerIndex + 1
-    return chosenWorker
+        : this.nextWorkerId + 1
+    return chosenWorkerKey
+  }
+
+  /** {@inheritDoc} */
+  public remove (workerKey: number): boolean {
+    if (this.nextWorkerId === workerKey) {
+      this.nextWorkerId =
+        this.nextWorkerId > this.pool.workers.length - 1
+          ? this.pool.workers.length - 1
+          : this.nextWorkerId
+    }
+    return true
   }
 }