Remove automated cleanup of config tables during migration (#476)

Author: rajender-kumar-salesforce

messages/assess.json

@@ -232,5 +232,5 @@
   "processingNotRequired": "Assessment 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",
-  "cleanupMetadataTablesRequired": "Omnistudio configuration tables contain records. Manually clean up the tables.\n<a href='https://help.salesforce.com/s/articleView?id=xcloud.os_enable_omnistudio_metadata_api_support.htm&type=5' target='_blank'>Cleanup Metadata Tables</a>"
+  "cleanupMetadataTablesRequired": "Omnistudio configuration tables contain records. Back up your Omnistudio component table data, and manually clean up the Omnistudio configuration tables. <a href='https://help.salesforce.com/s/articleView?id=xcloud.os_enable_omnistudio_metadata_api_support.htm&type=5' target='_blank'>Learn more about cleaning up tables in Salesforce Help</a>"
 }

messages/migrate.json

@@ -297,6 +297,9 @@
   "deploymentTriggeredSuccessfully": "Please monitor your Deployment: %s using deployment status page in Org",
   "omniscriptPackageDeploymentFailedReturnedFalse": "Omniscript package deployment failed - deployment returned false. This may be due to missing package, permissions, or deployment timeout.",
   "omniscriptPackageDeploymentFailedWithMessage": "Omniscript package deployment failed: %s",
+  "cleanupMetadataTablesRequired": "Omnistudio configuration tables contain records. The migration can't proceed. Records on these configuration tables block the Omnistudio Metadata setting from being enabled. Back up your Omnistudio component table data, manually clean up the Omnistudio configuration tables, and validate before running the migration.",
+  "cleanupMetadataTablesHelpUrl": "https://help.salesforce.com/s/articleView?id=xcloud.os_enable_omnistudio_metadata_api_support.htm&type=5",
+  "cleanupMetadataTablesHelpLinkText": "Learn more about cleaning up tables in Salesforce Help",
   "metadataTablesAlreadyClean": "OmniStudio metadata tables are empty",
   "startingMetadataCleanup": "Initiated cleanup process for Omnistudio metadata tables.",
   "failedToCleanTables": "Table cleanup failed: %s, Please contact Salesforce Support.",

src/migration/premigrate.ts

@@ -53,8 +53,8 @@ export class PreMigrate extends BaseMigrationTool {
     }
 
     // Handle config tables cleanup for standard data model migration
-    const isMetadataCleanupSuccess = await this.handleOmniStudioMetadataCleanup();
-    if (!isMetadataCleanupSuccess) {
+    const isMetadataTablesValid = await this.validateOmniStudioMetadataTables();
+    if (!isMetadataTablesValid) {
       process.exit(1);
     }
   }
@@ -186,11 +186,11 @@ export class PreMigrate extends BaseMigrationTool {
   }
 
   /**
-   * Handles OmniStudio metadata tables cleanup with user consent
+   * Validates that OmniStudio metadata tables are clean before migration can proceed.
    *
-   * @returns Promise<boolean> - true if cleanup was successful, false otherwise
+   * @returns Promise<boolean> - true if tables are clean and migration can proceed, false otherwise
    */
-  public async handleOmniStudioMetadataCleanup(): Promise<boolean> {
+  public async validateOmniStudioMetadataTables(): Promise<boolean> {
     if (isStandardDataModelWithMetadataAPIEnabled()) {
       return true;
     }
@@ -200,14 +200,11 @@ export class PreMigrate extends BaseMigrationTool {
       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();
+    const helpUrl = this.messages.getMessage('cleanupMetadataTablesHelpUrl');
+    const helpLinkText = this.messages.getMessage('cleanupMetadataTablesHelpLinkText');
+    const clickableLink = `\x1b]8;;${helpUrl}\x1b\\${helpLinkText}\x1b]8;;\x1b\\`;
+    Logger.error(`${this.messages.getMessage('cleanupMetadataTablesRequired')} ${clickableLink}`);
+    return false;
   }
 
   private async checkLwcDeployPrerequisites(
@@ -319,6 +316,8 @@ export class PreMigrate extends BaseMigrationTool {
    *
    * @returns Promise<boolean> - true if user consents, false otherwise
    */
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore TS6133: kept intentionally for future metadata cleanup flow.
   private async getMetadataCleanupConsent(): Promise<boolean> {
     const askWithTimeOut = PromptUtil.askWithTimeOut(this.messages);
     let validResponse = false;

test/migration/premigrate.test.ts

@@ -9,6 +9,8 @@ import sinon = require('sinon');
 import { PreMigrate } from '../../src/migration/premigrate';
 import { Logger } from '../../src/utils/logger';
 import { PromptUtil } from '../../src/utils/promptUtil';
+import { OmniStudioMetadataCleanupService } from '../../src/utils/config/OmniStudioMetadataCleanupService';
+import * as dataModelService from '../../src/utils/dataModelService';
 
 describe('PreMigrate - handleAllVersionsPrerequisites for Standard Data Model', () => {
   let preMigrate: PreMigrate;
@@ -121,4 +123,31 @@ describe('PreMigrate - handleAllVersionsPrerequisites for Standard Data Model',
       expect(processExitStub.called).to.be.false;
     });
   });
+
+  describe('OmniStudio metadata prerequisites', () => {
+    it('should log cleanup required and exit when config tables are not empty', async () => {
+      // Arrange
+      const expectedMessage = 'Omnistudio configuration tables contain records.';
+      getMessageStub.withArgs('cleanupMetadataTablesRequired').returns(expectedMessage);
+      getMessageStub
+        .withArgs('cleanupMetadataTablesHelpUrl')
+        .returns(
+          'https://help.salesforce.com/s/articleView?id=xcloud.os_enable_omnistudio_metadata_api_support.htm&type=5'
+        );
+      getMessageStub
+        .withArgs('cleanupMetadataTablesHelpLinkText')
+        .returns('Learn more about cleaning up tables in Salesforce Help');
+      sandbox.stub(dataModelService, 'isStandardDataModelWithMetadataAPIEnabled').returns(false);
+      sandbox.stub(preMigrate, 'getOmniStudioMetadataEnableConsent').resolves(true);
+      sandbox.stub(OmniStudioMetadataCleanupService.prototype, 'hasCleanOmniStudioMetadataTables').resolves(false);
+
+      // Act
+      await preMigrate.handleOmnistudioMetadataPrerequisites();
+
+      // Assert - Logger.error is called with the message + ANSI clickable link appended
+      expect(logErrorStub.calledOnce).to.be.true;
+      expect((logErrorStub.firstCall.args[0] as string).startsWith(expectedMessage)).to.be.true;
+      expect(processExitStub.calledWith(1)).to.be.true;
+    });
+  });
 });