feat: flexipage migration with storage

snehaljha-sf · snehaljha-sf · commit 780a2aa0c2c4 · 2025-07-18T16:16:38.000+05:30
diff --git a/messages/assess.json b/messages/assess.json
@@ -126,5 +126,6 @@
   "updatedModifiedContent": "updated content in file: %s",
   "generatedDiffForFile": "Generated diff for file: %s",
   "errorProcessingFlexiPage": "Error processing flexipage file: %s, %s",
-  "flexipagesWithChanges": "Found %s flexipage files with changes"
+  "flexipagesWithChanges": "Found %s flexipage files with changes",
+  "migratingFlexiPages": "Migrating FlexiPages"
 }
diff --git a/src/commands/omnistudio/migration/assess.ts b/src/commands/omnistudio/migration/assess.ts
@@ -41,7 +41,7 @@ export default class Assess extends OmniStudioBaseCommand {
     }),
     relatedobjects: flags.string({
       char: 'r',
-      description: messages.getMessage('apexLwc'),
+      description: messages.getMessage('relatedObjectGA'),
     }),
     verbose: flags.builtin({
       type: 'builtin',
diff --git a/src/error/errorInterfaces.ts b/src/error/errorInterfaces.ts
@@ -0,0 +1,30 @@
+export class KeyNotFoundInStorageError extends Error {
+  public componentType: string;
+  public key: string;
+
+  public constructor(key: string, componentType: string) {
+    super(`Key ${key} not found in storage`);
+    this.key = key;
+    this.componentType = componentType;
+  }
+}
+
+export class DuplicateKeyError extends Error {
+  public componentType: string;
+  public key: string;
+
+  public constructor(key: string, componentType: string) {
+    super(`Key ${key} is duplicate in storage`);
+    this.key = key;
+    this.componentType = componentType;
+  }
+}
+
+export class TargetPropertyNotFoundError extends Error {
+  public componentName: string;
+
+  public constructor(componentName: string) {
+    super(`Target property not found for component ${componentName}`);
+    this.componentName = componentName;
+  }
+}
diff --git a/src/migration/flexcard.ts b/src/migration/flexcard.ts
@@ -185,6 +185,8 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
     }
     uniqueNames.add(cleanedName);
 
+    this.addToAssessmentStorage(originalName, cleanedName);
+
     // Check for author name changes
     const originalAuthor = flexCard[this.namespacePrefix + 'Author__c'];
     if (originalAuthor) {
@@ -584,6 +586,18 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
     }
   }
 
+  private addToAssessmentStorage(originalName: string, cleanedName: string) {
+    let storage: MigrationStorage = StorageUtil.getOmnistudioAssessmentStorage();
+    if (storage.fcStorage.has(originalName)) {
+      storage.fcStorage.get(originalName).isDuplicate = true;
+    } else {
+      storage.fcStorage.set(originalName, {
+        name: cleanedName,
+        isDuplicate: false,
+      });
+    }
+  }
+
   private prepareStorageForFlexcards(
     cardsUploadInfo: Map<string, UploadRecordResult>,
     originalRecords: Map<string, any>
diff --git a/src/migration/omniscript.ts b/src/migration/omniscript.ts
@@ -428,6 +428,13 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
 
     const warnings: string[] = [];
 
+    if (omniProcessType === 'OmniScript') {
+      this.addToAssessmentStorage(
+        existingTypeVal,
+        existingSubTypeVal,
+        omniscript[this.namespacePrefix + 'Language__c']
+      );
+    }
     const recordName =
       `${existingTypeVal.cleanName()}_` +
       `${existingSubTypeVal.cleanName()}` +
@@ -774,6 +781,21 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
     };
   }
 
+  private addToAssessmentStorage(type: StringVal, subtype: StringVal, language: string) {
+    let storage: MigrationStorage = StorageUtil.getOmnistudioAssessmentStorage();
+    const key = `${type.val}${subtype.val}${language}`;
+    if (storage.osStorage.has(key)) {
+      storage.osStorage.get(key).isDuplicate = true;
+    } else {
+      storage.osStorage.set(key, {
+        type: type.cleanName(),
+        subtype: subtype.cleanName(),
+        language: language || 'English',
+        isDuplicate: false,
+      });
+    }
+  }
+
   private updateStorageForOmniscript(
     osUploadInfo: Map<string, UploadRecordResult>,
     originalOsRecords: Map<string, any>
diff --git a/src/migration/related/FlexipageMigration.ts b/src/migration/related/FlexipageMigration.ts
@@ -18,6 +18,7 @@ import { XMLUtil } from '../../utils/XMLUtil';
 import { FileDiffUtil } from '../../utils/lwcparser/fileutils/FileDiffUtil';
 import { transformFlexipageBundle } from '../../utils/flexipage/flexiPageTransformer';
 import { Flexipage } from '../interfaces';
+import { DuplicateKeyError, KeyNotFoundInStorageError, TargetPropertyNotFoundError } from '../../error/errorInterfaces';
 import { BaseRelatedObjectMigration } from './BaseRealtedObjectMigration';
 
 /**
@@ -72,7 +73,7 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
    * @returns Array of FlexiPage assessment information
    */
   public assess(): FlexiPageAssessmentInfo[] {
-    Logger.info(this.messages.getMessage('assessingFlexiPages'));
+    Logger.log(this.messages.getMessage('assessingFlexiPages'));
     return this.process('assess');
   }
 
@@ -82,7 +83,7 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
    * @returns Array of FlexiPage assessment information after migration
    */
   public migrate(): FlexiPageAssessmentInfo[] {
-    Logger.info(this.messages.getMessage('migratingFlexiPages'));
+    Logger.log(this.messages.getMessage('migratingFlexiPages'));
     return this.process('migrate');
   }
 
@@ -100,13 +101,13 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
    * @returns Array of FlexiPage assessment information
    */
   private process(mode: 'assess' | 'migrate'): FlexiPageAssessmentInfo[] {
-    Logger.info(this.messages.getMessage('retrievingFlexiPages'));
+    Logger.logVerbose(this.messages.getMessage('retrievingFlexiPages'));
     shell.cd(this.projectPath);
     sfProject.retrieve(Constants.FlexiPage, this.org.getUsername());
     const files = fs
       .readdirSync(path.join(this.projectPath, 'force-app', 'main', 'default', 'flexipages'))
       .filter((file) => file.endsWith('.xml'));
-    Logger.info(this.messages.getMessage('successfullyRetrievedFlexiPages', [files.length]));
+    Logger.logVerbose(this.messages.getMessage('successfullyRetrievedFlexiPages', [files.length]));
     const progressBar = createProgressBar('Migrating', 'Flexipage');
     progressBar.setTotal(files.length);
     const flexPageAssessmentInfos: FlexiPageAssessmentInfo[] = [];
@@ -124,8 +125,16 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
           ])
         );
       } catch (error) {
-        Logger.error(this.messages.getMessage('errorProcessingFlexiPage', [file, error]));
-        Logger.error(error);
+        if (error instanceof KeyNotFoundInStorageError) {
+          Logger.error(`${error.componentType} ${error.key} can't be migrated`);
+        } else if (error instanceof TargetPropertyNotFoundError) {
+          Logger.error(error.message);
+        } else if (error instanceof DuplicateKeyError) {
+          Logger.error(`${error.componentType} ${error.key} is duplicate`);
+        } else {
+          Logger.error(this.messages.getMessage('errorProcessingFlexiPage', [file, error]));
+          Logger.error(error);
+        }
         flexPageAssessmentInfos.push({
           name: file,
           errors: [error instanceof Error ? error.message : JSON.stringify(error)],
@@ -137,10 +146,12 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
       progressBar.increment();
     }
     progressBar.stop();
-    Logger.info(this.messages.getMessage('completedProcessingAllFlexiPages', [flexPageAssessmentInfos.length]));
-    flexPageAssessmentInfos.filter((flexPageAssessmentInfo) => flexPageAssessmentInfo.status !== 'No Changes');
-    Logger.info(this.messages.getMessage('flexipagesWithChanges', [flexPageAssessmentInfos.length]));
-    return flexPageAssessmentInfos;
+    Logger.logVerbose(this.messages.getMessage('completedProcessingAllFlexiPages', [flexPageAssessmentInfos.length]));
+    const filteredResults = flexPageAssessmentInfos.filter(
+      (flexPageAssessmentInfo) => flexPageAssessmentInfo.status !== 'No Changes'
+    );
+    Logger.log(this.messages.getMessage('flexipagesWithChanges', [filteredResults.length]));
+    return filteredResults;
   }
 
   /**
@@ -165,9 +176,7 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
     Logger.logVerbose(this.messages.getMessage('readFlexiPageContent', [fileContent.length]));
 
     const json = this.xmlUtil.parse(fileContent) as Flexipage;
-    const jsonPath = path.join(shell.pwd().toString(), 'json', fileName + '.json');
-    fs.writeFileSync(jsonPath.toString(), JSON.stringify(json) || '');
-    const transformedFlexiPage = transformFlexipageBundle(json, this.namespace);
+    const transformedFlexiPage = transformFlexipageBundle(json, this.namespace, mode);
     if (transformedFlexiPage === false) {
       return {
         name: fileName,
@@ -179,9 +188,6 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
     }
     const modifiedContent = this.xmlUtil.build(transformedFlexiPage, 'FlexiPage');
 
-    const xmlPath = path.join(shell.pwd().toString(), 'xml', fileName);
-    fs.writeFileSync(xmlPath.toString(), modifiedContent);
-
     if (mode === 'migrate') {
       fs.writeFileSync(filePath, modifiedContent);
       Logger.logVerbose(this.messages.getMessage('updatedModifiedContent', [filePath]));
diff --git a/src/utils/flexipage/flexiPageTransformer.ts b/src/utils/flexipage/flexiPageTransformer.ts
@@ -5,17 +5,29 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { Flexipage, FlexiComponentInstanceProperty } from '../../migration/interfaces';
+import { DuplicateKeyError, KeyNotFoundInStorageError, TargetPropertyNotFoundError } from '../../error/errorInterfaces';
+import {
+  Flexipage,
+  FlexiComponentInstanceProperty,
+  OmniScriptStorage,
+  FlexcardStorage,
+} from '../../migration/interfaces';
+import { StorageUtil } from '../storageUtil';
 
 /** Attributes to remove during transformation */
 const attrsToRemove = ['target'];
 
 /** Component name to look for during transformation */
 const lookupComponentName = 'vlocityLWCOmniWrapper';
 /** Target component name after transformation */
-const targetComponentName = 'runtime_omnistudio:omniscript';
+const targetComponentNameOS = 'runtime_omnistudio:omniscript';
 /** Target identifier after transformation */
-const targetIdentifier = 'runtime_omnistudio_omniscript';
+const targetIdentifierOS = 'runtime_omnistudio_omniscript';
+
+const targetComponentNameFlexCard = 'runtime_omnistudio:flexcard';
+const targetIdentifierFlexCard = 'runtime_omnistudio_flexcard';
+
+const flexCardPrefix = 'cf';
 
 /**
  * Transforms a Flexipage bundle by replacing vlocityLWCOmniWrapper components
@@ -32,7 +44,11 @@ const targetIdentifier = 'runtime_omnistudio_omniscript';
  * @returns The transformed Flexipage bundle if changes were made, or false if no changes were needed
  * @throws Error if the 'target' property is not found for a component
  */
-export function transformFlexipageBundle(ogBundle: Flexipage, namespace: string): Flexipage | boolean {
+export function transformFlexipageBundle(
+  ogBundle: Flexipage,
+  namespace: string,
+  mode: 'assess' | 'migrate'
+): Flexipage | boolean {
   const bundle: Flexipage = JSON.parse(JSON.stringify(ogBundle)) as Flexipage;
   let changes = false;
 
@@ -62,9 +78,13 @@ export function transformFlexipageBundle(ogBundle: Flexipage, namespace: string)
         (prop) => prop.name === 'target'
       )?.value;
       if (!typeSubtypeLanguage) {
-        throw new Error('target property not found for component ' + item.componentInstance.componentName);
+        throw new TargetPropertyNotFoundError(item.componentInstance.componentName);
       }
-      const newProps = createNewProps(typeSubtypeLanguage);
+      const newProps = createNewProps(typeSubtypeLanguage.split(':')[1], namespace, mode);
+      const targetComponentName = newProps.componentName;
+      const targetIdentifier = newProps.identifier;
+      delete newProps.componentName;
+      delete newProps.identifier;
       const leftProps = item.componentInstance.componentInstanceProperties?.filter?.(propRemover) ?? [];
       const replacedProps = [
         ...leftProps,
@@ -88,11 +108,77 @@ export function transformFlexipageBundle(ogBundle: Flexipage, namespace: string)
  * @returns Object containing the new properties for the transformed component
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-function createNewProps(_property: string): Record<string, string> {
+function createNewProps(nameKey: string, namespace: string, mode: 'assess' | 'migrate'): Record<string, string> {
+  if (nameKey.startsWith(flexCardPrefix)) {
+    return createNewPropsForFlexCard(nameKey.substring(flexCardPrefix.length), namespace, mode);
+  }
+  return createNewPropsForOmniScript(nameKey, namespace, mode);
+  // return {
+  //   language: 'English',
+  //   subType: 'OSForCustomLWC',
+  //   theme: 'lightning',
+  //   type: 'OSForCustomLWC',
+  // };
+}
+
+function createNewPropsForOmniScript(
+  nameKey: string,
+  namespace: string,
+  mode: 'assess' | 'migrate'
+): Record<string, string> {
+  let migratedScriptName: OmniScriptStorage;
+  if (mode === 'assess') {
+    migratedScriptName = StorageUtil.getOmnistudioAssessmentStorage().osStorage.get(nameKey);
+  } else {
+    migratedScriptName = StorageUtil.getOmnistudioMigrationStorage().osStorage.get(nameKey);
+  }
+
+  if (!migratedScriptName) {
+    throw new KeyNotFoundInStorageError(nameKey, 'OmniScript');
+  }
+
+  if (migratedScriptName.isDuplicate) {
+    throw new DuplicateKeyError(nameKey, 'OmniScript');
+  }
+
+  return {
+    componentName: targetComponentNameOS,
+    identifier: targetIdentifierOS,
+    language: migratedScriptName.language || 'English',
+    subType: migratedScriptName.subtype,
+    type: migratedScriptName.type,
+    theme: 'OSForCustomLWC',
+    direction: 'ltr',
+    display: 'Display button to open Omniscript',
+    inlineVariant: 'brand',
+  };
+}
+
+function createNewPropsForFlexCard(
+  nameKey: string,
+  namespace: string,
+  mode: 'assess' | 'migrate'
+): Record<string, string> {
+  let migratedCardName: FlexcardStorage;
+  if (mode === 'assess') {
+    migratedCardName = StorageUtil.getOmnistudioAssessmentStorage().fcStorage.get(nameKey);
+  } else {
+    migratedCardName = StorageUtil.getOmnistudioMigrationStorage().fcStorage.get(nameKey);
+  }
+
+  if (!migratedCardName) {
+    throw new KeyNotFoundInStorageError(nameKey, 'Flexcard');
+  }
+
+  if (migratedCardName.isDuplicate) {
+    throw new DuplicateKeyError(nameKey, 'Flexcard');
+  }
+
   return {
-    language: 'English',
-    subType: 'OSForCustomLWC',
-    theme: 'lightning',
-    type: 'OSForCustomLWC',
+    componentName: targetComponentNameFlexCard,
+    identifier: targetIdentifierFlexCard,
+    flexcardName: migratedCardName.name,
+    objectApiName: '{!objectApiName}',
+    recordId: '{!recordId}',
   };
 }
diff --git a/src/utils/resultsbuilder/FlexipageAssessmentReporter.ts b/src/utils/resultsbuilder/FlexipageAssessmentReporter.ts
@@ -68,7 +68,7 @@ export class FlexipageAssessmentReporter {
       {
         name: 'Can be Automated',
         count: flexipageAssessmentInfos.filter((info) => info.status === 'Can be Automated').length,
-        cssClass: 'text-warning',
+        cssClass: 'text-success',
       },
       {
         name: 'Has Errors',
diff --git a/src/utils/resultsbuilder/index.ts b/src/utils/resultsbuilder/index.ts
diff --git a/test/migration/related/FlexipageMigration.test.ts b/test/migration/related/FlexipageMigration.test.ts
diff --git a/test/utils/flexipage/flexiPageTransformer.test.ts b/test/utils/flexipage/flexiPageTransformer.test.ts
diff --git a/test/utils/resultsbuilder/FlexipageAssessmentReporter.test.ts b/test/utils/resultsbuilder/FlexipageAssessmentReporter.test.ts

Original file line number	Diff line number	Diff line change
`@@ -126,5 +126,6 @@`
`126`	`126`	`"updatedModifiedContent": "updated content in file: %s",`
`127`	`127`	`"generatedDiffForFile": "Generated diff for file: %s",`
`128`	`128`	`"errorProcessingFlexiPage": "Error processing flexipage file: %s, %s",`
`129`		`- "flexipagesWithChanges": "Found %s flexipage files with changes"`
	`129`	`+ "flexipagesWithChanges": "Found %s flexipage files with changes",`
	`130`	`+ "migratingFlexiPages": "Migrating FlexiPages"`
`130`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ export class FlexipageAssessmentReporter {`
`68`	`68`	`{`
`69`	`69`	`name: 'Can be Automated',`
`70`	`70`	`count: flexipageAssessmentInfos.filter((info) => info.status === 'Can be Automated').length,`
`71`		`- cssClass: 'text-warning',`
	`71`	`+ cssClass: 'text-success',`
`72`	`72`	`},`
`73`	`73`	`{`
`74`	`74`	`name: 'Has Errors',`