refactor: silence sonar

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

diff --git a/src/pools/thread/dynamic.ts b/src/pools/thread/dynamic.ts
index e80276d976640c25a9fe194847289e1ba0d7db45..d3764c285291407d75b1ee293ece40ebbc8c5dfd 100644 (file)
--- a/src/pools/thread/dynamic.ts
+++ b/src/pools/thread/dynamic.ts
@@ -1,75 +1,62 @@
-import { EventEmitter } from 'events'
-import type { FixedThreadPoolOptions, WorkerWithMessageChannel } from './fixed'
-import { FixedThreadPool } from './fixed'
-
-class MyEmitter extends EventEmitter {}
-
-export type DynamicThreadPoolOptions = FixedThreadPoolOptions
+import { PoolEvents, type PoolType, PoolTypes } from '../pool'
+import { checkDynamicPoolSize } from '../utils'
+import { FixedThreadPool, type ThreadPoolOptions } 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 structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
 export class DynamicThreadPool<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Data = any,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Response = any
+  Data = unknown,
+  Response = unknown
 > extends FixedThreadPool<Data, Response> {
-  public readonly emitter: MyEmitter
-
   /**
-   * @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 (
-    public readonly min: number,
-    public readonly max: number,
-    public readonly filename: string,
-    public readonly opts: DynamicThreadPoolOptions = { maxTasks: 1000 }
+    min: number,
+    max: number,
+    filePath: string,
+    opts: ThreadPoolOptions = {}
   ) {
-    super(min, filename, opts)
+    super(min, filePath, opts, max)
+    checkDynamicPoolSize(
+      this.minimumNumberOfWorkers,
+      this.maximumNumberOfWorkers as number
+    )
+  }
 
-    this.emitter = new MyEmitter()
+  /** @inheritDoc */
+  protected shallCreateDynamicWorker (): boolean {
+    return !this.full && this.internalBusy()
   }
 
-  protected chooseWorker (): WorkerWithMessageChannel {
-    let worker: WorkerWithMessageChannel | undefined
-    for (const entry of this.tasks) {
-      if (entry[1] === 0) {
-        worker = entry[0]
-        break
-      }
+  /** @inheritDoc */
+  protected checkAndEmitDynamicWorkerCreationEvents (): void {
+    if (this.full) {
+      this.emitter?.emit(PoolEvents.full, this.info)
     }
+  }
 
-    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.newWorker()
-      worker.port2?.on('message', (message: { kill?: number }) => {
-        if (message.kill) {
-          worker.postMessage({ kill: 1 })
-          void worker.terminate()
-          // clean workers from data structures
-          const workerIndex = this.workers.indexOf(worker)
-          this.workers.splice(workerIndex, 1)
-          this.tasks.delete(worker)
-        }
-      })
-      return worker
-    }
+  /** @inheritDoc */
+  protected get type (): PoolType {
+    return PoolTypes.dynamic
+  }
+
+  /** @inheritDoc */
+  protected get busy (): boolean {
+    return this.full && this.internalBusy()
   }
 }