Merge dependabot/npm_and_yarn/examples/typescript/websocket-server-pool/ws-hybrid...

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

diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts
index a9d8f685fec3432db4fc6829dabcfd84f146babe..ddda04b113ec9028b0cd24c8f53001d12714a901 100644 (file)
--- a/src/pools/thread/fixed.ts
+++ b/src/pools/thread/fixed.ts
@@ -1,19 +1,16 @@
 import {
-  MessageChannel,
+  type MessageChannel,
+  type MessagePort,
   SHARE_ENV,
+  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,
-  type PoolType,
-  PoolTypes,
-  type WorkerType,
-  WorkerTypes
-} from '../pool'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
+import { type WorkerType, WorkerTypes } from '../worker'
 
 /**
  * Options for a poolifier thread pool.
@@ -27,27 +24,18 @@ export interface ThreadPoolOptions extends PoolOptions<Worker> {
   workerOptions?: WorkerOptions
 }
 
-/**
- * A thread worker with message channels for communication between main thread and thread worker.
- */
-export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>
-
 /**
  * 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 execution response. 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.
    *
@@ -69,47 +57,90 @@ export class FixedThreadPool<
   }
 
   /** @inheritDoc */
-  protected async destroyWorker (
-    worker: ThreadWorkerWithMessageChannel
-  ): Promise<void> {
-    this.sendToWorker(worker, { kill: 1 })
+  protected async destroyWorkerNode (workerNodeKey: number): Promise<void> {
+    this.flagWorkerNodeAsNotReady(workerNodeKey)
+    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.once('exit', () => {
+        resolve()
+      })
+    })
+    await this.sendKillMessageToWorker(workerNodeKey)
+    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, workerId: this.getWorkerInfo(workerNodeKey).id },
+      transferList
+    )
+  }
+
+  /** @inheritDoc */
+  protected sendStartupMessageToWorker (workerNodeKey: number): void {
+    const workerNode = this.workerNodes[workerNodeKey]
+    const port2: MessagePort = (workerNode.messageChannel as MessageChannel)
+      .port2
+    workerNode.worker.postMessage(
+      {
+        ready: false,
+        workerId: this.getWorkerInfo(workerNodeKey).id,
+        port: port2
+      },
+      [port2]
+    )
   }
 
   /** @inheritDoc */
   protected registerWorkerMessageListener<Message extends Data | Response>(
-    worker: ThreadWorkerWithMessageChannel,
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    (
+      this.workerNodes[workerNodeKey]?.messageChannel as MessageChannel
+    ).port1.on('message', listener)
+  }
+
+  /** @inheritDoc */
+  protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    worker.port2?.on('message', listener)
+    (
+      this.workerNodes[workerNodeKey]?.messageChannel as MessageChannel
+    ).port1.once('message', listener)
   }
 
   /** @inheritDoc */
-  protected createWorker (): ThreadWorkerWithMessageChannel {
+  protected deregisterWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    (
+      this.workerNodes[workerNodeKey]?.messageChannel as MessageChannel
+    ).port1.off('message', listener)
+  }
+
+  /** @inheritDoc */
+  protected createWorker (): Worker {
     return new Worker(this.filePath, {
       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 */
   protected get type (): PoolType {
     return PoolTypes.fixed
@@ -120,16 +151,6 @@ export class FixedThreadPool<
     return WorkerTypes.thread
   }
 
-  /** @inheritDoc */
-  protected get minSize (): number {
-    return this.numberOfWorkers
-  }
-
-  /** @inheritDoc */
-  protected get maxSize (): number {
-    return this.numberOfWorkers
-  }
-
   /** @inheritDoc */
   protected get busy (): boolean {
     return this.internalBusy()