feat: validate and enable metadata api

Author: shaurabh-tiwari-git

messages/assess.json

@@ -197,5 +197,7 @@
   "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",
   "needManualInterventionAsSpecialCharsInChildFlexcardName": "Need manual intervention as child flexcards have special characters in their name",
-  "needManualInterventionAsSpecialCharsInFlexcardName": "Need manual intervention as flexcard has special characters in name"
+  "needManualInterventionAsSpecialCharsInFlexcardName": "Need manual intervention as flexcard has special characters in name",
+  "errorCheckingOmniStudioMetadata": "We couldn't check whether the Omnistudio Metadata is enabled: %s. Try again later.",
+  "omniStudioSettingsMetadataAlreadyEnabled": "OmniStudio Metadata is already enabled with standard data model. No need for migration."
 }

messages/migrate.json

@@ -253,5 +253,13 @@
   "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."
+  "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 will be enabled. Once it is enabled, it can't be disabled. Do you want to proceed? [y/n]",
+  "errorCheckingOmniStudioMetadata": "We couldn't check whether the Omnistudio Metadata is enabled: %s. Try again later.",
+  "omniStudioSettingsMetadataAlreadyEnabled": "OmniStudio Metadata is already enabled with standard data model. No need for migration.",
+  "omniStudioSettingsMetadataEnabled": "OmniStudio Metadata is enabled with standard data model.",
+  "errorEnablingOmniStudioSettingsMetadata": "We couldn't enable the OmniStudio Metadata: %s. Please enable it manually.",
+  "manuallyEnableOmniStudioSettingsMetadata": "Please manually enable the OmniStudio Metadata in your org's OmniStudio Settings.",
+  "omniStudioMetadataEnableConsentNotGiven": "You’ve not consented to proceed with the OmniStudio Metadata enablement. We’ll not be able to proceed with the migration.",
+  "checkingOmniStudioSettingsMetadataStatus": "Checking OmniStudio Metadata status..."
 }

src/commands/omnistudio/migration/migrate.ts

@@ -127,8 +127,15 @@ 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()) {
+      // Get user consent to enable OmniStudio Metadata for standard data model migration
+      const omniStudioMetadataEnableConsent = await preMigrate.getOmniStudioMetadataEnableConsent();
+      if (!omniStudioMetadataEnableConsent) {
+        Logger.error(messages.getMessage('omniStudioMetadataEnableConsentNotGiven'));
+        return;
+      }
+
+      // Handle config tables cleanup for standard data model migration
       const isMetadataCleanupSuccess = await preMigrate.handleOmniStudioMetadataCleanup();
       if (!isMetadataCleanupSuccess) {
         return;

src/migration/postMigrate.ts

@@ -12,6 +12,7 @@ import { BaseMigrationTool } from './base';
 import { Deployer } from './deployer';
 import * as fs from 'fs';
 import * as path from 'path';
+import { isStandardDataModel } from '../utils/dataModelService';
 
 export class PostMigrate extends BaseMigrationTool {
   private readonly org: Org;
@@ -48,6 +49,9 @@ export class PostMigrate extends BaseMigrationTool {
     if (designerOk) {
       await this.enableStandardRuntimeIfNeeded(userActionMessage);
     }
+    if (isStandardDataModel()) {
+      await this.enableOmniStudioSettingsMetadataIfNeeded(userActionMessage);
+    }
     return userActionMessage;
   }
 
@@ -125,6 +129,44 @@ export class PostMigrate extends BaseMigrationTool {
     }
   }
 
+  private async enableOmniStudioSettingsMetadataIfNeeded(userActionMessage: string[]): Promise<void> {
+    try {
+      Logger.logVerbose(this.messages.getMessage('checkingOmniStudioSettingsMetadataStatus'));
+      const result = await this.settingsPrefManager.enableOmniStudioSettingsMetadata();
+      if (result === null) {
+        Logger.logVerbose(this.messages.getMessage('omniStudioSettingsMetadataAlreadyEnabled'));
+      } else if (result?.success === true) {
+        /* The API call returns true if the metadata enabling call was successful.
+        But it takes time for the checks to run and the metadata to be enabled or reverted back.
+        We need to wait and check for it to be enabled or reverted back.
+        */
+        const maxAttempts = 12;
+        let attempts = 0;
+        while (attempts < maxAttempts) {
+          await new Promise((resolve) => setTimeout(resolve, 5000));
+          const isMetadataEnabled = await this.settingsPrefManager.isOmniStudioSettingsMetadataEnabled();
+          if (isMetadataEnabled) {
+            Logger.logVerbose(this.messages.getMessage('omniStudioSettingsMetadataEnabled'));
+            break;
+          }
+          attempts++;
+        }
+        if (attempts === maxAttempts) {
+          Logger.error(this.messages.getMessage('errorEnablingOmniStudioSettingsMetadata', ['Unknown error']));
+          userActionMessage.push(this.messages.getMessage('manuallyEnableOmniStudioSettingsMetadata'));
+        }
+      } else {
+        const errors = result?.errors?.join(', ') || 'Unknown error';
+        Logger.error(this.messages.getMessage('errorEnablingOmniStudioSettingsMetadata', [errors]));
+        userActionMessage.push(this.messages.getMessage('manuallyEnableOmniStudioSettingsMetadata'));
+      }
+    } catch (error) {
+      const errMsg = error instanceof Error ? error.message : String(error);
+      Logger.error(this.messages.getMessage('errorEnablingOmniStudioSettingsMetadata', [errMsg]));
+      userActionMessage.push(this.messages.getMessage('manuallyEnableOmniStudioSettingsMetadata'));
+    }
+  }
+
   // If we processed exp sites and switched metadata api from off->on then only we revert it
   public async restoreExperienceAPIMetadataSettings(
     isExperienceBundleMetadataAPIProgramaticallyEnabled: {

src/migration/premigrate.ts

@@ -110,6 +110,41 @@ export class PreMigrate extends BaseMigrationTool {
     return deploymentConfig;
   }
 
+  /**
+   * Gets user consent for OmniStudio metadata cleanup
+   *
+   * @returns Promise<boolean> - true if user consents, false otherwise
+   */
+  public async getOmniStudioMetadataEnableConsent(): 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('omniStudioMetadataEnableConsentMessage')
+        );
+        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;
+  }
+
   /**
    * Handles OmniStudio metadata tables cleanup with user consent
    *

src/utils/OmnistudioSettingsPrefManager.ts

@@ -78,4 +78,36 @@ export class OmnistudioSettingsPrefManager {
     }
     return null; // Already enabled, no action needed
   }
+
+  // OmniStudio Metadata methods
+  public async isOmniStudioSettingsMetadataEnabled(): Promise<boolean> {
+    try {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      const result = (await this.connection.metadata.read('OmniStudioSettings', ['OmniStudio'])) as unknown;
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      const metadata = result as MetadataInfo;
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      return metadata?.enableOmniStudioMetadata === 'true' || false;
+    } catch (error) {
+      const errMsg = error instanceof Error ? error.message : String(error);
+      Logger.error(this.messages.getMessage('errorCheckingOmniStudioMetadata', [errMsg]));
+      return false;
+    }
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  public async enableOmniStudioSettingsMetadata(): Promise<any> {
+    const isMetadataEnabled = await this.isOmniStudioSettingsMetadataEnabled();
+    if (isMetadataEnabled) {
+      return null;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return await this.connection.metadata.update('OmniStudioSettings', [
+      {
+        fullName: 'OmniStudio',
+        enableOmniStudioMetadata: 'true',
+      } as MetadataInfo,
+    ]);
+  }
 }

src/utils/validatorService.ts

@@ -2,6 +2,7 @@ import { Connection, Messages } from '@salesforce/core';
 import { Logger } from '../utils/logger';
 import { OmnistudioOrgDetails } from './orgUtils';
 import { isStandardDataModel } from './dataModelService';
+import { OmnistudioSettingsPrefManager } from './OmnistudioSettingsPrefManager';
 
 export class ValidatorService {
   private readonly messages: Messages;
@@ -20,9 +21,16 @@ export class ValidatorService {
     }
 
     // If data model is standard no need to check for the licences
-    // TODO: Add metadata toggle validation
     const isStandard = isStandardDataModel();
     if (isStandard) {
+      // Check if OmniStudio Metadata is already enabled for standard data model
+      const omniStudioSettingsPrefManager = new OmnistudioSettingsPrefManager(this.connection, this.messages);
+      const isOmniStudioSettingsMetadataEnabled =
+        await omniStudioSettingsPrefManager.isOmniStudioSettingsMetadataEnabled();
+      if (isOmniStudioSettingsMetadataEnabled) {
+        Logger.error(this.messages.getMessage('omniStudioSettingsMetadataAlreadyEnabled'));
+        return false;
+      }
       return true;
     }