Merge pull request #355 from sf-kishore-kurri/u/kkurri/W-19181248

feat: @W-19181248: Assessment/Migration message for IP & OS components

Author: snehaljha-sf

messages/assess.json

@@ -40,27 +40,27 @@
   "errorDuringFlexCardAssessment": "Error during FlexCard assessment",
   "errorDuringOmniScriptAssessment": "Error during OmniScript assessment",
   "processingFlexCard": "Processing FlexCard: %s",
-  "processingDataRaptor": "Processing DataRaptor: %s",
+  "processingDataRaptor": "Processing DataMapper: %s",
   "processingOmniScript": "Processing OmniScript: %s",
-  "foundDataRaptorsToAssess": "Found %s DataRaptors to assess",
-  "foundOmniScriptsToAssess": "Found %s OmniScripts and Integration Procedures to assess",
-  "startingDataRaptorAssessment": "Starting DataRaptor assessment",
-  "startingOmniScriptAssessment": "Starting OmniScript assessment",
+  "foundDataRaptorsToAssess": "Found %s DataMappers to assess",
+  "foundOmniScriptsToAssess": "Found %s %s to assess",
+  "startingDataRaptorAssessment": "Starting DataMappers assessment",
+  "startingOmniScriptAssessment": "Starting %s assessment",
   "allVersionsInfo": "allVersions : %s",
   "assessmentInitialization": "Assessment Initialization: Using namespace: %s",
   "apiVersionInfo": "API Version: %s",
   "assessmentTargets": "Assessment targets: %s",
   "relatedObjectsInfo": "Related objects: %s",
   "allVersionsFlagInfo": "All versions: %s",
-  "assessedDataRaptorsCount": "Assessed %s DataRaptors",
-  "dataRaptorAssessmentCompleted": "DataRaptor assessment completed",
+  "assessedDataRaptorsCount": "Assessed %s DataMappers",
+  "dataRaptorAssessmentCompleted": "DataMappers assessment completed",
   "flexCardAssessment": "FlexCard Assessment",
   "assessedFlexCardsCount": "Assessed %s FlexCards",
   "flexCardAssessmentCompleted": "FlexCard assessment completed",
-  "omniScriptAssessment": "OmniScript and Integration Procedure Assessment",
+  "omniScriptAssessment": "%s Assessment",
   "assessedOmniScriptsCount": "Assessed %s OmniScripts",
   "assessedIntegrationProceduresCount": "Assessed %s Integration Procedures",
-  "omniScriptAssessmentCompleted": "OmniScript and Integration Procedure assessment completed",
+  "omniScriptAssessmentCompleted": "%s assessment completed",
   "startingFlexCardAssessment": "Starting FlexCard assessment",
   "foundFlexCardsToAssess": "Found %s FlexCards to assess",
   "startingApexAssessment": "Starting Apex assessment in project path: %s",
@@ -90,7 +90,7 @@
   "cardNameChangeMessage": "Card name will be changed from %s to %s to follow API naming standards",
   "authordNameChangeMessage": "Author name will be changed from %s to %s to follow API naming standards",
   "omniScriptNameChangeMessage": "OmniScript reference part %s will be changed to %s during migration.",
-  "dataRaptorNameChangeMessage": "DataRaptor reference %s will be changed to %s during migration.",
+  "dataRaptorNameChangeMessage": "DataMapper reference %s will be changed to %s during migration.",
   "integrationProcedureNameChangeMessage": "Integration Procedure reference %s will be changed to %s during migration.",
   "integrationProcedureManualUpdateMessage": "Integration Procedure reference %s may need manual updates after migration.",
   "duplicateCardNameMessage": "Potential duplicate: Another card has the same name %s after name cleaning. This may cause conflicts during migration",

messages/migrate.json

@@ -65,9 +65,9 @@
   "migratingComponent": "Migrating: %s",
   "migrationCompleted": "Migration completed: %s",
   "formulaSyntaxError": "There was some problem while updating the formula syntax, please check the all the formula's syntax once : %s",
-  "foundDataRaptorsToMigrate": "Found %s DataRaptors to migrate",
+  "foundDataRaptorsToMigrate": "Found %s DataMappers to migrate",
   "foundFlexCardsToMigrate": "Found %s FlexCards to migrate",
-  "foundOmniScriptsToMigrate": "Found %s OmniScripts and Integration Procedures to migrate",
+  "foundOmniScriptsToMigrate": "Found %s %s to migrate",
   "allVersionsInfo": "allVersions : %s",
   "migrationInitialization": "Migration Initialization: Using namespace: %s",
   "apiVersionInfo": "API Version: %s",
@@ -94,7 +94,7 @@
   "packageSelectionPrompt": "Enter the number of the package to use (1-%s):",
   "invalidPackageSelection": "Invalid selection. Please enter a number between 1 and %s.",
   "selectedPackage": "Selected package: %s (Version: %s)",
-  "dataRaptorNameChangeMessage": "DataRaptor reference %s will be changed to %s during migration.",
+  "dataRaptorNameChangeMessage": "DataMapper reference %s will be changed to %s during migration.",
   "integrationProcedureNameChangeMessage": "Integration Procedure reference %s will be changed to %s during migration.",
   "integrationProcedureManualUpdateMessage": "Integration Procedure reference %s may need manual updates after migration.",
   "cardAuthorNameChangeMessage": "Card author name has been modified to fit naming rules: %s",
@@ -115,5 +115,6 @@
   "labelStatusComplete": "Complete",
   "migrationConsentNotGiven": "Couldn't confirm whether assessment errors are resolved",
   "migrationConsentMessage": "Ensure that all items in the assessment report are marked as Green before proceeding with the migration. Do you want to proceed?",
+  "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"
 }

src/commands/omnistudio/migration/assess.ts

@@ -173,7 +173,8 @@ export default class Assess extends OmniStudioBaseCommand {
       // If no specific component is specified, assess all components
       await this.assessDataRaptors(assesmentInfo, namespace, conn);
       await this.assessFlexCards(assesmentInfo, namespace, conn, allVersions);
-      await this.assessOmniScripts(assesmentInfo, namespace, conn, allVersions, OmniScriptExportType.All);
+      await this.assessOmniScripts(assesmentInfo, namespace, conn, allVersions, OmniScriptExportType.OS);
+      await this.assessOmniScripts(assesmentInfo, namespace, conn, allVersions, OmniScriptExportType.IP);
       return;
     }
 
@@ -224,20 +225,38 @@ export default class Assess extends OmniStudioBaseCommand {
     allVersions: boolean,
     exportType: OmniScriptExportType
   ): Promise<void> {
-    Logger.logVerbose(messages.getMessage('omniScriptAssessment'));
+    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);
-    assesmentInfo.omniAssessmentInfo = await osMigrator.assess(
+    const newOmniAssessmentInfo = await osMigrator.assess(
       assesmentInfo.dataRaptorAssessmentInfos,
       assesmentInfo.flexCardAssessmentInfos
     );
-    Logger.logVerbose(
-      messages.getMessage('assessedOmniScriptsCount', [assesmentInfo.omniAssessmentInfo.osAssessmentInfos.length])
-    );
-    Logger.logVerbose(
-      messages.getMessage('assessedIntegrationProceduresCount', [
-        assesmentInfo.omniAssessmentInfo.ipAssessmentInfos.length,
-      ])
-    );
-    Logger.log(messages.getMessage('omniScriptAssessmentCompleted'));
+
+    // Initialize omniAssessmentInfo if it doesn't exist
+    if (!assesmentInfo.omniAssessmentInfo) {
+      assesmentInfo.omniAssessmentInfo = {
+        osAssessmentInfos: [],
+        ipAssessmentInfos: [],
+      };
+    }
+
+    // Merge results instead of overwriting
+    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,
+        ])
+      );
+    }
+    Logger.log(messages.getMessage('omniScriptAssessmentCompleted', [exportComponentType]));
   }
 }

src/commands/omnistudio/migration/migrate.ts

@@ -81,6 +81,7 @@ export default class Migrate extends OmniStudioBaseCommand {
   }
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  // eslint-disable-next-line complexity
   public async runMigration(): Promise<any> {
     let apiVersion = this.flags.apiversion as string;
     const migrateOnly = (this.flags.only || '') as string;
@@ -168,6 +169,12 @@ export default class Migrate extends OmniStudioBaseCommand {
     let objectMigrationResults = await this.truncateObjects(migrationObjects, debugTimer);
     const allTruncateComplete = objectMigrationResults.length === 0;
 
+    // Log truncation errors if any exist
+    if (!allTruncateComplete) {
+      this.logTruncationErrors(objectMigrationResults);
+      return;
+    }
+
     if (allTruncateComplete) {
       objectMigrationResults = await this.migrateObjects(migrationObjects, debugTimer, namespace);
     }
@@ -280,6 +287,8 @@ export default class Migrate extends OmniStudioBaseCommand {
     namespace: string
   ): Promise<MigratedObject[]> {
     let objectMigrationResults: MigratedObject[] = [];
+    // Migrate in correct dependency order
+    // DM -> IP -> OS -> FC
     for (const cls of migrationObjects.reverse()) {
       try {
         Logger.log(messages.getMessage('migratingComponent', [cls.getName()]));
@@ -319,8 +328,19 @@ export default class Migrate extends OmniStudioBaseCommand {
     if (!migrateOnly) {
       migrationObjects = [
         new DataRaptorMigrationTool(namespace, conn, this.logger, messages, this.ux),
+        // Integration Procedure
+        new OmniScriptMigrationTool(
+          OmniScriptExportType.IP,
+          namespace,
+          conn,
+          this.logger,
+          messages,
+          this.ux,
+          allVersions
+        ),
+        // Omniscript
         new OmniScriptMigrationTool(
-          OmniScriptExportType.All,
+          OmniScriptExportType.OS,
           namespace,
           conn,
           this.logger,
@@ -433,4 +453,12 @@ export default class Migrate extends OmniStudioBaseCommand {
 
     return mergedResults;
   }
+
+  private logTruncationErrors(objectMigrationResults: MigratedObject[]): void {
+    objectMigrationResults.forEach((result) => {
+      if (result.errors && result.errors.length > 0) {
+        Logger.error(messages.getMessage('truncationFailed', [result.name, result.errors.join(', ')]));
+      }
+    });
+  }
 }

src/migration/base.ts

@@ -7,7 +7,7 @@ import { Stringutil } from '../utils/StringValue/stringutil';
 import { Logger } from '../utils/logger';
 import { TransformData, UploadRecordResult } from './interfaces';
 
-export type ComponentType = 'Data Mapper' | 'Flexcard' | 'Omniscript and Integration Procedure';
+export type ComponentType = 'DataMappers' | 'Flexcards' | 'Omniscripts' | 'Integration Procedures';
 
 /**
  * Creates a progress bar for migration/assessment operations
@@ -17,10 +17,15 @@ export type ComponentType = 'Data Mapper' | 'Flexcard' | 'Omniscript and Integra
  * @returns A configured cliProgress.SingleBar instance
  */
 export const createProgressBar = (action: string, componentType: ComponentType): cliProgress.SingleBar => {
+  // Normalize type to string for comparison
+  const typeStr = String(componentType);
+
+  // Determine if space should be empty or tabs
+  const noSpaceTypes = ['Omniscript', 'Integration Procedure', 'ExperienceSites'];
+  const space = noSpaceTypes.includes(typeStr) ? '' : '\t\t\t\t';
+
   return new cliProgress.SingleBar({
-    format: `${action} ${componentType} |${
-      componentType === 'Omniscript and Integration Procedure' ? '' : '\t\t\t\t'
-    } {bar} | {percentage}% || {value}/{total} Tasks`,
+    format: `${action} ${componentType} | ${space} {bar} | {percentage}% || {value}/{total} Tasks`,
     barCompleteChar: '\u2588',
     barIncompleteChar: '\u2591',
     hideCursor: true,

src/migration/dataraptor.ts

@@ -101,7 +101,7 @@ export class DataRaptorMigrationTool extends BaseMigrationTool implements Migrat
       (dr) => dr[this.namespacePrefix + 'Type__c'] !== 'Migration'
     ).length;
     Logger.log(this.messages.getMessage('foundDataRaptorsToMigrate', [nonMigrationDataRaptors]));
-    const progressBar = createProgressBar('Migrating', 'Data Mapper');
+    const progressBar = createProgressBar('Migrating', 'DataMappers');
     progressBar.start(nonMigrationDataRaptors, progressCounter);
     for (let dr of dataRaptors) {
       // Skip if Type is "Migration"
@@ -237,7 +237,7 @@ export class DataRaptorMigrationTool extends BaseMigrationTool implements Migrat
     const existingDataRaptorNames = new Set<string>();
     const dataRaptorItemsMap = await this.getAllDRToItemsMap();
 
-    const progressBar = createProgressBar('Assessing', 'Data Mapper');
+    const progressBar = createProgressBar('Assessing', 'DataMappers');
     let progressCounter = 0;
     let nonMigrationDataRaptors = dataRaptors.filter(
       (dr) => dr[this.namespacePrefix + 'Type__c'] !== 'Migration'

src/migration/flexcard.ts

@@ -86,7 +86,7 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
     const cards = await this.getAllActiveCards();
     Logger.log(this.messages.getMessage('foundFlexCardsToMigrate', [cards.length]));
 
-    const progressBar = createProgressBar('Migrating', 'Flexcard');
+    const progressBar = createProgressBar('Migrating', 'Flexcards');
     // Save the Vlocity Cards in OmniUiCard
     const cardUploadResponse = await this.uploadAllCards(cards, progressBar);
 
@@ -123,7 +123,7 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
   public async processCardComponents(flexCards: AnyJson[]): Promise<FlexCardAssessmentInfo[]> {
     const flexCardAssessmentInfos: FlexCardAssessmentInfo[] = [];
     let progressCounter = 0;
-    const progressBar = createProgressBar('Assessing', 'Flexcard');
+    const progressBar = createProgressBar('Assessing', 'Flexcards');
     progressBar.start(flexCards.length, progressCounter);
     const uniqueNames = new Set<string>();
 

src/migration/omniscript.ts

@@ -12,7 +12,7 @@ import {
   QueryTools,
   SortDirection,
 } from '../utils';
-import { BaseMigrationTool } from './base';
+import { BaseMigrationTool, ComponentType } from './base';
 import {
   InvalidEntityTypeError,
   MigrationResult,
@@ -65,7 +65,11 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
   }
 
   getName(): string {
-    return 'OmniScript / Integration Procedures';
+    if (this.exportType === OmniScriptExportType.IP) {
+      return 'Integration Procedures';
+    } else if (this.exportType === OmniScriptExportType.OS) {
+      return 'Omniscripts';
+    }
   }
 
   getRecordName(record: string) {
@@ -189,9 +193,11 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
     flexCardAssessmentInfos: FlexCardAssessmentInfo[]
   ): Promise<OmniAssessmentInfo> {
     try {
-      Logger.log(this.messages.getMessage('startingOmniScriptAssessment'));
+      const exportComponentType =
+        this.exportType === OmniScriptExportType.IP ? 'Integration Procedures' : 'Omniscripts';
+      Logger.log(this.messages.getMessage('startingOmniScriptAssessment', [exportComponentType]));
       const omniscripts = await this.getAllOmniScripts();
-      Logger.log(this.messages.getMessage('foundOmniScriptsToAssess', [omniscripts.length]));
+      Logger.log(this.messages.getMessage('foundOmniScriptsToAssess', [omniscripts.length, exportComponentType]));
 
       const omniAssessmentInfos = await this.processOmniComponents(
         omniscripts,
@@ -220,7 +226,9 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
     const existingDataRaptorNames = new Set(dataRaptorAssessmentInfos.map((info) => info.name));
     const existingFlexCardNames = new Set(flexCardAssessmentInfos.map((info) => info.name));
 
-    const progressBar = createProgressBar('Assessing', 'Omniscript and Integration Procedure');
+    const progressBarType: ComponentType =
+      this.exportType === OmniScriptExportType.IP ? 'Integration Procedures' : 'Omniscripts';
+    const progressBar = createProgressBar('Assessing', progressBarType);
     let progressCounter = 0;
     progressBar.start(omniscripts.length, progressCounter);
     // First, collect all OmniScript names from the omniscripts array
@@ -509,8 +517,10 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
     // Variables to be returned After Migration
     let originalOsRecords = new Map<string, any>();
     let osUploadInfo = new Map<string, UploadRecordResult>();
-    Logger.log(this.messages.getMessage('foundOmniScriptsToMigrate', [omniscripts.length]));
-    const progressBar = createProgressBar('Migrating', 'Omniscript and Integration Procedure');
+    const exportComponentType = this.exportType === OmniScriptExportType.IP ? 'Integration Procedures' : 'Omniscripts';
+    Logger.log(this.messages.getMessage('foundOmniScriptsToMigrate', [omniscripts.length, exportComponentType]));
+    const progressBarType: ComponentType = exportComponentType;
+    const progressBar = createProgressBar('Migrating', progressBarType);
     let progressCounter = 0;
     progressBar.start(omniscripts.length, progressCounter);
 

src/utils/constants/documentRegistry.ts

@@ -52,8 +52,8 @@ export const documentRegistry = {
   dataRaptorNameChangeMessage:
     'https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_update_references_to_dataraptors_from_apex_after_migration.htm&type=5',
   integrationProcedureNameChangeMessage:
-    'https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_update_references_to_integration_procedures_after_migration.htm&type=5',
+    'https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_update_references_to_dataraptors_from_apex_after_migration.htm&type=5',
   integrationProcedureManualUpdateMessage:
-    'https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_update_references_to_integration_procedures_after_migration.htm&type=5',
+    'https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_update_references_to_dataraptors_from_apex_after_migration.htm&type=5',
   duplicateCardNameMessage: 'https://help.salesforce.com/s/articleView?id=xcloud.os_clone_a_flexcard.htm&type=5',
 };