feat: internal messaging strict worker id checking

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

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index e8be44f2e3b5b02671f44ce6739df7a87b61273c..c9145f571186a9d5783531236414aff7eadd463e 100644 (file)
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,41 +1,49 @@
-import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
-import type { Draft, MessageValue } from '../../utility-types'
+import {
+  SHARE_ENV,
+  Worker,
+  type WorkerOptions,
+  isMainThread
+} from 'node:worker_threads'
+import type { MessageValue } from '../../utility-types'
 import { AbstractPool } from '../abstract-pool'
-import type { PoolOptions } from '../pool'
-import { PoolType } from '../pool-internal'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
+import { type WorkerType, WorkerTypes } from '../worker'
 
 /**
- * A thread worker with message channels for communication between main thread and thread worker.
+ * Options for a poolifier thread pool.
  */
-export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>
+export interface ThreadPoolOptions extends PoolOptions<Worker> {
+  /**
+   * Worker options.
+   *
+   * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options
+   */
+  workerOptions?: WorkerOptions
+}
 
 /**
  * A thread pool with a fixed number of threads.
  *
- * It is possible to perform tasks in sync or asynchronous mode as you prefer.
- *
- * 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 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.
    *
-   * @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.
+   * @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> = {}
+    protected readonly opts: ThreadPoolOptions = {}
   ) {
     super(numberOfThreads, filePath, opts)
   }
@@ -46,53 +54,46 @@ export class FixedThreadPool<
   }
 
   /** @inheritDoc */
-  public async destroyWorker (
-    worker: ThreadWorkerWithMessageChannel
-  ): Promise<void> {
-    this.sendToWorker(worker, { kill: 1 })
+  protected async destroyWorker (worker: Worker): Promise<void> {
+    this.sendToWorker(worker, { kill: true, workerId: worker.threadId })
     await worker.terminate()
   }
 
   /** @inheritDoc */
-  protected sendToWorker (
-    worker: ThreadWorkerWithMessageChannel,
-    message: MessageValue<Data>
-  ): void {
+  protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
     worker.postMessage(message)
   }
 
   /** @inheritDoc */
-  public registerWorkerMessageListener<Message extends Data | Response> (
-    messageChannel: ThreadWorkerWithMessageChannel,
-    listener: (message: MessageValue<Message>) => void
-  ): void {
-    messageChannel.port2?.on('message', listener)
+  protected createWorker (): Worker {
+    return new Worker(this.filePath, {
+      env: SHARE_ENV,
+      ...this.opts.workerOptions
+    })
   }
 
   /** @inheritDoc */
-  protected createWorker (): ThreadWorkerWithMessageChannel {
-    return new Worker(this.filePath, {
-      env: SHARE_ENV
-    })
+  protected get type (): PoolType {
+    return PoolTypes.fixed
+  }
+
+  /** @inheritDoc */
+  protected get worker (): WorkerType {
+    return WorkerTypes.thread
   }
 
   /** @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 get minSize (): number {
+    return this.numberOfWorkers
   }
 
   /** @inheritDoc */
-  public get type (): PoolType {
-    return PoolType.FIXED
+  protected get maxSize (): number {
+    return this.numberOfWorkers
   }
 
   /** @inheritDoc */
-  public get busy (): boolean {
-    return this.internalGetBusyStatus()
+  protected get busy (): boolean {
+    return this.internalBusy()
   }
 }