refactor: freeze empty function type
[poolifier.git] / src / pools / cluster / dynamic.ts
index 2a25f7b3c81eae02270259671dc1b8f8fa0a021b..513a73c5d7804cfa2e109a5d9cf6c01f4c060945 100644 (file)
@@ -1,5 +1,5 @@
-import type { Worker } from 'cluster'
-import { isKillBehavior, KillBehaviors } from '../../worker/worker-options'
+import { EMPTY_OBJECT_LITERAL } from '../../utils'
+import { PoolType } from '../pool-internal'
 import type { ClusterPoolOptions } from './fixed'
 import { FixedClusterPool } from './fixed'
 
@@ -9,9 +9,8 @@ import { FixedClusterPool } from './fixed'
  * This cluster pool creates new workers when the others are busy, up to the maximum number of workers.
  * When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
  *
- * @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 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.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
@@ -22,54 +21,27 @@ export class DynamicClusterPool<
   /**
    * Constructs a new poolifier dynamic cluster pool.
    *
-   * @param min Minimum number of workers which are always active.
-   * @param max Maximum number of workers that can be created by this pool.
-   * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
-   * @param opts Options for this dynamic cluster pool. Default: `{ maxTasks: 1000 }`
+   * @param min Minimum number of workers which are always active.
+   * @param max Maximum number of workers that can be created by this pool.
+   * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
+   * @param opts - Options for this dynamic cluster pool.
    */
   public constructor (
     min: number,
-    public readonly max: number,
+    protected readonly max: number,
     filePath: string,
-    opts: ClusterPoolOptions = { maxTasks: 1000 }
+    opts: ClusterPoolOptions = EMPTY_OBJECT_LITERAL
   ) {
     super(min, filePath, opts)
   }
 
-  /**
-   * Choose a worker for the next task.
-   *
-   * It will first check for and return an idle worker.
-   * If all workers are busy, then it will try to create a new one up to the `max` worker count.
-   * If the max worker count is reached, the emitter will emit a `FullPool` event and it will fall back to using a round robin algorithm to distribute the load.
-   *
-   * @returns Cluster worker.
-   */
-  protected chooseWorker (): Worker {
-    for (const [worker, numberOfTasks] of this.tasks) {
-      if (numberOfTasks === 0) {
-        // A worker is free, use it
-        return worker
-      }
-    }
-
-    if (this.workers.length === this.max) {
-      this.emitter.emit('FullPool')
-      return super.chooseWorker()
-    }
+  /** {@inheritDoc} */
+  public get type (): PoolType {
+    return PoolType.DYNAMIC
+  }
 
-    // All workers are busy, create a new worker
-    const workerCreated = this.createAndSetupWorker()
-    this.registerWorkerMessageListener<Data>(workerCreated, message => {
-      const tasksInProgress = this.tasks.get(workerCreated)
-      if (
-        isKillBehavior(KillBehaviors.HARD, message.kill) ||
-        tasksInProgress === 0
-      ) {
-        // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime)
-        void this.destroyWorker(workerCreated)
-      }
-    })
-    return workerCreated
+  /** {@inheritDoc} */
+  public get busy (): boolean {
+    return this.workers.length === this.max
   }
 }