Merge pull request #368 from snehaljha-sf/alpha-merge

Alpha merge

Author: snehaljha-sf

README.md

@@ -30,7 +30,7 @@ You can also authenticate using a consumer key (client ID) and secret key throug
 3. In a new terminal session, Install the Omnistudio Migration Assistant by running the `sf plugins install` command. For example
 
 ```
-sf plugins install @salesforce/[email protected]beta.13
+sf plugins install @salesforce/[email protected]rc.16
 ```
 
 4. Run the Omnistudio Migration Assistant from the Salesforce CLI:

messages/assess.json

@@ -33,14 +33,13 @@
   "invalidNamespace": "The namespace you have passed is not valid namespace, the valid namespace of your org is ",
   "noPackageInstalled": "No package installed on given org.",
   "alreadyStandardModel": "The org is already on standard data model.",
-  "invalidRelatedObjectsOptionGA": "Invalid option provided for -r: %s. Valid options are apex, lwc.",
-  "invalidRelatedObjectsOption": "Invalid option provided for -r: %s. Valid option is apex.",
+  "invalidRelatedObjectsOption": "Invalid option provided for -r: %s. Valid options are apex, lwc, expsites, flexipage.",
   "formulaSyntaxError": "There was some problem while updating the formula syntax, please check the all the formula's syntax once : %s",
   "errorDuringFlexCardAssessment": "Error during FlexCard assessment",
   "errorDuringOmniScriptAssessment": "Error during OmniScript assessment",
   "errorDuringGlobalAutoNumberAssessment": "Error during GlobalAutoNumber assessment",
   "processingFlexCard": "Processing FlexCard: %s",
-  "processingDataRaptor": "Processing DataRaptor: %s",
+  "processingDataRaptor": "Processing DataMapper: %s",
   "processingOmniScript": "Processing OmniScript: %s",
   "processingGlobalAutoNumber": "Processing GlobalAutoNumber: %s",
   "foundDataRaptorsToAssess": "Found %s DataRaptors to assess",
@@ -55,8 +54,8 @@
   "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",
@@ -96,23 +95,23 @@
   "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",
   "duplicateGlobalAutoNumberNameMessage": "Potential duplicate: Another Global Auto Number has the same name %s after name cleaning. This may cause conflicts during migration",
   "existingApexPrompt": "Do you have a sfdc project that already contains the APEX classes retrieved from your org? [y/n]",
-  "enterExistingProjectPath": "Enter the path to the project folder that contains the retrieved APEX classes:",
+  "enterExistingProjectPath": "Enter the path to the project folder that contains the retrieved APEX classes",
   "invalidProjectFolderPath": "Provided project folder does not exist. Please provide a valid project folder path",
   "requestTimedOut": "Request timed out",
   "retrieveApexPrompt": "Omnistudio Migration Assistant can connect to your org and retrieve the APEX classes. Provide an empty project folder to store the retrieved APEX classes. Would you like to proceed with the retrieval? [y/n]",
-  "enterEmptyProjectPath": "Enter the path to an empty project folder to retrieve to and process the APEX classes:",
+  "enterEmptyProjectPath": "Enter the path to an empty project folder to retrieve to and process the APEX classes",
   "notEmptyProjectFolderPath": "Provided project folder is not empty. Please provide a valid empty project folder name and path",
   "operationCancelled": "Operation cancelled.",
   "invalidYesNoResponse": "Invalid response. Please answer y or n.",
   "notSfdxProjectFolderPath": "Provided folder is not a valid Salesforce DX project. Please select a folder containing sfdx-project.json",
   "failedToGetValidProjectPath": "Failed to get valid project path",
-  "errorRunningAssess": "Error running assess",
+  "errorRunningAssess": "Assessment process failed reason : %s",
   "enableVerboseOutput": "Enable verbose output",
   "apexFileChangesIdentifiedNotApplied": "Changes identified for Apex class %s but not applied (assessment mode)",
   "apexFileHasMultipleInterfaces": "File %s has multiple interfaces including Callable, standardizing to System.Callable only",
@@ -141,7 +140,7 @@
   "enableExperienceBundleMetadataAPIProgramatically": "ExperienceBundle metadata api needs to be programatically enabled",
   "unableToEnableExperienceBundleMetadataAPI": "Since the api could not able enabled the experience sites would not be processed",
   "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';",
+  "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",
@@ -182,5 +181,6 @@
   "errorMigrationMessage": "Error migrating object: %s",
   "nameMappingUndefined": "Name Mapping is undefined",
   "experienceSiteException": "Exception occurred while processing experience sites",
-  "reservedKeysFoundInPropertySet": "Reserved keys found in any of output response transformation fields: %s."
+  "reservedKeysFoundInPropertySet": "Reserved keys found in any of output response transformation fields: %s.",
+  "invalidTypeAssessErrorMessage": "We couldn't assess your Omnistudio components in the %s namespace. Select the correct namespace and try again"
 }

messages/migrate.json

@@ -34,23 +34,22 @@
   "invalidNamespace": "The namespace you have passed is not valid namespace, the valid namespace of your org is ",
   "noPackageInstalled": "No package installed on given org.",
   "alreadyStandardModel": "The org is already on standard data model.",
-  "invalidRelatedObjectsOptionGA": "Invalid option provided for -r: %s. Valid options are apex, lwc.",
-  "invalidRelatedObjectsOption": "Invalid option provided for -r: %s. Valid option is apex.",
+  "invalidRelatedObjectsOption": "Invalid option provided for -r: %s. Valid options are apex, lwc, expsites, flexipage.",
   "userConsentMessage": "By proceeding further, you hereby consent to the use, accept changes to your custom code and the accompanying terms and conditions associated with the use of the OmniStudio Migration Tool. Do you want to proceed? [y/n]",
   "userDeclinedConsent": "User declined consent, will not process %s .",
   "userConsentedToProceed": "User consented to proceed",
   "existingApexPrompt": "Do you have a sfdc project that already contains the APEX classes retrieved from your org? [y/n]",
-  "enterExistingProjectPath": "Enter the path to the project folder that contains the retrieved APEX classes:",
+  "enterExistingProjectPath": "Enter the path to the project folder that contains the retrieved APEX classes",
   "invalidProjectFolderPath": "Provided project folder does not exist. Please provide a valid project folder path",
   "requestTimedOut": "Request timed out",
   "retrieveApexPrompt": "Omnistudio Migration Tool can connect to your org and retrieve the APEX classes. Provide an empty project folder to store the retrieved APEX classes. Would you like to proceed with the retrieval? [y/n]",
-  "enterEmptyProjectPath": "Enter the path to an empty project folder to retrieve to and process the APEX classes:",
+  "enterEmptyProjectPath": "Enter the path to an empty project folder to retrieve to and process the APEX classes",
   "notEmptyProjectFolderPath": "Provided project folder is not empty. Please provide a valid empty project folder name and path",
   "invalidYesNoResponse": "Invalid response. Please answer y or n.",
   "notSfdxProjectFolderPath": "Provided folder is not a valid Salesforce DX project. Please select a folder containing sfdx-project.json",
   "operationCancelled": "Operation cancelled.",
   "failedToGetValidProjectPath": "Failed to get valid project path",
-  "errorRunningMigrate": "Error running migrate %s",
+  "errorRunningMigrate": "Migration process failed reason : %s",
   "couldNotEnableOmniPreferences": "Could not enable Omni preferences: %s",
   "errorSettingDesignersToStandardDataModel": "Error occurred while setting designers to use the standard data model %s",
   "exceptionSettingDesignersToStandardDataModel": "Exception occurred while setting designers to use the standard data model %s",
@@ -67,7 +66,7 @@
   "migrationCompleted": "Migration completed: %s",
   "migrationFailed": "Migration failed: %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 %s to migrate",
   "foundGlobalAutoNumbersToMigrate": "Found %s GlobalAutoNumbers to migrate",
@@ -97,7 +96,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",
@@ -117,7 +116,6 @@
   "labelStatusFailed": "Failed",
   "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?",
   "foundFlexiPages": "Found %s FlexiPages to migrate",
   "migratingFlexiPages": "Migrating FlexiPages",
   "completedProcessingAllFlexiPages": "Completed processing all flexipage files. Total processed: %s",
@@ -217,5 +215,8 @@
   "skipFlexcardAngularOmniScriptDependencyWarning": "Skipping FlexCard %s due to Angular OmniScript dependencies",
   "flexCardMigrationProcessingMessage": "Processing %s FlexCards for migration (%s skipped due to Angular dependencies)",
   "noMetadataToDeploy": "No metadata to deploy",
-  "manifestDeployementStarted": "Manifest deployment started with id: %s"
+  "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"
 }

package.json

@@ -15,10 +15,10 @@
     "@types/jsdom": "^21.1.7",
     "@types/lodash.chunk": "^4.2.9",
     "@types/shelljs": "^0.8.15",
-    "jsdom": "^25.0.0",
-    "lodash.chunk": "^4.2.0",
     "cli-progress": "^3.12.0",
     "diff": "^5.1.0",
+    "jsdom": "^25.0.0",
+    "lodash.chunk": "^4.2.0",
     "open": "^8.4.2",
     "shelljs": "^0.8.5",
     "tslib": "^2",

src/commands/omnistudio/migration/assess.ts

@@ -5,6 +5,7 @@ import OmniStudioBaseCommand from '../../basecommand';
 import { AssessmentInfo } from '../../../utils/interfaces';
 import { AssessmentReporter } from '../../../utils/resultsbuilder/assessmentReporter';
 import { OmniScriptExportType, OmniScriptMigrationTool } from '../../../migration/omniscript';
+import { InvalidEntityTypeError } from '../../../migration/interfaces';
 import { CardMigrationTool } from '../../../migration/flexcard';
 import { DataRaptorMigrationTool } from '../../../migration/dataraptor';
 import { GlobalAutoNumberMigrationTool } from '../../../migration/globalautonumber';
@@ -54,8 +55,9 @@ export default class Assess extends OmniStudioBaseCommand {
     try {
       // eslint-disable-next-line @typescript-eslint/no-unsafe-return
       return await this.runAssess();
-    } catch (error) {
-      Logger.error(messages.getMessage('errorRunningAssess'), error);
+    } catch (e) {
+      const error = e as Error;
+      Logger.error(messages.getMessage('errorRunningAssess', [error.message]), error);
       process.exit(1);
     }
   }
@@ -71,12 +73,10 @@ export default class Assess extends OmniStudioBaseCommand {
     let objectsToProcess: string[];
     // To-Do: Add LWC to valid options when GA is released
     const validOptions = [Constants.Apex, Constants.ExpSites, Constants.FlexiPage, Constants.LWC];
-
     const apiVersion = conn.getApiVersion();
+    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn);
 
-    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn, this.flags.namespace);
-
-    if (!orgs.hasValidNamespace && this.flags.namespace) {
+    if (!orgs.hasValidNamespace) {
       Logger.warn(messages.getMessage('invalidNamespace') + orgs.packageDetails.namespace);
     }
 
@@ -126,9 +126,17 @@ export default class Assess extends OmniStudioBaseCommand {
     try {
       // Assess OmniStudio components
       await this.assessOmniStudioComponents(assesmentInfo, assessOnly, namespace, conn, allVersions);
-    } catch (error) {
-      Logger.error(`Cannot assess OmniStudio components within ${namespace}`);
-      process.exit(1);
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    } catch (ex: any) {
+      if (ex instanceof InvalidEntityTypeError) {
+        Logger.error(messages.getMessage('invalidTypeAssessErrorMessage', [namespace]));
+        process.exit(1);
+      }
+
+      if (ex instanceof Error) {
+        Logger.error(messages.getMessage('errorRunningAssess', [ex.message]));
+        process.exit(1);
+      }
     }
 
     // Assess related objects if specified

src/commands/omnistudio/migration/migrate.ts

@@ -73,7 +73,7 @@ export default class Migrate extends OmniStudioBaseCommand {
       return await this.runMigration();
     } catch (e) {
       const error = e as Error;
-      Logger.error(messages.getMessage('errorRunningMigrate'), error);
+      Logger.error(messages.getMessage('errorRunningMigrate', [error.message]));
       process.exit(1);
     }
   }
@@ -85,12 +85,11 @@ export default class Migrate extends OmniStudioBaseCommand {
     const relatedObjects = (this.flags.relatedobjects || '') as string;
     // this.org is guaranteed because requiresUsername=true, as opposed to supportsUsername
     const conn = this.org.getConnection();
-
     const apiVersion = conn.getApiVersion();
 
-    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn, this.flags.namespace);
+    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn);
 
-    if (!orgs.hasValidNamespace && this.flags.namespace) {
+    if (!orgs.hasValidNamespace) {
       Logger.warn(messages.getMessage('invalidNamespace') + orgs.packageDetails.namespace);
     }
 
@@ -174,9 +173,14 @@ export default class Migrate extends OmniStudioBaseCommand {
     let objectMigrationResults = await this.truncateObjects([...migrationObjects].reverse(), debugTimer);
     const allTruncateComplete = objectMigrationResults.length === 0;
 
+    // Log truncation errors if any exist
+    if (!allTruncateComplete) {
+      this.logTruncationErrors(objectMigrationResults);
+      return;
+    }
+
     if (allTruncateComplete) {
-      // Migrate in correct dependency order (NOT reversed)
-      objectMigrationResults = await this.migrateObjects(migrationObjects, debugTimer);
+      objectMigrationResults = await this.migrateObjects(migrationObjects, debugTimer, namespace);
     }
 
     const omnistudioRelatedObjectsMigration = new OmnistudioRelatedObjectMigrationFacade(
@@ -351,7 +355,11 @@ export default class Migrate extends OmniStudioBaseCommand {
     return objectMigrationResults;
   }
 
-  private async migrateObjects(migrationObjects: MigrationTool[], debugTimer: DebugTimer): Promise<MigratedObject[]> {
+  private async migrateObjects(
+    migrationObjects: MigrationTool[],
+    debugTimer: DebugTimer,
+    namespace: string
+  ): Promise<MigratedObject[]> {
     let objectMigrationResults: MigratedObject[] = [];
     // Migrate in correct dependency order
     for (const cls of migrationObjects) {
@@ -375,7 +383,7 @@ export default class Migrate extends OmniStudioBaseCommand {
         );
       } catch (ex: any) {
         if (ex instanceof InvalidEntityTypeError) {
-          Logger.error(ex.message);
+          Logger.error(messages.getMessage('invalidTypeMigrateErrorMessage', [namespace]));
           process.exit(1);
         }
         const errMsg = ex instanceof Error ? ex.message : String(ex);
@@ -672,4 +680,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

@@ -8,7 +8,7 @@ import { Logger } from '../utils/logger';
 import { TransformData, UploadRecordResult } from './interfaces';
 import { NameMappingRegistry } from './NameMappingRegistry';
 
-export type ComponentType = 'Data Mapper' | 'Flexcard' | 'Omniscripts' | 'Integration Procedures' | 'GlobalAutoNumber';
+export type ComponentType = 'DataMappers' | 'Flexcards' | 'Omniscripts' | 'Integration Procedures' | 'GlobalAutoNumber';
 export type RelatedObjectType = 'Flexipage' | 'ExperienceSites' | 'Lightning Web Components' | 'Apex Classes';
 
 /**