fix: related objects status for deployment failure case

Author: rajender-kumar-salesforce

messages/migrate.json

@@ -284,6 +284,7 @@
   "deployComponentsManually": "Metadata Components deployment failed. Please deploy using generated package.xml manually using Salesforce CLI or Workbench. Check the logs for detailed error information.",
   "omniscriptDeploymentFailedContinuing": "Omniscript package deployment failed, continuing with report generation. Manual deployment required.",
   "deploymentFailedContinuing": "Deployment failed, continuing with report generation. Manual deployment required.",
+  "manualDeploymentNeeded": "Manual deployment needed",
   "ensurePackageInstalled": "Please ensure omniscript customization package is properly installed: %s",
   "packageDeploymentFailedWithError": "Omniscript package deployment failed after %s attempts. Error: %s. Please check deployment logs and org settings.",
   "maxRetryAttemptsExceeded": "Maximum retry attempts (%s) exceeded for omniscript package deployment",
@@ -329,4 +330,4 @@
   "processingNotRequired": "Migration is not required for orgs on standard data model with the Omnistudio Metadata setting turned on.",
   "skippingTruncation": "Skipping truncation as the org is on standard data model.",
   "loglevelFlagDeprecated": "loglevel is deprecated. Use --verbose instead."
-}
+}

src/commands/omnistudio/migration/migrate.ts

@@ -278,9 +278,11 @@ export default class Migrate extends SfCommand<MigrateResult> {
       messages
     );
 
+    let deploymentFailed = false;
     try {
       await postMigrate.deploy(actionItems);
     } catch (error) {
+      deploymentFailed = true;
       Logger.error(messages.getMessage('errorDeployingComponents'), error);
       Logger.logVerbose(error);
       // Even if deployment fails completely, continue with report generation
@@ -295,7 +297,8 @@ export default class Migrate extends SfCommand<MigrateResult> {
       messages,
       actionItems,
       objectsToProcess,
-      migrateOnly
+      migrateOnly,
+      deploymentFailed
     );
     Logger.log(
       messages.getMessage('migrationSuccessfulMessage', [

src/migration/postMigrate.ts

@@ -234,6 +234,9 @@ export class PostMigrate extends BaseMigrationTool {
 
       // Log the specific error details for troubleshooting
       Logger.logVerbose(`Deployment error details: ${errorMessage}`);
+
+      // Re-throw so callers (migrate.ts) can track deploymentFailed state
+      throw error;
     }
   }
 }

src/utils/resultsbuilder/index.ts

@@ -59,6 +59,9 @@ export class ResultsBuilder {
   private static successStatus = ['Ready for migration', 'Complete', 'Successfully migrated'];
   private static errorStatus = ['Failed', 'Needs manual intervention'];
 
+  /** Set at report generation start; used to show "Manual deployment needed" when deployment failed */
+  private static deploymentFailed = false;
+
   public static async generateReport(
     results: MigratedObject[],
     relatedObjectMigrationResult: RelatedObjectAssesmentInfo,
@@ -67,8 +70,11 @@ export class ResultsBuilder {
     messages: Messages<string>,
     actionItems: string[],
     objectsToProcess: string[],
-    migrateOnly: string
+    migrateOnly: string,
+    deploymentFailed = false
   ): Promise<void> {
+    ResultsBuilder.deploymentFailed = deploymentFailed;
+
     fs.mkdirSync(resultsDir, { recursive: true });
     Logger.info(messages.getMessage('generatingComponentReports'));
     for (const result of results) {
@@ -382,7 +388,9 @@ export class ResultsBuilder {
       total: result.length,
       filterGroups: [
         ...this.getStatusFilterGroup(
-          result.flatMap((item) => item.experienceSiteAssessmentPageInfos.map((page) => page.status))
+          result.flatMap((item) =>
+            item.experienceSiteAssessmentPageInfos.map((page) => this.resolveDisplayStatus(page.status, messages))
+          )
         ),
       ],
       headerGroups: [
@@ -421,7 +429,7 @@ export class ResultsBuilder {
           ],
         },
       ],
-      rows: this.getRowsForExperienceSites(result),
+      rows: this.getRowsForExperienceSites(result, messages),
       props: JSON.stringify({
         recordName: 'Pages',
         rowBased: true,
@@ -453,7 +461,9 @@ export class ResultsBuilder {
       },
       assessmentDate: new Date().toLocaleString(),
       total: result.length,
-      filterGroups: [...this.getStatusFilterGroup(result.map((item) => item.status))],
+      filterGroups: [
+        ...this.getStatusFilterGroup(result.map((item) => this.resolveDisplayStatus(item.status, messages))),
+      ],
       headerGroups: [
         {
           header: [
@@ -499,14 +509,14 @@ export class ResultsBuilder {
           createRowDataParam('path', item.name, false, 1, 1, true, item.path),
           createRowDataParam(
             'status',
-            item.status,
+            this.resolveDisplayStatus(item.status, messages),
             false,
             1,
             1,
             false,
             undefined,
             undefined,
-            item.status === 'Successfully migrated' ? 'text-success' : 'text-error'
+            this.resolveStatusCssClass(item.status)
           ),
           createRowDataParam(
             'diff',
@@ -658,7 +668,11 @@ export class ResultsBuilder {
       },
       assessmentDate: new Date().toLocaleString(),
       total: result.length,
-      filterGroups: [...this.getStatusFilterGroup(result.flatMap((item) => this.getStatusFromErrors(item.errors)))],
+      filterGroups: [
+        ...this.getStatusFilterGroup(
+          result.flatMap((item) => this.resolveDisplayStatus(this.getStatusFromErrors(item.errors), messages))
+        ),
+      ],
       headerGroups: [
         {
           header: [
@@ -695,21 +709,27 @@ export class ResultsBuilder {
           ],
         },
       ],
-      rows: this.getLwcRowsForReport(result),
+      rows: this.getLwcRowsForReport(result, messages),
     };
 
     const reportTemplate = fs.readFileSync(reportTemplateFilePath, 'utf8');
     const html = TemplateParser.generate(reportTemplate, data, messages);
     fs.writeFileSync(path.join(resultsDir, lwcFileName), html);
   }
 
-  private static getLwcRowsForReport(lwcAssessmentInfos: LWCAssessmentInfo[]): ReportRowParam[] {
+  private static getLwcRowsForReport(
+    lwcAssessmentInfos: LWCAssessmentInfo[],
+    messages: Messages<string>
+  ): ReportRowParam[] {
     const rows: ReportRowParam[] = [];
 
     for (const lwcAssessmentInfo of lwcAssessmentInfos) {
       let showCommon = true;
       const rid = `${this.rowClass}${this.rowId++}`;
       const commonRowSpan = Math.max(1, lwcAssessmentInfo.changeInfos.length);
+      const actualStatus = this.getStatusFromErrors(lwcAssessmentInfo.errors);
+      const displayStatus = this.resolveDisplayStatus(actualStatus, messages);
+      const statusCssClass = this.resolveStatusCssClass(actualStatus);
       for (const fileChangeInfo of lwcAssessmentInfo.changeInfos) {
         rows.push({
           rowId: rid,
@@ -719,14 +739,14 @@ export class ResultsBuilder {
                   createRowDataParam('name', lwcAssessmentInfo.name, true, commonRowSpan, 1, false),
                   createRowDataParam(
                     'status',
-                    this.getStatusFromErrors(lwcAssessmentInfo.errors),
+                    displayStatus,
                     false,
                     commonRowSpan,
                     1,
                     false,
                     undefined,
                     undefined,
-                    this.getStatusCssClass(lwcAssessmentInfo.errors)
+                    statusCssClass
                   ),
                 ]
               : []),
@@ -1021,57 +1041,66 @@ export class ResultsBuilder {
     ];
   }
 
-  private static getDifferentStatusDataForFlexipage(data: FlexiPageAssessmentInfo[]): SummaryItemDetailParam[] {
+  private static buildStatusSummary(counts: {
+    completed: number;
+    manualDeploymentNeeded: number;
+    skipped: number;
+    failed: number;
+  }): SummaryItemDetailParam[] {
+    const result: SummaryItemDetailParam[] = [
+      { name: 'Successfully migrated', count: counts.completed, cssClass: 'text-success' },
+    ];
+    if (counts.manualDeploymentNeeded > 0) {
+      result.push({
+        name: 'Manual deployment needed',
+        count: counts.manualDeploymentNeeded,
+        cssClass: 'text-error',
+      });
+    }
+    result.push({ name: 'Skipped', count: counts.skipped, cssClass: 'text-error' });
+    result.push({ name: 'Failed', count: counts.failed, cssClass: 'text-error' });
+    return result;
+  }
+
+  private static countStatusesFromItems(statuses: string[]): {
+    completed: number;
+    manualDeploymentNeeded: number;
+    skipped: number;
+    failed: number;
+  } {
     let completed = 0;
+    let manualDeploymentNeeded = 0;
     let skipped = 0;
     let failed = 0;
-    data.forEach((item) => {
-      if (item.status === 'Successfully migrated') completed++;
-      else if (item.status === 'Skipped') skipped++;
-      else failed++;
-    });
+    for (const status of statuses) {
+      if (this.isManualDeploymentNeeded(status)) {
+        manualDeploymentNeeded++;
+      } else if (status === 'Successfully migrated') {
+        completed++;
+      } else if (status === 'Skipped') {
+        skipped++;
+      } else {
+        failed++;
+      }
+    }
+    return { completed, manualDeploymentNeeded, skipped, failed };
+  }
 
-    return [
-      { name: 'Successfully migrated', count: completed, cssClass: 'text-success' },
-      { name: 'Skipped', count: skipped, cssClass: 'text-error' },
-      { name: 'Failed', count: failed, cssClass: 'text-error' },
-    ];
+  private static getDifferentStatusDataForFlexipage(data: FlexiPageAssessmentInfo[]): SummaryItemDetailParam[] {
+    return this.buildStatusSummary(this.countStatusesFromItems(data.map((item) => item.status)));
   }
 
   private static getDifferentStatusDataForLwc(data: LWCAssessmentInfo[]): SummaryItemDetailParam[] {
-    let completed = 0;
-    let failed = 0;
-    data.forEach((item) => {
-      if (this.getStatusFromErrors(item.errors) === 'Successfully migrated') completed++;
-      else failed++;
-    });
-
-    return [
-      { name: 'Successfully migrated', count: completed, cssClass: 'text-success' },
-      { name: 'Skipped', count: 0, cssClass: 'text-error' },
-      { name: 'Failed', count: failed, cssClass: 'text-error' },
-    ];
+    return this.buildStatusSummary(
+      this.countStatusesFromItems(data.map((item) => this.getStatusFromErrors(item.errors)))
+    );
   }
 
   private static getDifferentStatusDataForExperienceSites(
     data: ExperienceSiteAssessmentInfo[]
   ): SummaryItemDetailParam[] {
-    let completed = 0;
-    let skipped = 0;
-    let failed = 0;
-    data
-      .flatMap((item) => item.experienceSiteAssessmentPageInfos)
-      .forEach((item) => {
-        if (item.status === 'Successfully migrated') completed++;
-        else if (item.status === 'Skipped') skipped++;
-        else failed++;
-      });
-
-    return [
-      { name: 'Successfully migrated', count: completed, cssClass: 'text-success' },
-      { name: 'Skipped', count: skipped, cssClass: 'text-error' },
-      { name: 'Failed', count: failed, cssClass: 'text-error' },
-    ];
+    const statuses = data.flatMap((item) => item.experienceSiteAssessmentPageInfos.map((page) => page.status));
+    return this.buildStatusSummary(this.countStatusesFromItems(statuses));
   }
 
   private static getStatusFilterGroup(statuses: string[]): FilterGroupParam[] {
@@ -1085,13 +1114,26 @@ export class ResultsBuilder {
     return 'Successfully migrated';
   }
 
-  private static getStatusCssClass(errors: string[], neutralSuccess = false): string {
-    if (errors && errors.length > 0) return 'text-error';
-    if (neutralSuccess) return '';
-    return 'text-success';
+  /** True when deployment failed but the component was successfully processed locally. */
+  private static isManualDeploymentNeeded(status: string): boolean {
+    return this.deploymentFailed && status === 'Successfully migrated';
+  }
+
+  /** Returns display status — "Manual deployment needed" when deployment failed, original status otherwise. */
+  private static resolveDisplayStatus(status: string, messages: Messages<string>): string {
+    return this.isManualDeploymentNeeded(status) ? messages.getMessage('manualDeploymentNeeded') : status;
+  }
+
+  /** Returns CSS class — error for manual deployment needed, success/error otherwise. */
+  private static resolveStatusCssClass(status: string): string {
+    if (this.isManualDeploymentNeeded(status)) return 'text-error';
+    return status === 'Successfully migrated' ? 'text-success' : 'text-error';
   }
 
-  private static getRowsForExperienceSites(result: ExperienceSiteAssessmentInfo[]): ReportRowParam[] {
+  private static getRowsForExperienceSites(
+    result: ExperienceSiteAssessmentInfo[],
+    messages: Messages<string>
+  ): ReportRowParam[] {
     const rows: ReportRowParam[] = [];
 
     result.forEach((item) => {
@@ -1100,7 +1142,7 @@ export class ResultsBuilder {
       item.experienceSiteAssessmentPageInfos.forEach((page) => {
         rows.push({
           rowId: rId,
-          data: this.getRowDataForExperienceSites(page, item, showBundleName),
+          data: this.getRowDataForExperienceSites(page, item, showBundleName, messages),
         });
         showBundleName = false;
       });
@@ -1112,8 +1154,11 @@ export class ResultsBuilder {
   private static getRowDataForExperienceSites(
     page: ExperienceSiteAssessmentPageInfo,
     item: ExperienceSiteAssessmentInfo,
-    showBundleName: boolean
+    showBundleName: boolean,
+    messages: Messages<string>
   ): ReportDataParam[] {
+    const displayStatus = this.resolveDisplayStatus(page.status, messages);
+    const statusCssClass = this.resolveStatusCssClass(page.status);
     return [
       createRowDataParam(
         'name',
@@ -1128,17 +1173,7 @@ export class ResultsBuilder {
       ),
       createRowDataParam('pageName', page.name, false, 1, 1, false, undefined, undefined),
       createRowDataParam('path', page.name + this.experienceSiteFileSuffix, false, 1, 1, true, page.path),
-      createRowDataParam(
-        'status',
-        page.status,
-        false,
-        1,
-        1,
-        false,
-        undefined,
-        undefined,
-        page.status === 'Successfully migrated' ? 'text-success' : 'text-error'
-      ),
+      createRowDataParam('status', displayStatus, false, 1, 1, false, undefined, undefined, statusCssClass),
       createRowDataParam(
         'diff',
         page.name + 'diff',