Merge dependabot/npm_and_yarn/examples/typescript/http-server-pool/fastify-hybrid...
[poolifier.git] / src / pools / cluster / fixed.ts
index dbf1d470b7e7f36eb12dec0bba28c081fac60786..4a8cb4f1eeeafeb59adf1e30c5d678328cb19b70 100644 (file)
@@ -1,26 +1,14 @@
-import cluster, { type ClusterSettings, type Worker } from 'node:cluster'
-import type { MessageValue } from '../../utility-types'
-import { AbstractPool } from '../abstract-pool'
-import { type PoolOptions, type PoolType, PoolTypes } from '../pool'
-import { type WorkerType, WorkerTypes } from '../worker'
+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
-   */
-  env?: Record<string, unknown>
-  /**
-   * Cluster settings.
-   *
-   * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
-   */
-  settings?: ClusterSettings
-}
+export type ClusterPoolOptions = PoolOptions<Worker>
 
 /**
  * A cluster pool with a fixed number of workers.
@@ -44,9 +32,10 @@ export class FixedClusterPool<
   public constructor (
     numberOfWorkers: number,
     filePath: string,
-    protected readonly opts: ClusterPoolOptions = {}
+    opts: ClusterPoolOptions = {},
+    maximumNumberOfWorkers?: number
   ) {
-    super(numberOfWorkers, filePath, opts)
+    super(numberOfWorkers, filePath, opts, maximumNumberOfWorkers)
   }
 
   /** @inheritDoc */
@@ -60,58 +49,65 @@ export class FixedClusterPool<
   }
 
   /** @inheritDoc */
-  protected destroyWorker (worker: Worker): void {
-    this.sendToWorker(worker, { kill: true, workerId: worker.id })
-    worker.on('disconnect', () => {
-      worker.kill()
-    })
-    worker.disconnect()
+  protected sendToWorker (
+    workerNodeKey: number,
+    message: MessageValue<Data>
+  ): void {
+    this.workerNodes[workerNodeKey]?.worker.send({
+      ...message,
+      workerId: this.getWorkerInfo(workerNodeKey)?.id
+    } satisfies MessageValue<Data>)
   }
 
   /** @inheritDoc */
-  protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
-    worker.send(message)
+  protected sendStartupMessageToWorker (workerNodeKey: number): void {
+    this.sendToWorker(workerNodeKey, {
+      ready: false
+    })
   }
 
   /** @inheritDoc */
-  protected sendStartupMessageToWorker (worker: Worker): void {
-    this.sendToWorker(worker, {
-      ready: false,
-      workerId: worker.id
-    })
+  protected registerWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    this.workerNodes[workerNodeKey].worker.on('message', listener)
   }
 
   /** @inheritDoc */
-  protected registerWorkerMessageListener<Message extends Data | Response>(
-    worker: Worker,
+  protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
     listener: (message: MessageValue<Message>) => void
   ): void {
-    worker.on('message', listener)
+    this.workerNodes[workerNodeKey].worker.once('message', listener)
   }
 
   /** @inheritDoc */
-  protected createWorker (): Worker {
-    return cluster.fork(this.opts.env)
+  protected deregisterWorkerMessageListener<Message extends Data | Response>(
+    workerNodeKey: number,
+    listener: (message: MessageValue<Message>) => void
+  ): void {
+    this.workerNodes[workerNodeKey].worker.off('message', listener)
   }
 
   /** @inheritDoc */
-  protected get type (): PoolType {
-    return PoolTypes.fixed
+  protected shallCreateDynamicWorker (): boolean {
+    return false
   }
 
   /** @inheritDoc */
-  protected get worker (): WorkerType {
-    return WorkerTypes.cluster
+  protected checkAndEmitDynamicWorkerCreationEvents (): void {
+    /* noop */
   }
 
   /** @inheritDoc */
-  protected get minSize (): number {
-    return this.numberOfWorkers
+  protected get type (): PoolType {
+    return PoolTypes.fixed
   }
 
   /** @inheritDoc */
-  protected get maxSize (): number {
-    return this.numberOfWorkers
+  protected get worker (): WorkerType {
+    return WorkerTypes.cluster
   }
 
   /** @inheritDoc */