refactor: silence sonar

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

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index d843144c633fd99d5becf18ad1d5918ab570eaf6..f48d0bcd9960da1a2ff89582035a9ad9a9581774 100644 (file)
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,51 +1,32 @@
 import {
-  MessageChannel,
-  SHARE_ENV,
-  Worker,
-  type WorkerOptions,
+  type MessageChannel,
+  type MessagePort,
+  type TransferListItem,
+  type Worker,
   isMainThread
 } from 'node:worker_threads'
-import type { Draft, MessageValue } from '../../utility-types'
+import type { MessageValue } from '../../utility-types'
 import { AbstractPool } from '../abstract-pool'
-import {
-  type PoolOptions,
-  type PoolType,
-  PoolTypes,
-  type WorkerType,
-  WorkerTypes
-} from '../pool'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
+import { type WorkerType, WorkerTypes } from '../worker'
 
 /**
  * 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.
- */
-export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>
+export type ThreadPoolOptions = PoolOptions<Worker>
 
 /**
  * A thread pool with a fixed number of threads.
  *
- * It is possible to perform tasks in sync or asynchronous mode as you prefer.
- *
- * @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.
+ * @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 FixedThreadPool<
   Data = unknown,
   Response = unknown
-> extends AbstractPool<ThreadWorkerWithMessageChannel, Data, Response> {
+> extends AbstractPool<Worker, Data, Response> {
   /**
    * Constructs a new poolifier fixed thread pool.
    *
@@ -56,9 +37,10 @@ export class FixedThreadPool<
   public constructor (
     numberOfThreads: number,
     filePath: string,
-    protected readonly opts: ThreadPoolOptions = {}
+    opts: ThreadPoolOptions = {},
+    maximumNumberOfThreads?: number
   ) {
-    super(numberOfThreads, filePath, opts)
+    super(numberOfThreads, filePath, opts, maximumNumberOfThreads)
   }
 
   /** @inheritDoc */
@@ -67,65 +49,83 @@ export class FixedThreadPool<
   }
 
   /** @inheritDoc */
-  protected async destroyWorker (
-    worker: ThreadWorkerWithMessageChannel
-  ): Promise<void> {
-    this.sendToWorker(worker, { kill: 1 })
-    await worker.terminate()
+  protected sendToWorker (
+    workerNodeKey: number,
+    message: MessageValue<Data>,
+    transferList?: TransferListItem[]
+  ): void {
+    this.workerNodes[workerNodeKey].messageChannel?.port1?.postMessage(
+      { ...message, workerId: this.getWorkerInfo(workerNodeKey).id },
+      transferList
+    )
   }
 
   /** @inheritDoc */
-  protected sendToWorker (
-    worker: ThreadWorkerWithMessageChannel,
-    message: MessageValue<Data>
-  ): void {
-    worker.postMessage(message)
+  protected sendStartupMessageToWorker (workerNodeKey: number): void {
+    const workerNode = this.workerNodes[workerNodeKey]
+    const port2: MessagePort = (workerNode.messageChannel as MessageChannel)
+      .port2
+    workerNode.worker.postMessage(
+      {
+        ready: false,
+        workerId: this.getWorkerInfo(workerNodeKey).id,
+        port: port2
+      },
+      [port2]
+    )
   }
 
   /** @inheritDoc */
   protected registerWorkerMessageListener<Message extends Data | Response>(
-    worker: ThreadWorkerWithMessageChannel,
+    workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    worker.port2?.on('message', listener)
+    this.workerNodes[workerNodeKey].messageChannel?.port1?.on(
+      'message',
+      listener
+    )
   }
 
   /** @inheritDoc */
-  protected createWorker (): ThreadWorkerWithMessageChannel {
-    return new Worker(this.filePath, {
-      env: SHARE_ENV,
-      ...this.opts.workerOptions
-    })
+  protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    this.workerNodes[workerNodeKey].messageChannel?.port1?.once(
+      'message',
+      listener
+    )
   }
 
   /** @inheritDoc */
-  protected afterWorkerSetup (worker: ThreadWorkerWithMessageChannel): void {
-    const { port1, port2 } = new MessageChannel()
-    worker.postMessage({ parent: port1 }, [port1])
-    worker.port1 = port1
-    worker.port2 = port2
-    // Listen to worker messages.
-    this.registerWorkerMessageListener(worker, super.workerListener())
+  protected deregisterWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    this.workerNodes[workerNodeKey].messageChannel?.port1?.off(
+      'message',
+      listener
+    )
   }
 
   /** @inheritDoc */
-  protected get type (): PoolType {
-    return PoolTypes.fixed
+  protected shallCreateDynamicWorker (): boolean {
+    return false
   }
 
   /** @inheritDoc */
-  protected get worker (): WorkerType {
-    return WorkerTypes.thread
+  protected checkAndEmitDynamicWorkerCreationEvents (): void {
+    /* noop */
   }
 
   /** @inheritDoc */
-  protected get minSize (): number {
-    return this.numberOfWorkers
+  protected get type (): PoolType {
+    return PoolTypes.fixed
   }
 
   /** @inheritDoc */
-  protected get maxSize (): number {
-    return this.numberOfWorkers
+  protected get worker (): WorkerType {
+    return WorkerTypes.thread
   }
 
   /** @inheritDoc */