fix: unref() message port at worker exit
[poolifier.git] / src / worker / thread-worker.ts
index ce17c59a19c0644f3b2eb188e712e29447c0c773..4d4c1c3479f14970db523ff96d873f0b4cdac79f 100644 (file)
@@ -1,12 +1,13 @@
-import type { MessagePort } from 'node:worker_threads'
-import { isMainThread, parentPort } from 'node:worker_threads'
-import type {
-  MessageValue,
-  TaskFunctions,
-  WorkerFunction
-} from '../utility-types'
+import {
+  type MessagePort,
+  isMainThread,
+  parentPort,
+  threadId
+} from 'node:worker_threads'
+import type { MessageValue } from '../utility-types'
 import { AbstractWorker } from './abstract-worker'
 import type { WorkerOptions } from './worker-options'
+import type { TaskFunctions, WorkerFunction } from './worker-functions'
 
 /**
  * A thread worker used by a poolifier `ThreadPool`.
@@ -17,8 +18,8 @@ import type { WorkerOptions } from './worker-options'
  * If you use a `DynamicThreadPool` the extra workers that were created will be terminated,
  * but the minimum number of workers will be guaranteed.
  *
- * @typeParam Data - Type of data this worker receives from pool's execution. This can only be serializable data.
- * @typeParam Response - Type of response the worker sends back to the main thread. This can only be serializable data.
+ * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
+ * @typeParam Response - Type of response the worker sends back to the main thread. This can only be structured-cloneable data.
  * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
  * @since 0.0.1
  */
@@ -26,21 +27,64 @@ export class ThreadWorker<
   Data = unknown,
   Response = unknown
 > extends AbstractWorker<MessagePort, Data, Response> {
+  /**
+   * Message port used to communicate with the main thread.
+   */
+  private port!: MessagePort
   /**
    * Constructs a new poolifier thread worker.
    *
-   * @param fn - Function processed by the worker when the pool's `execution` function is invoked.
+   * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked.
    * @param opts - Options for the worker.
    */
   public constructor (
-    fn: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>,
+    taskFunctions:
+    | WorkerFunction<Data, Response>
+    | TaskFunctions<Data, Response>,
     opts: WorkerOptions = {}
   ) {
-    super('worker-thread-pool:poolifier', isMainThread, fn, parentPort, opts)
+    super(
+      'worker-thread-pool:poolifier',
+      isMainThread,
+      parentPort as MessagePort,
+      taskFunctions,
+      opts
+    )
+  }
+
+  /** @inheritDoc */
+  protected handleReadyMessage (message: MessageValue<Data>): void {
+    if (
+      !this.isMain &&
+      message.workerId === this.id &&
+      message.ready != null &&
+      message.port != null
+    ) {
+      this.port = message.port
+      this.port.on('message', this.messageListener.bind(this))
+      this.sendToMainWorker({ ready: true, workerId: this.id })
+    }
+  }
+
+  /** @inheritDoc */
+  protected handleKillMessage (message: MessageValue<Data, unknown>): void {
+    super.handleKillMessage(message)
+    this.port?.unref()
+    this.port?.close()
+  }
+
+  /** @inheritDoc */
+  protected get id (): number {
+    return threadId
   }
 
   /** @inheritDoc */
   protected sendToMainWorker (message: MessageValue<Response>): void {
-    this.getMainWorker().postMessage(message)
+    this.port.postMessage(message)
+  }
+
+  /** @inheritDoc */
+  protected handleError (e: Error | string): string {
+    return e as string
   }
 }