fix: refine type definition for transferList

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

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index cd414502cfd8a706e8d30836b23a90ce64c35a91..7977cd61abd5263023b855fe9f7f23ba5135de10 100644 (file)
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,43 +1,45 @@
-import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
-import type { Draft, MessageValue } from '../../utility-types'
-import { AbstractPool } from '../abstract-pool'
-import type { PoolOptions } from '../pool'
-import { PoolType } from '../pool-internal'
+import {
+  isMainThread,
+  type TransferListItem,
+  type Worker
+} from 'node:worker_threads'
+
+import type { MessageValue } from '../../utility-types.js'
+import { AbstractPool } from '../abstract-pool.js'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool.js'
+import { type WorkerType, WorkerTypes } from '../worker.js'
 
 /**
- * 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 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.
- *
- * This pool selects the threads in a round robin fashion.
- *
- * @template DataType of data sent to the worker. This can only be serializable data.
- * @template ResponseType 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> = {}
+    opts: ThreadPoolOptions = {},
+    maximumNumberOfThreads?: number
   ) {
-    super(numberOfThreads, filePath, opts)
+    super(numberOfThreads, filePath, opts, maximumNumberOfThreads)
   }
 
   /** @inheritDoc */
@@ -46,53 +48,90 @@ export class FixedThreadPool<
   }
 
   /** @inheritDoc */
-  public async destroyWorker (
-    worker: ThreadWorkerWithMessageChannel
-  ): Promise<void> {
-    this.sendToWorker(worker, { kill: 1 })
-    await worker.terminate()
+  protected sendToWorker (
+    workerNodeKey: number,
+    message: MessageValue<Data>,
+    transferList?: readonly TransferListItem[]
+  ): void {
+    this.workerNodes[workerNodeKey]?.messageChannel?.port1.postMessage(
+      {
+        ...message,
+        workerId: this.getWorkerInfo(workerNodeKey)?.id
+      } satisfies MessageValue<Data>,
+      transferList
+    )
   }
 
   /** @inheritDoc */
-  protected sendToWorker (
-    worker: ThreadWorkerWithMessageChannel,
-    message: MessageValue<Data>
+  protected sendStartupMessageToWorker (workerNodeKey: number): void {
+    const workerNode = this.workerNodes[workerNodeKey]
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const port2 = workerNode.messageChannel!.port2
+    workerNode.worker.postMessage(
+      {
+        ready: false,
+        workerId: this.getWorkerInfo(workerNodeKey)?.id,
+        port: port2
+      } satisfies MessageValue<Data>,
+      [port2]
+    )
+  }
+
+  /** @inheritDoc */
+  protected registerWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
   ): void {
-    worker.postMessage(message)
+    this.workerNodes[workerNodeKey].messageChannel?.port1.on(
+      'message',
+      listener
+    )
   }
 
   /** @inheritDoc */
-  public registerWorkerMessageListener<Message extends Data | Response> (
-    messageChannel: ThreadWorkerWithMessageChannel,
+  protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    messageChannel.port2?.on('message', listener)
+    this.workerNodes[workerNodeKey].messageChannel?.port1.once(
+      'message',
+      listener
+    )
+  }
+
+  /** @inheritDoc */
+  protected deregisterWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    this.workerNodes[workerNodeKey].messageChannel?.port1.off(
+      'message',
+      listener
+    )
+  }
+
+  /** @inheritDoc */
+  protected shallCreateDynamicWorker (): boolean {
+    return false
   }
 
   /** @inheritDoc */
-  protected createWorker (): ThreadWorkerWithMessageChannel {
-    return new Worker(this.filePath, {
-      env: SHARE_ENV
-    })
+  protected checkAndEmitDynamicWorkerCreationEvents (): void {
+    /* noop */
   }
 
   /** @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 type (): PoolType {
+    return PoolTypes.fixed
   }
 
   /** @inheritDoc */
-  public get type (): PoolType {
-    return PoolType.FIXED
+  protected get worker (): WorkerType {
+    return WorkerTypes.thread
   }
 
   /** @inheritDoc */
-  public get busy (): boolean {
-    return this.internalGetBusyStatus()
+  protected get busy (): boolean {
+    return this.internalBusy()
   }
 }