feat: messages and other fixes

Author: snehaljha-sf

messages/assess.json

@@ -90,5 +90,13 @@
   "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."
+  "integrationProcedureManualUpdateMessage": "Integration Procedure reference {0} may need manual updates after migration.",
+  "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",
+  "errorParsingHtmlTemplate": "Error while parsing template",
+  "errorParsingData": "Error while parsing data for template",
+  "errorGeneratingHTML": "Error while generating HTML from template for {} with properties {}",
+  "unexpectedError": "Unexpected Assessment error",
+  "errorEvaluatingExpression": "Error evaluating expression: {0}, {1}"
 }

messages/migrate.json

@@ -79,5 +79,13 @@
   "alreadyStandardModel": "The org is already on standard data model.",
   "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"
+  "duplicateCardNameMessage": "Potential duplicate: Another card has the same name {0} after name cleaning. This may cause conflicts during migration",
+  "apexFileChangesApplied": "Applied changes to Apex class {0}",
+  "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}"
 }

src/migration/related/ApexMigration.ts

@@ -151,9 +151,9 @@ export class ApexMigration extends BaseRelatedObjectMigration {
       // Only write file changes if we're in migration mode, not assessment mode
       if (type === 'migration') {
         fs.writeFileSync(file.location, updatedContent);
-        Logger.logger.info(`Applied changes to Apex class ${file.name}`);
+        Logger.logger.info(migrateMessages.getMessage('apexFileChangesApplied', [file.name]));
       } else {
-        Logger.logger.info(`Changes identified for Apex class ${file.name} but not applied (assessment mode)`);
+        Logger.logger.info(assessMessages.getMessage('apexFileChangesIdentifiedNotApplied', [file.name]));
       }
       difference = new FileDiffUtil().getFileDiff(file.name, fileContent, updatedContent);
     }
@@ -182,16 +182,14 @@ export class ApexMigration extends BaseRelatedObjectMigration {
 
     // Case 2: Already implements multiple interfaces including Callable - keep only System.Callable
     if (implementsInterface.has(this.callableInterface) && implementsInterface.size > 1) {
-      Logger.logger.info(
-        `File ${file.name} has multiple interfaces including Callable, standardizing to System.Callable only`
-      );
+      Logger.logger.info(assessMessages.getMessage('apexFileHasMultipleInterfaces', [file.name]));
       // We need to identify the entire implements clause and replace it
       return this.replaceAllInterfaces(implementsInterface, tokenUpdates, parser, file.name);
     }
 
     // Case 3: Implements VlocityOpenInterface2 - replace with System.Callable
     if (implementsInterface.has(this.vlocityOpenInterface2)) {
-      Logger.logger.info(`File ${file.name} implements VlocityOpenInterface2, replacing with System.Callable`);
+      Logger.logger.info(assessMessages.getMessage('apexFileImplementsVlocityOpenInterface2', [file.name]));
       const tokens = implementsInterface.get(this.vlocityOpenInterface2);
       tokenUpdates.push(new RangeTokenUpdate(CALLABLE, tokens[0], tokens[1]));
       tokenUpdates.push(new InsertAfterTokenUpdate(this.callMethodBody(), parser.classDeclaration));
@@ -242,7 +240,7 @@ export class ApexMigration extends BaseRelatedObjectMigration {
       if (!parser.hasCallMethodImplemented) {
         tokenUpdates.push(new InsertAfterTokenUpdate(this.callMethodBody(), parser.classDeclaration));
       } else {
-        Logger.logger.info(`File ${fileName} already has a call() method, not adding`);
+        Logger.logger.info(assessMessages.getMessage('apexFileAlreadyHasCallMethod', [fileName]));
       }
     }
 

src/utils/resultsbuilder/IPAssessmentReporter.ts

@@ -138,7 +138,7 @@ export class IPAssessmentReporter {
             rowspan: 2,
           },
           {
-            name: 'Data Mapper Dependencies',
+            name: 'Remote Action Dependencies',
             colspan: 1,
             rowspan: 2,
           },

src/utils/resultsbuilder/assessmentReporter.ts

@@ -1,7 +1,9 @@
 /* eslint-disable prettier/prettier */
 /* eslint-disable @typescript-eslint/restrict-template-expressions */
 import fs from 'fs';
+import path from 'path';
 import open from 'open';
+import { Messages } from '@salesforce/core';
 import { AssessmentInfo } from '../interfaces';
 import { DashboardParam } from '../reportGenerator/reportInterfaces';
 import { OmnistudioOrgDetails } from '../orgUtils';
@@ -16,22 +18,23 @@ import { DRAssessmentReporter } from './DRAssessmentReporter';
 import { FlexcardAssessmentReporter } from './FlexcardAssessmentReporter';
 
 export class AssessmentReporter {
-  private static basePath = process.cwd() + '/assessment_reports';
-  private static omniscriptAssessmentFilePath = this.basePath + '/omniscript_assessment.html';
-  private static flexcardAssessmentFilePath = this.basePath + '/flexcard_assessment.html';
-  private static integrationProcedureAssessmentFilePath = this.basePath + '/integration_procedure_assessment.html';
-  private static dataMapperAssessmentFilePath = this.basePath + '/datamapper_assessment.html';
-  private static apexAssessmentFilePath = this.basePath + '/apex_assessment.html';
-  private static dashboardFilePath = this.basePath + '/dashboard.html';
-  private static dashboardTemplate = process.cwd() + '/src/templates/dashboard.template';
+  private static basePath = path.join(process.cwd(), 'assessment_reports');
+  private static omniscriptAssessmentFileName = 'omniscript_assessment.html';
+  private static flexcardAssessmentFileName = 'flexcard_assessment.html';
+  private static integrationProcedureAssessmentFileName = 'integration_procedure_assessment.html';
+  private static dataMapperAssessmentFileName = 'datamapper_assessment.html';
+  private static apexAssessmentFileName = 'apex_assessment.html';
+  private static dashboardFileName = 'dashboard.html';
+  private static dashboardTemplate = path.join(process.cwd(), 'src/templates/dashboard.template');
   // TODO: Uncomment code once MVP for migration is completed
   // private static lwcAssessmentFilePath = this.basePath + '/lwc_assessment.html';
   public static async generate(
     result: AssessmentInfo,
     instanceUrl: string,
     omnistudioOrgDetails: OmnistudioOrgDetails,
     assessOnly: string,
-    relatedObjects: string[]
+    relatedObjects: string[],
+    messages: Messages
   ): Promise<void> {
     fs.mkdirSync(this.basePath, { recursive: true });
 
@@ -41,33 +44,36 @@ export class AssessmentReporter {
     );
     if (!assessOnly) {
       this.createDocument(
-        this.omniscriptAssessmentFilePath,
+        path.join(this.basePath, this.omniscriptAssessmentFileName),
         TemplateParser.generate(
           assessmentReportTemplate,
           OSAssessmentReporter.getOmniscriptAssessmentData(
             result.omniAssessmentInfo.osAssessmentInfos,
             instanceUrl,
             omnistudioOrgDetails
-          )
+          ),
+          messages
         )
       );
 
       this.createDocument(
-        this.flexcardAssessmentFilePath,
+        path.join(this.basePath, this.flexcardAssessmentFileName),
         TemplateParser.generate(
           assessmentReportTemplate,
           FlexcardAssessmentReporter.getFlexcardAssessmentData(
             result.flexCardAssessmentInfos,
             instanceUrl,
             omnistudioOrgDetails
-          )
+          ),
+          messages
         )
       );
       this.createDocument(
-        this.apexAssessmentFilePath,
+        path.join(this.basePath, this.apexAssessmentFileName),
         TemplateParser.generate(
           assessmentReportTemplate,
-          ApexAssessmentReporter.getApexAssessmentData(result.apexAssessmentInfos, omnistudioOrgDetails)
+          ApexAssessmentReporter.getApexAssessmentData(result.apexAssessmentInfos, omnistudioOrgDetails),
+          messages
         )
       );
 
@@ -77,82 +83,88 @@ export class AssessmentReporter {
       // );
 
       this.createDocument(
-        this.integrationProcedureAssessmentFilePath,
+        path.join(this.basePath, this.integrationProcedureAssessmentFileName),
         TemplateParser.generate(
           assessmentReportTemplate,
           IPAssessmentReporter.getIntegrationProcedureAssessmentData(
             result.omniAssessmentInfo.ipAssessmentInfos,
             instanceUrl,
             omnistudioOrgDetails
-          )
+          ),
+          messages
         )
       );
 
       this.createDocument(
-        this.dataMapperAssessmentFilePath,
+        path.join(this.basePath, this.dataMapperAssessmentFileName),
         TemplateParser.generate(
           assessmentReportTemplate,
           DRAssessmentReporter.getDatamapperAssessmentData(
             result.dataRaptorAssessmentInfos,
             instanceUrl,
             omnistudioOrgDetails
-          )
+          ),
+          messages
         )
       );
     } else {
       switch (assessOnly) {
         case Constants.Omniscript:
           this.createDocument(
-            this.omniscriptAssessmentFilePath,
+            path.join(this.basePath, this.omniscriptAssessmentFileName),
             TemplateParser.generate(
               assessmentReportTemplate,
               OSAssessmentReporter.getOmniscriptAssessmentData(
                 result.omniAssessmentInfo.osAssessmentInfos,
                 instanceUrl,
                 omnistudioOrgDetails
-              )
+              ),
+              messages
             )
           );
           break;
 
         case Constants.Flexcard:
           this.createDocument(
-            this.flexcardAssessmentFilePath,
+            path.join(this.basePath, this.flexcardAssessmentFileName),
             TemplateParser.generate(
               assessmentReportTemplate,
               FlexcardAssessmentReporter.getFlexcardAssessmentData(
                 result.flexCardAssessmentInfos,
                 instanceUrl,
                 omnistudioOrgDetails
-              )
+              ),
+              messages
             )
           );
           break;
 
         case Constants.IntegrationProcedure:
           this.createDocument(
-            this.integrationProcedureAssessmentFilePath,
+            path.join(this.basePath, this.integrationProcedureAssessmentFileName),
             TemplateParser.generate(
               assessmentReportTemplate,
               IPAssessmentReporter.getIntegrationProcedureAssessmentData(
                 result.omniAssessmentInfo.ipAssessmentInfos,
                 instanceUrl,
                 omnistudioOrgDetails
-              )
+              ),
+              messages
             )
           );
           break;
 
         case Constants.DataMapper:
           this.createDocument(
-            this.dataMapperAssessmentFilePath,
+            path.join(this.basePath, this.dataMapperAssessmentFileName),
             TemplateParser.generate(
               assessmentReportTemplate,
               DRAssessmentReporter.getDatamapperAssessmentData(
                 result.dataRaptorAssessmentInfos,
                 instanceUrl,
                 omnistudioOrgDetails
-              )
+              ),
+              messages
             )
           );
           break;
@@ -163,10 +175,11 @@ export class AssessmentReporter {
 
     if (relatedObjects && relatedObjects.includes(Constants.Apex)) {
       this.createDocument(
-        this.apexAssessmentFilePath,
+        path.join(this.basePath, this.apexAssessmentFileName),
         TemplateParser.generate(
           assessmentReportTemplate,
-          ApexAssessmentReporter.getApexAssessmentData(result.apexAssessmentInfos, omnistudioOrgDetails)
+          ApexAssessmentReporter.getApexAssessmentData(result.apexAssessmentInfos, omnistudioOrgDetails),
+          messages
         )
       );
     }
@@ -179,20 +192,21 @@ export class AssessmentReporter {
     // }
 
     // await this.createMasterDocument(nameUrls, basePath);
-    this.createDashboard(this.basePath, result, omnistudioOrgDetails);
+    this.createDashboard(this.basePath, result, omnistudioOrgDetails, messages);
     pushAssestUtilites('javascripts', this.basePath);
     pushAssestUtilites('styles', this.basePath);
-    await open('file://' + this.dashboardFilePath);
+    await open(path.join(this.basePath, this.dashboardFileName));
   }
   private static createDashboard(
     basePath: string,
     result: AssessmentInfo,
-    omnistudioOrgDetails: OmnistudioOrgDetails
+    omnistudioOrgDetails: OmnistudioOrgDetails,
+    messages: Messages
   ): void {
     const dashboardTemplate = fs.readFileSync(this.dashboardTemplate, 'utf8');
     this.createDocument(
-      basePath + '/dashboard.html',
-      TemplateParser.generate(dashboardTemplate, this.createDashboardParam(result, omnistudioOrgDetails))
+      path.join(basePath, this.dashboardFileName),
+      TemplateParser.generate(dashboardTemplate, this.createDashboardParam(result, omnistudioOrgDetails), messages)
     );
   }
   private static createDashboardParam(
@@ -205,35 +219,35 @@ export class AssessmentReporter {
       org: getOrgDetailsForReport(omnistudioOrgDetails),
       assessmentDate: new Date().toISOString(),
       summaryItems: [
+        {
+          name: 'DataMapper',
+          total: result.dataRaptorAssessmentInfos.length,
+          data: DRAssessmentReporter.getSummaryData(result.dataRaptorAssessmentInfos),
+          file: this.dataMapperAssessmentFileName,
+        },
+        {
+          name: 'Integration Procedure',
+          total: result.omniAssessmentInfo.ipAssessmentInfos.length,
+          data: IPAssessmentReporter.getSummaryData(result.omniAssessmentInfo.ipAssessmentInfos),
+          file: this.integrationProcedureAssessmentFileName,
+        },
         {
           name: 'OmniScript',
           total: result.omniAssessmentInfo.osAssessmentInfos.length,
           data: OSAssessmentReporter.getSummaryData(result.omniAssessmentInfo.osAssessmentInfos),
-          file: this.omniscriptAssessmentFilePath,
+          file: this.omniscriptAssessmentFileName,
         },
         {
           name: 'Flexcard',
           total: result.flexCardAssessmentInfos.length,
           data: FlexcardAssessmentReporter.getSummaryData(result.flexCardAssessmentInfos),
-          file: this.flexcardAssessmentFilePath,
-        },
-        {
-          name: 'Integration Procedure',
-          total: result.omniAssessmentInfo.ipAssessmentInfos.length,
-          data: IPAssessmentReporter.getSummaryData(result.omniAssessmentInfo.ipAssessmentInfos),
-          file: this.integrationProcedureAssessmentFilePath,
-        },
-        {
-          name: 'DataMapper',
-          total: result.dataRaptorAssessmentInfos.length,
-          data: DRAssessmentReporter.getSummaryData(result.dataRaptorAssessmentInfos),
-          file: this.dataMapperAssessmentFilePath,
+          file: this.flexcardAssessmentFileName,
         },
         {
           name: 'Apex',
           total: result.apexAssessmentInfos.length,
           data: ApexAssessmentReporter.getSummaryData(result.apexAssessmentInfos),
-          file: this.apexAssessmentFilePath,
+          file: this.apexAssessmentFileName,
         },
       ],
     };