X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Ffixed.ts;h=d69055cf0909efa3b9cf45983163e0be6a35c513;hb=c3581f79ea34bd89cbdff40ac6c44eb7394f7919;hp=bed8f3a7dba8ae87ed6085df040723a93eb0e739;hpb=cda5cc74c77bdfc37b220ef19637876e221b5061;p=poolifier.git

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index bed8f3a7..d69055cf 100644
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,83 +1,138 @@
-import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
-import type { Draft, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
+import {
+  type MessageChannel,
+  type MessagePort,
+  SHARE_ENV,
+  type TransferListItem,
+  Worker,
+  type WorkerOptions,
+  isMainThread
+} from 'node:worker_threads'
+import type { MessageValue } from '../../utility-types'
 import { AbstractPool } from '../abstract-pool'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
+import { type WorkerType, WorkerTypes } from '../worker'
 
-export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>
+/**
+ * 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 pool with a static number of threads, is possible to execute tasks in sync or async mode as you prefer.
- *
- * This pool will select the worker thread in a round robin fashion.
+ * A thread pool with a fixed number of threads.
  *
+ * @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
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export class FixedThreadPool<Data = any, Response = any> extends AbstractPool<
-  ThreadWorkerWithMessageChannel,
-  Data,
-  Response
-> {
+export class FixedThreadPool<
+  Data = unknown,
+  Response = unknown
+> extends AbstractPool<Worker, Data, Response> {
   /**
-   * @param numThreads Num of threads for this worker pool.
-   * @param filePath A file path with implementation of `ThreadWorker` class, relative path is fine.
-   * @param opts An object with possible options for example `errorHandler`, `onlineHandler`. Default: `{ maxTasks: 1000 }`
+   * 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.
    */
   public constructor (
-    numThreads: number,
+    numberOfThreads: number,
     filePath: string,
-    opts: PoolOptions<ThreadWorkerWithMessageChannel> = { maxTasks: 1000 }
+    protected readonly opts: ThreadPoolOptions = {}
   ) {
-    super(numThreads, filePath, opts)
+    super(numberOfThreads, filePath, opts)
   }
 
+  /** @inheritDoc */
   protected isMain (): boolean {
     return isMainThread
   }
 
-  protected async destroyWorker (
-    worker: ThreadWorkerWithMessageChannel
-  ): Promise<void> {
+  /** @inheritDoc */
+  protected async destroyWorkerNode (workerNodeKey: number): Promise<void> {
+    this.flushTasksQueue(workerNodeKey)
+    // FIXME: wait for tasks to be finished
+    const workerNode = this.workerNodes[workerNodeKey]
+    const worker = workerNode.worker
+    const waitWorkerExit = new Promise<void>((resolve) => {
+      worker.on('exit', () => {
+        resolve()
+      })
+    })
+    await this.sendKillMessageToWorker(
+      workerNodeKey,
+      workerNode.info.id as number
+    )
+    workerNode.closeChannel()
     await worker.terminate()
+    await waitWorkerExit
   }
 
+  /** @inheritDoc */
   protected sendToWorker (
-    worker: ThreadWorkerWithMessageChannel,
-    message: MessageValue<Data>
+    workerNodeKey: number,
+    message: MessageValue<Data>,
+    transferList?: TransferListItem[]
   ): void {
-    worker.postMessage(message)
+    (
+      this.workerNodes[workerNodeKey].messageChannel as MessageChannel
+    ).port1.postMessage(message, transferList)
   }
 
-  protected registerWorkerMessageListener (
-    port: ThreadWorkerWithMessageChannel,
-    listener: (message: MessageValue<Response>) => void
-  ): void {
-    port.port2?.on('message', listener)
+  /** @inheritDoc */
+  protected sendStartupMessageToWorker (workerNodeKey: number): void {
+    const workerNode = this.workerNodes[workerNodeKey]
+    const worker = workerNode.worker
+    const port2: MessagePort = (workerNode.messageChannel as MessageChannel)
+      .port2
+    worker.postMessage(
+      {
+        ready: false,
+        workerId: workerNode.info.id,
+        port: port2
+      },
+      [port2]
+    )
   }
 
-  protected unregisterWorkerMessageListener (
-    port: ThreadWorkerWithMessageChannel,
-    listener: (message: MessageValue<Response>) => void
+  /** @inheritDoc */
+  protected registerWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
   ): void {
-    port.port2?.removeListener('message', listener)
+    (
+      this.workerNodes[workerNodeKey].messageChannel as MessageChannel
+    ).port1.on('message', listener)
   }
 
-  protected newWorker (): ThreadWorkerWithMessageChannel {
+  /** @inheritDoc */
+  protected createWorker (): Worker {
     return new Worker(this.filePath, {
-      env: SHARE_ENV
+      env: SHARE_ENV,
+      ...this.opts.workerOptions
     })
   }
 
-  protected afterNewWorkerPushed (
-    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)
+  /** @inheritDoc */
+  protected get type (): PoolType {
+    return PoolTypes.fixed
+  }
+
+  /** @inheritDoc */
+  protected get worker (): WorkerType {
+    return WorkerTypes.thread
+  }
+
+  /** @inheritDoc */
+  protected get busy (): boolean {
+    return this.internalBusy()
   }
 }