Merge branch 'master' of github.com:poolifier/poolifier

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

diff --git a/src/worker/cluster-worker.ts b/src/worker/cluster-worker.ts
index 092dd51129089f761e06da0d8db39672396c119a..0fd9095625fa7ab6bf4bd9203cbf9b4e2ef03348 100644 (file)
--- a/src/worker/cluster-worker.ts
+++ b/src/worker/cluster-worker.ts
@@ -1,53 +1,71 @@
-import type { Worker } from 'cluster'
-import { isMaster, worker } from 'cluster'
+import cluster, { type Worker } from 'node:cluster'
 import type { MessageValue } from '../utility-types'
 import { AbstractWorker } from './abstract-worker'
 import type { WorkerOptions } from './worker-options'
+import type { TaskFunction, TaskFunctions } from './task-functions'
 
 /**
- * An example worker that will be always alive, you just need to **extend** this class if you want a static pool.
+ * A cluster worker used by a poolifier `ClusterPool`.
  *
- * When this worker is inactive for more than 1 minute, it will send this info to the main worker,
- * if you are using DynamicClusterPool, the workers created after will be killed, the min num of worker will be guaranteed.
+ * When this worker is inactive for more than the given `maxInactiveTime`,
+ * it will send a termination request to its main worker.
  *
+ * If you use a `DynamicClusterPool` 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 worker. This can only be structured-cloneable data.
  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export class ClusterWorker<Data = any, Response = any> extends AbstractWorker<
-  Worker,
-  Data,
-  Response
-> {
-  public constructor (fn: (data: Data) => Response, opts: WorkerOptions = {}) {
-    super('worker-cluster-pool:pioardi', isMaster, fn, opts)
+export class ClusterWorker<
+  Data = unknown,
+  Response = unknown
+> extends AbstractWorker<Worker, Data, Response> {
+  /**
+   * Constructs a new poolifier cluster 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(
+      'poolifier:cluster-worker',
+      cluster.isPrimary,
+      cluster.worker as Worker,
+      taskFunctions,
+      opts
+    )
+  }
 
-    worker.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.kill) {
-        // here is time to kill this worker, just clearing the interval
-        if (this.interval) clearInterval(this.interval)
-        this.emitDestroy()
+  /** @inheritDoc */
+  protected handleReadyMessage (message: MessageValue<Data>): void {
+    if (message.workerId === this.id && message.ready === false) {
+      try {
+        this.getMainWorker().on('message', this.messageListener.bind(this))
+        this.sendToMainWorker({
+          ready: true,
+          taskFunctionNames: this.listTaskFunctionNames()
+        })
+      } catch {
+        this.sendToMainWorker({
+          ready: false,
+          taskFunctionNames: this.listTaskFunctionNames()
+        })
       }
-    })
+    }
   }
 
-  protected getMainWorker (): Worker {
-    return worker
+  /** @inheritDoc */
+  protected get id (): number {
+    return this.getMainWorker().id
   }
 
+  /** @inheritDoc */
   protected sendToMainWorker (message: MessageValue<Response>): void {
-    this.getMainWorker().send(message)
-  }
-
-  protected handleError (e: Error | string): string {
-    return e instanceof Error ? e.message : e
+    this.getMainWorker().send({ ...message, workerId: this.id })
   }
 }