CXCDS-14100: move SCI configuration from .env to schematics-config (#…

…19952)
SAP · Feb 7, 2025 · 944b991 · 944b991
1 parent b0d19eb
commit 944b991
Show file tree

Hide file tree

Showing 14 changed files with 114 additions and 38 deletions.
diff --git a/.env-cmdrc b/.env-cmdrc
@@ -15,8 +15,7 @@
     "CX_BASE_URL": "https://api.cg79x9wuu9-eccommerc1-p1-public.model-t.myhybris.cloud"
   },
   "cds": {
-    "CX_CDS": "true",
-    "CX_SCI": "false"
+    "CX_CDS": "true"
   },
   "lighthouse": {
     "CX_BASE_URL": "https://api.spartacus.rocks"

diff --git a/integration-libs/cds/src/config/cds-config.ts b/integration-libs/cds/src/config/cds-config.ts
@@ -23,7 +23,6 @@ export abstract class CdsConfig {
     endpoints?: CdsEndpoints;
     merchandising?: MerchandisingConfig;
     profileTag?: ProfileTagConfig;
-    sciEnabled?: boolean;
   };
 }
 

diff --git a/integration-libs/cds/src/config/profile-tag.config.ts b/integration-libs/cds/src/config/profile-tag.config.ts
@@ -9,5 +9,4 @@ export interface ProfileTagConfig {
   configUrl?: string;
   allowInsecureCookies?: boolean;
   gtmId?: string;
-  sciEnabled?: boolean;
 }
diff --git a/integration-libs/cds/src/profiletag/model/profile-tag.model.ts b/integration-libs/cds/src/profiletag/model/profile-tag.model.ts
@@ -22,7 +22,6 @@ export interface ProfileTagJsConfig {
   configUrl?: string;
   allowInsecureCookies?: boolean;
   gtmId?: string;
-  sciEnabled?: boolean;
 }
 
 export interface ConsentReferenceEvent extends CustomEvent {

diff --git a/integration-libs/cds/src/profiletag/services/profiletag-event.service.spec.ts b/integration-libs/cds/src/profiletag/services/profiletag-event.service.spec.ts
@@ -26,7 +26,6 @@ const mockCDSConfig: CdsConfig = {
       configUrl: 'https:tag.static.us.context.cloud.sap',
       allowInsecureCookies: false,
       gtmId: 'test-id-1234567',
-      sciEnabled: false,
     },
   },
 };

diff --git a/integration-libs/cds/src/schematics/add-cds/__snapshots__/index_spec.ts.snap b/integration-libs/cds/src/schematics/add-cds/__snapshots__/index_spec.ts.snap
@@ -21,6 +21,59 @@ import { I18nConfig, provideConfig } from "@spartacus/core";
     cds: {
       tenant: 'my-tenant',
       baseUrl: 'my-base-url.com',
+      endpoints: {
+        strategyProducts: '/strategy/\${tenant}/strategies/\${strategyId}/products',
+        searchIntelligence:
+          '/search-intelligence/v1/sites/\${cdsSiteId}/trendingSearches',
+      },
+      merchandising: {
+        defaultCarouselViewportThreshold: 80,
+      },
+    },
+  }),
+  provideConfig(<CdsConfig>{
+    cds: {
+      profileTag: {
+        javascriptUrl:
+          'profile-tag-load-url.com',
+        configUrl:
+          'profile-tag-config-url.com',
+        allowInsecureCookies: true
+      },
+    },
+  })
+  ]
+})
+export class CdsFeatureModule { }
+"
+`;
+
+exports[`Spartacus CDS schematics: ng-add CDS feature with sciEnabled option set to true general setup should create the feature module 1`] = `
+"import { NgModule } from '@angular/core';
+import { CdsConfig, CdsModule } from "@spartacus/cds";
+import { cdsTranslationChunksConfig, cdsTranslationsEn } from "@spartacus/cds/assets";
+import { I18nConfig, provideConfig } from "@spartacus/core";
+
+@NgModule({
+  declarations: [],
+  imports: [
+    CdsModule.forRoot()
+  ],
+  providers: [provideConfig(<I18nConfig>{
+    i18n: {
+      resources: { en: cdsTranslationsEn },
+      chunks: cdsTranslationChunksConfig,
+    },
+  }),
+  provideConfig(<CdsConfig>{
+    cds: {
+      tenant: 'my-tenant',
+      baseUrl: 'my-base-url.com',
+      endpoints: {
+        strategyProducts: '/strategy/v1/sites/\${baseSite}/strategies/\${strategyId}/products',
+        searchIntelligence:
+          '/search-intelligence/v1/sites/\${cdsSiteId}/trendingSearches',
+      },
       merchandising: {
         defaultCarouselViewportThreshold: 80,
       },
@@ -33,7 +86,7 @@ import { I18nConfig, provideConfig } from "@spartacus/core";
           'profile-tag-load-url.com',
         configUrl:
           'profile-tag-config-url.com',
-        allowInsecureCookies: true,
+        allowInsecureCookies: true
       },
     },
   })
@@ -64,6 +117,11 @@ import { I18nConfig, provideConfig } from "@spartacus/core";
     cds: {
       tenant: 'my-tenant',
       baseUrl: 'my-base-url.com',
+      endpoints: {
+        strategyProducts: '/strategy/\${tenant}/strategies/\${strategyId}/products',
+        searchIntelligence:
+          '/search-intelligence/v1/sites/\${cdsSiteId}/trendingSearches',
+      },
       merchandising: {
         defaultCarouselViewportThreshold: 80,
       },
@@ -76,7 +134,7 @@ import { I18nConfig, provideConfig } from "@spartacus/core";
           'PROFILE_TAG_LOAD_URL_PLACEHOLDER',
         configUrl:
           'PROFILE_TAG_CONFIG_URL_PLACEHOLDER',
-        allowInsecureCookies: true,
+        allowInsecureCookies: true
       },
     },
   })

diff --git a/integration-libs/cds/src/schematics/add-cds/index_spec.ts b/integration-libs/cds/src/schematics/add-cds/index_spec.ts
@@ -140,5 +140,38 @@ describe('Spartacus CDS schematics: ng-add', () => {
         });
       });
     });
+
+    describe('with sciEnabled option set to true', () => {
+      beforeAll(async () => {
+        appTree = await generateDefaultWorkspace(schematicRunner, appTree);
+        appTree = await schematicRunner.runSchematic(
+          'ng-add',
+          {
+            ...cdsFeatureOptions,
+            profileTagConfigUrl: 'profile-tag-config-url.com',
+            profileTagLoadUrl: 'profile-tag-load-url.com',
+            sciEnabled: true,
+          },
+          appTree
+        );
+      });
+
+      describe('general setup', () => {
+        it('should create the feature module', async () => {
+          const module = appTree.readContent(cdsFeatureModulePath);
+          expect(module).toMatchSnapshot();
+        });
+
+        it('should NOT install the required feature dependencies', async () => {
+          const userFeatureModule = appTree.readContent(userFeatureModulePath);
+          expect(userFeatureModule).toBeFalsy();
+
+          const trackingPersonalizationFeatureModule = appTree.readContent(
+            trackingPersonalizationFeatureModulePath
+          );
+          expect(trackingPersonalizationFeatureModule).toBeFalsy();
+        });
+      });
+    });
   });
 });
diff --git a/integration-libs/cds/src/schematics/add-cds/schema.json b/integration-libs/cds/src/schematics/add-cds/schema.json
@@ -47,6 +47,12 @@
       "type": "string",
       "description": "Configuration URL for ProfileTag. (e.g. https://tag.static.stage.context.cloud.sap/config/my-config123)",
       "x-prompt": "[CDS] What is the ProfileTag configuration URL?"
+    },
+    "sciEnabled": {
+      "type": "boolean",
+      "description": "CDS/ISS is integrated into the SAP Cloud Identity Service (SCI). The downstream services use different domains and URL formats. To enable SCI, enable this parameter and make sure to use the proper profile tag urls (see documentation).",
+      "default": false,
+      "x-prompt": "[CDS] Do you want to enable SCI?"
     }
   }
 }
diff --git a/projects/schematics/src/shared/lib-configs/integration-libs/cds-schematics-config.ts b/projects/schematics/src/shared/lib-configs/integration-libs/cds-schematics-config.ts
@@ -22,6 +22,7 @@ export interface SpartacusCdsOptions extends LibraryOptions {
   baseUrl?: string;
   profileTagLoadUrl?: string;
   profileTagConfigUrl?: string;
+  sciEnabled?: boolean;
 }
 
 export const CDS_FOLDER_NAME = 'cds';
@@ -68,6 +69,15 @@ function buildCdsConfig(
       cds: {
         tenant: '${options.tenant || 'TENANT_PLACEHOLDER'}',
         baseUrl: '${options.baseUrl || 'BASE_URL_PLACEHOLDER'}',
+        endpoints: {
+          strategyProducts: '${
+            options.sciEnabled
+              ? '/strategy/v1/sites/${baseSite}/strategies/${strategyId}/products'
+              : '/strategy/${tenant}/strategies/${strategyId}/products'
+          }',
+          searchIntelligence:
+            '/search-intelligence/v1/sites/\${cdsSiteId}/trendingSearches',
+        },
         merchandising: {
           defaultCarouselViewportThreshold: 80,
         },
@@ -96,7 +106,7 @@ function buildCdsConfig(
                   options.profileTagConfigUrl ||
                   'PROFILE_TAG_CONFIG_URL_PLACEHOLDER'
                 }',
-              allowInsecureCookies: true,
+              allowInsecureCookies: true
             },
           },
         }`,

diff --git a/projects/storefrontapp/src/app/spartacus/features/cds/cds-feature.module.ts b/projects/storefrontapp/src/app/spartacus/features/cds/cds-feature.module.ts
@@ -19,7 +19,6 @@ import {
   cdsTranslationsDe,
   cdsTranslationsZh,
 } from '@spartacus/cds/assets';
-import { environment } from '../../../../environments/environment';
 
 /**
  * Only differences to the default cds config, they are merged together.
@@ -28,28 +27,17 @@ import { environment } from '../../../../environments/environment';
  * @see CdsModule.forRoot
  */
 
-const sciEnabled = environment.sciEnabled;
-
 const cds1: CdsConfig = {
   cds: {
     baseSite: ['electronics-spa', 'electronics', 'electronics-standalone'],
     tenant: 'argotest',
     baseUrl: 'https://api.stage.context.cloud.sap',
-    endpoints: {
-      strategyProducts: sciEnabled
-        ? '/strategy/v1/sites/${baseSite}/strategies/${strategyId}/products'
-        : '/strategy/${tenant}/strategies/${strategyId}/products',
-      searchIntelligence:
-        '/search-intelligence/v1/sites/${cdsSiteId}/trendingSearches',
-    },
     profileTag: {
       javascriptUrl:
         'https://tag.static.stage.context.cloud.sap/js/profile-tag.js',
-      configUrl: sciEnabled
-        ? 'https://tag.static.stage.context.cloud.sap/config/profiletag-default-config'
-        : 'https://tag.static.stage.context.cloud.sap/config/mytenant-main-default',
+      configUrl:
+        'https://tag.static.stage.context.cloud.sap/config/mytenant-main-default',
       allowInsecureCookies: true,
-      sciEnabled: sciEnabled,
     },
   },
 };
@@ -70,20 +58,10 @@ const cds2: CdsConfig = {
     ],
     tenant: 'A_CDS_TENANT',
     baseUrl: 'A_CDS_BASE_URL',
-    endpoints: {
-      strategyProducts: sciEnabled
-        ? '/strategy/v1/sites/${baseSite}/strategies/${strategyId}/products'
-        : '/strategy/${tenant}/strategies/${strategyId}/products',
-      searchIntelligence:
-        '/search-intelligence/v1/sites/${cdsSiteId}/trendingSearches',
-    },
     profileTag: {
       javascriptUrl: 'A_CDS_PROFILE_TAG_LOAD_URL',
-      configUrl: sciEnabled
-        ? 'https://tag.static.stage.context.cloud.sap/config/profiletag-default-config'
-        : 'A_CDS_PROFILE_TAG_CONFIG_URL',
+      configUrl: 'A_CDS_PROFILE_TAG_CONFIG_URL',
       allowInsecureCookies: true,
-      sciEnabled: sciEnabled,
     },
   },
 };

diff --git a/projects/storefrontapp/src/environments/environment.prod.ts b/projects/storefrontapp/src/environments/environment.prod.ts
@@ -11,7 +11,6 @@ export const environment: Environment = {
   occBaseUrl: buildProcess.env.CX_BASE_URL,
   occApiPrefix: '/occ/v2/',
   cds: buildProcess.env.CX_CDS,
-  sciEnabled: buildProcess.env.CX_SCI,
   b2b: buildProcess.env.CX_B2B,
   cdc: buildProcess.env.CX_CDC,
   cdp: buildProcess.env.CX_CDP,

diff --git a/projects/storefrontapp/src/environments/environment.ts b/projects/storefrontapp/src/environments/environment.ts
@@ -24,7 +24,6 @@ export const environment: Environment = {
   occBaseUrl: buildProcess.env.CX_BASE_URL,
   occApiPrefix: '/occ/v2/',
   cds: buildProcess.env.CX_CDS ?? false,
-  sciEnabled: buildProcess.env.CX_SCI ?? false,
   b2b: buildProcess.env.CX_B2B ?? false,
   cdc: buildProcess.env.CX_CDC ?? false,
   cdp: buildProcess.env.CX_CDP ?? false,

diff --git a/projects/storefrontapp/src/environments/models/build.process.env.d.ts b/projects/storefrontapp/src/environments/models/build.process.env.d.ts
@@ -13,7 +13,6 @@ interface BuildProcess {
 interface Env {
   CX_BASE_URL: string;
   CX_CDS: boolean;
-  CX_SCI: boolean;
   CX_CDC: boolean;
   CX_CDP: boolean;
   CX_B2B: boolean;

diff --git a/projects/storefrontapp/src/environments/models/environment.model.ts b/projects/storefrontapp/src/environments/models/environment.model.ts
@@ -10,7 +10,6 @@ export interface Environment {
   occApiPrefix: string;
   b2b: boolean;
   cds: boolean;
-  sciEnabled: boolean;
   cdc: boolean;
   cdp: boolean;
   cpq: boolean;