refactor: cleanup pool busyness checks

[poolifier.git] / src / pools / thread / dynamic.ts

diff --git a/src/pools/thread/dynamic.ts b/src/pools/thread/dynamic.ts
index 51dca2f33698aede373eb2b95871f6d0dbc5ca84..05b61684173af58c7ed7dbbc52218c874a35fa7a 100644 (file)
--- a/src/pools/thread/dynamic.ts
+++ b/src/pools/thread/dynamic.ts
@@ -1,66 +1,52 @@
-import type { JSONValue, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
+import type { PoolOptions } from '../pool'
+import { PoolType } from '../pool-internal'
 import type { ThreadWorkerWithMessageChannel } from './fixed'
 import { FixedThreadPool } from './fixed'
 
 /**
- * A thread pool with a min/max number of threads, is possible to execute tasks in sync or async mode as you prefer.
+ * A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
  *
- * This thread pool will create new workers when the other ones are busy, until the max number of threads,
- * when the max number of threads is reached, an event will be emitted, if you want to listen this event use the emitter method.
+ * This thread pool creates new threads when the others are busy, up to the maximum number of threads.
+ * When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`.
  *
+ * @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 [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
 export class DynamicThreadPool<
-  Data extends JSONValue = JSONValue,
-  Response extends JSONValue = JSONValue
+  Data = unknown,
+  Response = unknown
 > extends FixedThreadPool<Data, Response> {
   /**
-   * @param min Min number of threads that will be always active
-   * @param max Max number of threads that will be active
-   * @param filename A file path with implementation of `ThreadWorker` class, relative path is fine.
-   * @param opts An object with possible options for example `errorHandler`, `onlineHandler`. Default: `{ maxTasks: 1000 }`
+   * Constructs a new poolifier dynamic thread pool.
+   *
+   * @param min - Minimum number of threads which are always active.
+   * @param max - Maximum number of threads that can be created by this pool.
+   * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
+   * @param opts - Options for this dynamic thread pool.
    */
   public constructor (
     min: number,
     public readonly max: number,
-    filename: string,
-    opts: PoolOptions<ThreadWorkerWithMessageChannel> = { maxTasks: 1000 }
+    filePath: string,
+    opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
   ) {
-    super(min, filename, opts)
+    super(min, filePath, opts)
   }
 
-  protected chooseWorker (): ThreadWorkerWithMessageChannel {
-    let worker: ThreadWorkerWithMessageChannel | undefined
-    for (const entry of this.tasks) {
-      if (entry[1] === 0) {
-        worker = entry[0]
-        break
-      }
-    }
+  /** @inheritDoc */
+  public get type (): PoolType {
+    return PoolType.DYNAMIC
+  }
+
+  /** @inheritDoc */
+  public get full (): boolean {
+    return this.workerNodes.length === this.max
+  }
 
-    if (worker) {
-      // a worker is free, use it
-      return worker
-    } else {
-      if (this.workers.length === this.max) {
-        this.emitter.emit('FullPool')
-        return super.chooseWorker()
-      }
-      // all workers are busy create a new worker
-      const worker = this.internalNewWorker()
-      worker.port2?.on('message', (message: MessageValue<Data>) => {
-        if (message.kill) {
-          this.sendToWorker(worker, { kill: 1 })
-          void this.destroyWorker(worker)
-          // clean workers from data structures
-          const workerIndex = this.workers.indexOf(worker)
-          this.workers.splice(workerIndex, 1)
-          this.tasks.delete(worker)
-        }
-      })
-      return worker
-    }
+  /** @inheritDoc */
+  public get busy (): boolean {
+    return this.full && this.internalBusy()
   }
 }