src/worker/cluster-worker.ts

   1 import cluster, { type Worker } from 'node:cluster'
   2 import type { MessageValue } from '../utility-types'
   3 import { AbstractWorker } from './abstract-worker'
   4 import type { WorkerOptions } from './worker-options'
   5 import type { TaskFunctions, WorkerFunction } from './worker-functions'
   6
   7 /**
   8  * A cluster worker used by a poolifier `ClusterPool`.
   9  *
  10  * When this worker is inactive for more than the given `maxInactiveTime`,
  11  * it will send a termination request to its main worker.
  12  *
  13  * If you use a `DynamicClusterPool` the extra workers that were created will be terminated,
  14  * but the minimum number of workers will be guaranteed.
  15  *
  16  * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
  17  * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
  18  * @author [Christopher Quadflieg](https://github.com/Shinigami92)
  19  * @since 2.0.0
  20  */
  21 export class ClusterWorker<
  22   Data = unknown,
  23   Response = unknown
  24 > extends AbstractWorker<Worker, Data, Response> {
  25   /**
  26    * Constructs a new poolifier cluster worker.
  27    *
  28    * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked.
  29    * @param opts - Options for the worker.
  30    */
  31   public constructor (
  32     taskFunctions:
  33     | WorkerFunction<Data, Response>
  34     | TaskFunctions<Data, Response>,
  35     opts: WorkerOptions = {}
  36   ) {
  37     super(
  38       'worker-cluster-pool:poolifier',
  39       cluster.isPrimary,
  40       cluster.worker as Worker,
  41       taskFunctions,
  42       opts
  43     )
  44     if (!this.isMain) {
  45       this.getMainWorker()?.on('message', this.messageListener.bind(this))
  46     }
  47   }
  48
  49   /** @inheritDoc */
  50   protected handleReadyMessage (message: MessageValue<Data>): void {
  51     if (message.workerId === this.id && message.ready != null) {
  52       !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
  53     }
  54   }
  55
  56   /** @inheritDoc */
  57   protected get id (): number {
  58     return this.getMainWorker().id
  59   }
  60
  61   /** @inheritDoc */
  62   protected sendToMainWorker (message: MessageValue<Response>): void {
  63     this.getMainWorker().send(message)
  64   }
  65 }