src/worker/cluster-worker.ts

   1 import cluster, { type Worker } from 'node:cluster'
   2 import type { MessageValue } from '../utility-types.js'
   3 import { AbstractWorker } from './abstract-worker.js'
   4 import type { WorkerOptions } from './worker-options.js'
   5 import type { TaskFunction, TaskFunctions } from './task-functions.js'
   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: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
  33     opts: WorkerOptions = {}
  34   ) {
  35     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
  36     super(cluster.isPrimary, cluster.worker!, taskFunctions, opts)
  37   }
  38
  39   /** @inheritDoc */
  40   protected handleReadyMessage (message: MessageValue<Data>): void {
  41     if (message.workerId === this.id && message.ready === false) {
  42       try {
  43         this.getMainWorker().on('message', this.messageListener.bind(this))
  44         this.sendToMainWorker({
  45           ready: true,
  46           taskFunctionNames: this.listTaskFunctionNames()
  47         })
  48       } catch {
  49         this.sendToMainWorker({
  50           ready: false,
  51           taskFunctionNames: this.listTaskFunctionNames()
  52         })
  53       }
  54     }
  55   }
  56
  57   /** @inheritDoc */
  58   protected get id (): number {
  59     return this.getMainWorker().id
  60   }
  61
  62   /** @inheritDoc */
  63   protected readonly sendToMainWorker = (
  64     message: MessageValue<Response>
  65   ): void => {
  66     this.getMainWorker().send({ ...message, workerId: this.id })
  67   }
  68 }