build(deps-dev): bump typescript

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

diff --git a/src/worker/cluster-worker.ts b/src/worker/cluster-worker.ts
index e750126b929ec93cb7d8e38bcfd9d754eefe6059..325b7a410b6cb7686ebee51f1d37b06043622fad 100644 (file)
--- a/src/worker/cluster-worker.ts
+++ b/src/worker/cluster-worker.ts
@@ -1,96 +1,71 @@
-import { AsyncResource } from 'async_hooks'
-import { isMaster, worker } from 'cluster'
-import type { MessageValue } from '../utility-types'
-import type { WorkerOptions } from './worker-options'
+import cluster, { type Worker } from 'node:cluster'
+
+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 cluster worker used by a poolifier `ClusterPool`.
+ *
+ * When this worker is inactive for more than the given `maxInactiveTime`,
+ * it will send a termination request to its main worker.
  *
- * 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.
+ * 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 AsyncResource {
-  protected readonly maxInactiveTime: number
-  protected readonly async: boolean
-  protected lastTask: number
-  protected readonly interval?: NodeJS.Timeout
-
+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 (
-    fn: (data: Data) => Response,
-    public readonly opts: WorkerOptions = {}
+    taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
+    opts: WorkerOptions = {}
   ) {
-    super('worker-cluster-pool:pioardi')
-
-    this.maxInactiveTime = this.opts.maxInactiveTime ?? 1000 * 60
-    this.async = !!this.opts.async
-    this.lastTask = Date.now()
-    if (!fn) throw new Error('Fn parameter is mandatory')
-    // keep the worker active
-    if (!isMaster) {
-      // console.log('ClusterWorker#constructor', 'is not master')
-      this.interval = setInterval(
-        this.checkAlive.bind(this),
-        this.maxInactiveTime / 2
-      )
-      this.checkAlive.bind(this)()
-    }
-    worker.on('message', (value: MessageValue<Data>) => {
-      // console.log("cluster.on('message', value)", value)
-      if (value?.data && value.id) {
-        // here you will receive messages
-        // console.log('This is the main worker ' + isMaster)
-        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()
-      }
-    })
+    super(cluster.isPrimary, cluster.worker, taskFunctions, opts)
   }
 
-  protected checkAlive (): void {
-    if (Date.now() - this.lastTask > this.maxInactiveTime) {
-      worker.send({ kill: 1 })
+  /** @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 run (
-    fn: (data?: Data) => Response,
-    value: MessageValue<Data>
-  ): void {
-    try {
-      const res = fn(value.data as Data)
-      worker.send({ data: res, id: value.id })
-      this.lastTask = Date.now()
-    } catch (e) {
-      const err = e instanceof Error ? e.message : e
-      worker.send({ error: err, id: value.id })
-      this.lastTask = Date.now()
-    }
+  /** @inheritDoc */
+  protected get id (): number {
+    return this.getMainWorker().id
   }
 
-  protected runAsync (
-    fn: (data?: Data) => Promise<Response>,
-    value: MessageValue<Data>
-  ): void {
-    fn(value.data)
-      .then(res => {
-        worker.send({ data: res, id: value.id })
-        this.lastTask = Date.now()
-        return null
-      })
-      .catch(e => {
-        const err = e instanceof Error ? e.message : e
-        worker.send({ error: err, id: value.id })
-        this.lastTask = Date.now()
-      })
+  /** @inheritDoc */
+  protected readonly sendToMainWorker = (
+    message: MessageValue<Response>
+  ): void => {
+    this.getMainWorker().send({
+      ...message,
+      workerId: this.id
+    } satisfies MessageValue<Response>)
   }
 }