Merge pull request #879 from poolifier/dependabot/npm_and_yarn/examples/typescript...

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

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index 2c4f66f0ff4d8be12d192f4028b1b1a17262bbc7..32107e48635314e25269cc37e2c0ad7fdd3fcd75 100644 (file)
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,35 +1,41 @@
 import {
-  isMainThread,
-  MessageChannel,
+  type MessageChannel,
+  type MessagePort,
   SHARE_ENV,
-  Worker
+  type TransferListItem,
+  Worker,
+  type WorkerOptions,
+  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 } 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.
- *
- * @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.
+ * @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.
    *
@@ -40,69 +46,90 @@ export class FixedThreadPool<
   public constructor (
     numberOfThreads: number,
     filePath: string,
-    opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+    protected readonly opts: ThreadPoolOptions = {}
   ) {
     super(numberOfThreads, filePath, opts)
   }
 
-  /** {@inheritDoc} */
+  /** @inheritDoc */
   protected isMain (): boolean {
     return isMainThread
   }
 
-  /** {@inheritDoc} */
-  public async destroyWorker (
-    worker: ThreadWorkerWithMessageChannel
-  ): Promise<void> {
-    this.sendToWorker(worker, { kill: 1 })
+  /** @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, worker.threadId)
+    workerNode.closeChannel()
     await worker.terminate()
+    await waitWorkerExit
   }
 
-  /** {@inheritDoc} */
+  /** @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)
+  }
+
+  /** @inheritDoc */
+  protected sendStartupMessageToWorker (workerNodeKey: number): void {
+    const worker = this.workerNodes[workerNodeKey].worker
+    const port2: MessagePort = (
+      this.workerNodes[workerNodeKey].messageChannel as MessageChannel
+    ).port2
+    worker.postMessage(
+      {
+        ready: false,
+        workerId: worker.threadId,
+        port: port2
+      },
+      [port2]
+    )
   }
 
-  /** {@inheritDoc} */
-  public registerWorkerMessageListener<Message extends Data | Response>(
-    messageChannel: ThreadWorkerWithMessageChannel,
+  /** @inheritDoc */
+  protected registerWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    messageChannel.port2?.on('message', listener)
+    (
+      this.workerNodes[workerNodeKey].messageChannel as MessageChannel
+    ).port1.on('message', listener)
   }
 
-  /** {@inheritDoc} */
-  protected createWorker (): ThreadWorkerWithMessageChannel {
+  /** @inheritDoc */
+  protected createWorker (): Worker {
     return new Worker(this.filePath, {
-      env: SHARE_ENV
+      env: SHARE_ENV,
+      ...this.opts.workerOptions
     })
   }
 
-  /** {@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())
-  }
-
-  /** {@inheritDoc} */
-  public get type (): PoolType {
-    return PoolType.FIXED
+  /** @inheritDoc */
+  protected get type (): PoolType {
+    return PoolTypes.fixed
   }
 
-  /** {@inheritDoc} */
-  public get full (): boolean {
-    return this.workers.length === this.numberOfWorkers
+  /** @inheritDoc */
+  protected get worker (): WorkerType {
+    return WorkerTypes.thread
   }
 
-  /** {@inheritDoc} */
-  public get busy (): boolean {
+  /** @inheritDoc */
+  protected get busy (): boolean {
     return this.internalBusy()
   }
 }