From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Mon, 23 Aug 2021 22:24:36 +0000 (+0200)
Subject: Do not enforce the singleton design pattern in the worker object factory
X-Git-Tag: v1.0.42~1
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=535aaa2703cd3ecaf57de713ffd5c685e2e68fb3;p=e-mobility-charging-stations-simulator.git

Do not enforce the singleton design pattern in the worker object factory

Let the caller be responsible of not duplicating pool/set reference

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/src/charging-station/Bootstrap.ts b/src/charging-station/Bootstrap.ts
index 52e1242f..3cd83d1d 100644
--- a/src/charging-station/Bootstrap.ts
+++ b/src/charging-station/Bootstrap.ts
@@ -8,11 +8,11 @@ import path from 'path';
 import { version } from '../../package.json';
 
 export default class Bootstrap {
-  private static instance: Bootstrap;
+  private static instance: Bootstrap | null = null;
+  private static workerImplementation: WorkerAbstract | null = null;
   private version: string = version;
   private started: boolean;
   private workerScript: string;
-  private workerImplementation: WorkerAbstract | null = null;
 
   private constructor() {
     this.started = false;
@@ -32,7 +32,7 @@ export default class Bootstrap {
     if (isMainThread && !this.started) {
       try {
         let numStationsTotal = 0;
-        await this.workerImplementation.start();
+        await Bootstrap.workerImplementation.start();
         // Start ChargingStation object in worker thread
         if (Configuration.getStationTemplateURLs()) {
           for (const stationURL of Configuration.getStationTemplateURLs()) {
@@ -43,7 +43,7 @@ export default class Bootstrap {
                   index,
                   templateFile: path.join(path.resolve(__dirname, '../'), 'assets', 'station-templates', path.basename(stationURL.file))
                 };
-                await this.workerImplementation.addElement(workerData);
+                await Bootstrap.workerImplementation.addElement(workerData);
                 numStationsTotal++;
               }
             } catch (error) {
@@ -56,7 +56,7 @@ export default class Bootstrap {
         if (numStationsTotal === 0) {
           console.log('No charging station template enabled in configuration, exiting');
         } else {
-          console.log(`Charging station simulator ${this.version} started with ${numStationsTotal.toString()} charging station(s) and ${Utils.workerDynamicPoolInUse() ? `${Configuration.getWorkerPoolMinSize().toString()}/` : ''}${this.workerImplementation.size}${Utils.workerPoolInUse() ? `/${Configuration.getWorkerPoolMaxSize().toString()}` : ''} worker(s) concurrently running in '${Configuration.getWorkerProcess()}' mode${this.workerImplementation.maxElementsPerWorker ? ` (${this.workerImplementation.maxElementsPerWorker} charging station(s) per worker)` : ''}`);
+          console.log(`Charging station simulator ${this.version} started with ${numStationsTotal.toString()} charging station(s) and ${Utils.workerDynamicPoolInUse() ? `${Configuration.getWorkerPoolMinSize().toString()}/` : ''}${Bootstrap.workerImplementation.size}${Utils.workerPoolInUse() ? `/${Configuration.getWorkerPoolMaxSize().toString()}` : ''} worker(s) concurrently running in '${Configuration.getWorkerProcess()}' mode${Bootstrap.workerImplementation.maxElementsPerWorker ? ` (${Bootstrap.workerImplementation.maxElementsPerWorker} charging station(s) per worker)` : ''}`);
         }
         this.started = true;
       } catch (error) {
@@ -67,19 +67,19 @@ export default class Bootstrap {
 
   public async stop(): Promise<void> {
     if (isMainThread && this.started) {
-      await this.workerImplementation.stop();
+      await Bootstrap.workerImplementation.stop();
     }
     this.started = false;
   }
 
   public async restart(): Promise<void> {
     await this.stop();
-    this.initWorkerImplementation(true);
+    this.initWorkerImplementation();
     await this.start();
   }
 
-  private initWorkerImplementation(forceInstantiation = false) {
-    this.workerImplementation = WorkerFactory.getWorkerImplementation<StationWorkerData>(this.workerScript, Configuration.getWorkerProcess(),
+  private initWorkerImplementation() {
+    Bootstrap.workerImplementation = WorkerFactory.getWorkerImplementation<StationWorkerData>(this.workerScript, Configuration.getWorkerProcess(),
       {
         startDelay: Configuration.getWorkerStartDelay(),
         poolMaxSize: Configuration.getWorkerPoolMaxSize(),
@@ -88,8 +88,8 @@ export default class Bootstrap {
         poolOptions: {
           workerChoiceStrategy: Configuration.getWorkerPoolStrategy()
         }
-      }, forceInstantiation);
-    if (!this.workerImplementation) {
+      });
+    if (!Bootstrap.workerImplementation) {
       throw new Error('Worker implementation not found');
     }
   }
diff --git a/src/worker/WorkerFactory.ts b/src/worker/WorkerFactory.ts
index b5cf327c..093c7cd3 100644
--- a/src/worker/WorkerFactory.ts
+++ b/src/worker/WorkerFactory.ts
@@ -8,34 +8,30 @@ import WorkerStaticPool from './WorkerStaticPool';
 import { isMainThread } from 'worker_threads';
 
 export default class WorkerFactory {
-  private static workerImplementation: WorkerAbstract | null;
-
   private constructor() {}
 
-  public static getWorkerImplementation<T>(workerScript: string, workerProcessType: WorkerProcessType, options?: WorkerOptions, forceInstantiation = false): WorkerAbstract | null {
+  public static getWorkerImplementation<T>(workerScript: string, workerProcessType: WorkerProcessType, options?: WorkerOptions): WorkerAbstract | null {
     if (!isMainThread) {
       throw new Error('Trying to get a worker implementation outside the main thread');
     }
-    if (!WorkerFactory.workerImplementation || forceInstantiation) {
-      options = options ?? {} as WorkerOptions;
-      options.startDelay = options.startDelay ?? Constants.WORKER_START_DELAY;
-      WorkerFactory.workerImplementation = null;
-      switch (workerProcessType) {
-        case WorkerProcessType.WORKER_SET:
-          options.elementsPerWorker = options.elementsPerWorker ?? Constants.DEFAULT_CHARGING_STATIONS_PER_WORKER;
-          WorkerFactory.workerImplementation = new WorkerSet<T>(workerScript, options.elementsPerWorker, options.startDelay);
-          break;
-        case WorkerProcessType.STATIC_POOL:
-          options.poolMaxSize = options.poolMaxSize ?? Constants.DEFAULT_WORKER_POOL_MAX_SIZE;
-          WorkerFactory.workerImplementation = new WorkerStaticPool<T>(workerScript, options.poolMaxSize, options.startDelay, options.poolOptions);
-          break;
-        case WorkerProcessType.DYNAMIC_POOL:
-          options.poolMinSize = options.poolMinSize ?? Constants.DEFAULT_WORKER_POOL_MIN_SIZE;
-          options.poolMaxSize = options.poolMaxSize ?? Constants.DEFAULT_WORKER_POOL_MAX_SIZE;
-          WorkerFactory.workerImplementation = new WorkerDynamicPool<T>(workerScript, options.poolMinSize, options.poolMaxSize, options.startDelay, options.poolOptions);
-          break;
-      }
+    options = options ?? {} as WorkerOptions;
+    options.startDelay = options.startDelay ?? Constants.WORKER_START_DELAY;
+    let workerImplementation: WorkerAbstract = null;
+    switch (workerProcessType) {
+      case WorkerProcessType.WORKER_SET:
+        options.elementsPerWorker = options.elementsPerWorker ?? Constants.DEFAULT_CHARGING_STATIONS_PER_WORKER;
+        workerImplementation = new WorkerSet<T>(workerScript, options.elementsPerWorker, options.startDelay);
+        break;
+      case WorkerProcessType.STATIC_POOL:
+        options.poolMaxSize = options.poolMaxSize ?? Constants.DEFAULT_WORKER_POOL_MAX_SIZE;
+        workerImplementation = new WorkerStaticPool<T>(workerScript, options.poolMaxSize, options.startDelay, options.poolOptions);
+        break;
+      case WorkerProcessType.DYNAMIC_POOL:
+        options.poolMinSize = options.poolMinSize ?? Constants.DEFAULT_WORKER_POOL_MIN_SIZE;
+        options.poolMaxSize = options.poolMaxSize ?? Constants.DEFAULT_WORKER_POOL_MAX_SIZE;
+        workerImplementation = new WorkerDynamicPool<T>(workerScript, options.poolMinSize, options.poolMaxSize, options.startDelay, options.poolOptions);
+        break;
     }
-    return WorkerFactory.workerImplementation;
+    return workerImplementation;
   }
 }