Only allow primitive JSON for transfer between worker and main worker (#128)

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

import type { Worker } from 'cluster'
import type { JSONValue, MessageValue } from '../../utility-types'
import type { ClusterPoolOptions } from './fixed'
import { FixedClusterPool } from './fixed'

/**
 * A cluster pool with a min/max number of workers, is possible to execute tasks in sync or async mode as you prefer.
 *
 * This cluster pool will create new workers when the other ones are busy, until the max number of workers,
 * when the max number of workers is reached, an event will be emitted, if you want to listen this event use the emitter method.
 *
 * @author [Christopher Quadflieg](https://github.com/Shinigami92)
 * @since 2.0.0
 */
export class DynamicClusterPool<
  Data extends JSONValue = JSONValue,
  Response extends JSONValue = JSONValue
> extends FixedClusterPool<Data, Response> {
  /**
   * @param min Min number of workers that will be always active
   * @param max Max number of workers that will be active
   * @param filename A file path with implementation of `ClusterWorker` class, relative path is fine.
   * @param opts An object with possible options for example `errorHandler`, `onlineHandler`. Default: `{ maxTasks: 1000 }`
   */
  public constructor (
    min: number,
    public readonly max: number,
    filename: string,
    opts: ClusterPoolOptions = { maxTasks: 1000 }
  ) {
    super(min, filename, opts)
  }

  protected chooseWorker (): Worker {
    let worker: Worker | undefined
    for (const entry of this.tasks) {
      if (entry[1] === 0) {
        worker = entry[0]
        break
      }
    }

    if (worker) {
      // a worker is free, use it
      return worker
    } else {
      if (this.workers.length === this.max) {
        this.emitter.emit('FullPool')
        return super.chooseWorker()
      }
      // all workers are busy create a new worker
      const worker = this.internalNewWorker()
      worker.on('message', (message: MessageValue<Data>) => {
        if (message.kill) {
          this.sendToWorker(worker, { kill: 1 })
          void this.destroyWorker(worker)
          // clean workers from data structures
          const workerIndex = this.workers.indexOf(worker)
          this.workers.splice(workerIndex, 1)
          this.tasks.delete(worker)
        }
      })
      return worker
    }
  }
}