X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fabstract-pool.ts;h=68e833710f802d7bd30f52bab9955dc373072c35;hb=28cf3617988a06edf63b13e3183e9df866564423;hp=0da7f86bfd7870ae1f1efd020dee765ec9c142f9;hpb=164d950a1bcdc39b4762294c1581e8befbb344e2;p=poolifier.git

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index 0da7f86b..68e83371 100644
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -25,10 +25,10 @@ export abstract class AbstractPool<
   Data = unknown,
   Response = unknown
 > implements IPoolInternal<Worker, Data, Response> {
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public readonly workers: Array<WorkerType<Worker>> = []
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public readonly emitter?: PoolEmitter
 
   /**
@@ -45,9 +45,9 @@ export abstract class AbstractPool<
   > = new Map<string, PromiseResponseWrapper<Worker, Response>>()
 
   /**
-   * Worker choice strategy instance implementing the worker choice algorithm.
+   * Worker choice strategy context referencing a worker choice algorithm implementation.
    *
-   * Default to a strategy implementing a round robin algorithm.
+   * Default to a round robin algorithm.
    */
   protected workerChoiceStrategyContext: WorkerChoiceStrategyContext<
   Worker,
@@ -142,14 +142,23 @@ export abstract class AbstractPool<
   private checkPoolOptions (opts: PoolOptions<Worker>): void {
     this.opts.workerChoiceStrategy =
       opts.workerChoiceStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN
+    if (
+      !Object.values(WorkerChoiceStrategies).includes(
+        this.opts.workerChoiceStrategy
+      )
+    ) {
+      throw new Error(
+        `Invalid worker choice strategy '${this.opts.workerChoiceStrategy}'`
+      )
+    }
     this.opts.enableEvents = opts.enableEvents ?? true
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public abstract get type (): PoolType
 
   /**
-   * Number of tasks concurrently running.
+   * Number of tasks concurrently running in the pool.
    */
   private get numberOfRunningTasks (): number {
     return this.promiseResponseMap.size
@@ -165,7 +174,7 @@ export abstract class AbstractPool<
     return this.workers.findIndex(workerItem => workerItem.worker === worker)
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public setWorkerChoiceStrategy (
     workerChoiceStrategy: WorkerChoiceStrategy
   ): void {
@@ -180,15 +189,14 @@ export abstract class AbstractPool<
       })
     }
     this.workerChoiceStrategyContext.setWorkerChoiceStrategy(
-      this,
       workerChoiceStrategy
     )
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public abstract get full (): boolean
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public abstract get busy (): boolean
 
   protected internalBusy (): boolean {
@@ -198,14 +206,14 @@ export abstract class AbstractPool<
     )
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public findFreeWorkerKey (): number {
     return this.workers.findIndex(workerItem => {
       return workerItem.tasksUsage.running === 0
     })
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public async execute (data: Data): Promise<Response> {
     const [workerKey, worker] = this.chooseWorker()
     const messageId = crypto.randomUUID()
@@ -221,7 +229,7 @@ export abstract class AbstractPool<
     return res
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   public async destroy (): Promise<void> {
     await Promise.all(
       this.workers.map(async workerItem => {
@@ -231,7 +239,7 @@ export abstract class AbstractPool<
   }
 
   /**
-   * Shutdowns given worker.
+   * Shutdowns given worker in the pool.
    *
    * @param worker - A worker within `workers`.
    */
@@ -240,6 +248,8 @@ export abstract class AbstractPool<
   /**
    * Setup hook that can be overridden by a Poolifier pool implementation
    * to run code before workers are created in the abstract constructor.
+   *
+   * @virtual
    */
   protected setupHook (): void {
     // Can be overridden
@@ -289,21 +299,10 @@ export abstract class AbstractPool<
     }
   }
 
-  /**
-   * Removes the given worker from the pool.
-   *
-   * @param worker - The worker that will be removed.
-   */
-  protected removeWorker (worker: Worker): void {
-    const workerKey = this.getWorkerKey(worker)
-    this.workers.splice(workerKey, 1)
-    this.workerChoiceStrategyContext.remove(workerKey)
-  }
-
   /**
    * Chooses a worker for the next task.
    *
-   * The default implementation uses a round robin algorithm to distribute the load.
+   * The default uses a round robin algorithm to distribute the load.
    *
    * @returns [worker key, worker].
    */
@@ -344,6 +343,7 @@ export abstract class AbstractPool<
    * Can be used to update the `maxListeners` or binding the `main-worker`\<-\>`worker` connection if not bind by default.
    *
    * @param worker - The newly created worker.
+   * @virtual
    */
   protected abstract afterWorkerSetup (worker: Worker): void
 
@@ -383,9 +383,9 @@ export abstract class AbstractPool<
    */
   protected workerListener (): (message: MessageValue<Response>) => void {
     return message => {
-      if (message.id !== undefined) {
+      if (message.id != null) {
         const promiseResponse = this.promiseResponseMap.get(message.id)
-        if (promiseResponse !== undefined) {
+        if (promiseResponse != null) {
           if (message.error != null) {
             promiseResponse.reject(message.error)
           } else {
@@ -426,7 +426,7 @@ export abstract class AbstractPool<
   }
 
   /**
-   * Gets worker tasks usage.
+   * Gets the given worker tasks usage in the pool.
    *
    * @param worker - The worker.
    * @returns The worker tasks usage.
@@ -440,7 +440,7 @@ export abstract class AbstractPool<
   }
 
   /**
-   * Pushes the given worker.
+   * Pushes the given worker in the pool.
    *
    * @param worker - The worker.
    * @param tasksUsage - The worker tasks usage.
@@ -453,7 +453,7 @@ export abstract class AbstractPool<
   }
 
   /**
-   * Sets the given worker.
+   * Sets the given worker in the pool.
    *
    * @param workerKey - The worker key.
    * @param worker - The worker.
@@ -469,4 +469,15 @@ export abstract class AbstractPool<
       tasksUsage
     }
   }
+
+  /**
+   * Removes the given worker from the pool.
+   *
+   * @param worker - The worker that will be removed.
+   */
+  protected removeWorker (worker: Worker): void {
+    const workerKey = this.getWorkerKey(worker)
+    this.workers.splice(workerKey, 1)
+    this.workerChoiceStrategyContext.remove(workerKey)
+  }
 }