Merge pull request #331 from sf-aastha-paruthi/u/aparuthi/ExperienceSitesMigration

@W-18777114  [Migration] Migrate OS and FC components associated with vLocity LWC wrapper to Omniscript standard wrapper in experience sites

Author: snehaljha-sf

src/commands/omnistudio/migration/migrate.ts

@@ -9,8 +9,7 @@
  */
 import * as os from 'os';
 import { flags } from '@salesforce/command';
-import { Messages } from '@salesforce/core';
-import { ExecuteAnonymousResult } from 'jsforce';
+import { Connection, Messages } from '@salesforce/core';
 import OmniStudioBaseCommand from '../../basecommand';
 import { DataRaptorMigrationTool } from '../../../migration/dataraptor';
 import { DebugTimer, MigratedObject, MigratedRecordInfo } from '../../../utils';
@@ -24,8 +23,8 @@ import { generatePackageXml } from '../../../utils/generatePackageXml';
 import { OmnistudioOrgDetails, OrgUtils } from '../../../utils/orgUtils';
 import { Constants } from '../../../utils/constants/stringContants';
 import { OrgPreferences } from '../../../utils/orgPreferences';
-import { AnonymousApexRunner } from '../../../utils/apex/executor/AnonymousApexRunner';
 import { ProjectPathUtil } from '../../../utils/projectPathUtil';
+import { PostMigrate } from '../../../migration/postMigrate';
 
 // Initialize Messages with the current plugin directory
 Messages.importMessagesDirectory(__dirname);
@@ -85,7 +84,6 @@ export default class Migrate extends OmniStudioBaseCommand {
     const migrateOnly = (this.flags.only || '') as string;
     const allVersions = this.flags.allversions || (false as boolean);
     const relatedObjects = (this.flags.relatedobjects || '') as string;
-
     // this.org is guaranteed because requiresUsername=true, as opposed to supportsUsername
     const conn = this.org.getConnection();
     if (apiVersion) {
@@ -124,9 +122,10 @@ export default class Migrate extends OmniStudioBaseCommand {
     let projectPath: string;
     let objectsToProcess: string[] = [];
     let targetApexNamespace: string;
+    const isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean } = { value: false };
     if (relatedObjects) {
       // To-Do: Add LWC to valid options when GA is released
-      const validOptions = [Constants.Apex];
+      const validOptions = [Constants.Apex, Constants.ExpSites];
       objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
       // Validate input
       for (const obj of objectsToProcess) {
@@ -141,7 +140,15 @@ export default class Migrate extends OmniStudioBaseCommand {
         // Use ProjectPathUtil for APEX project folder selection (matches assess.ts logic)
         projectPath = await ProjectPathUtil.getProjectPath(messages, true);
         targetApexNamespace = await this.getTargetApexNamespace(objectsToProcess, targetApexNamespace);
-      }
+        await this.handleExperienceSitePrerequisites(
+          objectsToProcess,
+          conn,
+          isExperienceBundleMetadataAPIProgramaticallyEnabled
+        );
+        Logger.logVerbose(
+          'The objects to process after handleExpSitePrerequisite are ' + JSON.stringify(objectsToProcess)
+        );
+      } // TODO - What if general consent is no
     }
 
     Logger.log(messages.getMessage('migrationInitialization', [String(namespace)]));
@@ -181,8 +188,20 @@ export default class Migrate extends OmniStudioBaseCommand {
       relatedObjectMigrationResult.lwcAssessmentInfos
     );
 
+    // POST MIGRATION
     let actionItems = [];
-    actionItems = await this.setDesignersToUseStandardDataModel(namespace);
+    const postMigrate: PostMigrate = new PostMigrate(
+      this.org,
+      namespace,
+      conn,
+      this.logger,
+      messages,
+      this.ux,
+      objectsToProcess
+    );
+
+    actionItems = await postMigrate.setDesignersToUseStandardDataModel(namespace);
+    await postMigrate.restoreExperienceAPIMetadataSettings(isExperienceBundleMetadataAPIProgramaticallyEnabled);
 
     await ResultsBuilder.generateReport(
       objectMigrationResults,
@@ -200,27 +219,47 @@ export default class Migrate extends OmniStudioBaseCommand {
     return { objectMigrationResults };
   }
 
-  private async setDesignersToUseStandardDataModel(namespace: string): Promise<string[]> {
-    const userActionMessage: string[] = [];
-    try {
-      Logger.logVerbose('Setting designers to use the standard data model');
-      const apexCode = `
-          ${namespace}.OmniStudioPostInstallClass.useStandardDataModel();
-        `;
-
-      const result: ExecuteAnonymousResult = await AnonymousApexRunner.run(this.org, apexCode);
-      if (result?.success === false) {
-        const message = result?.exceptionStackTrace;
-        Logger.error(`Error occurred while setting designers to use the standard data model ${message}`);
-        userActionMessage.push(messages.getMessage('manuallySwitchDesignerToStandardDataModel'));
-      } else if (result?.success === true) {
-        Logger.logVerbose('Successfully executed setDesignersToUseStandardDataModel');
+  private async handleExperienceSitePrerequisites(
+    objectsToProcess: string[],
+    conn: Connection,
+    isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean }
+  ): Promise<void> {
+    if (objectsToProcess.includes(Constants.ExpSites)) {
+      const expMetadataApiConsent = await this.getExpSiteMetadataEnableConsent();
+      Logger.logVerbose(`The consent for exp site is  ${expMetadataApiConsent}`);
+
+      if (expMetadataApiConsent === false) {
+        Logger.warn('Consent for experience sites is not provided. Experience sites will not be processed');
+        this.removeKeyFromRelatedObjectsToProcess(Constants.ExpSites, objectsToProcess);
+        Logger.logVerbose(`Objects to process after removing expsite are ${JSON.stringify(objectsToProcess)}`);
+        return;
+      }
+
+      const isMetadataAPIPreEnabled = await OrgPreferences.isExperienceBundleMetadataAPIEnabled(conn);
+      if (isMetadataAPIPreEnabled === true) {
+        Logger.logVerbose('ExperienceBundle metadata api is already enabled');
+        return;
       }
-    } catch (ex) {
-      Logger.error(`Exception occurred while setting designers to use the standard data model ${JSON.stringify(ex)}`);
-      userActionMessage.push(messages.getMessage('manuallySwitchDesignerToStandardDataModel'));
+
+      Logger.logVerbose('ExperienceBundle metadata api needs to be programatically enabled');
+      isExperienceBundleMetadataAPIProgramaticallyEnabled.value = await OrgPreferences.setExperienceBundleMetadataAPI(
+        conn,
+        true
+      );
+      if (isExperienceBundleMetadataAPIProgramaticallyEnabled.value === false) {
+        this.removeKeyFromRelatedObjectsToProcess(Constants.ExpSites, objectsToProcess);
+        Logger.warn('Since the api could not able enabled the experience sites would not be processed');
+      }
+
+      Logger.logVerbose(`Objects to process are ${JSON.stringify(objectsToProcess)}`);
+    }
+  }
+
+  private removeKeyFromRelatedObjectsToProcess(keyToRemove: string, relatedObjects: string[]): void {
+    const index = relatedObjects.indexOf(Constants.ExpSites);
+    if (index > -1) {
+      relatedObjects.splice(index, 1);
     }
-    return userActionMessage;
   }
 
   private async truncateObjects(migrationObjects: MigrationTool[], debugTimer: DebugTimer): Promise<MigratedObject[]> {
@@ -354,6 +393,23 @@ export default class Migrate extends OmniStudioBaseCommand {
     return consent;
   }
 
+  private async getExpSiteMetadataEnableConsent(): Promise<boolean> {
+    let consent: boolean | null = null;
+
+    while (consent === null) {
+      try {
+        consent = await Logger.confirm(
+          'By proceeding further, you hereby consent to enable digital experience metadata api(y/n). If y sites will be processed, if n expsites will not be processed'
+        );
+      } catch (error) {
+        Logger.log(messages.getMessage('invalidYesNoResponse'));
+        consent = null;
+      }
+    }
+
+    return consent;
+  }
+
   private mergeRecordAndUploadResults(
     migrationResults: MigrationResult,
     migrationTool: MigrationTool

src/migration/flexcard.ts

@@ -4,13 +4,21 @@ import CardMappings from '../mappings/VlocityCard';
 import { DebugTimer, QueryTools, SortDirection } from '../utils';
 import { NetUtils } from '../utils/net';
 import { BaseMigrationTool } from './base';
-import { MigrationResult, MigrationTool, ObjectMapping, UploadRecordResult } from './interfaces';
+import {
+  MigrationResult,
+  MigrationTool,
+  ObjectMapping,
+  UploadRecordResult,
+  MigrationStorage,
+  FlexcardStorage,
+} from './interfaces';
 import { Connection, Messages } from '@salesforce/core';
 import { UX } from '@salesforce/command';
 import { FlexCardAssessmentInfo } from '../../src/utils';
 import { Logger } from '../utils/logger';
 import { createProgressBar } from './base';
 import { Constants } from '../utils/constants/stringContants';
+import { StorageUtil } from '../utils/storageUtil';
 
 export class CardMigrationTool extends BaseMigrationTool implements MigrationTool {
   static readonly VLOCITYCARD_NAME = 'VlocityCard__c';
@@ -75,6 +83,7 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
   async migrate(): Promise<MigrationResult[]> {
     // Get All the Active VlocityCard__c records
     const cards = await this.getAllActiveCards();
+
     Logger.log(this.messages.getMessage('foundFlexCardsToMigrate', [cards.length]));
 
     const progressBar = createProgressBar('Migrating', 'Flexcard');
@@ -445,6 +454,9 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
       await this.uploadCard(cards, card, cardsUploadInfo, originalRecords, uniqueNames);
       progressBar.update(++progressCounter);
     }
+
+    this.prepareStorageForFlexcards(cardsUploadInfo, originalRecords);
+
     progressBar.stop();
 
     return cardsUploadInfo;
@@ -526,8 +538,9 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
             this.messages.getMessage('cardAuthorNameChangeMessage', [transformedCardAuthorName])
           );
         }
+
+        uploadResult.newName = transformedCardName;
         if (transformedCardName !== card['Name']) {
-          uploadResult.newName = transformedCardName;
           uploadResult.warnings.unshift(this.messages.getMessage('cardNameChangeMessage', [transformedCardName]));
         }
 
@@ -571,6 +584,52 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
     }
   }
 
+  private prepareStorageForFlexcards(
+    cardsUploadInfo: Map<string, UploadRecordResult>,
+    originalRecords: Map<string, any>
+  ) {
+    Logger.logVerbose('Started preparing storage for flexcards');
+    let storage: MigrationStorage = StorageUtil.getOmnistudioMigrationStorage();
+
+    for (let key of Array.from(originalRecords.keys())) {
+      try {
+        let oldrecord = originalRecords.get(key);
+        let newrecord = cardsUploadInfo.get(key);
+
+        Logger.logVerbose('Oldrecord - ' + JSON.stringify(oldrecord));
+        Logger.logVerbose('Newrecord - ' + JSON.stringify(newrecord));
+
+        let value: FlexcardStorage = {
+          name: newrecord['newName'],
+          isDuplicate: false,
+        };
+
+        if (newrecord.hasErrors) {
+          value.error = newrecord.errors;
+          value.migrationSuccess = false;
+        } else {
+          value.migrationSuccess = true;
+        }
+
+        let finalKey = `${oldrecord['Name']}`;
+        if (storage.fcStorage.has(finalKey)) {
+          // Key already exists - handle accordingly
+          Logger.logVerbose(`Key ${finalKey} already exists in flexcard storage`);
+          value.isDuplicate = true;
+          storage.fcStorage.set(finalKey, value);
+        } else {
+          // Key doesn't exist - safe to set
+          storage.fcStorage.set(finalKey, value);
+        }
+      } catch (error) {
+        Logger.logVerbose('Error occurred while processing key for flexcard storage');
+        Logger.error(error);
+      }
+
+      StorageUtil.printMigrationStorage();
+    }
+  }
+
   private getChildCards(card: AnyJson): string[] {
     let childs = [];
     const definition = JSON.parse(card[this.namespacePrefix + 'Definition__c']);

src/migration/interfaces.ts

@@ -43,6 +43,9 @@ export interface UploadRecordResult {
   warnings: string[];
   hasErrors: boolean;
   success?: boolean;
+  type?: string;
+  subtype?: string;
+  language?: string;
 }
 
 export interface MigrationResult {
@@ -91,3 +94,74 @@ export interface RelatedObjectMigrationResult {
   apexClasses: string[];
   lwcComponents: string[];
 }
+
+export interface ExpSitePageJson {
+  // Index signature to allow any additional properties
+  [key: string]: any;
+  appPageId: string;
+  componentName: string;
+  dataProviders: unknown[]; // Replace 'any' with a specific type if known
+  id: string;
+  label: string;
+  regions: ExpSiteRegion[];
+  themeLayoutType: string;
+  type: string;
+  viewType: string;
+}
+
+export interface ExpSiteRegion {
+  // Index signature to allow any additional properties
+  [key: string]: any;
+  id: string;
+  regionName: string;
+  type: string;
+  components?: ExpSiteComponent[]; // Optional, as some regions don't have components
+}
+
+export interface ExpSiteComponent {
+  // Index signature to allow any additional properties
+  [key: string]: any;
+  componentAttributes: ExpSiteComponentAttributes;
+  componentName: string;
+  id: string;
+  renderPriority?: string;
+  renditionMap: unknown; // Replace with better type if known
+  type: string;
+  subtype?: string;
+  language?: string;
+}
+
+export interface ExpSiteComponentAttributes {
+  // Index signature to allow any additional string properties
+  [key: string]: any;
+  // This is a union of possible structures. You can separate them if needed.
+  layout?: string;
+  params?: string;
+  standAlone?: boolean;
+  target?: string;
+  customHeadTags?: string;
+  description?: string;
+  title?: string;
+  richTextValue?: string;
+}
+
+export interface MigrationStorage {
+  osStorage: Map<string, OmniScriptStorage>;
+  fcStorage: Map<string, FlexcardStorage>;
+}
+
+export interface Storage {
+  migrationSuccess?: boolean;
+  error?: string[];
+  isDuplicate: boolean;
+}
+
+export interface OmniScriptStorage extends Storage {
+  type: string;
+  subtype: string;
+  language: string;
+}
+
+export interface FlexcardStorage extends Storage {
+  name: string;
+}