Merge pull request #433 from shaurabh-tiwari-git/metadataEnablementEnhancements

@W-19808193 - Metdata API enhancements

Author: sf-aastha-paruthi

messages/assess.json

@@ -197,7 +197,7 @@
   "dmNameUpdateFailed": "DM reference %s can’t be updated",
   "invalidTypeAssessErrorMessage": "We couldn't assess your Omnistudio components in the %s namespace. Select the correct namespace and try again",
   "assessmentSuccessfulMessage": "Migration assessment for org %s is complete and reports are ready for review in the folder %s",
-  "errorCheckingOmniStudioMetadata": "We couldn't check whether the Omnistudio Metadata is enabled: %s. Try again later.",
-  "omniStudioSettingsMetadataAlreadyEnabled": "The Omnistudio Metadata setting is already enabled with standard data model. No need for migration.",
+  "errorCheckingOmniStudioMetadata": "Error while checking the Omnistudio settings metadata status: %s.",
+  "omniStudioSettingsMetadataAlreadyEnabled": "The Omnistudio Metadata setting is already enabled with standard data model. No need for migration."
   "missingMandatoryField": "Missing mandatory field: %s for %s"
 }

messages/migrate.json

@@ -288,17 +288,19 @@
   "omniscriptPackageDeploymentFailedWithMessage": "Omniscript package deployment failed: %s",
   "metadataTablesAlreadyClean": "OmniStudio metadata tables are empty",
   "startingMetadataCleanup": "Initiated cleanup process for Omnistudio metadata tables.",
-  "failedToCleanTables": "Table cleanup failed: %s",
+  "failedToCleanTables": "Table cleanup failed: %s, Please contact Salesforce Support.",
   "errorCheckingMetadataTables": "Error checking Omnistudio metadata tables: %s",
   "metadataCleanupCompleted": "The Omnistudio metadata table cleanup process is complete. Total records cleaned: %s",
   "metadataCleanupConsentMessage": "By proceeding further, you hereby consent to clean up the Omnistudio metadata tables. Proceeding with the cleanup process will permanently delete all records from OmniUiCardConfig, OmniScriptConfig, OmniIntegrationProcConfig, and OmniDataTransformConfig tables. Do you want to proceed? [y/n]",
   "metadataCleanupConsentNotGiven": "You’ve not consented to proceed with the Omnistudio metadata table cleanup. We’ll not be able to proceed with the migration.",
   "omniStudioMetadataEnableConsentMessage": "As part of the migration process, the Omnistudio Metadata setting will be enabled. After the setting is enabled, you cannot disable it. Do you want to proceed? [y/n]",
-  "errorCheckingOmniStudioMetadata": "We couldn't check whether the Omnistudio Metadata is enabled: %s. Try again later.",
+  "errorCheckingOmniStudioMetadata": "Error while checking the Omnistudio settings metadata status: %s.",
   "omniStudioSettingsMetadataAlreadyEnabled": "The Omnistudio Metadata setting is already enabled with standard data model. No need for migration.",
   "omniStudioSettingsMetadataEnabled": "The Omnistudio Metadata setting is enabled with standard data model.",
-  "errorEnablingOmniStudioSettingsMetadata": "We couldn't enable the Omnistudio Metadata setting: %s. Enable it manually.",
-  "manuallyEnableOmniStudioSettingsMetadata": "Manually enable the Omnistudio Metadata setting in your org’s Omnistudio Settings page.",
+  "timeoutEnablingOmniStudioSettingsMetadata": "Timeout while checking the metadata enablement status. Tried for %s seconds. Refer to registered email for more details.",
+  "errorEnablingOmniStudioSettingsMetadata": "Error while enabling the Omnistudio Metadata setting: %s.",
+  "fieldIntegrityExceptions": "Metadata cleanup failed for %s due to a field integrity exception. Deactivate the %s and try again.",
+  "manuallyEnableOmniStudioSettingsMetadata": "Manually enable the Omnistudio Metadata setting in your org’s Omnistudio Settings page. Refer <a href='https://help.salesforce.com/s/articleView?id=xcloud.os_enable_omnistudio_metadata_api_support.htm&type=5' target='_blank'>this documentation</a> for more details.",
   "omniStudioMetadataEnableConsentNotGiven": "You’ve not consented to proceed with enabling the Omnistudio Metadata setting. We’ll not be able to proceed with the migration.",
   "enablingOmniStudioSettingsMetadataStatus": "Enabling Omnistudio Metadata setting…",
   "omniStudioAllVersionsMigrationConsent": "Org uses the standard data model. All versions of Omnistudio components such as Omniscripts, Data Mappers, Integration Procedures, and Flexcards must be migrated to enable the Omnistudio Metadata API setting. But you’ve not specified -a  or allversions flag in the command.  Proceed to migrate all versions of the Omnistudio components? [y/n]",

src/migration/postMigrate.ts

@@ -146,9 +146,9 @@ export class PostMigrate extends BaseMigrationTool {
         */
         const maxAttempts = 6;
         let attempts = 0;
+        const metadataService = new OmniStudioMetadataCleanupService(this.connection, this.messages);
         while (attempts < maxAttempts) {
           await new Promise((resolve) => setTimeout(resolve, 20000));
-          const metadataService = new OmniStudioMetadataCleanupService(this.connection, this.messages);
           const isConfigTablesEmpty = await metadataService.hasCleanOmniStudioMetadataTables(); //Check is the config tables are populated or not.
           if (!isConfigTablesEmpty) {
             // If the config tables are populated, means the metadata is enabled.
@@ -159,7 +159,7 @@ export class PostMigrate extends BaseMigrationTool {
         }
         if (attempts === maxAttempts) {
           // TODO: We need to figure out and show the user that what is the actual issue which is causing the metadata to not be enabled.
-          Logger.error(this.messages.getMessage('errorEnablingOmniStudioSettingsMetadata', ['Unknown error']));
+          Logger.error(this.messages.getMessage('timeoutEnablingOmniStudioSettingsMetadata', [maxAttempts * 20]));
           userActionMessage.push(this.messages.getMessage('manuallyEnableOmniStudioSettingsMetadata'));
         }
       } else {

src/utils/config/OmniStudioMetadataCleanupService.ts

@@ -2,6 +2,7 @@ import { Connection, Messages } from '@salesforce/core';
 import { Logger } from '../logger';
 import { QueryTools } from '../query';
 import { NetUtils } from '../net';
+import { getMigrationHeading } from '../stringUtils';
 
 /**
  * OmniStudioMetadataCleanupService
@@ -21,6 +22,13 @@ export class OmniStudioMetadataCleanupService {
     'OmniDataTransformConfig',
   ];
 
+  private static readonly FIELD_MAP = {
+    OmniUiCardConfig: getMigrationHeading('Flexcard'),
+    OmniScriptConfig: getMigrationHeading('OmniScript'),
+    OmniIntegrationProcConfig: getMigrationHeading('Integration Procedure'),
+    OmniDataTransformConfig: getMigrationHeading('Data Mapper'),
+  };
+
   private readonly connection: Connection;
   private readonly messages: Messages;
 
@@ -60,17 +68,33 @@ export class OmniStudioMetadataCleanupService {
 
       let totalCleanedRecords = 0;
       const failedTables: string[] = [];
+      const tablesWithFieldIntegrityExceptions: string[] = [];
+      const toDeactivate: string[] = [];
 
       for (const tableName of OmniStudioMetadataCleanupService.CONFIG_TABLES) {
-        const recordCount = await this.cleanupOmniStudioMetadataTable(tableName);
+        const result = await this.cleanupOmniStudioMetadataTable(tableName);
 
-        if (recordCount >= 0) {
-          totalCleanedRecords += recordCount;
+        if (result.recordCount >= 0) {
+          totalCleanedRecords += result.recordCount;
         } else {
           failedTables.push(tableName);
+          if (result.statusCode === 'FIELD_INTEGRITY_EXCEPTION') {
+            tablesWithFieldIntegrityExceptions.push(tableName);
+            toDeactivate.push(OmniStudioMetadataCleanupService.FIELD_MAP[tableName]);
+          }
         }
       }
 
+      if (tablesWithFieldIntegrityExceptions.length > 0) {
+        Logger.error(
+          this.messages.getMessage('fieldIntegrityExceptions', [
+            tablesWithFieldIntegrityExceptions.join(', '),
+            toDeactivate.join(', '),
+          ])
+        );
+        return false;
+      }
+
       if (failedTables.length > 0) {
         Logger.error(this.messages.getMessage('failedToCleanTables', [failedTables.join(', ')]));
         return false;
@@ -88,16 +112,21 @@ export class OmniStudioMetadataCleanupService {
    * Checks a specific table for records and cleans them if found
    *
    * @param tableName - Name of the table to check and clean
-   * @returns Promise<number> - number of cleaned records, or -1 if failed
+   * @returns Promise<{recordCount: number, statusCode?: string}> - recordCount: number of cleaned records (or -1 if failed), statusCode: optional error status code
    */
-  private async cleanupOmniStudioMetadataTable(tableName: string): Promise<number> {
+  private async cleanupOmniStudioMetadataTable(
+    tableName: string
+  ): Promise<{ recordCount: number; statusCode?: string }> {
     const recordIds = await QueryTools.queryIds(this.connection, tableName);
 
     if (recordIds.length === 0) {
-      return 0;
+      return { recordCount: 0 };
     }
 
-    const deleteSuccess = await NetUtils.delete(this.connection, recordIds);
-    return deleteSuccess ? recordIds.length : -1;
+    const deleteResult = await NetUtils.deleteWithFieldIntegrityException(this.connection, recordIds);
+    if (!deleteResult.success) {
+      return { recordCount: -1, statusCode: deleteResult.statusCode };
+    }
+    return { recordCount: recordIds.length };
   }
 }

src/utils/net/index.ts

@@ -124,6 +124,52 @@ class NetUtils {
     return true;
   }
 
+  public static async deleteWithFieldIntegrityException(
+    connection: Connection,
+    data: string[]
+  ): Promise<{ success: boolean; statusCode?: string; message?: string }> {
+    // Metadata API only accepts 200 records per request
+    const chunks = chunk(data, NetUtils.CHUNK_SIZE);
+    let hasFieldIntegrityException = false;
+    let hasErrors = false;
+    let errorCode: string | undefined;
+    let message: string | undefined;
+
+    for (let curr of chunks) {
+      const deleteUrl = 'composite/sobjects?allOrNone=true&ids=' + curr.join(',');
+
+      const response = await this.request<DeleteResponse[]>(connection, deleteUrl, [], RequestMethod.DELETE);
+      // Check each response for errors
+      response.forEach((result) => {
+        if (!result.success && result.errors && result.errors.length > 0) {
+          result.errors.forEach((error) => {
+            hasErrors = true;
+            // Check if this error is a FIELD_INTEGRITY_EXCEPTION
+            if (error.statusCode === 'FIELD_INTEGRITY_EXCEPTION') {
+              hasFieldIntegrityException = true;
+              message = error.message;
+              return;
+            } else {
+              errorCode = error.statusCode;
+            }
+          });
+        }
+      });
+    }
+
+    // If there are failed records, return failure with status code
+    if (hasErrors) {
+      return {
+        success: false,
+        // Override with FIELD_INTEGRITY_EXCEPTION if found, otherwise use first encountered
+        statusCode: hasFieldIntegrityException ? 'FIELD_INTEGRITY_EXCEPTION' : errorCode,
+        message: message,
+      };
+    }
+
+    return { success: true };
+  }
+
   public static async request<TResultType>(
     connection: Connection,
     url: string,
@@ -156,4 +202,14 @@ interface TreeResult {
   results: UploadRecordResult[];
 }
 
+interface DeleteResponse {
+  id: string;
+  success: boolean;
+  errors: Array<{
+    statusCode: string;
+    message: string;
+    fields: string[];
+  }>;
+}
+
 export { NetUtils, RequestMethod, TreeResult };