Merge pull request #366 from sf-kishore-kurri/u/kkurri/GA/W-18480479

feat: @W-18480479 : Enabling standard runtime along with data model

Author: snehaljha-sf

messages/assess.json

@@ -142,10 +142,6 @@
   "relatedObjectsToProcess": "Objects to process are",
   "consentForExperienceSites": "By proceeding further, you hereby consent to enable digital experience metadata api(y/n). If y sites will be processed, if n expsites will not be processed",
   "failedToGetConsentError": "Failed to get user consent: %s",
-  "settingDesignersToStandardModel": "Setting designers to use the standard data model",
-  "errorSettingDesignersToStandardModel": "Error occurred while setting designers to use the standard data model",
-  "designersSetToStandardModel": "Successfully executed setDesignersToUseStandardDataModel",
-  "exceptionSettingDesignersToStandardModel": "Exception occurred while setting designers to use the standard data model",
   "noRelatedObjects": "No related objects to process",
   "turnOffExperienceBundleAPI": "Since ExperienceSiteMetadata API was programatically enabled, turing it off",
   "errorRevertingExperienceBundleMetadataAPI": "Exception occurred while reverting metadata API. Please do that manually",
@@ -177,7 +173,7 @@
   "flexcardStorageProcessingStarted": "Started preparing storage for flexcards",
   "errorWhileProcessingFlexcardStorage": "Error occurred while processing key for flexcard storage",
   "missingInfo": "Info is missing",
-  "errorCheckingGlobalAutoNumber": "We couldn’t check whether the Global Auto Number setting is enabled: %s. Try again later.",
+  "errorCheckingGlobalAutoNumber": "We couldn't check whether the Global Auto Number setting is enabled: %s. Try again later.",
   "errorMigrationMessage": "Error migrating object: %s",
   "nameMappingUndefined": "Name Mapping is undefined",
   "experienceSiteException": "Exception occurred while processing experience sites",

messages/migrate.json

@@ -111,7 +111,6 @@
   "errorParsingData": "Error while parsing data for template",
   "errorGeneratingHTML": "Error while generating HTML from template for %s with properties %s",
   "errorEvaluatingExpression": "Error evaluating expression: %s, %s",
-  "manuallySwitchDesignerToStandardDataModel": "To complete the setup, please manually run the required Apex code to configure OmniStudio Designers to use the Standard Data Model <br> https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_change_the_sobject_data_model_after_migration.htm&type=5",
   "labelStatusSkipped": "Skipped",
   "labelStatusFailed": "Failed",
   "labelStatusComplete": "Complete",
@@ -155,10 +154,6 @@
   "relatedObjectsToProcess": "Objects to process are",
   "consentForExperienceSites": "'By proceeding further, you hereby consent to enable digital experience metadata api(y/n). If y sites will be processed, if n expsites will not be processed';",
   "failedToGetConsentError": "Failed to get user consent: %s",
-  "settingDesignersToStandardModel": "Setting designers to use the standard data model",
-  "errorSettingDesignersToStandardModel": "Error occurred while setting designers to use the standard data model",
-  "designersSetToStandardModel": "Successfully executed setDesignersToUseStandardDataModel",
-  "exceptionSettingDesignersToStandardModel": "Exception occurred while setting designers to use the standard data model",
   "noRelatedObjects": "No related objects to process",
   "turnOffExperienceBundleAPI": "Since ExperienceSiteMetadata API was programatically enabled, turing it off",
   "errorRevertingExperienceBundleMetadataAPI": "Exception occurred while reverting metadata API. Please do that manually",
@@ -218,5 +213,22 @@
   "manifestDeployementStarted": "Manifest deployment started with id: %s",
   "migrationConsentMessage": "Make sure that all records listed in the Assessment Status column in the Assessment Report are marked as Green before proceeding with the migration. Do you want to proceed? Yes or No?",
   "truncationFailed": "Truncation failed for %s: %s",
-  "invalidTypeMigrateErrorMessage": "We couldn't migrate your Omnistudio components in the %s namespace. Select the correct namespace and try again"
-}
+  "invalidTypeMigrateErrorMessage": "We couldn't migrate your Omnistudio components in the %s namespace. Select the correct namespace and try again",
+  "errorCheckingStandardRuntime": "We couldn't check whether the Standard OmniStudio Runtime setting is enabled: %s. Try again later.",
+  "checkingStandardRuntimeStatus": "Checking Standard OmniStudio Runtime status...",
+  "standardRuntimeAlreadyEnabled": "Standard OmniStudio Runtime is already enabled, no action needed.",
+  "standardRuntimeEnabled": "Standard OmniStudio Runtime has been successfully enabled.",
+  "errorEnablingStandardRuntime": "Failed to enable Standard OmniStudio Runtime: %s",
+  "exceptionEnablingStandardRuntime": "Exception occurred while enabling Standard OmniStudio Runtime: %s",
+  "manuallyEnableStandardRuntime": "Please manually enable the Standard OmniStudio Runtime setting in your org's OmniStudio Settings.",
+  "standardDesignerAlreadyEnabled": "Standard OmniStudio designer is already enabled, no action needed for package: %s",
+  "settingDesignersToStandardModel": "Setting OmniStudio designers to use standard data model",
+  "designersSetToStandardModel": "OmniStudio designers have been successfully set to use standard data model.",
+  "errorSettingDesignersToStandardModel": "Failed to set designers to standard data model: %s",
+  "exceptionSettingDesignersToStandardModel": "Exception occurred while setting designers to standard data model: %s",
+  "manuallySwitchDesignerToStandardDataModel": "Please manually switch the OmniStudio designer to use standard data model in your org. Follow the documentation <a href='https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_change_the_sobject_data_model_after_migration.htm&type=5' target='_blank'>here</a>.",
+  "checkingStandardDesignerStatus": "Checking if standard designer is already enabled for package: %s",
+  "enableStandardRuntimeAfterDesigner": "Standard designer setup successful, proceeding with Standard Runtime enablement",
+  "skipStandardRuntimeDueToFailure": "Skipping Standard Runtime enablement due to designer setup failure",
+  "errorCheckingStandardDesigner": "Failed to check standard designer status for package %s: %s"
+}

src/commands/omnistudio/migration/migrate.ts

@@ -208,7 +208,7 @@ export default class Migrate extends OmniStudioBaseCommand {
     );
 
     if (!migrateOnly) {
-      await postMigrate.setDesignersToUseStandardDataModel(namespace, actionItems);
+      await postMigrate.executeTasks(namespace, actionItems);
     }
     // From here also actionItems need to be collected
     await postMigrate.restoreExperienceAPIMetadataSettings(
@@ -437,7 +437,7 @@ export default class Migrate extends OmniStudioBaseCommand {
           allVersions
         ),
         new CardMigrationTool(namespace, conn, this.logger, messages, this.ux, allVersions),
-        new GlobalAutoNumberMigrationTool(namespace, conn, this.logger, messages, this.ux),
+        // new GlobalAutoNumberMigrationTool(namespace, conn, this.logger, messages, this.ux),
       ];
     } else {
       // For single component migration, the order doesn't matter as much

src/migration/globalautonumber.ts

@@ -12,17 +12,16 @@ import { GlobalAutoNumberAssessmentInfo } from '../utils/interfaces';
 import { Logger } from '../utils/logger';
 import { createProgressBar } from './base';
 import { OrgPreferences } from '../utils/orgPreferences';
-import { OmniGlobalAutoNumberPrefManager } from '../utils/OmniGlobalAutoNumberPrefManager';
-
+import { OmnistudioSettingsPrefManager } from '../utils/OmnistudioSettingsPrefManager';
 import { Constants } from '../utils/constants/stringContants';
 
 export class GlobalAutoNumberMigrationTool extends BaseMigrationTool implements MigrationTool {
-  private prefManager: OmniGlobalAutoNumberPrefManager;
+  private prefManager: OmnistudioSettingsPrefManager;
   private globalAutoNumberSettings: AnyJson[] | null = null;
 
   constructor(namespace: string, connection: Connection, logger: Logger, messages: Messages, ux: UX) {
     super(namespace, connection, logger, messages, ux);
-    this.prefManager = new OmniGlobalAutoNumberPrefManager(this.connection, this.messages);
+    this.prefManager = new OmnistudioSettingsPrefManager(this.connection, this.messages);
   }
 
   static readonly GLOBAL_AUTO_NUMBER_SETTING_NAME = 'GlobalAutoNumberSetting__c';
@@ -101,7 +100,7 @@ export class GlobalAutoNumberMigrationTool extends BaseMigrationTool implements
       await super.truncate(this.namespacePrefix + GlobalAutoNumberMigrationTool.GLOBAL_AUTO_NUMBER_SETTING_NAME);
       Logger.logVerbose(this.messages.getMessage('postMigrationCleanupCompleted'));
       // Enable the org preference after successful cleanup
-      const result = await this.prefManager.enable();
+      const result = await this.prefManager.enableGlobalAutoNumber();
       if (result?.success) {
         Logger.logVerbose(this.messages.getMessage('omniGlobalAutoNumberPrefEnabled'));
         return '';
@@ -171,7 +170,7 @@ export class GlobalAutoNumberMigrationTool extends BaseMigrationTool implements
    */
   private async performPreMigrationChecks(): Promise<void> {
     // Check if Global Auto Number preference is already enabled
-    const isEnabled = await this.prefManager.isEnabled();
+    const isEnabled = await this.prefManager.isGlobalAutoNumberEnabled();
     if (isEnabled) {
       const errorMessage = this.messages.getMessage('globalAutoNumberPrefEnabledError');
       throw new Error(errorMessage);

src/migration/postMigrate.ts

@@ -6,6 +6,7 @@ import { ExecuteAnonymousResult } from 'jsforce';
 import { Logger } from '../utils/logger';
 import { AnonymousApexRunner } from '../utils/apex/executor/AnonymousApexRunner';
 import { Constants } from '../utils/constants/stringContants';
+import { OmnistudioSettingsPrefManager } from '../utils/OmnistudioSettingsPrefManager';
 import { OrgPreferences } from '../utils/orgPreferences';
 import { BaseMigrationTool } from './base';
 import { Deployer } from './deployer';
@@ -17,6 +18,7 @@ export class PostMigrate extends BaseMigrationTool {
   private readonly relatedObjectsToProcess: string[];
   private readonly projectPath: string;
   private readonly deploymentConfig: { autoDeploy: boolean; authKey: string | undefined };
+  private settingsPrefManager: OmnistudioSettingsPrefManager;
 
   // Source Custom Object Names
   constructor(
@@ -35,32 +37,123 @@ export class PostMigrate extends BaseMigrationTool {
     this.relatedObjectsToProcess = relatedObjectsToProcess;
     this.deploymentConfig = deploymentConfig;
     this.projectPath = projectPath;
+    this.settingsPrefManager = new OmnistudioSettingsPrefManager(connection, messages);
   }
 
-  public async setDesignersToUseStandardDataModel(
+  /**
+   * Execute post migration tasks with dependency handling.
+   */
+  public async executeTasks(namespaceToModify: string, userActionMessage: string[]): Promise<string[]> {
+    const designerOk = await this.enableDesignersToUseStandardDataModelIfNeeded(namespaceToModify, userActionMessage);
+    if (designerOk) {
+      await this.enableStandardRuntimeIfNeeded(userActionMessage);
+    }
+    return userActionMessage;
+  }
+
+  /**
+   * Checks if OmniStudio designers are already using the standard data model for the specific package.
+   */
+  private async isStandardDesignerEnabled(namespaceToModify: string): Promise<boolean> {
+    try {
+      const query = `SELECT DeveloperName, Value FROM OmniInteractionConfig WHERE DeveloperName IN ('TheFirstInstalledOmniPackage', 'InstalledIndustryPackage')`;
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+      const result = await this.connection.query(query);
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      if (result?.totalSize > 0) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        const records = result.records as Array<{ DeveloperName: string; Value: string }>;
+
+        for (const record of records) {
+          if (record.Value === namespaceToModify) {
+            return true;
+          }
+        }
+        return false;
+      } else {
+        return false;
+      }
+    } catch (error) {
+      const errMsg = error instanceof Error ? error.message : String(error);
+      Logger.error(this.messages.getMessage('errorCheckingStandardDesigner', [namespaceToModify, errMsg]));
+      return false;
+    }
+  }
+
+  public async enableDesignersToUseStandardDataModelIfNeeded(
     namespaceToModify: string,
     userActionMessage: string[]
-  ): Promise<string[]> {
+  ): Promise<boolean> {
     try {
       Logger.logVerbose(this.messages.getMessage('settingDesignersToStandardModel'));
+
+      // First check if standard designer is already enabled for this package
+      Logger.logVerbose(this.messages.getMessage('checkingStandardDesignerStatus', [namespaceToModify]));
+      const isAlreadyEnabled = await this.isStandardDesignerEnabled(namespaceToModify);
+
+      if (isAlreadyEnabled) {
+        Logger.logVerbose(this.messages.getMessage('standardDesignerAlreadyEnabled', [namespaceToModify]));
+        return true;
+      }
+
       const apexCode = `
           ${namespaceToModify}.OmniStudioPostInstallClass.useStandardDataModel();
         `;
 
       const result: ExecuteAnonymousResult = await AnonymousApexRunner.run(this.org, apexCode);
 
       if (result?.success === false) {
-        const message = result?.exceptionStackTrace;
+        const message = result?.exceptionStackTrace || result?.exceptionMessage || 'Unknown error';
+
         Logger.error(this.messages.getMessage('errorSettingDesignersToStandardModel', [message]));
+        Logger.logVerbose(this.messages.getMessage('skipStandardRuntimeDueToFailure'));
         userActionMessage.push(this.messages.getMessage('manuallySwitchDesignerToStandardDataModel'));
+
+        // Do NOT attempt to enable standard runtime when setup fails
+        return false;
       } else if (result?.success === true) {
         Logger.logVerbose(this.messages.getMessage('designersSetToStandardModel'));
+        return true;
+      } else {
+        // Handle unexpected result structure
+        Logger.error('Received unexpected response from Apex execution - unable to determine success status');
+        userActionMessage.push(this.messages.getMessage('manuallySwitchDesignerToStandardDataModel'));
+        return false;
       }
     } catch (ex) {
-      Logger.error(this.messages.getMessage('exceptionSettingDesignersToStandardModel', [JSON.stringify(ex)]));
+      const errorDetails = ex instanceof Error ? ex.message : JSON.stringify(ex);
+      Logger.error(this.messages.getMessage('exceptionSettingDesignersToStandardDataModel', [errorDetails]));
+      Logger.logVerbose(this.messages.getMessage('skipStandardRuntimeDueToFailure'));
       userActionMessage.push(this.messages.getMessage('manuallySwitchDesignerToStandardDataModel'));
+      return false;
+    }
+  }
+
+  /**
+   * Enables Standard OmniStudio Runtime if it's currently disabled.
+   */
+  private async enableStandardRuntimeIfNeeded(userActionMessage: string[]): Promise<void> {
+    try {
+      Logger.logVerbose(this.messages.getMessage('checkingStandardRuntimeStatus'));
+
+      const result = await this.settingsPrefManager.enableStandardRuntimeIfDisabled();
+
+      if (result === null) {
+        Logger.logVerbose(this.messages.getMessage('standardRuntimeAlreadyEnabled'));
+      } else if (result?.success === true) {
+        Logger.logVerbose(this.messages.getMessage('standardRuntimeEnabled'));
+      } else {
+        const errors = result?.errors?.join(', ') || 'Unknown error';
+        Logger.error(this.messages.getMessage('errorEnablingStandardRuntime', [errors]));
+        userActionMessage.push(this.messages.getMessage('manuallyEnableStandardRuntime'));
+      }
+    } catch (error) {
+      const errMsg = error instanceof Error ? error.message : String(error);
+      Logger.error(this.messages.getMessage('exceptionEnablingStandardRuntime', [errMsg]));
+      userActionMessage.push(this.messages.getMessage('manuallyEnableStandardRuntime'));
     }
-    return userActionMessage;
   }
 
   // If we processed exp sites and switched metadata api from off->on then only we revert it