Merge pull request #246 from salesforcecli/u/abhinavkumar2/W-16276171

U/abhinavkumar2/w 16276171

Author: AbhinavKumar-sf

.gitignore

@@ -43,3 +43,5 @@ out.log
 migrationresults.html
 
 oclif.manifest.json
+omnistudio_migration
+

command-snapshot.json

@@ -1,20 +1,55 @@
 [
-  {
-    "command": "basecommand",
-    "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-    "flags": ["apiversion", "json", "loglevel", "targetusername"],
-    "alias": []
-  },
-  {
-    "command": "omnistudio:migration:info",
-    "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-    "flags": ["allversions", "apiversion", "json", "loglevel", "name", "targetdevhubusername", "targetusername"],
-    "alias": []
-  },
-  {
-    "command": "omnistudio:migration:migrate",
-    "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-    "flags": ["allversions", "apiversion", "json", "loglevel", "namespace", "only", "targetusername"],
-    "alias": []
-  }
-]
+    {
+        "command": "basecommand",
+        "plugin": "@salesforce/plugin-omnistudio-migration-tool",
+        "flags": [
+            "apiversion",
+            "json",
+            "loglevel",
+            "targetusername"
+        ],
+        "alias": []
+    },
+    {
+        "command": "omnistudio:migration:assess",
+        "plugin": "@salesforce/plugin-omnistudio-migration-tool",
+        "flags": [
+            "allversions",
+            "apiversion",
+            "json",
+            "loglevel",
+            "namespace",
+            "only",
+            "targetusername"
+        ],
+        "alias": []
+    },
+    {
+        "command": "omnistudio:migration:info",
+        "plugin": "@salesforce/plugin-omnistudio-migration-tool",
+        "flags": [
+            "allversions",
+            "apiversion",
+            "json",
+            "loglevel",
+            "name",
+            "targetdevhubusername",
+            "targetusername"
+        ],
+        "alias": []
+    },
+    {
+        "command": "omnistudio:migration:migrate",
+        "plugin": "@salesforce/plugin-omnistudio-migration-tool",
+        "flags": [
+            "allversions",
+            "apiversion",
+            "json",
+            "loglevel",
+            "namespace",
+            "only",
+            "targetusername"
+        ],
+        "alias": []
+    }
+]

messages/assess.json

@@ -0,0 +1,29 @@
+{
+  "examples": [
+    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE",
+    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=dr",
+    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=ip",
+    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=os",
+    "omnistudio:migration:assess -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=fc"
+  ],
+  "commandDescription": "print a greeting and your org IDs",
+  "namespaceFlagDescription": "The namespaced of the package",
+  "apiVersionFlagDescription": "The Salesforce API version to use",
+  "errorNoOrgResults": "No results found for the org '%s'.",
+  "onlyFlagDescription": "Migrate a single element: osip | fc | dr",
+  "invalidOnlyFlag": "Invalid flag, valid options are: osip | fc | dr",
+  "couldNotDeactivateOmniProcesses": "Could not deactivate current OmniProcesses",
+  "couldNotTruncate": "Could not truncate {0}",
+  "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",
+  "invalidDataRaptorName": "Invalid name, can not have special characters",
+  "duplicatedCardName": "Duplicated Flex Card name",
+  "duplicatedDrName": "Duplicated DataRaptor name",
+  "duplicatedOSName": "Duplicated OmniScript name",
+  "errorWhileActivatingOs": "Could not activate OmniScript / Integration Procedure: ",
+  "errorWhileActivatingCard": "Could not activate Card: ",
+  "errorWhileUploadingCard": "An error ocurred while uploading Card: ",
+  "errorWhileCreatingElements": "An error ocurred while saving OmniScript elements: ",
+  "allVersionsDescription": "Migrate all versions of a component"
+}

package.json

@@ -36,6 +36,7 @@
     "@salesforce/ts-sinon": "^1",
     "@types/babel__traverse": "^7.20.6",
     "@types/jsforce": "^1.11.5",
+    "@types/mocha": "^10.0.8",
     "@typescript-eslint/eslint-plugin": "^4.2.0",
     "@typescript-eslint/parser": "^4.2.0",
     "chai": "^4.4.1",

src/commands/omnistudio/migration/OmnistudioRelatedObjectMigrationFacade.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/member-ordering */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -69,7 +70,6 @@ export default class OmnistudioRelatedObjectMigrationFacade {
         migrationTool.migrateRelatedObjects(null, null);
       } catch (Error) {
         // Log the error
-        Logger.ux.error(Error.message);
         Logger.logger.error(Error.message);
         return { migrationResult };
       }

src/commands/omnistudio/migration/assess.ts

@@ -0,0 +1,57 @@
+import * as os from 'os';
+import { flags } from '@salesforce/command';
+import { Messages } from '@salesforce/core';
+import OmniStudioBaseCommand from '../../basecommand';
+import { AssessmentInfo } from '../../../utils/interfaces';
+import { AssessmentReporter } from '../../../utils/resultsbuilder/assessmentReporter';
+import { LwcMigration } from '../../../migration/related/LwcMigration';
+import { ApexMigration } from '../../../migration/related/ApexMigration';
+import { Logger } from '../../../utils/logger';
+import OmnistudioRelatedObjectMigrationFacade from './OmnistudioRelatedObjectMigrationFacade';
+
+Messages.importMessagesDirectory(__dirname);
+const messages = Messages.loadMessages('@salesforce/plugin-omnistudio-migration-tool', 'assess');
+
+export default class Assess extends OmniStudioBaseCommand {
+  public static description = messages.getMessage('commandDescription');
+
+  public static examples = messages.getMessage('examples').split(os.EOL);
+
+  public static args = [{ name: 'file' }];
+
+  protected static flagsConfig = {
+    namespace: flags.string({
+      char: 'n',
+      description: messages.getMessage('namespaceFlagDescription'),
+    }),
+    only: flags.string({
+      char: 'o',
+      description: messages.getMessage('onlyFlagDescription'),
+    }),
+    allversions: flags.boolean({
+      char: 'a',
+      description: messages.getMessage('allVersionsDescription'),
+      required: false,
+    }),
+  };
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  public async run(): Promise<any> {
+    const namespace = (this.flags.namespace || 'vlocity_ins') as string;
+    const apiVersion = (this.flags.apiversion || '55.0') as string;
+    const conn = this.org.getConnection();
+    Logger.initialiseLogger(this.ux, this.logger);
+    const projectDirectory = OmnistudioRelatedObjectMigrationFacade.intializeProject();
+    conn.setApiVersion(apiVersion);
+    const lwcparser = new LwcMigration(projectDirectory, namespace, this.org);
+    const apexMigrator = new ApexMigration(projectDirectory, namespace, this.org);
+    this.logger.info(namespace);
+    this.ux.log(`Using Namespace: ${namespace}`);
+    const assesmentInfo: AssessmentInfo = {
+      lwcAssessmentInfos: lwcparser.assessment(),
+      apexAssessmentInfos: apexMigrator.assess(),
+    };
+    await AssessmentReporter.generate(assesmentInfo, conn.instanceUrl);
+    return assesmentInfo;
+  }
+}

src/migration/related/ApexMigration.ts

@@ -16,6 +16,8 @@ import { MigrationResult, RelatedObjectsMigrate } from '../interfaces';
 import { sfProject } from '../../utils/sfcli/project/sfProject';
 import { fileutil, File } from '../../utils/file/fileutil';
 import { Logger } from '../../utils/logger';
+import { ApexAssessmentInfo } from '../../utils';
+import { FileDiffUtil } from '../../utils/lwcparser/fileutils/FileDiffUtil';
 import { BaseRelatedObjectMigration } from './BaseRealtedObjectMigration';
 
 const APEXCLASS = 'Apexclass';
@@ -50,23 +52,36 @@ export class ApexMigration extends BaseRelatedObjectMigration implements Related
     sfProject.deploy(APEXCLASS, targetOrg.getUsername());
     shell.cd(pwd);
   }
-  public processApexFiles(dir: string): File[] {
+
+  public assess(): ApexAssessmentInfo[] {
+    const pwd = shell.pwd();
+    shell.cd(this.projectPath);
+    const targetOrg: Org = this.org;
+    sfProject.retrieve(APEXCLASS, targetOrg.getUsername());
+    const apexAssessmentInfos = this.processApexFiles(this.projectPath);
+    shell.cd(pwd);
+    return apexAssessmentInfos;
+  }
+  public processApexFiles(dir: string): ApexAssessmentInfo[] {
     dir += APEX_CLASS_PATH;
     let files: File[] = [];
     files = fileutil.readFilesSync(dir);
+    const fileAssessmentInfo: ApexAssessmentInfo[] = [];
     for (const file of files) {
       if (file.ext !== '.cls') continue;
       try {
-        this.processApexFile(file);
+        const apexAssementInfo = this.processApexFile(file);
+        if (apexAssementInfo && apexAssementInfo.diff && apexAssementInfo.diff.length === 0) continue;
+        fileAssessmentInfo.push(apexAssementInfo);
       } catch (err) {
         Logger.logger.error(`Error processing ${file.name}`);
         Logger.logger.error(err);
       }
     }
-    return files;
+    return fileAssessmentInfo;
   }
 
-  public processApexFile(file: File): void {
+  public processApexFile(file: File): ApexAssessmentInfo {
     const fileContent = fs.readFileSync(file.location, 'utf8');
     const interfaces: InterfaceImplements[] = [];
     interfaces.push(this.vlocityOpenInterface, this.vlocityOpenInterface2, this.callableInterface);
@@ -95,11 +110,26 @@ export class ApexMigration extends BaseRelatedObjectMigration implements Related
       updateMessages.push('File has been updated to allow calls to Omnistudio components');
       tokenUpdates.push(...tokeUpdatesForMethodCalls);
     }
+    let difference = '';
     if (tokenUpdates && tokenUpdates.length > 0) {
+      const updatedContent = parser.rewrite(tokenUpdates);
       fs.writeFileSync(file.location, parser.rewrite(tokenUpdates));
+      difference = new FileDiffUtil().getFileDiff(file.name, fileContent, updatedContent);
+    }
+    if (updateMessages.length === 0) {
+      Logger.logger.info(
+        `File ${file.name} does not have any omnistudio calls or remote calls. No changes will be applied.`
+      );
     }
     const warningMessage: string[] = this.processNonReplacableMethodCalls(file, parser);
     Logger.logger.warn(warningMessage);
+    return {
+      name: file.name,
+      warnings: warningMessage,
+      infos: updateMessages,
+      path: file.location,
+      diff: difference,
+    };
   }
 
   private processApexFileForRemotecalls(file: File, parser: ApexASTParser): TokenUpdater[] {