Merge pull request #354 from sf-aastha-paruthi/u/aparuthi/experienceSiteFixes

W-19244322 - Experience Site Fixes: Migrate OS and FC from vLocity wrapper to omnistudio wrapper in experience sites

Author: snehaljha-sf

messages/assess.json

@@ -183,5 +183,6 @@
   "missingInfo": "Info is missing",
   "errorCheckingGlobalAutoNumber": "We couldn’t check whether the Global Auto Number setting is enabled: %s. Try again later.",
   "errorMigrationMessage": "Error migrating object: %s",
-  "nameMappingUndefined": "Name Mapping is undefined"
+  "nameMappingUndefined": "Name Mapping is undefined",
+  "experienceSiteException": "Exception occurred while processing experience sites"
 }

messages/migrate.json

@@ -195,8 +195,8 @@
   "flexcardStorageProcessingStarted": "Started preparing storage for flexcards",
   "errorWhileProcessingFlexcardStorage": "Error occurred while processing key for flexcard storage",
   "missingInfo": "Info is missing",
-  "incompleteMigrationDetected": "We couldn’t complete the migration process",
   "errorCheckingGlobalAutoNumber": "We couldn’t check whether the Global Auto Number setting is enabled: %s. Try again later.",
   "errorMigrationMessage": "Error migrating object: %s",
-  "nameMappingUndefined": "Name Mapping is undefined"
+  "nameMappingUndefined": "Name Mapping is undefined",
+  "experienceSiteException": "Exception occurred while processing experience sites"
 }

src/commands/omnistudio/migration/assess.ts

@@ -98,7 +98,7 @@ export default class Assess extends OmniStudioBaseCommand {
 
     const namespace = orgs.packageDetails.namespace;
     let projectPath = '';
-    const preMigrate: PreMigrate = new PreMigrate(this.org, namespace, conn, this.logger, messages, this.ux);
+    const preMigrate: PreMigrate = new PreMigrate(namespace, conn, this.logger, messages, this.ux);
     if (relatedObjects) {
       objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
       projectPath = await ProjectPathUtil.getProjectPath(messages, true);

src/commands/omnistudio/migration/migrate.ts

@@ -132,7 +132,7 @@ export default class Migrate extends OmniStudioBaseCommand {
     let projectPath: string;
     let objectsToProcess: string[] = [];
     let targetApexNamespace: string;
-    const preMigrate: PreMigrate = new PreMigrate(this.org, namespace, conn, this.logger, messages, this.ux);
+    const preMigrate: PreMigrate = new PreMigrate(namespace, conn, this.logger, messages, this.ux);
     const isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean } = { value: false };
     if (relatedObjects) {
       const validOptions = [Constants.Apex, Constants.ExpSites, Constants.FlexiPage, Constants.LWC];
@@ -451,11 +451,13 @@ export default class Migrate extends OmniStudioBaseCommand {
         let errors: any[] = obj.errors || [];
         errors = errors.concat(recordResults.errors || []);
 
-        obj.status = recordResults?.skipped
-          ? messages.getMessage('labelStatusSkipped')
-          : !recordResults || recordResults.hasErrors
-          ? messages.getMessage('labelStatusFailed')
-          : messages.getMessage('labelStatusComplete');
+        if (recordResults?.skipped) {
+          obj.status = messages.getMessage('labelStatusSkipped');
+        } else if (!recordResults || recordResults.hasErrors) {
+          obj.status = messages.getMessage('labelStatusFailed');
+        } else {
+          obj.status = messages.getMessage('labelStatusComplete');
+        }
         obj.errors = errors;
         obj.migratedId = recordResults.id;
         obj.warnings = recordResults.warnings;

src/migration/flexcard.ts

@@ -113,7 +113,8 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
       const flexCards = await this.getAllActiveCards();
       Logger.log(this.messages.getMessage('foundFlexCardsToAssess', [flexCards.length]));
 
-      const flexCardsAssessmentInfos = this.processCardComponents(flexCards);
+      const flexCardsAssessmentInfos = await this.processCardComponents(flexCards);
+      this.prepareAssessmentStorageForFlexcards(flexCardsAssessmentInfos);
       return flexCardsAssessmentInfos;
     } catch (err) {
       if (err instanceof InvalidEntityTypeError) {
@@ -135,9 +136,6 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
       try {
         const flexCardAssessmentInfo = await this.processFlexCard(flexCard, uniqueNames);
         flexCardAssessmentInfos.push(flexCardAssessmentInfo);
-
-        // Prepare assessment storage for flexcards
-        this.prepareAssessmentStorageForFlexcards(flexCardAssessmentInfos);
       } catch (e) {
         flexCardAssessmentInfos.push({
           name: flexCard['Name'],
@@ -638,7 +636,7 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
           flexCardAssessmentInfo.nameMapping === undefined ||
           flexCardAssessmentInfo.nameMapping === null
         ) {
-          Logger.logVerbose(this.messages.getMessage('missingInfo'));
+          Logger.error(this.messages.getMessage('missingInfo'));
           return;
         }
 
@@ -647,8 +645,8 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
           isDuplicate: false,
         };
 
-        if (flexCardAssessmentInfo.warnings) {
-          value.error = flexCardAssessmentInfo.warnings;
+        if (flexCardAssessmentInfo.errors && flexCardAssessmentInfo.errors.length > 0) {
+          value.error = flexCardAssessmentInfo.errors;
           value.migrationSuccess = false;
         } else {
           value.migrationSuccess = true;
@@ -668,9 +666,8 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
         Logger.logVerbose(this.messages.getMessage('errorWhileProcessingFlexcardStorage'));
         Logger.error(error);
       }
-
-      StorageUtil.printMigrationStorage();
     }
+    StorageUtil.printAssessmentStorage();
   }
 
   private prepareStorageForFlexcards(
@@ -692,13 +689,13 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
 
         if (newrecord === undefined) {
           value.error = ['Migration Failed'];
-        }
-
-        if (newrecord.hasErrors) {
-          value.error = newrecord.errors;
-          value.migrationSuccess = false;
         } else {
-          value.migrationSuccess = true;
+          if (newrecord.hasErrors) {
+            value.error = newrecord.errors;
+            value.migrationSuccess = false;
+          } else {
+            value.migrationSuccess = true;
+          }
         }
 
         let finalKey = `${oldrecord['Name']}`;

src/migration/omniscript.ts

@@ -537,6 +537,7 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
 
   private updateStorageForOmniscriptAssessment(osAssessmentInfo: OSAssessmentInfo[]): void {
     if (osAssessmentInfo === undefined || osAssessmentInfo === null) {
+      Logger.error(this.messages.getMessage('missingInfo'));
       return;
     }
 
@@ -559,7 +560,7 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
           isDuplicate: false,
         };
 
-        if (Array.isArray(currentOsRecordInfo.errors) && currentOsRecordInfo.errors.length > 0) {
+        if (currentOsRecordInfo.errors && currentOsRecordInfo.errors.length > 0) {
           value.error = currentOsRecordInfo.errors;
           value.migrationSuccess = false;
         } else {
@@ -579,7 +580,7 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
           storage.osStorage.set(finalKey, value);
         }
       } catch (error) {
-        Logger.logVerbose(error);
+        Logger.error(error);
       }
     }
 
@@ -905,11 +906,16 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
             isDuplicate: false,
           };
 
-          if (newrecord.hasErrors) {
-            value.error = newrecord.errors;
+          // New record can be undefined
+          if (newrecord === undefined) {
             value.migrationSuccess = false;
           } else {
-            value.migrationSuccess = true;
+            if (newrecord.hasErrors) {
+              value.error = newrecord.errors;
+              value.migrationSuccess = false;
+            } else {
+              value.migrationSuccess = true;
+            }
           }
 
           let finalKey = `${oldrecord[this.namespacePrefix + 'Type__c']}${

src/migration/premigrate.ts

@@ -1,29 +1,16 @@
-/* eslint-disable */
-
-import { Connection, Messages, Org } from '@salesforce/core';
+import { Connection, Messages } from '@salesforce/core';
 import { UX } from '@salesforce/command';
 import { Logger } from '../utils/logger';
 import { Constants } from '../utils/constants/stringContants';
 import { OrgPreferences } from '../utils/orgPreferences';
-import { BaseMigrationTool } from './base';
 import { askStringWithTimeout } from '../utils/promptUtil';
+import { YES_SHORT, YES_LONG, NO_SHORT, NO_LONG } from '../utils/projectPathUtil';
+import { BaseMigrationTool } from './base';
 
 export class PreMigrate extends BaseMigrationTool {
-  private readonly org: Org;
-
   // Source Custom Object Names
-  constructor(org: Org, namespace: string, connection: Connection, logger: Logger, messages: Messages, ux: UX) {
+  public constructor(namespace: string, connection: Connection, logger: Logger, messages: Messages, ux: UX) {
     super(namespace, connection, logger, messages, ux);
-    this.org = org;
-  }
-
-  // Just to disable org is unused error coming
-  public printOrgDetails(): void {
-    try {
-      Logger.log(JSON.stringify(this.org));
-    } catch (e) {
-      Logger.log(e);
-    }
   }
 
   public async handleExperienceSitePrerequisites(
@@ -67,8 +54,9 @@ export class PreMigrate extends BaseMigrationTool {
   // This needs to be behind timeout
   private async getExpSiteMetadataEnableConsent(): Promise<boolean> {
     const question = this.messages.getMessage('consentForExperienceSites');
+    const validResponse = false;
 
-    while (true) {
+    while (!validResponse) {
       try {
         // Get string input from user with timeout
         const userInput = await askStringWithTimeout(
@@ -80,19 +68,18 @@ export class PreMigrate extends BaseMigrationTool {
         // Validate and convert the input
         const normalizedInput = userInput.trim().toLowerCase();
 
-        if (normalizedInput === 'y' || normalizedInput === 'yes') {
+        if (normalizedInput === YES_SHORT || normalizedInput === YES_LONG) {
           return true;
-        } else if (normalizedInput === 'n' || normalizedInput === 'no') {
+        } else if (normalizedInput === NO_SHORT || normalizedInput === NO_LONG) {
           return false;
         } else {
           // Invalid input - show error and continue loop to re-prompt
           Logger.error(this.messages.getMessage('invalidYesNoResponse'));
-          Logger.log('Please enter "y" or "yes" to consent, "n" or "no" to decline.');
         }
       } catch (error) {
         // Handle timeout or other errors
-        Logger.error(this.messages.getMessage('failedToGetConsentError', [error.message]));
-        throw error; // Re-throw to let caller handle timeout
+        Logger.error(this.messages.getMessage('requestTimedOut'));
+        process.exit(1);
       }
     }
   }

src/migration/related/ExperienceSiteMigration.ts

@@ -97,6 +97,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
             Logger.logVerbose(this.messages.getMessage('fileNotHavingWrapper'));
           }
         } catch (err) {
+          this.populateExceptionInfo(file, experienceSitesAssessmentInfo);
           Logger.error(this.messages.getMessage('errorProcessingExperienceSite', [file.name]));
           Logger.error(JSON.stringify(err));
         }
@@ -168,6 +169,25 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
     return experienceSiteAssessmentInfo;
   }
 
+  private populateExceptionInfo(file: File, experienceSiteAssessmentInfos: ExperienceSiteAssessmentInfo[]): void {
+    try {
+      const experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo = {
+        name: file.name,
+        warnings: ['Unknown error occurred'],
+        errors: [''],
+        infos: [],
+        path: file.location,
+        diff: JSON.stringify([]),
+        hasOmnistudioContent: false,
+        status: 'Errors',
+      };
+
+      experienceSiteAssessmentInfos.push(experienceSiteAssessmentInfo);
+    } catch {
+      Logger.error(this.messages.getMessage('experienceSiteException'));
+    }
+  }
+
   private processRegion(
     region: ExpSiteRegion,
     experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo,
@@ -259,16 +279,22 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
   ): void {
     Logger.logVerbose(this.messages.getMessage('processingFlexcardComponent', [JSON.stringify(component)]));
     const flexcardName = targetName.substring(2); // cfCardName -> CardName
-    const targetDataFromStorageFC: FlexcardStorage = storage.fcStorage.get(flexcardName);
+    const targetDataFromStorageFC: FlexcardStorage = storage.fcStorage.get(flexcardName.toLowerCase());
 
     Logger.logVerbose(this.messages.getMessage('targetData', [JSON.stringify(targetDataFromStorageFC)]));
 
     // Remove later
     if (this.shouldAddWarning(targetDataFromStorageFC)) {
       const warningMsg: string = this.getWarningMessage(flexcardName, targetDataFromStorageFC);
       experienceSiteAssessmentInfo.warnings.push(warningMsg);
+      experienceSiteAssessmentInfo.status = 'Errors';
     } else {
       component.componentName = TARGET_COMPONENT_NAME_FC;
+
+      const keysToDelete = ['target', 'layout', 'params', 'standalone'];
+
+      keysToDelete.forEach((key) => delete currentAttribute[key]);
+
       currentAttribute['flexcardName'] = targetDataFromStorageFC.name;
       currentAttribute['objectApiName'] = '{!objectApiName}';
       currentAttribute['recordId'] = '{!recordId}';
@@ -285,7 +311,6 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
     Logger.logVerbose(this.messages.getMessage('processingOmniscriptComponent', [JSON.stringify(component)]));
     // Use storage to find the updated properties
     const targetDataFromStorage: OmniScriptStorage = storage.osStorage.get(targetName.toLowerCase());
-    StorageUtil.printAssessmentStorage();
     Logger.logVerbose(this.messages.getMessage('targetData', [JSON.stringify(targetDataFromStorage)]));
 
     if (this.shouldAddWarning(targetDataFromStorage)) {
@@ -303,7 +328,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
       keysToDelete.forEach((key) => delete currentAttribute[key]);
 
       currentAttribute['direction'] = 'ltr';
-      currentAttribute['display'] = 'Display button to open Omniscript';
+      currentAttribute['display'] = 'Display OmniScript on page';
       currentAttribute['inlineVariant'] = 'brand';
       currentAttribute['language'] =
         targetDataFromStorage.language === undefined ? 'English' : targetDataFromStorage.language;

src/utils/resultsbuilder/index.ts

@@ -256,7 +256,7 @@ export class ResultsBuilder {
       },
       assessmentDate: new Date().toString(),
       total: result.length,
-      filterGroups: [createFilterGroupParam('Filter by Status', 'status', ['Complete', 'Error'])],
+      filterGroups: [createFilterGroupParam('Filter by Status', 'status', ['Complete', 'Failed'])],
       headerGroups: [
         {
           header: [
@@ -295,13 +295,13 @@ export class ResultsBuilder {
           createRowDataParam('path', item.path, false, 1, 1, false),
           createRowDataParam(
             'status',
-            item.warnings ? 'Error' : 'Complete', // This is the value which the status key takes
+            item.warnings && item.warnings.length > 0 ? 'Failed' : 'Complete',
             false,
             1,
             1,
             false,
             undefined,
-            item.warnings ? 'Error' : 'Complete' // This is what gets displayed
+            item.warnings && item.warnings.length > 0 ? 'Failed' : 'Complete'
           ),
           createRowDataParam(
             'diff',
@@ -311,17 +311,18 @@ export class ResultsBuilder {
             1,
             false,
             undefined,
-            FileDiffUtil.getDiffHTML(item.diff, item.name)
+            FileDiffUtil.getDiffHTML(item.diff, this.rowId.toString())
           ),
           createRowDataParam(
             'errors',
-            item.warnings ? 'Error' : 'Complete',
+            item.warnings && item.warnings.length > 0 ? 'Failed' : 'Complete',
             false,
             1,
             1,
             false,
             undefined,
-            item.warnings
+            item.warnings,
+            item.warnings ? 'text-error' : 'text-success'
           ),
         ],
       })),

test/migration/related/ExperienceSiteMigration.test.ts

@@ -203,7 +203,11 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSites('/test/project', Migrate);
 
       // Assert
-      expect(result).to.be.an('array').that.is.empty;
+      expect(result).to.be.an('array').that.has.length(1);
+      expect(result[0].name).to.equal('error.json');
+      expect(result[0].status).to.equal('Errors');
+      expect(result[0].errors).to.include('Unknown error occurred');
+      expect(result[0].hasOmnistudioContent).to.be.false;
       expect((Logger.error as sinon.SinonStub).called).to.be.true;
     });
   });
@@ -269,7 +273,7 @@ describe('ExperienceSiteMigration', () => {
       expect(component.componentAttributes.subType).to.equal('TestSubtype');
       expect(component.componentAttributes.language).to.equal('English');
       expect(component.componentAttributes.direction).to.equal('ltr');
-      expect(component.componentAttributes.display).to.equal('Display button to open Omniscript');
+      expect(component.componentAttributes.display).to.equal('Display OmniScript on page');
       expect(component.componentAttributes.theme).to.equal('lightning'); // Preserved from original layout
     });