feat: add a basic authentication scheme for UI WebSocket server

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

diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts
index 8b0b1c8fa532c3afdd879dd6f6418576e5531139..d577ded4141858bbc08213615f116fd199bfc2c8 100644 (file)
--- a/src/utils/Configuration.ts
+++ b/src/utils/Configuration.ts
@@ -4,7 +4,7 @@ import { env } from 'node:process'
 import { fileURLToPath } from 'node:url'
 
 import chalk from 'chalk'
-import merge from 'just-merge'
+import { mergeDeepRight } from 'rambda'
 
 import {
   buildPerformanceUriFilePath,
@@ -18,6 +18,7 @@ import { Constants } from './Constants.js'
 import { hasOwnProp, isCFEnvironment, once } from './Utils.js'
 import {
   ApplicationProtocol,
+  ApplicationProtocolVersion,
   type ConfigurationData,
   ConfigurationSection,
   FileType,
@@ -45,7 +46,7 @@ type ConfigurationSectionType =
 
 // eslint-disable-next-line @typescript-eslint/no-extraneous-class
 export class Configuration {
-  public static configurationChangeCallback: () => Promise<void>
+  public static configurationChangeCallback?: () => Promise<void>
 
   private static readonly configurationFile = join(
     dirname(fileURLToPath(import.meta.url)),
@@ -90,8 +91,7 @@ export class Configuration {
 
   public static getSupervisionUrls (): string | string[] | undefined {
     if (
-      Configuration.getConfigurationData()?.['supervisionURLs' as keyof ConfigurationData] !==
-      undefined
+      Configuration.getConfigurationData()?.['supervisionURLs' as keyof ConfigurationData] != null
     ) {
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       Configuration.getConfigurationData()!.supervisionUrls = Configuration.getConfigurationData()![
@@ -156,13 +156,14 @@ export class Configuration {
     let uiServerConfiguration: UIServerConfiguration = {
       enabled: false,
       type: ApplicationProtocol.WS,
+      version: ApplicationProtocolVersion.VERSION_11,
       options: {
         host: Constants.DEFAULT_UI_SERVER_HOST,
         port: Constants.DEFAULT_UI_SERVER_PORT
       }
     }
     if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.uiServer)) {
-      uiServerConfiguration = merge<UIServerConfiguration>(
+      uiServerConfiguration = mergeDeepRight(
         uiServerConfiguration,
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         Configuration.getConfigurationData()!.uiServer!
@@ -177,17 +178,37 @@ export class Configuration {
   }
 
   private static buildPerformanceStorageSection (): StorageConfiguration {
-    let storageConfiguration: StorageConfiguration = {
-      enabled: false,
-      type: StorageType.JSON_FILE,
-      uri: getDefaultPerformanceStorageUri(StorageType.JSON_FILE)
+    let storageConfiguration: StorageConfiguration
+    switch (Configuration.getConfigurationData()?.performanceStorage?.type) {
+      case StorageType.SQLITE:
+        storageConfiguration = {
+          enabled: false,
+          type: StorageType.SQLITE,
+          uri: getDefaultPerformanceStorageUri(StorageType.SQLITE)
+        }
+        break
+      case StorageType.JSON_FILE:
+        storageConfiguration = {
+          enabled: false,
+          type: StorageType.JSON_FILE,
+          uri: getDefaultPerformanceStorageUri(StorageType.JSON_FILE)
+        }
+        break
+      case StorageType.NONE:
+      default:
+        storageConfiguration = {
+          enabled: true,
+          type: StorageType.NONE
+        }
+        break
     }
     if (hasOwnProp(Configuration.getConfigurationData(), ConfigurationSection.performanceStorage)) {
       storageConfiguration = {
         ...storageConfiguration,
         ...Configuration.getConfigurationData()?.performanceStorage,
-        ...(Configuration.getConfigurationData()?.performanceStorage?.type ===
-          StorageType.JSON_FILE &&
+        ...((Configuration.getConfigurationData()?.performanceStorage?.type ===
+          StorageType.JSON_FILE ||
+          Configuration.getConfigurationData()?.performanceStorage?.type === StorageType.SQLITE) &&
           Configuration.getConfigurationData()?.performanceStorage?.uri != null && {
           uri: buildPerformanceUriFilePath(
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -317,8 +338,8 @@ export class Configuration {
       undefined,
       "Use 'stationTemplateUrls' instead"
     )
-    Configuration.getConfigurationData()?.['stationTemplateURLs' as keyof ConfigurationData] !==
-      undefined &&
+    Configuration.getConfigurationData()?.['stationTemplateURLs' as keyof ConfigurationData] !=
+      null &&
       // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
       (Configuration.getConfigurationData()!.stationTemplateUrls =
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -327,7 +348,8 @@ export class Configuration {
         ] as StationTemplateUrl[])
     Configuration.getConfigurationData()?.stationTemplateUrls.forEach(
       (stationTemplateUrl: StationTemplateUrl) => {
-        if (stationTemplateUrl?.['numberOfStation' as keyof StationTemplateUrl] !== undefined) {
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        if (stationTemplateUrl['numberOfStation' as keyof StationTemplateUrl] != null) {
           console.error(
             `${chalk.green(logPrefix())} ${chalk.red(
               `Deprecated configuration key 'numberOfStation' usage for template file '${stationTemplateUrl.file}' in 'stationTemplateUrls'. Use 'numberOfStations' instead`
@@ -488,14 +510,13 @@ export class Configuration {
   ): void {
     if (
       sectionName != null &&
-      Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData] !==
-        undefined &&
+      Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData] != null &&
       (
         Configuration.getConfigurationData()?.[sectionName as keyof ConfigurationData] as Record<
         string,
         unknown
         >
-      )?.[key] !== undefined
+      )[key] != null
     ) {
       console.error(
         `${chalk.green(logPrefix())} ${chalk.red(
@@ -504,9 +525,7 @@ export class Configuration {
           }`
         )}`
       )
-    } else if (
-      Configuration.getConfigurationData()?.[key as keyof ConfigurationData] !== undefined
-    ) {
+    } else if (Configuration.getConfigurationData()?.[key as keyof ConfigurationData] != null) {
       console.error(
         `${chalk.green(logPrefix())} ${chalk.red(
           `Deprecated configuration key '${key}' usage${
@@ -544,7 +563,7 @@ export class Configuration {
         if (
           !Configuration.configurationFileReloading &&
           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          filename!.trim()!.length > 0 &&
+          filename!.trim().length > 0 &&
           event === 'change'
         ) {
           Configuration.configurationFileReloading = true
@@ -556,9 +575,9 @@ export class Configuration {
           )
           delete Configuration.configurationData
           Configuration.configurationSectionCache.clear()
-          if (Configuration.configurationChangeCallback !== undefined) {
+          if (Configuration.configurationChangeCallback != null) {
             Configuration.configurationChangeCallback()
-              .catch((error) => {
+              .catch(error => {
                 throw typeof error === 'string' ? new Error(error) : error
               })
               .finally(() => {