src/worker/WorkerSet.ts

   1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
   2
   3 import { Worker } from 'worker_threads';
   4
   5 import {
   6   type MessageHandler,
   7   type WorkerData,
   8   WorkerMessageEvents,
   9   type WorkerOptions,
  10   type WorkerSetElement,
  11 } from '../types/Worker';
  12 import Utils from '../utils/Utils';
  13 import WorkerAbstract from './WorkerAbstract';
  14 import { WorkerUtils } from './WorkerUtils';
  15
  16 export default class WorkerSet extends WorkerAbstract<WorkerData> {
  17   private readonly workerSet: Set<WorkerSetElement>;
  18
  19   /**
  20    * Create a new `WorkerSet`.
  21    *
  22    * @param workerScript -
  23    * @param workerOptions -
  24    */
  25   constructor(workerScript: string, workerOptions?: WorkerOptions) {
  26     super(workerScript, workerOptions);
  27     this.workerSet = new Set<WorkerSetElement>();
  28   }
  29
  30   get size(): number {
  31     return this.workerSet.size;
  32   }
  33
  34   get maxElementsPerWorker(): number | null {
  35     return this.workerOptions.elementsPerWorker;
  36   }
  37
  38   /**
  39    *
  40    * @param elementData -
  41    * @returns
  42    * @public
  43    */
  44   public async addElement(elementData: WorkerData): Promise<void> {
  45     if (!this.workerSet) {
  46       throw new Error("Cannot add a WorkerSet element: workers' set does not exist");
  47     }
  48     if (
  49       this.workerSet.size === 0 ||
  50       this.getLastWorkerSetElement().numberOfWorkerElements >= this.workerOptions.elementsPerWorker
  51     ) {
  52       await this.startWorker();
  53     }
  54     this.getLastWorker().postMessage({
  55       id: WorkerMessageEvents.START_WORKER_ELEMENT,
  56       data: elementData,
  57     });
  58     this.getLastWorkerSetElement().numberOfWorkerElements++;
  59     // Start element sequentially to optimize memory at startup
  60     if (this.workerOptions.elementStartDelay > 0) {
  61       await Utils.sleep(this.workerOptions.elementStartDelay);
  62     }
  63   }
  64
  65   /**
  66    *
  67    * @returns
  68    * @public
  69    */
  70   public async start(): Promise<void> {
  71     await this.startWorker();
  72   }
  73
  74   /**
  75    *
  76    * @returns
  77    * @public
  78    */
  79   public async stop(): Promise<void> {
  80     for (const workerSetElement of this.workerSet) {
  81       await workerSetElement.worker.terminate();
  82     }
  83     this.workerSet.clear();
  84   }
  85
  86   /**
  87    * Start a new `Worker`.
  88    */
  89   private async startWorker(): Promise<void> {
  90     const worker = new Worker(this.workerScript);
  91     worker.on(
  92       'message',
  93       (
  94         this.workerOptions?.messageHandler ??
  95         (() => {
  96           /* This is intentional */
  97         })
  98       ).bind(this) as MessageHandler<Worker>
  99     );
 100     worker.on('error', WorkerUtils.defaultErrorHandler.bind(this) as (err: Error) => void);
 101     worker.on('exit', (code) => {
 102       WorkerUtils.defaultExitHandler(code);
 103       this.workerSet.delete(this.getWorkerSetElementByWorker(worker));
 104     });
 105     this.workerSet.add({ worker, numberOfWorkerElements: 0 });
 106     // Start worker sequentially to optimize memory at startup
 107     this.workerOptions.workerStartDelay > 0 &&
 108       (await Utils.sleep(this.workerOptions.workerStartDelay));
 109   }
 110
 111   private getLastWorkerSetElement(): WorkerSetElement {
 112     let workerSetElement: WorkerSetElement;
 113     for (workerSetElement of this.workerSet) {
 114       /* This is intentional */
 115     }
 116     return workerSetElement;
 117   }
 118
 119   private getLastWorker(): Worker {
 120     return this.getLastWorkerSetElement().worker;
 121   }
 122
 123   private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement {
 124     let workerSetElt: WorkerSetElement;
 125     for (const workerSetElement of this.workerSet) {
 126       if (workerSetElement.worker.threadId === worker.threadId) {
 127         workerSetElt = workerSetElement;
 128         break;
 129       }
 130     }
 131     return workerSetElt;
 132   }
 133 }