src/worker/WorkerSet.ts

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