Merge dependabot/npm_and_yarn/examples/typescript/http-server-pool/fastify-hybrid...

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

diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts
index b2724426a02111108b33debcaa3c116fe9e2b0c5..4a8cb4f1eeeafeb59adf1e30c5d678328cb19b70 100644 (file)
--- a/src/pools/cluster/fixed.ts
+++ b/src/pools/cluster/fixed.ts
@@ -1,92 +1,117 @@
-import { fork, isMaster, setupMaster, Worker } from 'cluster'
-import type { JSONValue, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
-import { AbstractPool } from '../abstract-pool'
+import cluster, { type Worker } from 'node:cluster'
+
+import type { MessageValue } from '../../utility-types.js'
+import { AbstractPool } from '../abstract-pool.js'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool.js'
+import { type WorkerType, WorkerTypes } from '../worker.js'
 
 /**
  * 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
-}
+export type ClusterPoolOptions = PoolOptions<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.
- *
- * @template Data Type of data sent to the worker.
- * @template Response Type of response of execution.
- *
+ * @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
  */
 export class FixedClusterPool<
-  Data extends JSONValue = JSONValue,
-  Response extends JSONValue = JSONValue
+  Data = unknown,
+  Response = unknown
 > extends AbstractPool<Worker, Data, Response> {
   /**
    * 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. Default: `{ maxTasks: 1000 }`
+   * @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 = { maxTasks: 1000 }
+    opts: ClusterPoolOptions = {},
+    maximumNumberOfWorkers?: number
   ) {
-    super(numberOfWorkers, filePath, opts)
+    super(numberOfWorkers, filePath, opts, maximumNumberOfWorkers)
   }
 
+  /** @inheritDoc */
   protected setupHook (): void {
-    setupMaster({
-      exec: this.filePath
-    })
+    cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath })
   }
 
+  /** @inheritDoc */
   protected isMain (): boolean {
-    return isMaster
+    return cluster.isPrimary
   }
 
-  protected destroyWorker (worker: Worker): void {
-    worker.kill()
+  /** @inheritDoc */
+  protected sendToWorker (
+    workerNodeKey: number,
+    message: MessageValue<Data>
+  ): void {
+    this.workerNodes[workerNodeKey]?.worker.send({
+      ...message,
+      workerId: this.getWorkerInfo(workerNodeKey)?.id
+    } satisfies MessageValue<Data>)
   }
 
-  protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
-    worker.send(message)
+  /** @inheritDoc */
+  protected sendStartupMessageToWorker (workerNodeKey: number): void {
+    this.sendToWorker(workerNodeKey, {
+      ready: false
+    })
   }
 
-  protected registerWorkerMessageListener<Message extends Data | Response> (
-    worker: Worker,
+  /** @inheritDoc */
+  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)
   }
 
-  protected unregisterWorkerMessageListener<Message extends Data | Response> (
-    worker: Worker,
+  /** @inheritDoc */
+  protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    worker.removeListener('message', listener)
+    this.workerNodes[workerNodeKey].worker.once('message', listener)
+  }
+
+  /** @inheritDoc */
+  protected deregisterWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    this.workerNodes[workerNodeKey].worker.off('message', listener)
+  }
+
+  /** @inheritDoc */
+  protected shallCreateDynamicWorker (): boolean {
+    return false
+  }
+
+  /** @inheritDoc */
+  protected checkAndEmitDynamicWorkerCreationEvents (): void {
+    /* noop */
+  }
+
+  /** @inheritDoc */
+  protected get type (): PoolType {
+    return PoolTypes.fixed
   }
 
-  protected createWorker (): Worker {
-    return fork(this.opts.env)
+  /** @inheritDoc */
+  protected get worker (): WorkerType {
+    return WorkerTypes.cluster
   }
 
-  protected afterWorkerSetup (worker: Worker): void {
-    // we will attach a listener for every task,
-    // when task is completed the listener will be removed but to avoid warnings we are increasing the max listeners size
-    worker.setMaxListeners(this.opts.maxTasks ?? 1000)
+  /** @inheritDoc */
+  protected get busy (): boolean {
+    return this.internalBusy()
   }
 }