Merge branch 'master' into feature/task-functions

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

diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts
index 7ad425a399d1f08c3c97afbaab9b12272571a580..9470cccd857321388d70e0bf7f09de1a20505cfe 100644 (file)
--- a/src/pools/cluster/fixed.ts
+++ b/src/pools/cluster/fixed.ts
@@ -1,9 +1,8 @@
-import type { Worker } from 'cluster'
-import cluster from 'cluster'
+import cluster, { type ClusterSettings, type Worker } from 'node:cluster'
 import type { MessageValue } from '../../utility-types'
 import { AbstractPool } from '../abstract-pool'
-import type { PoolOptions } from '../pool'
-import { PoolType } from '../pool-internal'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
+import { type WorkerType, WorkerTypes } from '../worker'
 
 /**
  * Options for a poolifier cluster pool.
@@ -14,19 +13,20 @@ export interface ClusterPoolOptions extends PoolOptions<Worker> {
    *
    * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
    */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  env?: any
+  env?: Record<string, unknown>
+  /**
+   * Cluster settings.
+   *
+   * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
+   */
+  settings?: ClusterSettings
 }
 
 /**
  * A cluster pool with a fixed number of workers.
  *
- * It is possible to perform tasks in sync or asynchronous mode as you prefer.
- *
- * This pool selects the workers in a round robin fashion.
- *
- * @template DataType of data sent to the worker. This can only be serializable data.
- * @template ResponseType of response of execution. 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 [Christopher Quadflieg](https://github.com/Shinigami92)
  * @since 2.0.0
  */
@@ -37,23 +37,21 @@ export class FixedClusterPool<
   /**
    * Constructs a new poolifier fixed cluster pool.
    *
-   * @param numberOfWorkers Number of workers for this pool.
-   * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
-   * @param opts Options for this fixed cluster pool.
+   * @param numberOfWorkers - Number of workers for this pool.
+   * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
+   * @param opts - Options for this fixed cluster pool.
    */
   public constructor (
     numberOfWorkers: number,
     filePath: string,
-    public readonly opts: ClusterPoolOptions = {}
+    protected readonly opts: ClusterPoolOptions = {}
   ) {
     super(numberOfWorkers, filePath, opts)
   }
 
   /** @inheritDoc */
   protected setupHook (): void {
-    cluster.setupPrimary({
-      exec: this.filePath
-    })
+    cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath })
   }
 
   /** @inheritDoc */
@@ -62,22 +60,48 @@ export class FixedClusterPool<
   }
 
   /** @inheritDoc */
-  public destroyWorker (worker: Worker): void {
-    this.sendToWorker(worker, { kill: 1 })
-    worker.kill()
+  protected async destroyWorkerNode (workerNodeKey: number): Promise<void> {
+    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.on('exit', () => {
+        resolve()
+      })
+    })
+    worker.on('disconnect', () => {
+      worker.kill()
+    })
+    await this.sendKillMessageToWorker(workerNodeKey)
+    worker.disconnect()
+    await waitWorkerExit
+  }
+
+  /** @inheritDoc */
+  protected sendToWorker (
+    workerNodeKey: number,
+    message: MessageValue<Data>
+  ): void {
+    this.workerNodes[workerNodeKey].worker.send({
+      ...message,
+      workerId: this.workerNodes[workerNodeKey].info.id as number
+    })
   }
 
   /** @inheritDoc */
-  protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
-    worker.send(message)
+  protected sendStartupMessageToWorker (workerNodeKey: number): void {
+    this.sendToWorker(workerNodeKey, {
+      ready: false
+    })
   }
 
   /** @inheritDoc */
-  public registerWorkerMessageListener<Message extends Data | Response> (
-    worker: Worker,
+  protected registerWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    worker.on('message', listener)
+    this.workerNodes[workerNodeKey].worker.on('message', listener)
   }
 
   /** @inheritDoc */
@@ -86,18 +110,17 @@ export class FixedClusterPool<
   }
 
   /** @inheritDoc */
-  protected afterWorkerSetup (worker: Worker): void {
-    // Listen worker messages.
-    this.registerWorkerMessageListener(worker, super.workerListener())
+  protected get type (): PoolType {
+    return PoolTypes.fixed
   }
 
   /** @inheritDoc */
-  public get type (): PoolType {
-    return PoolType.FIXED
+  protected get worker (): WorkerType {
+    return WorkerTypes.cluster
   }
 
   /** @inheritDoc */
-  public get busy (): boolean {
-    return this.internalGetBusyStatus()
+  protected get busy (): boolean {
+    return this.internalBusy()
   }
 }