Merge pull request #402 from snehaljha-sf/expSite_report_update

feat: add bundle grouping for exp site reports

Author: snehaljha-sf

messages/assess.json

@@ -133,6 +133,7 @@
   "generatedDiffForFile": "Generated difference for the file: %s",
   "errorProcessingFlexiPage": "Error processing FlexiPage: %s, %s",
   "flexipagesWithChanges": "Found %s FlexiPages with changes",
+  "expSitesWithChanges": "Found %s Experience Cloud Sites with changes",
   "migratingFlexiPages": "Migrating FlexiPages",
   "experienceSiteMetadataConsent": "Your consent for migrating Experience Cloud sites is %s",
   "experienceSiteConsentNotProvidedWarning": "You’ve not provided consent and your Experience Cloud sites won’t be processed.",

messages/migrate.json

@@ -101,6 +101,7 @@
   "errorEvaluatingExpression": "Error evaluating expression: %s, %s",
   "migrationConsentNotGiven": "Couldn't confirm whether assessment errors are resolved",
   "foundFlexiPages": "Found %s FlexiPages to migrate",
+  "expSitesWithChanges": "Found %s Experience Cloud Sites with changes",
   "migratingFlexiPages": "Migrating FlexiPages",
   "completedProcessingAllFlexiPages": "Completed processing all flexipages. Total processed: %s",
   "completedProcessingFlexiPage": "Completed processing %s. Errors: %s",

src/javascripts/reportGeneratorUtility.js

@@ -1,3 +1,6 @@
+let props = {};
+let classToHide = 'no-display';
+
 function toggleFilterDropdown(tableId) {
   const reportTable = document.getElementById(tableId);
   const dropdown = reportTable.querySelector('#filter-dropdown');
@@ -87,6 +90,8 @@ function filterAndSearchTable(tableId) {
 
   // Otherwise, apply filters and search
   let processedClasses = new Set();
+
+  let classRowMap = new Map();
   rows.forEach((row) => {
     if (row.id === 'no-rows-message') return;
 
@@ -112,10 +117,18 @@ function filterAndSearchTable(tableId) {
       }
     }
 
-    // row.style.display = show ? '' : 'none';
-    if (!processedClasses.has(row.classList[0])) {
-      hideOrShowData(reportTable, row.classList[0], show);
-      processedClasses.add(row.classList[0]);
+    if (props?.rowBased) {
+      if (show && !classRowMap.has(row.classList[0])) {
+        classRowMap.set(row.classList[0], { row, cnt: 1 });
+      } else if (show) {
+        classRowMap.get(row.classList[0]).cnt++;
+      }
+      row.style.display = show ? '' : 'none';
+    } else {
+      if (!processedClasses.has(row.classList[0])) {
+        hideOrShowData(reportTable, row.classList[0], show);
+        processedClasses.add(row.classList[0]);
+      }
     }
     if (show) visibleRowCount++;
   });
@@ -129,11 +142,24 @@ function filterAndSearchTable(tableId) {
     (row) => row.style.display !== 'none' && row.id !== 'no-rows-message'
   );
 
+  if (props?.rowBased) {
+    rows.forEach((row) => {
+      row.cells[0].classList.add(classToHide);
+    });
+
+    classRowMap.forEach((value) => {
+      value.row.cells[0].classList.remove(classToHide);
+      value.row.cells[0].rowSpan = value.cnt;
+    });
+  }
+
   // filter only distinct classes from visibleRows
-  const distinctClasses = [...new Set(visibleRows.map((row) => row.classList[0]))];
-  reportTable.querySelector('#row-count').textContent = `Showing ${distinctClasses.length} record${
-    distinctClasses.length !== 1 ? 's' : ''
-  }`;
+  let recordLabel = props?.recordName || 'records';
+  let cnt = visibleRows.length;
+  if (!props?.rowCount) {
+    cnt = [...new Set(visibleRows.map((row) => row.classList[0]))].length;
+  }
+  reportTable.querySelector('#row-count').textContent = `Total ${recordLabel}: ${cnt}`;
 }
 
 function toggleCtaSummaryPanel() {
@@ -160,6 +186,7 @@ function hideOrShowData(reportTable, rowClass, show) {
 }
 
 document.addEventListener('DOMContentLoaded', () => {
+  loadProps();
   document.querySelectorAll('.collapsible-content').forEach((collapsibleContent) => {
     collapsibleContent.style.display = 'none';
   });
@@ -266,6 +293,21 @@ function closeCtaPanel() {
   }
 }
 
+function loadProps() {
+  const propElement = document.querySelector('#props');
+  if (!propElement) {
+    return;
+  }
+
+  try {
+    props = JSON.parse(propElement.textContent);
+  } catch (error) {
+    console.error('error parsing props', error);
+    return;
+  }
+  console.log('parsed props', props);
+}
+
 // Expose globally so HTML inline event handlers can access them
 window.toggleFilterDropdown = toggleFilterDropdown;
 window.closeFilterDropdown = closeFilterDropdown;

src/migration/related/ApexMigration.ts

@@ -58,7 +58,7 @@ export class ApexMigration extends BaseRelatedObjectMigration {
     shell.cd(this.projectPath);
     Logger.info(migrateMessages.getMessage('processingApexFilesForMigration'));
     const apexAssessmentInfos = this.processApexFiles(this.projectPath, 'migration');
-    Logger.info(migrateMessages.getMessage('successfullyProcessedApexFilesForMigration', [apexAssessmentInfos.length]));
+    Logger.log(migrateMessages.getMessage('successfullyProcessedApexFilesForMigration', [apexAssessmentInfos.length]));
     Logger.logVerbose(
       migrateMessages.getMessage('apexMigrationResults', [JSON.stringify(apexAssessmentInfos, null, 2)])
     );
@@ -72,7 +72,7 @@ export class ApexMigration extends BaseRelatedObjectMigration {
     shell.cd(this.projectPath);
     Logger.info(assessMessages.getMessage('processingApexFilesForAssessment'));
     const apexAssessmentInfos = this.processApexFiles(this.projectPath, 'assessment');
-    Logger.info(assessMessages.getMessage('successfullyProcessedApexFilesForAssessment', [apexAssessmentInfos.length]));
+    Logger.log(assessMessages.getMessage('successfullyProcessedApexFilesForAssessment', [apexAssessmentInfos.length]));
     Logger.logVerbose(
       assessMessages.getMessage('apexAssessmentResults', [JSON.stringify(apexAssessmentInfos, null, 2)])
     );

src/migration/related/ExperienceSiteMigration.ts

@@ -16,7 +16,7 @@ import {
   FlexcardStorage,
 } from '../interfaces';
 import { FileDiffUtil } from '../../utils/lwcparser/fileutils/FileDiffUtil';
-import { ExperienceSiteAssessmentInfo } from '../../utils';
+import { ExperienceSiteAssessmentInfo, ExperienceSiteAssessmentPageInfo } from '../../utils';
 import { StorageUtil } from '../../utils/storageUtil';
 import { createProgressBar } from '../base';
 import { BaseRelatedObjectMigration } from './BaseRealtedObjectMigration';
@@ -60,6 +60,11 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
     const experienceSiteInfo = this.processExperienceSites(this.EXPERIENCE_SITES_PATH, type);
     Logger.info(this.messages.getMessage('experienceSiteSuccessfullyProcessed', [type]));
     shell.cd(pwd);
+    Logger.log(
+      this.messages.getMessage('expSitesWithChanges', [
+        experienceSiteInfo.flatMap((info) => info.experienceSiteAssessmentPageInfos).length,
+      ])
+    );
     return experienceSiteInfo;
   }
 
@@ -78,6 +83,10 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
     const experienceSitesAssessmentInfo: ExperienceSiteAssessmentInfo[] = [];
     Logger.logVerbose('The namespace for expsites processing is ' + this.namespace);
     for (const directory of directoryMap.keys()) {
+      const experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo = {
+        experienceBundleName: path.basename(path.dirname(directory)),
+        experienceSiteAssessmentPageInfos: [],
+      };
       const fileArray = directoryMap.get(directory);
       if (!fileArray) {
         continue;
@@ -89,30 +98,34 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
           continue;
         }
         try {
-          const experienceSiteInfo = this.processExperienceSite(file, type);
-          if (experienceSiteInfo?.hasOmnistudioContent === true) {
+          const experienceSitePageInfo = this.processExperienceSite(file, type);
+          if (experienceSitePageInfo?.hasOmnistudioContent === true) {
             Logger.logVerbose(this.messages.getMessage('experienceSiteWithOmniWrapperSuccessfullyProcessed'));
-            experienceSitesAssessmentInfo.push(experienceSiteInfo);
+            experienceSiteAssessmentInfo.experienceSiteAssessmentPageInfos.push(experienceSitePageInfo);
           } else {
             Logger.logVerbose(this.messages.getMessage('fileNotHavingWrapper'));
           }
         } catch (err) {
-          this.populateExceptionInfo(file, experienceSitesAssessmentInfo);
+          this.populateExceptionInfo(file, experienceSiteAssessmentInfo.experienceSiteAssessmentPageInfos);
           Logger.error(this.messages.getMessage('errorProcessingExperienceSite', [file.name]));
           Logger.error(JSON.stringify(err));
         }
       }
+
+      if (experienceSiteAssessmentInfo.experienceSiteAssessmentPageInfos.length > 0) {
+        experienceSitesAssessmentInfo.push(experienceSiteAssessmentInfo);
+      }
     }
 
     Logger.logVerbose(this.messages.getMessage('experienceSiteReportingDetails'));
     progressBar.stop();
     return experienceSitesAssessmentInfo;
   }
 
-  public processExperienceSite(file: File, type: string): ExperienceSiteAssessmentInfo {
+  public processExperienceSite(file: File, type: string): ExperienceSiteAssessmentPageInfo {
     Logger.logVerbose(this.messages.getMessage('processingFile', [file.name]));
 
-    const experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo = {
+    const experienceSiteAssessmentInfo: ExperienceSiteAssessmentPageInfo = {
       name: file.name,
       warnings: [],
       errors: [],
@@ -170,9 +183,9 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
     return experienceSiteAssessmentInfo;
   }
 
-  private populateExceptionInfo(file: File, experienceSiteAssessmentInfos: ExperienceSiteAssessmentInfo[]): void {
+  private populateExceptionInfo(file: File, experienceSiteAssessmentInfos: ExperienceSiteAssessmentPageInfo[]): void {
     try {
-      const experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo = {
+      const experienceSiteAssessmentInfo: ExperienceSiteAssessmentPageInfo = {
         name: file.name,
         warnings: ['Unknown error occurred'],
         errors: [''],
@@ -191,7 +204,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
 
   private processRegion(
     region: ExpSiteRegion,
-    experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo,
+    experienceSiteAssessmentInfo: ExperienceSiteAssessmentPageInfo,
     storage: MigrationStorage,
     lookupComponentName: string,
     type: string
@@ -213,7 +226,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
 
   private processComponent(
     component: ExpSiteComponent,
-    experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo,
+    experienceSiteAssessmentInfo: ExperienceSiteAssessmentPageInfo,
     storage: MigrationStorage,
     lookupComponentName: string,
     type: string
@@ -249,7 +262,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
   private updateComponentAndItsAttributes(
     component: ExpSiteComponent,
     currentAttribute: ExpSiteComponentAttributes,
-    experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo,
+    experienceSiteAssessmentInfo: ExperienceSiteAssessmentPageInfo,
     storage: MigrationStorage,
     type: string
   ): void {
@@ -277,7 +290,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
     targetName: string,
     component: ExpSiteComponent,
     currentAttribute: ExpSiteComponentAttributes,
-    experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo,
+    experienceSiteAssessmentInfo: ExperienceSiteAssessmentPageInfo,
     storage: MigrationStorage,
     type: string
   ): void {
@@ -309,7 +322,7 @@ export class ExperienceSiteMigration extends BaseRelatedObjectMigration {
     targetName: string,
     component: ExpSiteComponent,
     currentAttribute: ExpSiteComponentAttributes,
-    experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo,
+    experienceSiteAssessmentInfo: ExperienceSiteAssessmentPageInfo,
     storage: MigrationStorage,
     type: string
   ): void {

src/migration/related/LwcMigration.ts

@@ -34,7 +34,7 @@ export class LwcMigration extends BaseRelatedObjectMigration {
     shell.cd(this.projectPath);
     Logger.info(assessMessages.getMessage('processingLwcsForAssessment'));
     const filesMap = this.processLwcFiles(this.projectPath);
-    Logger.info(assessMessages.getMessage('successfullyProcessedLwcsForAssessment', [filesMap.size]));
+    Logger.log(assessMessages.getMessage('successfullyProcessedLwcsForAssessment', [filesMap.size]));
     Logger.logVerbose(assessMessages.getMessage('lwcAssessmentResults', [JSON.stringify(filesMap, null, 2)]));
     shell.cd(pwd);
     return this.processFiles(filesMap, type);
@@ -47,7 +47,7 @@ export class LwcMigration extends BaseRelatedObjectMigration {
     Logger.info(migrateMessages.getMessage('processingLwcsForMigration'));
     const filesMap = this.processLwcFiles(this.projectPath);
     const LWCAssessmentInfos = this.processFiles(filesMap, 'migration');
-    Logger.info(migrateMessages.getMessage('successfullyProcessedLwcsForMigration', [LWCAssessmentInfos.length]));
+    Logger.log(migrateMessages.getMessage('successfullyProcessedLwcsForMigration', [LWCAssessmentInfos.length]));
     Logger.logVerbose(migrateMessages.getMessage('lwcMigrationResults', [JSON.stringify(LWCAssessmentInfos, null, 2)]));
     shell.cd(pwd);
     return LWCAssessmentInfos;

src/styles/reportGenerator.css

@@ -576,6 +576,10 @@ td {
   padding-left: 0.5rem !important;
 }
 
+.no-display {
+  display: none;
+}
+
 .diff-cell {
   min-width: 30rem;
 }

src/templates/assessmentReport.template

@@ -9,6 +9,7 @@
 </head>
 
 <body>
+  <div id="props" class="no-display">{{props}}</div>
   <div style="margin: 20px">
     <div class="report-wrapper">
       <div id="scrollable-wrapper" class="scrollable-wrapper">

src/templates/migrationReport.template

@@ -9,6 +9,7 @@
 </head>
 
 <body>
+  <div id="props" class="no-display">{{props}}</div>
   <div class="slds-m-around_medium">
     <div class="slds-text-heading_large">
       <span>{{heading}}</span>

src/utils/interfaces.ts

@@ -187,14 +187,19 @@ export interface FileParser {
   // saveToFile(filePath: string, content: string | undefined): void;
 }
 
-export interface ExperienceSiteAssessmentInfo extends FileChangeInfo {
+export interface ExperienceSiteAssessmentPageInfo extends FileChangeInfo {
   warnings: string[];
   infos: string[];
   hasOmnistudioContent: boolean;
   errors: string[];
   status: 'Ready for migration' | 'Failed' | 'Successfully migrated' | 'Needs Manual Intervention' | 'Skipped';
 }
 
+export interface ExperienceSiteAssessmentInfo {
+  experienceBundleName: string;
+  experienceSiteAssessmentPageInfos: ExperienceSiteAssessmentPageInfo[];
+}
+
 export interface FileProcessor {
   process(file: File, type: string, namespace: string): string;
 }