src/worker/cluster-worker.ts

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