feat: complex configuration can be supplied as yaml (#1133)

intershop · Jul 22, 2022 · 4a71df7 · 4a71df7
1 parent d5155d3
commit 4a71df7
Show file tree

Hide file tree

Showing 11 changed files with 313 additions and 126 deletions.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -12,13 +12,19 @@ services:
         # activeThemes: b2b
         # activeThemes: b2c
     environment:
-      - LOGGING=on
-      - SOURCE_MAPS=on
-      - ICM_BASE_URL
-      # - PROXY_ICM=true
-      - TRUST_ICM=true
-      # - PROMETHEUS=on
-      # - MULTI_SITE_LOCALE_MAP={"en_US":"/en","de_DE":"/de","fr_FR":"/fr"}
+      LOGGING: 'true'
+      SOURCE_MAPS: 'true'
+      ICM_BASE_URL:
+      # PROXY_ICM: 'true'
+      TRUST_ICM: 'true'
+      # PROMETHEUS: 'true'
+      # MULTI_SITE_LOCALE_MAP: |
+      #   en_US: /en
+      #   de_DE: /de
+      #   fr_FR: /fr
+      # FEATURES: |
+      #   - compare
+      #   - rating
 
   # <CDN-Example>
   # add 127.0.0.1 mypwa.net to your hosts file and

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -94,6 +94,7 @@
     "express-http-proxy": "^1.6.3",
     "express-robots-txt": "1.0.0",
     "file-replace-loader": "^1.4.0",
+    "js-yaml": "^4.1.0",
     "lodash-es": "^4.17.21",
     "morgan": "^1.10.0",
     "ng-recaptcha": "^10.0.0",

diff --git a/src/app/core/store/core/configuration/configuration.actions.ts b/src/app/core/store/core/configuration/configuration.actions.ts
@@ -4,7 +4,7 @@ import { payload } from 'ish-core/utils/ngrx-creators';
 
 import { ConfigurationState } from './configuration.reducer';
 
-type ConfigurationType = Partial<ConfigurationState>;
+export type ConfigurationType = Partial<ConfigurationState>;
 
 export const applyConfiguration = createAction('[Configuration] Apply Configuration', payload<ConfigurationType>());
 

diff --git a/src/app/core/store/core/configuration/configuration.effects.ts b/src/app/core/store/core/configuration/configuration.effects.ts
@@ -17,6 +17,7 @@ import { StatePropertiesService } from 'ish-core/utils/state-transfer/state-prop
 
 import {
   applyConfiguration,
+  ConfigurationType,
   loadSingleServerTranslation,
   loadSingleServerTranslationSuccess,
 } from './configuration.actions';
@@ -73,20 +74,14 @@ export class ConfigurationEffects {
           this.stateProperties
             .getStateOrEnvOrDefault<string>('ICM_IDENTITY_PROVIDER', 'identityProvider')
             .pipe(map(x => x || 'ICM')),
-          this.stateProperties
-            .getStateOrEnvOrDefault<string | object>('IDENTITY_PROVIDERS', 'identityProviders')
-            .pipe(map(config => (typeof config === 'string' ? JSON.parse(config) : config))),
-          this.stateProperties
-            .getStateOrEnvOrDefault<Record<string, unknown> | string | false>(
-              'MULTI_SITE_LOCALE_MAP',
-              'multiSiteLocaleMap'
-            )
-            .pipe(
-              map(multiSiteLocaleMap => (multiSiteLocaleMap === false ? undefined : multiSiteLocaleMap)),
-              map(multiSiteLocaleMap =>
-                typeof multiSiteLocaleMap === 'string' ? JSON.parse(multiSiteLocaleMap) : multiSiteLocaleMap
-              )
-            )
+          this.stateProperties.getStateOrEnvOrDefault<ConfigurationType['identityProviders']>(
+            'IDENTITY_PROVIDERS',
+            'identityProviders'
+          ),
+          this.stateProperties.getStateOrEnvOrDefault<ConfigurationType['multiSiteLocaleMap']>(
+            'MULTI_SITE_LOCALE_MAP',
+            'multiSiteLocaleMap'
+          )
         ),
         map(
           ([

diff --git a/src/app/core/store/core/configuration/configuration.reducer.ts b/src/app/core/store/core/configuration/configuration.reducer.ts
@@ -40,7 +40,7 @@ const initialState: ConfigurationState = {
   lang: undefined,
   currency: undefined,
   serverTranslations: {},
-  multiSiteLocaleMap: {},
+  multiSiteLocaleMap: undefined,
   _deviceType: environment.defaultDeviceType,
 };
 

diff --git a/src/app/core/utils/functions.spec.ts b/src/app/core/utils/functions.spec.ts
@@ -74,6 +74,60 @@ describe('Functions', () => {
         }
       `);
     });
+
+    it('should handle empty source objects', () => {
+      expect(mergeDeep({ a: 1, b: { c: 2 }, d: 11 }, {})).toMatchInlineSnapshot(`
+        Object {
+          "a": 1,
+          "b": Object {
+            "c": 2,
+          },
+          "d": 11,
+        }
+      `);
+    });
+
+    it('should handle undefined source objects', () => {
+      expect(mergeDeep({ a: 1, b: { c: 2 }, d: 11 }, undefined)).toMatchInlineSnapshot(`
+        Object {
+          "a": 1,
+          "b": Object {
+            "c": 2,
+          },
+          "d": 11,
+        }
+      `);
+    });
+
+    it('should handle empty target objects', () => {
+      expect(mergeDeep({}, { a: 4, b: { c: 5 } })).toMatchInlineSnapshot(`
+        Object {
+          "a": 4,
+          "b": Object {
+            "c": 5,
+          },
+        }
+      `);
+    });
+
+    it('should handle undefined target objects', () => {
+      expect(mergeDeep(undefined, { a: 4, b: { c: 5 } })).toMatchInlineSnapshot(`
+        Object {
+          "a": 4,
+          "b": Object {
+            "c": 5,
+          },
+        }
+      `);
+    });
+
+    it('should handle empty target and source objects', () => {
+      expect(mergeDeep({}, {})).toMatchInlineSnapshot(`Object {}`);
+    });
+
+    it('should handle undefined target and source objects', () => {
+      expect(mergeDeep(undefined, undefined)).toBeUndefined();
+    });
   });
 
   describe('omit', () => {