@W-19464598 - Omnistudio config tables cleanup for UseCase2 (#417)

Author: shaurabh-tiwari-git

messages/migrate.json

@@ -244,5 +244,12 @@
   "customLabelAssessmentSummary": "Custom Label with same name and different value is already exist without namespace.",
   "generatedCustomLabelAssessmentReportPage": "Generated custom label assessment report page %s of %s with %s labels",
   "varDeclarationUpdated": "Variable initialization has been updated for target name",
-  "migrationSuccessfulMessage": "Migration process for org %s is complete and reports are ready for review in the folder %s"
+  "migrationSuccessfulMessage": "Migration process for org %s is complete and reports are ready for review in the folder %s",
+  "metadataTablesAlreadyClean": "OmniStudio metadata tables are empty",
+  "startingMetadataCleanup": "Initiated cleanup process for Omnistudio metadata tables.",
+  "failedToCleanTables": "Table cleanup failed: %s",
+  "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."
 }

src/commands/omnistudio/migration/migrate.ts

@@ -31,7 +31,7 @@ import { YES_SHORT, YES_LONG, NO_SHORT, NO_LONG } from '../../../utils/projectPa
 import { PostMigrate } from '../../../migration/postMigrate';
 import { PreMigrate } from '../../../migration/premigrate';
 import { GlobalAutoNumberMigrationTool } from '../../../migration/globalautonumber';
-import { initializeDataModelService } from '../../../utils/dataModelService';
+import { initializeDataModelService, isStandardDataModel } from '../../../utils/dataModelService';
 import { NameMappingRegistry } from '../../../migration/NameMappingRegistry';
 import { ValidatorService } from '../../../utils/validatorService';
 
@@ -127,6 +127,14 @@ export default class Migrate extends OmniStudioBaseCommand {
     const preMigrate: PreMigrate = new PreMigrate(namespace, conn, this.logger, messages, this.ux);
     const isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean } = { value: false };
 
+    // Handle config tables cleanup for standard data model migration
+    if (isStandardDataModel()) {
+      const isMetadataCleanupSuccess = await preMigrate.handleOmniStudioMetadataCleanup();
+      if (!isMetadataCleanupSuccess) {
+        return;
+      }
+    }
+
     let actionItems = [];
 
     let deploymentConfig = { autoDeploy: false, authKey: undefined };

src/migration/premigrate.ts

@@ -6,6 +6,7 @@ import { OrgPreferences } from '../utils/orgPreferences';
 import { askStringWithTimeout, PromptUtil } from '../utils/promptUtil';
 import { YES_SHORT, YES_LONG, NO_SHORT, NO_LONG } from '../utils/projectPathUtil';
 import { documentRegistry } from '../utils/constants/documentRegistry';
+import { OmniStudioMetadataCleanupService } from '../utils/config/OmniStudioMetadataCleanupService';
 import { BaseMigrationTool } from './base';
 
 const authEnvKey = 'OMA_AUTH_KEY';
@@ -109,6 +110,28 @@ export class PreMigrate extends BaseMigrationTool {
     return deploymentConfig;
   }
 
+  /**
+   * Handles OmniStudio metadata tables cleanup with user consent
+   *
+   * @returns Promise<boolean> - true if cleanup was successful, false otherwise
+   */
+  public async handleOmniStudioMetadataCleanup(): Promise<boolean> {
+    const omniStudioMetadataCleanupService = new OmniStudioMetadataCleanupService(this.connection, this.messages);
+
+    if (await omniStudioMetadataCleanupService.hasCleanOmniStudioMetadataTables()) {
+      Logger.logVerbose(this.messages.getMessage('metadataTablesAlreadyClean'));
+      return true;
+    }
+
+    const consent = await this.getMetadataCleanupConsent();
+
+    if (!consent) {
+      Logger.error(this.messages.getMessage('metadataCleanupConsentNotGiven'));
+      return false;
+    }
+    return await omniStudioMetadataCleanupService.cleanupOmniStudioMetadataTables();
+  }
+
   // This needs to be behind timeout
   private async getExpSiteMetadataEnableConsent(): Promise<boolean> {
     const question = this.messages.getMessage('consentForExperienceSites');
@@ -148,4 +171,39 @@ export class PreMigrate extends BaseMigrationTool {
       relatedObjects.splice(index, 1);
     }
   }
+
+  /**
+   * Gets user consent for OmniStudio metadata tables cleanup
+   *
+   * @returns Promise<boolean> - true if user consents, false otherwise
+   */
+  private async getMetadataCleanupConsent(): Promise<boolean> {
+    const askWithTimeOut = PromptUtil.askWithTimeOut(this.messages);
+    let validResponse = false;
+    let consent = false;
+
+    while (!validResponse) {
+      try {
+        const resp = await askWithTimeOut(
+          Logger.prompt.bind(Logger),
+          this.messages.getMessage('metadataCleanupConsentMessage')
+        );
+        const response = typeof resp === 'string' ? resp.trim().toLowerCase() : '';
+
+        if (response === YES_SHORT || response === YES_LONG) {
+          consent = true;
+          validResponse = true;
+        } else if (response === NO_SHORT || response === NO_LONG) {
+          consent = false;
+          validResponse = true;
+        } else {
+          Logger.error(this.messages.getMessage('invalidYesNoResponse'));
+        }
+      } catch (err) {
+        Logger.error(this.messages.getMessage('requestTimedOut'));
+        process.exit(1);
+      }
+    }
+    return consent;
+  }
 }

src/utils/config/OmniStudioMetadataCleanupService.ts

@@ -0,0 +1,103 @@
+import { Connection, Messages } from '@salesforce/core';
+import { Logger } from '../logger';
+import { QueryTools } from '../query';
+import { NetUtils } from '../net';
+
+/**
+ * OmniStudioMetadataCleanupService
+ *
+ * This service checks for records in four OmniStudio metadata tables and cleans them if found:
+ * - OmniUiCardConfig
+ * - OmniScriptConfig
+ * - OmniIntegrationProcConfig
+ * - OmniDataTransformConfig
+ */
+
+export class OmniStudioMetadataCleanupService {
+  private static readonly CONFIG_TABLES = [
+    'OmniUiCardConfig',
+    'OmniScriptConfig',
+    'OmniIntegrationProcConfig',
+    'OmniDataTransformConfig',
+  ];
+
+  private readonly connection: Connection;
+  private readonly messages: Messages;
+
+  public constructor(connection: Connection, messages: Messages) {
+    this.messages = messages;
+    this.connection = connection;
+  }
+
+  /**
+   * Checks if all config tables are clean (have no records)
+   *
+   * @returns Promise<boolean> - true if all tables are empty, false if any table has records
+   */
+  public async hasCleanOmniStudioMetadataTables(): Promise<boolean> {
+    try {
+      for (const tableName of OmniStudioMetadataCleanupService.CONFIG_TABLES) {
+        const recordIds = await QueryTools.queryIds(this.connection, tableName);
+        if (recordIds.length > 0) {
+          return false;
+        }
+      }
+      return true;
+    } catch (error) {
+      Logger.error(this.messages.getMessage('errorCheckingMetadataTables', [String(error)]));
+      return false;
+    }
+  }
+
+  /**
+   * Checks all config tables for records and cleans them if found
+   *
+   * @returns Promise<boolean> - true if cleanup was successful, false otherwise
+   */
+  public async cleanupOmniStudioMetadataTables(): Promise<boolean> {
+    try {
+      Logger.log(this.messages.getMessage('startingMetadataCleanup'));
+
+      let totalCleanedRecords = 0;
+      const failedTables: string[] = [];
+
+      for (const tableName of OmniStudioMetadataCleanupService.CONFIG_TABLES) {
+        const recordCount = await this.cleanupOmniStudioMetadataTable(tableName);
+
+        if (recordCount >= 0) {
+          totalCleanedRecords += recordCount;
+        } else {
+          failedTables.push(tableName);
+        }
+      }
+
+      if (failedTables.length > 0) {
+        Logger.error(this.messages.getMessage('failedToCleanTables', [failedTables.join(', ')]));
+        return false;
+      }
+
+      Logger.log(this.messages.getMessage('metadataCleanupCompleted', [totalCleanedRecords]));
+      return true;
+    } catch (error) {
+      Logger.error(this.messages.getMessage('errorCheckingMetadataTables', [String(error)]));
+      return false;
+    }
+  }
+
+  /**
+   * 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
+   */
+  private async cleanupOmniStudioMetadataTable(tableName: string): Promise<number> {
+    const recordIds = await QueryTools.queryIds(this.connection, tableName);
+
+    if (recordIds.length === 0) {
+      return 0;
+    }
+
+    const deleteSuccess = await NetUtils.delete(this.connection, recordIds);
+    return deleteSuccess ? recordIds.length : -1;
+  }
+}

src/utils/index.ts

@@ -1,3 +1,4 @@
 export * from './query';
 export * from './logging/debugtimer';
 export * from './interfaces';
+export * from './config/OmniStudioMetadataCleanupService';