docs: add changelog entry

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

diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts
index a0c6b16f6ed7b5a16e38c30c75c62302cd54b9c7..46cabdcb75787700bab966bed3ce3312056659ad 100644 (file)
--- a/src/pools/cluster/fixed.ts
+++ b/src/pools/cluster/fixed.ts
@@ -1,37 +1,14 @@
-import type { ClusterSettings, Worker } from 'node:cluster'
-import cluster from 'node:cluster'
+import cluster, { type Worker } from 'node:cluster'
 import type { MessageValue } from '../../utility-types'
 import { AbstractPool } from '../abstract-pool'
 import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
-
-/**
- * Options for a poolifier cluster pool.
- */
-export interface ClusterPoolOptions extends PoolOptions<Worker> {
-  /**
-   * Key/value pairs to add to worker process environment.
-   *
-   * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
-   */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  env?: any
-  /**
-   * Cluster settings.
-   *
-   * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
-   */
-  settings?: ClusterSettings
-}
+import { type WorkerType, WorkerTypes } from '../worker'
 
 /**
  * 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.
- *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. 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
  */
@@ -49,7 +26,7 @@ export class FixedClusterPool<
   public constructor (
     numberOfWorkers: number,
     filePath: string,
-    public readonly opts: ClusterPoolOptions = {}
+    protected readonly opts: PoolOptions<Worker> = {}
   ) {
     super(numberOfWorkers, filePath, opts)
   }
@@ -65,53 +42,55 @@ export class FixedClusterPool<
   }
 
   /** @inheritDoc */
-  protected destroyWorker (worker: Worker): void {
-    this.sendToWorker(worker, { kill: 1 })
-    worker.kill()
+  protected sendToWorker (
+    workerNodeKey: number,
+    message: MessageValue<Data>
+  ): void {
+    this.workerNodes[workerNodeKey].worker.send({
+      ...message,
+      workerId: this.getWorkerInfo(workerNodeKey).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 */
   protected registerWorkerMessageListener<Message extends Data | Response>(
-    worker: Worker,
+    workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    worker.on('message', listener)
+    this.workerNodes[workerNodeKey].worker.on('message', listener)
   }
 
   /** @inheritDoc */
-  protected createWorker (): Worker {
-    return cluster.fork(this.opts.env)
+  protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    this.workerNodes[workerNodeKey].worker.once('message', listener)
   }
 
   /** @inheritDoc */
-  protected afterWorkerSetup (worker: Worker): void {
-    // Listen to worker messages.
-    this.registerWorkerMessageListener(worker, super.workerListener())
+  protected deregisterWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    this.workerNodes[workerNodeKey].worker.off('message', listener)
   }
 
   /** @inheritDoc */
-  public get type (): PoolType {
+  protected get type (): PoolType {
     return PoolTypes.fixed
   }
 
   /** @inheritDoc */
-  protected get minSize (): number {
-    return this.numberOfWorkers
-  }
-
-  /** @inheritDoc */
-  protected get maxSize (): number {
-    return this.numberOfWorkers
-  }
-
-  /** @inheritDoc */
-  protected get full (): boolean {
-    return this.workerNodes.length >= this.numberOfWorkers
+  protected get worker (): WorkerType {
+    return WorkerTypes.cluster
   }
 
   /** @inheritDoc */