Merge pull request #336 from snehaljha-sf/only-labels

@W-19050490: Report labels and error handling

Author: snehaljha-sf

messages/assess.json

@@ -13,7 +13,7 @@
   "onlyFlagDescription": "Migrate a single element: os | ip | fc | dr",
   "invalidOnlyFlag": "Invalid flag, valid options are: os | ip | fc | dr",
   "couldNotDeactivateOmniProcesses": "Could not deactivate current OmniProcesses",
-  "couldNotTruncate": "Could not truncate {0}",
+  "couldNotTruncate": "Could not truncate %s",
   "couldNotTruncateOmnniProcess": "Could not truncate OmniProcess. Please make sure your OS/IP is not referenced in an OmniScrirpt or Flex Card.",
   "invalidNameTypeSubtypeOrLanguage": "Not a valid Name, Type, SubType or Language",
   "invalidOrRepeatingOmniscriptElementNames": "Invalid or Repeating Element Names for Same OmniScript",
@@ -79,21 +79,21 @@
   "processingLwcsForAssessment": "Processing LWCs for assessment",
   "successfullyProcessedLwcsForAssessment": "Successfully processed %s LWCs for assessment",
   "lwcAssessmentResults": "LWC assessment results: %s",
-  "errorReadingFiles": "Error in reading files: %s",
-  "errorProcessingFiles": "Error in processing files: %s",
+  "errorReadingFiles": "Error in reading files",
+  "errorProcessingFiles": "Error in processing files",
   "startingProcessRelatedObjects": "Starting processRelatedObjects for %s in project path: %s",
   "errorProcessingApexFile": "Error processing Apex file: %s",
   "fileUpdatedToAllowRemoteCalls": "File will be updated to allow remote calls",
   "fileUpdatedToAllowCalls": "File will be updated to allow calls",
   "fileImplementsVlocityOpenInterface": "File %s implements VlocityOpenInterface no changes will be applied",
   "methodCallBundleNameUpdated": "Method call bundle name will be updated in %s for class %s method %s",
-  "cardNameChangeMessage": "Card name will be changed from {0} to {1} to follow API naming standards",
-  "authordNameChangeMessage": "Author name will be changed from {0} to {1} to follow API naming standards",
-  "omniScriptNameChangeMessage": "OmniScript reference part {0} will be changed to {1} during migration.",
-  "dataRaptorNameChangeMessage": "DataRaptor reference {0} will be changed to {1} during migration.",
-  "integrationProcedureNameChangeMessage": "Integration Procedure reference {0} will be changed to {1} during migration.",
-  "integrationProcedureManualUpdateMessage": "Integration Procedure reference {0} may need manual updates after migration.",
-  "duplicateCardNameMessage": "Potential duplicate: Another card has the same name {0} after name cleaning. This may cause conflicts during migration",
+  "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.",
+  "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",
   "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:",
   "invalidProjectFolderPath": "Provided project folder does not exist. Please provide a valid project folder path",
@@ -107,12 +107,12 @@
   "failedToGetValidProjectPath": "Failed to get valid project path",
   "errorRunningAssess": "Error running assess",
   "enableVerboseOutput": "Enable verbose output",
-  "apexFileChangesIdentifiedNotApplied": "Changes identified for Apex class {0} but not applied (assessment mode)",
-  "apexFileHasMultipleInterfaces": "File {0} has multiple interfaces including Callable, standardizing to System.Callable only",
-  "apexFileImplementsVlocityOpenInterface2": "File {0} implements VlocityOpenInterface2, replacing with System.Callable",
+  "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",
+  "apexFileImplementsVlocityOpenInterface2": "File %s implements VlocityOpenInterface2, replacing with System.Callable",
   "errorParsingHtmlTemplate": "Error while parsing template",
   "errorParsingData": "Error while parsing data for template",
-  "errorGeneratingHTML": "Error while generating HTML from template for {} with properties {}",
+  "errorGeneratingHTML": "Error while generating HTML from template for %s with properties %s",
   "unexpectedError": "Unexpected Assessment error",
-  "errorEvaluatingExpression": "Error evaluating expression: {0}, {1}"
+  "errorEvaluatingExpression": "Error evaluating expression: %s, %s"
 }

messages/migrate.json

@@ -16,7 +16,7 @@
   "onlyFlagDescription": "Migrate a single element: os | ip | fc | dr",
   "invalidOnlyFlag": "Invalid flag, valid options are: os | ip | fc | dr",
   "couldNotDeactivateOmniProcesses": "Could not deactivate current OmniProcesses",
-  "couldNotTruncate": "Could not truncate {0}",
+  "couldNotTruncate": "Could not truncate %s",
   "couldNotTruncateOmnniProcess": "Could not truncate OmniProcess. Please make sure your OS/IP is not referenced in an OmniScrirpt or Flex Card.",
   "invalidNameTypeSubtypeOrLanguage": "Not a valid Name, Type, SubType or Language",
   "invalidOrRepeatingOmniscriptElementNames": "Invalid or Repeating Element Names for Same OmniScript",
@@ -94,20 +94,23 @@
   "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 {0} will be changed to {1} during migration.",
-  "integrationProcedureNameChangeMessage": "Integration Procedure reference {0} will be changed to {1} during migration.",
-  "integrationProcedureManualUpdateMessage": "Integration Procedure reference {0} may need manual updates after migration.",
-  "cardAuthorNameChangeMessage": "Card author name has been modified to fit naming rules: {0}",
-  "cardNameChangeMessage": "Card name has been modified to fit naming rules: {0}",
-  "duplicateCardNameMessage": "Potential duplicate: Another card has the same name {0} after name cleaning. This may cause conflicts during migration",
+  "dataRaptorNameChangeMessage": "DataRaptor 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",
+  "cardNameChangeMessage": "Card name has been modified to fit naming rules: %s",
+  "duplicateCardNameMessage": "Potential duplicate: Another card has the same name %s after name cleaning. This may cause conflicts during migration",
   "angularOmniscriptWarningMessage": " Angular OmniScript will not be migrated, please convert this to LWC based Omniscript",
-  "apexFileChangesApplied": "Applied changes to Apex class {0}",
+  "apexFileChangesApplied": "Applied changes to Apex class %s",
   "generatingComponentReports": "Generating report for components",
   "generatingRelatedObjectReports": "Generating report for related objects",
   "generatingMigrationReportDashboard": "Generating migration report dashboard",
   "errorParsingHtmlTemplate": "Error while parsing template",
   "errorParsingData": "Error while parsing data for template",
-  "errorGeneratingHTML": "Error while generating HTML from template for {} with properties {}",
-  "errorEvaluatingExpression": "Error evaluating expression: {0}, {1}",
-  "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"
+  "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"
 }

src/commands/omnistudio/migration/assess.ts

@@ -56,8 +56,7 @@ export default class Assess extends OmniStudioBaseCommand {
       // eslint-disable-next-line @typescript-eslint/no-unsafe-return
       return await this.runAssess();
     } catch (error) {
-      Logger.error(messages.getMessage('errorRunningAssess'));
-      Logger.error(error);
+      Logger.error(messages.getMessage('errorRunningAssess'), error);
       process.exit(1);
     }
   }

src/commands/omnistudio/migration/info.ts

@@ -54,8 +54,7 @@ export default class Org extends SfdxCommand {
     try {
       return await this.runInfo();
     } catch (error) {
-      Logger.error('Error running info');
-      Logger.error(error);
+      Logger.error(messages.getMessage('errorRunningInfo'), error);
       process.exit(1);
     }
   }

src/commands/omnistudio/migration/migrate.ts

@@ -73,8 +73,7 @@ export default class Migrate extends OmniStudioBaseCommand {
       return await this.runMigration();
     } catch (e) {
       const error = e as Error;
-      Logger.error(`Error running migrate ${error.message}`);
-      Logger.error(error);
+      Logger.error(messages.getMessage('errorRunningMigrate'), error);
       process.exit(1);
     }
   }
@@ -252,8 +251,7 @@ export default class Migrate extends OmniStudioBaseCommand {
           })
         );
       } catch (ex: any) {
-        Logger.error(JSON.stringify(ex));
-        Logger.error(ex.stack);
+        Logger.error('Error migrating object', ex);
         objectMigrationResults.push({
           name: cls.getName(),
           errors: [ex.message],
@@ -358,7 +356,7 @@ export default class Migrate extends OmniStudioBaseCommand {
       const obj = {
         id: record['Id'],
         name: migrationTool.getRecordName(record),
-        status: 'Skipped',
+        status: messages.getMessage('labelStatusSkipped'),
         errors: record['errors'],
         migratedId: undefined,
         warnings: [],
@@ -371,7 +369,10 @@ export default class Migrate extends OmniStudioBaseCommand {
         let errors: any[] = obj.errors || [];
         errors = errors.concat(recordResults.errors || []);
 
-        obj.status = !recordResults || recordResults.hasErrors ? 'Error' : 'Complete';
+        obj.status =
+          !recordResults || recordResults.hasErrors
+            ? messages.getMessage('labelStatusFailed')
+            : messages.getMessage('labelStatusComplete');
         obj.errors = errors;
         obj.migratedId = recordResults.id;
         obj.warnings = recordResults.warnings;

src/javascripts/reportGeneratorUtility.js

@@ -55,9 +55,7 @@ function filterAndSearchTable(tableId) {
     const visibleRows = Array.from(table.rows).filter(
       (row) => row.style.display !== 'none' && row.id !== 'no-rows-message'
     );
-    reportTable.querySelector('#row-count').textContent = `Showing ${visibleRows.length} record${
-      visibleRows.length !== 1 ? 's' : ''
-    }`;
+    reportTable.querySelector('#row-count').textContent = `Total Records: ${visibleRows.length}`;
     return;
   }
 

src/migration/dataraptor.ts

@@ -81,8 +81,7 @@ export class DataRaptorMigrationTool extends BaseMigrationTool implements Migrat
             );
             drItem[this.namespacePrefix + 'Formula__c'] = originalString;
           } catch (ex) {
-            Logger.error(JSON.stringify(ex));
-            Logger.error(ex.stack);
+            Logger.error('Error updating formula for data mapper', ex);
             Logger.logVerbose(
               this.messages.getMessage('formulaSyntaxError', [drItem[this.namespacePrefix + 'Formula__c']])
             );
@@ -216,8 +215,7 @@ export class DataRaptorMigrationTool extends BaseMigrationTool implements Migrat
       const dataRaptorAssessmentInfos = this.processDRComponents(dataRaptors);
       return dataRaptorAssessmentInfos;
     } catch (err) {
-      Logger.error(JSON.stringify(err));
-      Logger.error(err.stack);
+      Logger.error('Error assessing data mapper', err);
     }
   }
 
@@ -259,8 +257,7 @@ export class DataRaptorMigrationTool extends BaseMigrationTool implements Migrat
           apexDependencies: [],
         });
         const error = e as Error;
-        Logger.error(JSON.stringify(error));
-        Logger.error(error.stack);
+        Logger.error('Error processing data mapper', error);
       }
       progressBar.update(++progressCounter);
     }
@@ -318,8 +315,7 @@ export class DataRaptorMigrationTool extends BaseMigrationTool implements Migrat
               });
             }
           } catch (ex) {
-            Logger.error(JSON.stringify(ex));
-            Logger.error(ex.stack);
+            Logger.error('Error processing formula for data mapper', ex);
             Logger.logVerbose(this.messages.getMessage('formulaSyntaxError', [formula]));
           }
         }

src/migration/flexcard.ts

@@ -104,9 +104,7 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
       const flexCardsAssessmentInfos = this.processCardComponents(flexCards);
       return flexCardsAssessmentInfos;
     } catch (err) {
-      Logger.error(this.messages.getMessage('errorDuringFlexCardAssessment'));
-      Logger.error(JSON.stringify(err));
-      Logger.error(err.stack);
+      Logger.error(this.messages.getMessage('errorDuringFlexCardAssessment'), err);
     }
   }
 
@@ -136,8 +134,7 @@ export class CardMigrationTool extends BaseMigrationTool implements MigrationToo
           warnings: [this.messages.getMessage('unexpectedError')],
         });
         const error = e as Error;
-        Logger.error(JSON.stringify(error));
-        Logger.error(error.stack);
+        Logger.error('Error processing flex card', error);
       }
       progressBar.update(++progressCounter);
     }

src/migration/omniscript.ts

@@ -194,9 +194,7 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
       );
       return omniAssessmentInfos;
     } catch (err) {
-      Logger.error(this.messages.getMessage('errorDuringOmniScriptAssessment'));
-      Logger.error(JSON.stringify(err));
-      Logger.error(err.stack);
+      Logger.error(this.messages.getMessage('errorDuringOmniScriptAssessment'), err);
     }
   }
 
@@ -267,8 +265,7 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
           });
         }
         const error = e as Error;
-        Logger.error(JSON.stringify(error));
-        Logger.error(error.stack);
+        Logger.error('Error processing omniscripts', error);
         continue;
       }
       if (omniAssessmentInfo.type === 'OmniScript') {
@@ -557,8 +554,7 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
                 );
                 ipElement[`${this.namespacePrefix}PropertySet__c`] = originalString;
               } catch (ex) {
-                Logger.error(JSON.stringify(ex));
-                Logger.error(ex.stack);
+                Logger.error('Error processing formula for integration procedure', ex);
                 Logger.logVerbose(
                   this.messages.getMessage('formulaSyntaxError', [ipElement[`${this.namespacePrefix}PropertySet__c`]])
                 );

src/migration/related/ApexMigration.ts

@@ -105,11 +105,7 @@ export class ApexMigration extends BaseRelatedObjectMigration {
         fileAssessmentInfo.push(apexAssementInfo);
         Logger.logVerbose(assessMessages.getMessage('successfullyProcessedApexFile', [file.name]));
       } catch (err) {
-        Logger.error(assessMessages.getMessage('errorProcessingApexFile', [file.name]));
-        Logger.error(JSON.stringify(err));
-        if (err instanceof Error) {
-          Logger.error(err.stack);
-        }
+        Logger.error(assessMessages.getMessage('errorProcessingApexFile', [file.name]), err);
       }
       Logger.logVerbose(assessMessages.getMessage('successfullyProcessedApexFile', [file.name]));
     }