Merge branch 'master' into elu-strategy

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

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index a61c10b2346c8a44c4094605dfe6aa25787b8f09..a9d8f685fec3432db4fc6829dabcfd84f146babe 100644 (file)
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,7 +1,31 @@
-import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
+import {
+  MessageChannel,
+  SHARE_ENV,
+  Worker,
+  type WorkerOptions,
+  isMainThread
+} from 'node:worker_threads'
 import type { Draft, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
 import { AbstractPool } from '../abstract-pool'
+import {
+  type PoolOptions,
+  type PoolType,
+  PoolTypes,
+  type WorkerType,
+  WorkerTypes
+} from '../pool'
+
+/**
+ * Options for a poolifier thread pool.
+ */
+export interface ThreadPoolOptions extends PoolOptions<Worker> {
+  /**
+   * Worker options.
+   *
+   * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options
+   */
+  workerOptions?: WorkerOptions
+}
 
 /**
  * A thread worker with message channels for communication between main thread and thread worker.
@@ -15,9 +39,8 @@ export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>
  *
  * This pool selects the threads in a round robin fashion.
  *
- * @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 execution response. This can only be serializable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -28,22 +51,24 @@ export class FixedThreadPool<
   /**
    * Constructs a new poolifier fixed thread pool.
    *
-   * @param numberOfThreads Number of threads for this pool.
-   * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
-   * @param opts Options for this fixed thread pool. Default: `{ maxTasks: 1000 }`
+   * @param numberOfThreads - Number of threads for this pool.
+   * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute.
+   * @param opts - Options for this fixed thread pool.
    */
   public constructor (
     numberOfThreads: number,
     filePath: string,
-    opts: PoolOptions<ThreadWorkerWithMessageChannel> = { maxTasks: 1000 }
+    protected readonly opts: ThreadPoolOptions = {}
   ) {
     super(numberOfThreads, filePath, opts)
   }
 
+  /** @inheritDoc */
   protected isMain (): boolean {
     return isMainThread
   }
 
+  /** @inheritDoc */
   protected async destroyWorker (
     worker: ThreadWorkerWithMessageChannel
   ): Promise<void> {
@@ -51,6 +76,7 @@ export class FixedThreadPool<
     await worker.terminate()
   }
 
+  /** @inheritDoc */
   protected sendToWorker (
     worker: ThreadWorkerWithMessageChannel,
     message: MessageValue<Data>
@@ -58,33 +84,54 @@ export class FixedThreadPool<
     worker.postMessage(message)
   }
 
-  protected registerWorkerMessageListener<Message extends Data | Response> (
-    messageChannel: ThreadWorkerWithMessageChannel,
-    listener: (message: MessageValue<Message>) => void
-  ): void {
-    messageChannel.port2?.on('message', listener)
-  }
-
-  protected unregisterWorkerMessageListener<Message extends Data | Response> (
-    messageChannel: ThreadWorkerWithMessageChannel,
+  /** @inheritDoc */
+  protected registerWorkerMessageListener<Message extends Data | Response>(
+    worker: ThreadWorkerWithMessageChannel,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    messageChannel.port2?.removeListener('message', listener)
+    worker.port2?.on('message', listener)
   }
 
+  /** @inheritDoc */
   protected createWorker (): ThreadWorkerWithMessageChannel {
     return new Worker(this.filePath, {
-      env: SHARE_ENV
+      env: SHARE_ENV,
+      ...this.opts.workerOptions
     })
   }
 
+  /** @inheritDoc */
   protected afterWorkerSetup (worker: ThreadWorkerWithMessageChannel): void {
     const { port1, port2 } = new MessageChannel()
     worker.postMessage({ parent: port1 }, [port1])
     worker.port1 = port1
     worker.port2 = port2
-    // we will attach a listener for every task,
-    // when task is completed the listener will be removed but to avoid warnings we are increasing the max listeners size
-    worker.port2.setMaxListeners(this.opts.maxTasks ?? 1000)
+    // Listen to worker messages.
+    this.registerWorkerMessageListener(worker, super.workerListener())
+  }
+
+  /** @inheritDoc */
+  protected get type (): PoolType {
+    return PoolTypes.fixed
+  }
+
+  /** @inheritDoc */
+  protected get worker (): WorkerType {
+    return WorkerTypes.thread
+  }
+
+  /** @inheritDoc */
+  protected get minSize (): number {
+    return this.numberOfWorkers
+  }
+
+  /** @inheritDoc */
+  protected get maxSize (): number {
+    return this.numberOfWorkers
+  }
+
+  /** @inheritDoc */
+  protected get busy (): boolean {
+    return this.internalBusy()
   }
 }