README.md: refinement

[e-mobility-charging-stations-simulator.git] / src / worker / WorkerDynamicPool.ts

import { DynamicThreadPool, PoolOptions } from 'poolifier';

import Utils from '../utils/Utils';
import { Worker } from 'worker_threads';
import WorkerAbstract from './WorkerAbstract';
import { WorkerData } from '../types/Worker';

export default class WorkerDynamicPool<T> extends WorkerAbstract {
  private pool: DynamicPool;

  /**
   * Create a new `WorkerDynamicPool`.
   *
   * @param {string} workerScript
   * @param {number} min
   * @param {number} max
   * @param {number} workerStartDelay
   */
  constructor(workerScript: string, min: number, max: number, workerStartDelay?: number) {
    super(workerScript, workerStartDelay);
    this.pool = DynamicPool.getInstance(min, max, this.workerScript);
  }

  get size(): number {
    return this.pool.workers.length;
  }

  get maxElementsPerWorker(): number {
    return null;
  }

  /**
   *
   * @returns {Promise<void>}
   * @public
   */
  // eslint-disable-next-line @typescript-eslint/no-empty-function
  public async start(): Promise<void> { }

  /**
   *
   * @returns {Promise<void>}
   * @public
   */
  // eslint-disable-next-line @typescript-eslint/require-await
  public async stop(): Promise<void> {
    return this.pool.destroy();
  }

  /**
   *
   * @param elementData
   * @returns {Promise<void>}
   * @public
   */
  public async addElement(elementData: T): Promise<void> {
    await this.pool.execute(elementData);
    // Start worker sequentially to optimize memory at startup
    await Utils.sleep(this.workerStartDelay);
  }
}

class DynamicPool extends DynamicThreadPool<WorkerData> {
  private static instance: DynamicPool;

  private constructor(min: number, max: number, workerScript: string, opts?: PoolOptions<Worker>) {
    super(min, max, workerScript, opts);
  }

  public static getInstance(min: number, max: number, workerScript: string): DynamicPool {
    if (!DynamicPool.instance) {
      DynamicPool.instance = new DynamicPool(min, max, workerScript,
        {
          exitHandler: (code) => {
            if (code !== 0) {
              console.error(`Worker stopped with exit code ${code}`);
            }
          }
        }
      );
    }
    return DynamicPool.instance;
  }
}