Merge dependabot/npm_and_yarn/eslint-config-love-44.0.0 into combined-prs-branch

[poolifier.git] / src / worker / thread-worker.ts

diff --git a/src/worker/thread-worker.ts b/src/worker/thread-worker.ts
index 80b06ee9108f1b923a8a5af880e6803f678f649d..7115d71568a6fc0664ba6f74b17085b35bc50655 100644 (file)
--- a/src/worker/thread-worker.ts
+++ b/src/worker/thread-worker.ts
@@ -1,55 +1,101 @@
-import { isMainThread, parentPort } from 'worker_threads'
-import type { JSONValue, MessageValue } from '../utility-types'
-import { AbstractWorker } from './abstract-worker'
-import type { WorkerOptions } from './worker-options'
+import {
+  isMainThread,
+  type MessagePort,
+  parentPort,
+  threadId
+} from 'node:worker_threads'
+
+import type { MessageValue } from '../utility-types.js'
+import { AbstractWorker } from './abstract-worker.js'
+import type { TaskFunction, TaskFunctions } from './task-functions.js'
+import type { WorkerOptions } from './worker-options.js'
 
 /**
- * An example worker that will be always alive, you just need to **extend** this class if you want a static pool.
+ * A thread worker used by a poolifier `ThreadPool`.
+ *
+ * When this worker is inactive for more than the given `maxInactiveTime`,
+ * it will send a termination request to its main thread.
  *
- * When this worker is inactive for more than 1 minute, it will send this info to the main thread,
- * if you are using DynamicThreadPool, the workers created after will be killed, the min num of thread will be guaranteed.
+ * 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 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
  */
 export class ThreadWorker<
-  Data extends JSONValue = JSONValue,
-  Response extends JSONValue = JSONValue
+  Data = unknown,
+  Response = unknown
 > extends AbstractWorker<MessagePort, Data, Response> {
-  protected parent?: MessagePort
-
-  public constructor (fn: (data: Data) => Response, opts: WorkerOptions = {}) {
-    super('worker-thread-pool:pioardi', isMainThread, fn, opts)
-
-    parentPort?.on('message', (value: MessageValue<Data>) => {
-      if (value?.data && value.id) {
-        // here you will receive messages
-        // console.log('This is the main worker ' + isMain)
-        if (this.async) {
-          this.runInAsyncScope(this.runAsync.bind(this), this, fn, value)
-        } else {
-          this.runInAsyncScope(this.run.bind(this), this, fn, value)
-        }
-      } else if (value.parent) {
-        // save the port to communicate with the main thread
-        // this will be received once
-        this.parent = value.parent
-      } else if (value.kill) {
-        // here is time to kill this worker, just clearing the interval
-        if (this.interval) clearInterval(this.interval)
-        this.emitDestroy()
-      }
-    })
+  /**
+   * Message port used to communicate with the main worker.
+   */
+  private port?: MessagePort
+
+  /**
+   * Constructs a new poolifier thread worker.
+   *
+   * @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 (
+    taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
+    opts: WorkerOptions = {}
+  ) {
+    super(isMainThread, parentPort, taskFunctions, opts)
   }
 
-  protected getMainWorker (): MessagePort {
-    if (!this.parent) {
-      throw new Error('Parent was not set')
+  /** @inheritDoc */
+  protected handleReadyMessage (message: MessageValue<Data>): void {
+    if (
+      message.workerId === this.id &&
+      message.ready === false &&
+      message.port != null
+    ) {
+      try {
+        this.port = message.port
+        this.port.on('message', this.messageListener.bind(this))
+        this.sendToMainWorker({
+          ready: true,
+          taskFunctionNames: this.listTaskFunctionNames()
+        })
+      } catch {
+        this.sendToMainWorker({
+          ready: false,
+          taskFunctionNames: this.listTaskFunctionNames()
+        })
+      }
     }
-    return this.parent
   }
 
-  protected sendToMainWorker (message: MessageValue<Response>): void {
-    this.getMainWorker().postMessage(message)
+  /** @inheritDoc */
+  protected handleKillMessage (message: MessageValue<Data>): void {
+    super.handleKillMessage(message)
+    this.port?.unref()
+    this.port?.close()
+  }
+
+  /** @inheritDoc */
+  protected get id (): number {
+    return threadId
+  }
+
+  /** @inheritDoc */
+  protected readonly sendToMainWorker = (
+    message: MessageValue<Response>
+  ): void => {
+    this.port?.postMessage({
+      ...message,
+      workerId: this.id
+    } satisfies MessageValue<Response>)
+  }
+
+  /**
+   * @inheritDoc
+   * @override
+   */
+  protected handleError (error: Error | string): string {
+    return error as string
   }
 }