Merge pull request #455 from sf-aastha-paruthi/u/aparuthi/fileviewfix

@W-20469531 In Assessment Report - For Experience Pages, difference in changes column is not getting populated

Author: sf-aastha-paruthi

src/migration/related/ExperienceSiteMigration.ts

@@ -103,7 +103,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
         }
         try {
           const experienceSitePageInfo = this.processExperienceSite(file, type);
-          if (experienceSitePageInfo?.hasOmnistudioContent === true) {
+          if (experienceSitePageInfo?.hasOmnistudioContentWithChanges === true) {
             Logger.logVerbose(this.messages.getMessage('experienceSiteWithOmniWrapperSuccessfullyProcessed'));
             experienceSiteAssessmentInfo.experienceSiteAssessmentPageInfos.push(experienceSitePageInfo);
           } else {
@@ -136,7 +136,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
       infos: [],
       path: file.location,
       diff: JSON.stringify([]),
-      hasOmnistudioContent: false,
+      hasOmnistudioContentWithChanges: false,
       status: type === this.ASSESS ? 'Ready for migration' : 'Successfully migrated',
     };
 
@@ -150,7 +150,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
     // TODO - When will it be Flexcard
 
     if (regions === undefined) {
-      experienceSiteAssessmentInfo.hasOmnistudioContent = false;
+      experienceSiteAssessmentInfo.hasOmnistudioContentWithChanges = false;
       return experienceSiteAssessmentInfo;
     }
 
@@ -177,6 +177,17 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
 
     Logger.logVerbose(this.messages.getMessage('printDifference', [JSON.stringify(difference)]));
 
+    // If there are no differences, mark as not having OmniStudio content to exclude from report
+    // Only exclude if status is 'Ready for migration' or 'Successfully migrated' (no warnings/errors)
+    if (
+      difference.length === 0 &&
+      (experienceSiteAssessmentInfo.status === 'Ready for migration' ||
+        experienceSiteAssessmentInfo.status === 'Successfully migrated')
+    ) {
+      experienceSiteAssessmentInfo.hasOmnistudioContentWithChanges = false;
+      return experienceSiteAssessmentInfo;
+    }
+
     if (type === this.MIGRATE && normalizedOriginalFileContent !== noarmalizeUpdatedFileContent) {
       Logger.logVerbose(this.messages.getMessage('updatingFile'));
       fs.writeFileSync(file.location, noarmalizeUpdatedFileContent, 'utf8');
@@ -196,7 +207,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
         infos: [],
         path: file.location,
         diff: JSON.stringify([]),
-        hasOmnistudioContent: false,
+        hasOmnistudioContentWithChanges: false,
         status: 'Failed',
       };
 
@@ -242,7 +253,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
     // Check for legacy wrapper component
     if (component.componentName === lookupComponentName) {
       Logger.logVerbose(this.messages.getMessage('omniWrapperFound'));
-      experienceSiteAssessmentInfo.hasOmnistudioContent = true;
+      experienceSiteAssessmentInfo.hasOmnistudioContentWithChanges = true;
 
       this.updateComponentAndItsAttributes(
         component,
@@ -259,7 +270,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
       // Check for new LWC components that need reference updates
       if (this.isOmnistudioStandardWrapper(component.componentName)) {
         Logger.logVerbose(`Found Omnistudio component: ${component.componentName}`);
-        experienceSiteAssessmentInfo.hasOmnistudioContent = true;
+        experienceSiteAssessmentInfo.hasOmnistudioContentWithChanges = true;
 
         this.updateOmnistudioComponentReferences(component, experienceSiteAssessmentInfo, storage, type);
 

src/migration/related/FlexipageMigration.ts

@@ -206,12 +206,22 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
     const diff = new FileDiffUtil().getXMLDiff(normalizedOriginal, normalizedModified);
     Logger.logVerbose(this.messages.getMessage('generatedDiffForFile', [fileName]));
 
+    const status = mode === 'assess' ? 'Ready for migration' : 'Successfully migrated';
+
+    // Check if there are any actual changes (where old !== new)
+    const hasActualChanges = diff.some((d) => d.old !== d.new);
+
+    // Only exclude if there are no changes AND status indicates success (no warnings/errors)
+    if (!hasActualChanges && (status === 'Ready for migration' || status === 'Successfully migrated')) {
+      return null;
+    }
+
     return {
       path: filePath,
       name: fileName,
       diff: JSON.stringify(diff),
       errors: [],
-      status: mode === 'assess' ? 'Ready for migration' : 'Successfully migrated',
+      status,
     };
   }
 }

src/utils/interfaces.ts

@@ -204,7 +204,7 @@ export interface FileParser {
 export interface ExperienceSiteAssessmentPageInfo extends FileChangeInfo {
   warnings: string[];
   infos: string[];
-  hasOmnistudioContent: boolean;
+  hasOmnistudioContentWithChanges: boolean;
   errors: string[];
   status: 'Ready for migration' | 'Failed' | 'Successfully migrated' | 'Needs manual intervention' | 'Skipped';
 }

test/migration/related/ExperienceSiteMigration.test.ts

@@ -183,7 +183,7 @@ describe('ExperienceSiteMigration', () => {
 
       processFileStub.onCall(0).returns({
         name: 'site1.json',
-        hasOmnistudioContent: true,
+        hasOmnistudioContentWithChanges: true,
         warnings: [],
         infos: [],
         path: '/test/path/site1.json',
@@ -193,7 +193,7 @@ describe('ExperienceSiteMigration', () => {
       });
       processFileStub.onCall(1).returns({
         name: 'site3.json',
-        hasOmnistudioContent: false,
+        hasOmnistudioContentWithChanges: false,
         warnings: [],
         infos: [],
         path: '/test/path/site3.json',
@@ -208,7 +208,7 @@ describe('ExperienceSiteMigration', () => {
       // Assert
       expect(fileUtilStub.calledOnce).to.be.true;
       expect(processFileStub.calledTwice).to.be.true; // Only called for JSON files
-      expect(result).to.have.length(1); // Only files with hasOmnistudioContent: true
+      expect(result).to.have.length(1); // Only files with hasOmnistudioContentWithChanges: true
       expect(result[0].experienceSiteAssessmentPageInfos[0].name).to.equal('site1.json');
     });
 
@@ -229,7 +229,7 @@ describe('ExperienceSiteMigration', () => {
       expect(result[0].experienceSiteAssessmentPageInfos[0].name).to.equal('error.json');
       expect(result[0].experienceSiteAssessmentPageInfos[0].status).to.equal('Failed');
       expect(result[0].experienceSiteAssessmentPageInfos[0].warnings).to.include('Unknown error occurred');
-      expect(result[0].experienceSiteAssessmentPageInfos[0].hasOmnistudioContent).to.be.false;
+      expect(result[0].experienceSiteAssessmentPageInfos[0].hasOmnistudioContentWithChanges).to.be.false;
       expect((Logger.error as sinon.SinonStub).called).to.be.true;
     });
   });
@@ -256,7 +256,11 @@ describe('ExperienceSiteMigration', () => {
       sinon.stub(require('fs'), 'writeFileSync').value(fsWriteStub);
 
       storageUtilStub = sinon.stub(StorageUtil, 'getOmnistudioMigrationStorage');
-      sinon.stub(FileDiffUtil.prototype, 'getFileDiff').returns([]);
+      // Mock FileDiffUtil to return a non-empty diff (indicating changes were made)
+      sinon.stub(FileDiffUtil.prototype, 'getFileDiff').returns([
+        { old: 'line1', new: 'line1' },
+        { old: 'oldline', new: 'newline' },
+      ]);
     });
 
     it('should replace vlocityLWCOmniWrapper component with runtime_omnistudio_omniscript', () => {
@@ -286,7 +290,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(fsWriteStub.calledOnce).to.be.true;
 
       // Verify the file content was updated
@@ -303,19 +307,19 @@ describe('ExperienceSiteMigration', () => {
       expect(component.componentAttributes.theme).to.equal('lightning'); // Preserved from original layout
     });
 
-    it('should return hasOmnistudioContent false when no vlocityLWCOmniWrapper found', () => {
+    it('should return hasOmnistudioContentWithChanges false when no vlocityLWCOmniWrapper found', () => {
       // Arrange
       fsReadStub.returns(JSON.stringify(sampleExperienceSiteJsonWithoutWrapper));
 
       // Act
       const result = experienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.false;
+      expect(result.hasOmnistudioContentWithChanges).to.be.false;
       expect(fsWriteStub.called).to.be.false; // No changes made
     });
 
-    it('should return hasOmnistudioContent false when regions are undefined', () => {
+    it('should return hasOmnistudioContentWithChanges false when regions are undefined', () => {
       // Arrange
       const siteWithoutRegions = { ...sampleExperienceSiteJson, regions: undefined };
       fsReadStub.returns(JSON.stringify(siteWithoutRegions));
@@ -324,7 +328,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.false;
+      expect(result.hasOmnistudioContentWithChanges).to.be.false;
       expect(fsWriteStub.called).to.be.false;
     });
 
@@ -342,7 +346,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1);
       expect(result.warnings[0]).to.include('TestSubtype:English Needs manual intervention');
     });
@@ -374,7 +378,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1);
     });
 
@@ -405,7 +409,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1);
       expect(result.warnings[0]).to.include('Needs manual intervention as duplicated key found');
     });
@@ -427,7 +431,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1);
       expect(result.warnings[0]).to.include('The Target Name is empty. Check your Experience Cloud site configuration');
     });
@@ -450,7 +454,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       // Should not throw an error and continue processing
     });
 
@@ -514,7 +518,11 @@ describe('ExperienceSiteMigration', () => {
       sinon.stub(require('fs'), 'writeFileSync').value(fsWriteStub);
 
       storageUtilStub = sinon.stub(StorageUtil, 'getOmnistudioAssessmentStorage');
-      sinon.stub(FileDiffUtil.prototype, 'getFileDiff').returns([]);
+      // Mock FileDiffUtil to return a non-empty diff (indicating changes were made)
+      sinon.stub(FileDiffUtil.prototype, 'getFileDiff').returns([
+        { old: 'line1', new: 'line1' },
+        { old: 'oldline', new: 'newline' },
+      ]);
     });
 
     it('should use assessment storage instead of migration storage in assess mode', () => {
@@ -545,7 +553,7 @@ describe('ExperienceSiteMigration', () => {
 
       // Assert
       expect(storageUtilStub.calledOnce).to.be.true;
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(0);
     });
 
@@ -564,7 +572,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Assess);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1);
       expect(result.warnings[0]).to.include('TestSubtype:English Needs manual intervention');
     });
@@ -596,7 +604,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Assess);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1);
       expect(result.warnings[0]).to.include('Needs manual intervention as migration failed');
     });
@@ -628,12 +636,12 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Assess);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1);
       expect(result.warnings[0]).to.include('Needs manual intervention as duplicated key found');
     });
 
-    it('should return false for hasOmnistudioContent when no wrapper component found in assess mode', () => {
+    it('should return false for hasOmnistudioContentWithChanges when no wrapper component found in assess mode', () => {
       // Arrange
       const mockStorage: MigrationStorage = {
         osStorage: new Map<string, OmniScriptStorage>(),
@@ -647,7 +655,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Assess);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.false;
+      expect(result.hasOmnistudioContentWithChanges).to.be.false;
       expect(result.warnings).to.have.length(0);
       expect(fsWriteStub.called).to.be.false;
     });
@@ -712,7 +720,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Assess);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1); // Only the duplicate should generate a warning
       expect(result.warnings[0]).to.include('DuplicateSubtype:English');
       expect(result.warnings[0]).to.include('duplicated key found');
@@ -732,7 +740,7 @@ describe('ExperienceSiteMigration', () => {
       const result = experienceSiteMigration.processExperienceSite(mockFile, Assess);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1);
       expect(result.warnings[0]).to.include('Needs manual intervention');
       expect(result.status).to.equal('Needs manual intervention');
@@ -782,7 +790,11 @@ describe('ExperienceSiteMigration', () => {
       sinon.stub(require('fs'), 'writeFileSync').value(fsWriteStub);
 
       storageUtilStub = sinon.stub(StorageUtil, 'getOmnistudioMigrationStorage');
-      sinon.stub(FileDiffUtil.prototype, 'getFileDiff').returns([]);
+      // Mock FileDiffUtil to return a non-empty diff (indicating changes were made)
+      sinon.stub(FileDiffUtil.prototype, 'getFileDiff').returns([
+        { old: 'line1', new: 'line1' },
+        { old: 'oldline', new: 'newline' },
+      ]);
     });
 
     it('should process standard data model OmniScript component successfully', () => {
@@ -838,7 +850,7 @@ describe('ExperienceSiteMigration', () => {
       const result = standardDataModelExperienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(fsWriteStub.calledOnce).to.be.true;
 
       // Verify the file content was updated
@@ -889,7 +901,7 @@ describe('ExperienceSiteMigration', () => {
       const result = standardDataModelExperienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(result.warnings).to.have.length(1);
       expect(result.warnings[0]).to.include('standard-test.json needs manual intervention for configuration');
       expect(result.status).to.equal('Skipped');
@@ -939,7 +951,7 @@ describe('ExperienceSiteMigration', () => {
       const result = standardDataModelExperienceSiteMigration.processExperienceSite(mockFile, Migrate);
 
       // Assert
-      expect(result.hasOmnistudioContent).to.be.true;
+      expect(result.hasOmnistudioContentWithChanges).to.be.true;
       expect(fsWriteStub.calledOnce).to.be.true;
 
       // Verify the file content was updated

test/migration/related/FlexipageMigration.test.ts

@@ -104,8 +104,8 @@ describe('FlexipageMigration', () => {
 
     // Mock FileDiffUtil
     mockFileDiffUtil = {
-      getFileDiff: sandbox.stub().returns('mock-diff'),
-      getXMLDiff: sandbox.stub().returns('mock-diff'),
+      getFileDiff: sandbox.stub().returns([{ old: 'old-line', new: 'new-line' }]),
+      getXMLDiff: sandbox.stub().returns([{ old: 'old-line', new: 'new-line' }]),
     };
 
     // Mock transformFlexipageBundle
@@ -324,7 +324,7 @@ describe('FlexipageMigration', () => {
       expect(result).to.deep.include({
         path: filePath,
         name: fileName,
-        diff: JSON.stringify('mock-diff'),
+        diff: JSON.stringify([{ old: 'old-line', new: 'new-line' }]),
         errors: [],
         status: 'Ready for migration',
       });
@@ -352,7 +352,7 @@ describe('FlexipageMigration', () => {
       expect(result).to.deep.include({
         path: filePath,
         name: fileName,
-        diff: JSON.stringify('mock-diff'),
+        diff: JSON.stringify([{ old: 'old-line', new: 'new-line' }]),
         errors: [],
         status: 'Successfully migrated',
       });