UI Server: rename defaults constants

[e-mobility-charging-stations-simulator.git] / src / utils / Configuration.ts

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index 3fec05a882ba2803339307c83a9edbcf625ea9f2..4fc46b059ffa9dfa1aa5ce4c99883e758eb12c68 100644 (file)
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -1,23 +1,25 @@
-import ConfigurationData, {
-  ServerOptions,
-  StationTemplateUrl,
-  StorageConfiguration,
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+import chalk from 'chalk';
+
+import {
+  type ConfigurationData,
+  type StationTemplateUrl,
+  type StorageConfiguration,
   SupervisionUrlDistribution,
-  UIServerConfiguration,
-  WorkerConfiguration,
+  type UIServerConfiguration,
+  type WorkerConfiguration,
 } from '../types/ConfigurationData';
-
-import Constants from './Constants';
-import { EmptyObject } from '../types/EmptyObject';
+import type { EmptyObject } from '../types/EmptyObject';
+import type { HandleErrorParams } from '../types/Error';
 import { FileType } from '../types/FileType';
-import { HandleErrorParams } from '../types/Error';
 import { StorageType } from '../types/Storage';
-import WorkerConstants from '../worker/WorkerConstants';
+import { ApplicationProtocol } from '../types/UIProtocol';
 import { WorkerProcessType } from '../types/Worker';
-import chalk from 'chalk';
-import { fileURLToPath } from 'url';
-import fs from 'fs';
-import path from 'path';
+import WorkerConstants from '../worker/WorkerConstants';
+import Constants from './Constants';
 
 export default class Configuration {
   private static configurationFile = path.join(
@@ -30,6 +32,10 @@ export default class Configuration {
   private static configuration: ConfigurationData | null = null;
   private static configurationChangeCallback: () => Promise<void>;
 
+  private constructor() {
+    // This is intentional
+  }
+
   static setConfigurationChangeCallback(cb: () => Promise<void>): void {
     Configuration.configurationChangeCallback = cb;
   }
@@ -52,35 +58,23 @@ export default class Configuration {
         chalk`{green ${Configuration.logPrefix()}} {red Deprecated configuration section 'uiWebSocketServer' usage. Use 'uiServer' instead}`
       );
     }
-    let options: ServerOptions = {
-      host: Constants.DEFAULT_UI_WEBSOCKET_SERVER_HOST,
-      port: Constants.DEFAULT_UI_WEBSOCKET_SERVER_PORT,
-    };
     let uiServerConfiguration: UIServerConfiguration = {
-      enabled: true,
-      options,
+      enabled: false,
+      type: ApplicationProtocol.WS,
+      options: {
+        host: Constants.DEFAULT_UI_SERVER_HOST,
+        port: Constants.DEFAULT_UI_SERVER_PORT,
+      },
     };
     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'uiServer')) {
-      if (Configuration.objectHasOwnProperty(Configuration.getConfig().uiServer, 'options')) {
-        options = {
-          ...options,
-          ...(Configuration.objectHasOwnProperty(
-            Configuration.getConfig().uiServer.options,
-            'host'
-          ) && { host: Configuration.getConfig().uiServer.options.host }),
-          ...(Configuration.objectHasOwnProperty(
-            Configuration.getConfig().uiServer.options,
-            'port'
-          ) && { port: Configuration.getConfig().uiServer.options.port }),
-        };
-      }
-      uiServerConfiguration = {
-        ...uiServerConfiguration,
-        ...(Configuration.objectHasOwnProperty(Configuration.getConfig().uiServer, 'enabled') && {
-          enabled: Configuration.getConfig().uiServer.enabled,
-        }),
-        options,
-      };
+      uiServerConfiguration = Configuration.deepMerge(
+        uiServerConfiguration,
+        Configuration.getConfig().uiServer
+      );
+    }
+    if (Configuration.isCFEnvironment() === true) {
+      delete uiServerConfiguration.options.host;
+      uiServerConfiguration.options.port = parseInt(process.env.PORT);
     }
     return uiServerConfiguration;
   }
@@ -95,22 +89,7 @@ export default class Configuration {
     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'performanceStorage')) {
       storageConfiguration = {
         ...storageConfiguration,
-        ...(Configuration.objectHasOwnProperty(
-          Configuration.getConfig().performanceStorage,
-          'enabled'
-        ) && { enabled: Configuration.getConfig().performanceStorage.enabled }),
-        ...(Configuration.objectHasOwnProperty(
-          Configuration.getConfig().performanceStorage,
-          'type'
-        ) && { type: Configuration.getConfig().performanceStorage.type }),
-        ...(Configuration.objectHasOwnProperty(
-          Configuration.getConfig().performanceStorage,
-          'uri'
-        ) && {
-          uri: this.getDefaultPerformanceStorageUri(
-            Configuration.getConfig()?.performanceStorage?.type ?? StorageType.JSON_FILE
-          ),
-        }),
+        ...Configuration.getConfig().performanceStorage,
       };
     }
     return storageConfiguration;
@@ -207,7 +186,7 @@ export default class Configuration {
       null,
       "Use 'worker' section to define the worker pool strategy instead"
     );
-    const workerConfiguration: WorkerConfiguration = {
+    let workerConfiguration: WorkerConfiguration = {
       processType: Configuration.objectHasOwnProperty(Configuration.getConfig(), 'workerProcess')
         ? Configuration.getConfig().workerProcess
         : WorkerProcessType.WORKER_SET,
@@ -241,7 +220,7 @@ export default class Configuration {
       poolStrategy: Configuration.getConfig().workerPoolStrategy,
     };
     if (Configuration.objectHasOwnProperty(Configuration.getConfig(), 'worker')) {
-      return { ...workerConfiguration, ...Configuration.getConfig().worker };
+      workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig().worker };
     }
     return workerConfiguration;
   }
@@ -398,6 +377,10 @@ export default class Configuration {
     }
   }
 
+  private static isCFEnvironment(): boolean {
+    return process.env.VCAP_APPLICATION !== undefined;
+  }
+
   private static getDefaultPerformanceStorageUri(storageType: StorageType) {
     const SQLiteFileName = `${Constants.DEFAULT_PERFORMANCE_RECORDS_DB_NAME}.db`;
     switch (storageType) {
@@ -416,6 +399,10 @@ export default class Configuration {
     }
   }
 
+  private static isObject(item): boolean {
+    return item && typeof item === 'object' && Array.isArray(item) === false;
+  }
+
   private static objectHasOwnProperty(object: unknown, property: string): boolean {
     return Object.prototype.hasOwnProperty.call(object, property) as boolean;
   }
@@ -424,6 +411,29 @@ export default class Configuration {
     return typeof obj === 'undefined';
   }
 
+  private static deepMerge(target: object, ...sources: object[]): object {
+    if (!sources.length) {
+      return target;
+    }
+    const source = sources.shift();
+
+    if (Configuration.isObject(target) && Configuration.isObject(source)) {
+      for (const key in source) {
+        if (Configuration.isObject(source[key])) {
+          if (!target[key]) {
+            Object.assign(target, { [key]: {} });
+          }
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+          Configuration.deepMerge(target[key], source[key]);
+        } else {
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+          Object.assign(target, { [key]: source[key] });
+        }
+      }
+    }
+    return Configuration.deepMerge(target, ...sources);
+  }
+
   private static handleFileException(
     logPrefix: string,
     fileType: FileType,