fix: add missing crypto import
[poolifier.git] / src / pools / thread / fixed.ts
index 74c14ff2a33b6dc61e906e19bfdbaa7699fbc50e..a37ccbf76b5864b8cc4f27b847596d7b9c533d38 100644 (file)
@@ -1,7 +1,13 @@
-import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
-import type { Draft, JSONValue, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
+import {
+  isMainThread,
+  MessageChannel,
+  SHARE_ENV,
+  Worker
+} from 'node:worker_threads'
+import type { Draft, MessageValue } from '../../utility-types'
 import { AbstractPool } from '../abstract-pool'
+import type { PoolOptions } from '../pool'
+import { PoolType } from '../pool-internal'
 
 /**
  * A thread worker with message channels for communication between main thread and thread worker.
@@ -15,42 +21,44 @@ 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.
- * @template Response Type of response of execution.
- *
+ * @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 FixedThreadPool<
-  Data extends JSONValue = JSONValue,
-  Response extends JSONValue = JSONValue
+  Data = unknown,
+  Response = unknown
 > extends AbstractPool<ThreadWorkerWithMessageChannel, Data, Response> {
   /**
    * 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 }
+    opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
   ) {
     super(numberOfThreads, filePath, opts)
   }
 
+  /** {@inheritDoc} */
   protected isMain (): boolean {
     return isMainThread
   }
 
-  protected async destroyWorker (
+  /** {@inheritDoc} */
+  public async destroyWorker (
     worker: ThreadWorkerWithMessageChannel
   ): Promise<void> {
+    this.sendToWorker(worker, { kill: 1 })
     await worker.terminate()
-    // FIXME: The tests are currently failing, so these must be changed first
   }
 
+  /** {@inheritDoc} */
   protected sendToWorker (
     worker: ThreadWorkerWithMessageChannel,
     message: MessageValue<Data>
@@ -58,33 +66,38 @@ export class FixedThreadPool<
     worker.postMessage(message)
   }
 
-  protected registerWorkerMessageListener (
-    port: ThreadWorkerWithMessageChannel,
-    listener: (message: MessageValue<Response>) => void
-  ): void {
-    port.port2?.on('message', listener)
-  }
-
-  protected unregisterWorkerMessageListener (
-    port: ThreadWorkerWithMessageChannel,
-    listener: (message: MessageValue<Response>) => void
+  /** {@inheritDoc} */
+  public registerWorkerMessageListener<Message extends Data | Response>(
+    messageChannel: ThreadWorkerWithMessageChannel,
+    listener: (message: MessageValue<Message>) => void
   ): void {
-    port.port2?.removeListener('message', listener)
+    messageChannel.port2?.on('message', listener)
   }
 
+  /** {@inheritDoc} */
   protected createWorker (): ThreadWorkerWithMessageChannel {
     return new Worker(this.filePath, {
       env: SHARE_ENV
     })
   }
 
+  /** {@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} */
+  public get type (): PoolType {
+    return PoolType.FIXED
+  }
+
+  /** {@inheritDoc} */
+  public get busy (): boolean {
+    return this.internalGetBusyStatus()
   }
 }