Merge pull request #389 from mdmehran-qureshi/feature/custom-label-assessment-enhancements

feat: enhance custom label assessment with warnings, failed, and need…

Author: snehaljha-sf

messages/assess.json

@@ -101,7 +101,7 @@
   "integrationProcedureManualUpdateMessage": "Integration Procedure reference %s may need manual updates after migration.",
   "duplicateCardNameMessage": "Potential duplicate: Another card has the same name %s after name cleaning. This may cause conflicts during migration",
   "startingCustomLabelAssessment": "Starting Custom Label assessment",
-  "assessedCustomLabelsCount": "Assessed %s Custom Labels",
+  "assessedCustomLabelsCount": "Found %s labels that need attention out of %s total",
   "customLabelAssessmentCompleted": "Custom Label assessment completed",
   "errorDuringCustomLabelAssessment": "Error during Custom Label assessment: %s",
   "duplicateGlobalAutoNumberNameMessage": "Potential duplicate: Another Global Auto Number has the same name %s after name cleaning. This may cause conflicts during migration",
@@ -194,6 +194,9 @@
   "apexFileAlreadyHasCallMethod": "File %s already has call method, thus keeping the existing call method intact",
   "errorFetchingCustomLabels": "Error fetching custom labels: %s",
   "customLabelAssessmentSummary": "Custom Label with same name and different value is already exist without namespace.",
+  "customLabelWarningSummary": "Custom Label has potential conflicts that need review.",
+  "customLabelFailedSummary": "Custom Label assessment failed due to errors.",
+  "customLabelNeedsManualInterventionSummary": "Custom Label requires manual intervention for resolution.",
   "generatedCustomLabelAssessmentReportPage": "Generated custom label assessment report page %s of %s with %s labels",
   "manualDeploymentSteps": "<a href='%s' target='_blank'>Please refer to this documentation for manual deployment process</a>"
 }

src/commands/omnistudio/migration/assess.ts

@@ -117,7 +117,13 @@ export default class Assess extends OmniStudioBaseCommand {
       flexipageAssessmentInfos: [],
       experienceSiteAssessmentInfos: [],
       customLabelAssessmentInfos: [],
-      customLabelStatistics: { totalLabels: 0, canBeAutomated: 0, needManualIntervention: 0 },
+      customLabelStatistics: {
+        totalLabels: 0,
+        readyForMigration: 0,
+        needManualIntervention: 0,
+        warnings: 0,
+        failed: 0,
+      },
     };
 
     Logger.log(messages.getMessage('assessmentInitialization', [String(namespace)]));
@@ -329,14 +335,17 @@ export default class Assess extends OmniStudioBaseCommand {
       const customLabelResult = await CustomLabelsUtil.fetchCustomLabels(conn, namespace, messages);
       assesmentInfo.customLabelAssessmentInfos = customLabelResult.labels;
       assesmentInfo.customLabelStatistics = customLabelResult.statistics;
-      Logger.logVerbose(
-        messages.getMessage('assessedCustomLabelsCount', [assesmentInfo.customLabelAssessmentInfos.length])
-      );
       Logger.log(messages.getMessage('customLabelAssessmentCompleted'));
     } catch (error) {
       Logger.error(messages.getMessage('errorDuringCustomLabelAssessment', [(error as Error).message]));
       assesmentInfo.customLabelAssessmentInfos = [];
-      assesmentInfo.customLabelStatistics = { totalLabels: 0, canBeAutomated: 0, needManualIntervention: 0 };
+      assesmentInfo.customLabelStatistics = {
+        totalLabels: 0,
+        readyForMigration: 0,
+        needManualIntervention: 0,
+        warnings: 0,
+        failed: 0,
+      };
     }
   }
 }

src/utils/customLabels.ts

@@ -23,8 +23,10 @@ export interface CustomLabelAssessmentInfo {
 
 export interface CustomLabelStatistics {
   totalLabels: number;
-  canBeAutomated: number;
+  readyForMigration: number;
   needManualIntervention: number;
+  warnings: number;
+  failed: number;
 }
 
 export interface CustomLabelResult {
@@ -44,7 +46,7 @@ export class CustomLabelsUtil {
       if (!customLabels || customLabels.length === 0) {
         return {
           labels: [],
-          statistics: { totalLabels: 0, canBeAutomated: 0, needManualIntervention: 0 },
+          statistics: { totalLabels: 0, readyForMigration: 0, needManualIntervention: 0, warnings: 0, failed: 0 },
         };
       }
 
@@ -56,11 +58,11 @@ export class CustomLabelsUtil {
         const id = label.Id;
 
         const externalString = externalStrings.find((es) => es.Name === name);
-        let assessmentStatus = 'Can be Automated';
+        let assessmentStatus = 'Ready for migration';
         let summary = '';
 
         if (externalString && externalString.Value !== value) {
-          assessmentStatus = 'Need Manual Intervention';
+          assessmentStatus = 'Warnings';
           summary = messages.getMessage('customLabelAssessmentSummary');
         }
 
@@ -78,29 +80,39 @@ export class CustomLabelsUtil {
         };
       });
 
-      const labelsNeedingManualIntervention = processedLabels.filter(
-        (label) => label.assessmentStatus === 'Need Manual Intervention'
+      const warnings = processedLabels.filter((label) => label.assessmentStatus === 'Warnings');
+
+      const needsManualIntervention = processedLabels.filter(
+        (label) => label.assessmentStatus === 'Needs Manual Intervention'
       );
 
-      const canBeAutomated = processedLabels.filter((label) => label.assessmentStatus === 'Can be Automated').length;
+      const failed = processedLabels.filter((label) => label.assessmentStatus === 'Failed');
+
+      const readyForMigration = processedLabels.filter(
+        (label) => label.assessmentStatus === 'Ready for migration'
+      ).length;
+
+      const totalAttentionNeeded = warnings.length + needsManualIntervention.length + failed.length;
 
       Logger.logVerbose(
-        `Found ${labelsNeedingManualIntervention.length} labels that need manual intervention out of ${processedLabels.length} total`
+        messages.getMessage('assessedCustomLabelsCount', [String(totalAttentionNeeded), String(processedLabels.length)])
       );
 
       return {
-        labels: labelsNeedingManualIntervention,
+        labels: [...warnings, ...needsManualIntervention, ...failed],
         statistics: {
           totalLabels: processedLabels.length,
-          canBeAutomated,
-          needManualIntervention: labelsNeedingManualIntervention.length,
+          readyForMigration,
+          needManualIntervention: needsManualIntervention.length,
+          warnings: warnings.length,
+          failed: failed.length,
         },
       };
     } catch (error) {
       Logger.error(messages.getMessage('errorFetchingCustomLabels', [String(error)]));
       return {
         labels: [],
-        statistics: { totalLabels: 0, canBeAutomated: 0, needManualIntervention: 0 },
+        statistics: { totalLabels: 0, readyForMigration: 0, needManualIntervention: 0, warnings: 0, failed: 0 },
       };
     }
   }

src/utils/resultsbuilder/CustomLabelAssessmentReporter.ts

@@ -69,16 +69,30 @@ export class CustomLabelAssessmentReporter {
 
   public static getSummaryData(customLabelAssessmentInfos: CustomLabelAssessmentInfo[]): SummaryItemDetailParam[] {
     const safeCustomLabelInfos = customLabelAssessmentInfos || [];
-    const needManualIntervention = safeCustomLabelInfos.filter(
-      (label) => label.assessmentStatus === 'Need Manual Intervention'
+    const warnings = safeCustomLabelInfos.filter((label) => label.assessmentStatus === 'Warnings').length;
+
+    const needsManualIntervention = safeCustomLabelInfos.filter(
+      (label) => label.assessmentStatus === 'Needs Manual Intervention'
     ).length;
 
+    const failed = safeCustomLabelInfos.filter((label) => label.assessmentStatus === 'Failed').length;
+
     return [
       {
-        name: 'Need Manual Intervention',
-        count: needManualIntervention,
+        name: 'Warnings',
+        count: warnings,
         cssClass: 'text-warning',
       },
+      {
+        name: 'Needs Manual Intervention',
+        count: needsManualIntervention,
+        cssClass: 'text-error',
+      },
+      {
+        name: 'Failed',
+        count: failed,
+        cssClass: 'text-error',
+      },
     ];
   }
 
@@ -137,7 +151,7 @@ export class CustomLabelAssessmentReporter {
             false,
             undefined,
             undefined,
-            info.assessmentStatus === 'Need Manual Intervention' ? 'text-error' : 'text-success'
+            this.getStatusCssClass(info.assessmentStatus)
           ),
           createRowDataParam('summary', info.summary || '', false, 1, 1, false, undefined, undefined, undefined, true),
         ],
@@ -211,8 +225,28 @@ export class CustomLabelAssessmentReporter {
       {
         label: 'Assessment Status',
         key: 'assessmentStatus',
-        filters: [{ label: 'Can be Automated' }, { label: 'Need Manual Intervention' }],
+        filters: [
+          { label: 'Ready for migration' },
+          { label: 'Needs Manual Intervention' },
+          { label: 'Warnings' },
+          { label: 'Failed' },
+        ],
       },
     ];
   }
+
+  private static getStatusCssClass(status: string): string {
+    switch (status) {
+      case 'Warnings':
+        return 'text-warning';
+      case 'Needs Manual Intervention':
+        return 'text-error';
+      case 'Failed':
+        return 'text-error';
+      case 'Ready for migration':
+        return 'text-success';
+      default:
+        return 'text-success';
+    }
+  }
 }

src/utils/resultsbuilder/assessmentReporter.ts

@@ -132,7 +132,7 @@ export class AssessmentReporter {
         )
       );
 
-      // Generate custom labels report with pagination (empty if no labels need manual intervention)
+      // Generate custom labels report with pagination
       const customLabels = result.customLabelAssessmentInfos || [];
       this.generateCustomLabelAssessmentReport(
         customLabels,
@@ -442,15 +442,25 @@ export class AssessmentReporter {
         total: result.customLabelStatistics.totalLabels,
         data: [
           {
-            name: 'Can be Automated',
-            count: result.customLabelStatistics.canBeAutomated,
+            name: 'Ready for migration',
+            count: result.customLabelStatistics.readyForMigration,
             cssClass: 'text-success',
           },
           {
-            name: 'Need Manual Intervention',
-            count: result.customLabelStatistics.needManualIntervention,
+            name: 'Warning',
+            count: result.customLabelStatistics.warnings,
             cssClass: 'text-warning',
           },
+          {
+            name: 'Needs Manual Intervention',
+            count: result.customLabelStatistics.needManualIntervention,
+            cssClass: 'text-error',
+          },
+          {
+            name: 'Failed',
+            count: result.customLabelStatistics.failed,
+            cssClass: 'text-error',
+          },
         ],
         file: this.getCustomLabelAssessmentFileName(result.customLabelStatistics.needManualIntervention),
       });