Merge pull request #453 from sf-aastha-paruthi/u/aparuthi/usecaseMetadataEnabled

@W-20303952 Usecase2b, 3b Metadata API Enabled

Author: sf-aastha-paruthi

messages/assess.json

@@ -13,6 +13,7 @@
   "commandDescription": "If your Omnistudio components are on custom data model, assess the migration of the components from Omnistudio managed package runtime to Omnistudio standard runtime. If your Omnistudio components are on standard data model, assess the updates made to the component names and references.See: https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_naming_conventions.htm&type=5",
   "errorNoOrgResults": "No records found in the org '%s' to migrate.",
   "onlyFlagDescription": "Migrate a single component: os | ip | fc | dm | autonumber | cl",
+  "invalidOnlyFlag": "Invalid parameter entered. Select a valid parameter from these options: os | ip | fc | dm | autonumber | cl",
   "couldNotTruncate": "We couldn't clear all %s records.",
   "couldNotTruncateOmnniProcess": "We couldn't clear all records of your %s because the %s is referenced in an Omniscript or a Flexcard.",
   "invalidOrRepeatingOmniscriptElementNames": "Omniscript with invalid or duplicate element names found. Rename your Omniscript elements and try again.",
@@ -204,7 +205,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",
   "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.",
+  "omniStudioSettingsMetadataAlreadyEnabled": "The Omnistudio Metadata setting is already enabled with standard data model.",
   "missingMandatoryField": "Missing mandatory field: %s for %s",
   "validatingDrVersioningDisabled": "Checking the Data Mapper versioning setting in your org.",
   "drVersioningDisabled": "Proceeding with the assessment as the Data Mapper versioning setting is disabled.",
@@ -217,9 +218,12 @@
   "packagesHaveDifferentValue": "Both the InstalledIndustryPackage and TheFirstInstalledOmniPackage have different values.",
   "failedToCheckPackagesValue": "Failed to check the value of packages in Omni Interaction Configuration.",
   "packageDetails": "Your org contains only the TheFirstInstalledOmniPackage Omni Interaction Configuration.",
-  "orgUsecaseDetails": "The org is on %s data model with %s ",
-  "globalAutoNumberUnSupportedInOmnistudioPackage": "Omni Global Auto Number is not supported in Omnistudio Foundation package orgs.",
+  "orgUsecaseDetails": "The org is on %s data model with %s and Omnistudio Metadata API %s",
+  "globalAutoNumberUnSupportedInOmnistudioPackage": "Feature not supported - Omni Global Auto Number is not supported in Omnistudio Foundation package orgs.",
   "omniStudioAllVersionsProcessingConsent": "Org uses the standard data model. All versions of Omnistudio components such as Omniscripts, Data Mappers, Integration Procedures, and Flexcards must be assessed. But you’ve not specified -a  or allversions flag in the command.  Proceed to assess all versions of the Omnistudio components? [y/n]",
   "omniStudioAllVersionsProcessingConsentNotGiven": "You've not consented to assess all versions of the Omnistudio components. We cannot proceed with the assessment.",
-  "omniStudioAllVersionsProcessingConsentGiven": "You've consented to assess all versions of the Omnistudio components."
+  "omniStudioAllVersionsProcessingConsentGiven": "You've consented to assess all versions of the Omnistudio components.",
+  "preparingStorageForMetadataEnabledOrg": "Preparing storage for %s org on Standard Data Model with Metadata API enabled",
+  "processingNotRequired": "Assessment not required for Standard Data Model Orgs with Metadata API enabled",
+  "skippingTruncation": "Skipping Trunction as standard data model org"
 }

messages/migrate.json

@@ -297,7 +297,7 @@
   "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": "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.",
+  "omniStudioSettingsMetadataAlreadyEnabled": "The Omnistudio Metadata setting is already enabled with standard data model.",
   "omniStudioSettingsMetadataEnabled": "The Omnistudio Metadata setting is enabled with standard data model.",
   "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.",
@@ -320,6 +320,9 @@
   "packagesHaveDifferentValue": "Both the InstalledIndustryPackage and TheFirstInstalledOmniPackage have different values.",
   "failedToCheckPackagesValue": "Failed to check the value of packages in Omni Interaction Configuration.",
   "packageDetails": "Your org contains only the TheFirstInstalledOmniPackage Omni Interaction Configuration.",
-  "orgUsecaseDetails": "The Org is on %s data model with %s ",
-  "globalAutoNumberUnSupportedInOmnistudioPackage": "Omni Global Auto Number is not supported in Omnistudio Foundation package orgs."
+  "globalAutoNumberUnSupportedInOmnistudioPackage": "Feature not supported - Omni Global Auto Number is not supported in Omnistudio Foundation package orgs.",
+  "orgUsecaseDetails": "The Org is on %s data model with %s and Omnistudio Metadata API %s",
+  "preparingStorageForMetadataEnabledOrg": "Preparing storage for %s org on Standard Data Model with Metadata API enabled",
+  "processingNotRequired": "Migration not required for Standard Data Model Orgs with Metadata API enabled",
+  "skippingTruncation": "Skipping Trunction as standard data model org"
 }

src/commands/omnistudio/migration/assess.ts

@@ -20,7 +20,12 @@ import { ProjectPathUtil } from '../../../utils/projectPathUtil';
 import { PreMigrate } from '../../../migration/premigrate';
 import { PostMigrate } from '../../../migration/postMigrate';
 import { CustomLabelsUtil } from '../../../utils/customLabels';
-import { initializeDataModelService, isFoundationPackage, isStandardDataModel } from '../../../utils/dataModelService';
+import {
+  initializeDataModelService,
+  isFoundationPackage,
+  isStandardDataModel,
+  isStandardDataModelWithMetadataAPIEnabled,
+} from '../../../utils/dataModelService';
 
 import { ValidatorService } from '../../../utils/validatorService';
 
@@ -98,7 +103,9 @@ export default class Assess extends OmniStudioBaseCommand {
 
     // Handle all versions prerequisite for standard data model
     if (isStandardDataModel()) {
-      allVersions = await preMigrate.handleAllVersionsPrerequisites(allVersions);
+      if (!isStandardDataModelWithMetadataAPIEnabled()) {
+        allVersions = await preMigrate.handleAllVersionsPrerequisites(allVersions);
+      }
     }
     if (relatedObjects) {
       objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
@@ -274,10 +281,11 @@ export default class Assess extends OmniStudioBaseCommand {
   private async assessDataRaptors(assesmentInfo: AssessmentInfo, namespace: string, conn: Connection): Promise<void> {
     const drMigrator = new DataRaptorMigrationTool(namespace, conn, Logger, messages, this.ux);
     assesmentInfo.dataRaptorAssessmentInfos = await drMigrator.assess();
-    Logger.logVerbose(
-      messages.getMessage('assessedDataRaptorsCount', [assesmentInfo.dataRaptorAssessmentInfos.length])
+    this.logAssessmentCompletionIfNeeded(
+      'assessedDataRaptorsCount',
+      'dataRaptorAssessmentCompleted',
+      assesmentInfo.dataRaptorAssessmentInfos.length
     );
-    Logger.log(messages.getMessage('dataRaptorAssessmentCompleted'));
   }
 
   private async assessFlexCards(
@@ -287,10 +295,12 @@ export default class Assess extends OmniStudioBaseCommand {
     allVersions: boolean
   ): Promise<void> {
     const flexMigrator = new CardMigrationTool(namespace, conn, Logger, messages, this.ux, allVersions);
-    Logger.logVerbose(messages.getMessage('flexCardAssessment'));
     assesmentInfo.flexCardAssessmentInfos = await flexMigrator.assess();
-    Logger.logVerbose(messages.getMessage('assessedFlexCardsCount', [assesmentInfo.flexCardAssessmentInfos.length]));
-    Logger.log(messages.getMessage('flexCardAssessmentCompleted'));
+    this.logAssessmentCompletionIfNeeded(
+      'assessedFlexCardsCount',
+      'flexCardAssessmentCompleted',
+      assesmentInfo.flexCardAssessmentInfos.length
+    );
   }
 
   private async assessOmniScripts(
@@ -301,7 +311,6 @@ export default class Assess extends OmniStudioBaseCommand {
     exportType: OmniScriptExportType
   ): Promise<void> {
     const exportComponentType = exportType === OmniScriptExportType.IP ? 'Integration Procedures' : 'Omniscripts';
-    Logger.logVerbose(messages.getMessage('omniScriptAssessment', [exportComponentType]));
     const osMigrator = new OmniScriptMigrationTool(exportType, namespace, conn, Logger, messages, this.ux, allVersions);
     const newOmniAssessmentInfo = await osMigrator.assess(
       assesmentInfo.dataRaptorAssessmentInfos,
@@ -320,19 +329,26 @@ export default class Assess extends OmniStudioBaseCommand {
     if (exportType === OmniScriptExportType.OS) {
       // For OmniScript assessment, update osAssessmentInfos
       assesmentInfo.omniAssessmentInfo.osAssessmentInfos = newOmniAssessmentInfo.osAssessmentInfos;
-      Logger.logVerbose(
-        messages.getMessage('assessedOmniScriptsCount', [assesmentInfo.omniAssessmentInfo.osAssessmentInfos.length])
-      );
     } else {
       // For Integration Procedure assessment, update ipAssessmentInfos
       assesmentInfo.omniAssessmentInfo.ipAssessmentInfos = newOmniAssessmentInfo.ipAssessmentInfos;
-      Logger.logVerbose(
-        messages.getMessage('assessedIntegrationProceduresCount', [
-          assesmentInfo.omniAssessmentInfo.ipAssessmentInfos.length,
-        ])
+    }
+
+    if (exportType === OmniScriptExportType.OS) {
+      this.logAssessmentCompletionIfNeeded(
+        'assessedOmniScriptsCount',
+        'omniScriptAssessmentCompleted',
+        assesmentInfo.omniAssessmentInfo.osAssessmentInfos.length,
+        [exportComponentType]
+      );
+    } else {
+      this.logAssessmentCompletionIfNeeded(
+        'assessedIntegrationProceduresCount',
+        'omniScriptAssessmentCompleted',
+        assesmentInfo.omniAssessmentInfo.ipAssessmentInfos.length,
+        [exportComponentType]
       );
     }
-    Logger.log(messages.getMessage('omniScriptAssessmentCompleted', [exportComponentType]));
   }
 
   private async assessGlobalAutoNumbers(
@@ -371,4 +387,21 @@ export default class Assess extends OmniStudioBaseCommand {
       };
     }
   }
+
+  /**
+   * Logs assessment completion with count and completion message if needed
+   * Skips logging when standard data model with metadata API is enabled
+   */
+  private logAssessmentCompletionIfNeeded(
+    countMessageKey: string,
+    completionMessageKey: string,
+    count: number,
+    completionParams?: string[]
+  ): void {
+    if (isStandardDataModelWithMetadataAPIEnabled()) {
+      return;
+    }
+    Logger.logVerbose(messages.getMessage(countMessageKey, [count]));
+    Logger.log(messages.getMessage(completionMessageKey, completionParams || []));
+  }
 }

src/commands/omnistudio/migration/migrate.ts

@@ -36,6 +36,7 @@ import {
   initializeDataModelService,
   isFoundationPackage,
   isStandardDataModel,
+  isStandardDataModelWithMetadataAPIEnabled,
 } from '../../../utils/dataModelService';
 import { NameMappingRegistry } from '../../../migration/NameMappingRegistry';
 import { ValidatorService } from '../../../utils/validatorService';
@@ -74,6 +75,9 @@ export default class Migrate extends OmniStudioBaseCommand {
     }),
   };
 
+  // OmniStudio components that don't need migration logging when metadata API is enabled
+  private readonly OMNISTUDIO_COMPONENTS_FOR_LOGGING = [Constants.CustomLabel, Constants.GlobalAutoNumber];
+
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public async run(): Promise<any> {
     Logger.initialiseLogger(this.ux, this.logger, 'migrate', this.flags.verbose);
@@ -133,8 +137,11 @@ export default class Migrate extends OmniStudioBaseCommand {
     const isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean } = { value: false };
 
     if (isStandardDataModel()) {
-      allVersions = await preMigrate.handleAllVersionsPrerequisites(allVersions);
-      await preMigrate.handleOmnistudioMetadataPrerequisites();
+      if (!isStandardDataModelWithMetadataAPIEnabled()) {
+        // Only if metadata API is off we need the allVersions Consent and Omnistudio Metadata Cleanup
+        allVersions = await preMigrate.handleAllVersionsPrerequisites(allVersions);
+        await preMigrate.handleOmnistudioMetadataPrerequisites();
+      }
     }
 
     let actionItems = [];
@@ -254,7 +261,8 @@ export default class Migrate extends OmniStudioBaseCommand {
       orgs,
       messages,
       actionItems,
-      objectsToProcess
+      objectsToProcess,
+      migrateOnly
     );
     Logger.log(
       messages.getMessage('migrationSuccessfulMessage', [
@@ -357,10 +365,11 @@ export default class Migrate extends OmniStudioBaseCommand {
     // Truncate in reverse order (highest dependencies first) - this is correct for cleanup
     for (const cls of migrationObjects) {
       try {
-        Logger.log(messages.getMessage('cleaningComponent', [cls.getName()]));
-        debugTimer.lap('Cleaning: ' + cls.getName());
+        const componentName = cls.getName();
+
+        this.logTruncationStart(componentName, debugTimer);
         await cls.truncate();
-        Logger.log(messages.getMessage('cleaningDone', [cls.getName()]));
+        this.logTruncationComplete(componentName);
       } catch (ex: any) {
         objectMigrationResults.push({
           name: cls.getName(),
@@ -383,14 +392,12 @@ export default class Migrate extends OmniStudioBaseCommand {
     // Migrate in correct dependency order
     for (const cls of migrationObjects) {
       try {
-        Logger.log(messages.getMessage('migratingComponent', [cls.getName()]));
-        debugTimer.lap('Migrating: ' + cls.getName());
+        const componentName = cls.getName();
+
+        this.logMigrationStart(componentName, debugTimer);
         const results = await cls.migrate();
-        if (results.some((result) => result?.errors?.length > 0)) {
-          Logger.error(messages.getMessage('migrationFailed', [cls.getName()]));
-        } else {
-          Logger.log(messages.getMessage('migrationCompleted', [cls.getName()]));
-        }
+        this.logMigrationComplete(componentName, results);
+
         objectMigrationResults = objectMigrationResults.concat(
           results.map((r) => {
             return {
@@ -419,6 +426,80 @@ export default class Migrate extends OmniStudioBaseCommand {
     return objectMigrationResults;
   }
 
+  /**
+   * Log the start of component migration and track timing
+   */
+  private logMigrationStart(componentName: string, debugTimer: DebugTimer): void {
+    const shouldSkipLogging = this.shouldSkipLogging(componentName);
+
+    if (!shouldSkipLogging) {
+      Logger.log(messages.getMessage('migratingComponent', [componentName]));
+      debugTimer.lap('Migrating: ' + componentName);
+    }
+  }
+
+  /**
+   * Log the completion or failure of component migration
+   */
+  private logMigrationComplete(componentName: string, results: MigrationResult[]): void {
+    const shouldSkipLogging = this.shouldSkipLogging(componentName);
+
+    if (!shouldSkipLogging) {
+      if (results.some((result) => result?.errors?.length > 0) && !isStandardDataModelWithMetadataAPIEnabled()) {
+        Logger.error(messages.getMessage('migrationFailed', [componentName]));
+      } else {
+        Logger.log(messages.getMessage('migrationCompleted', [componentName]));
+      }
+    }
+  }
+
+  /**
+   * Check if migration logging should be skipped for a component
+   * Returns true if Metadata API is enabled and the component doesn't need migration
+   */
+  private shouldSkipTruncationLogging(componentName: string): boolean {
+    if (isStandardDataModel()) {
+      return true;
+    }
+
+    return this.shouldSkipLogging(componentName);
+  }
+
+  /**
+   * Check if migration logging should be skipped for a component
+   * Returns true if Metadata API is enabled and the component doesn't need migration
+   */
+  private shouldSkipLogging(componentName: string): boolean {
+    if (!isStandardDataModelWithMetadataAPIEnabled()) {
+      return false;
+    }
+
+    // Skip logging for OmniStudio components that don't need migration when metadata API is enabled
+    return !this.OMNISTUDIO_COMPONENTS_FOR_LOGGING.some((component) =>
+      componentName.toLowerCase().includes(component.toLowerCase())
+    );
+  }
+
+  /**
+   * Log the start of component truncation and track timing
+   */
+  private logTruncationStart(componentName: string, debugTimer: DebugTimer): void {
+    const shouldSkipLogging = this.shouldSkipTruncationLogging(componentName);
+    if (!shouldSkipLogging) {
+      Logger.log(messages.getMessage('cleaningComponent', [componentName]));
+      debugTimer.lap('Cleaning: ' + componentName);
+    }
+  }
+  /**
+   * Log the completion of component truncation
+   */
+  private logTruncationComplete(componentName: string): void {
+    const shouldSkipLogging = this.shouldSkipTruncationLogging(componentName);
+
+    if (!shouldSkipLogging) {
+      Logger.log(messages.getMessage('cleaningDone', [componentName]));
+    }
+  }
   /**
    * Get migration objects in the correct dependency order:
    * 1. Data Mappers (lowest dependencies)
@@ -519,6 +600,9 @@ export default class Migrate extends OmniStudioBaseCommand {
    */
   private async preProcessAllComponents(namespace: string, conn: any, migrateOnly: string): Promise<void> {
     try {
+      if (isStandardDataModelWithMetadataAPIEnabled()) {
+        return;
+      }
       const nameRegistry = NameMappingRegistry.getInstance();
       // Query all components that will be migrated
       const dataMappers = await this.queryDataMappers(conn, namespace);