Merge pull request #361 from sf-kishore-kurri/u/kkurri/W-18994070

feat: @W-18994070 : Naming convention and clean of flags on assess an…

Author: snehaljha-sf

DEV.md

@@ -11,7 +11,7 @@ This repository contains the code required to enable the OmniStudio Migration As
 5. In a new command line assistant, run the following command:
 
 ```
-bin/run omnistudio:migration:migrate -u [email protected] --namespace=agarciana46_238 --json
+bin/run omnistudio:migration:migrate -u [email protected]
 ```
 
 ### Usage & parameters
@@ -22,19 +22,12 @@ USAGE
   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
 
 OPTIONS
-  -n, --namespace=namespace                                                         the namespace of the vertical package
-
   -u, --targetusername=targetusername                                               username or alias for the target
                                                                                     org; overrides default target org
 
   -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                     org; overrides default dev hub org
 
-  --apiversion=apiversion                                                           override the api version used for
-                                                                                    api requests made by this command
-
-  --json                                                                            format output as json
-
   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                     this command invocation
 

README.md

@@ -28,7 +28,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].13
+sf plugins install @salesforce/[email protected].25
 ```
 
 4. Run the Omnistudio Migration Assistant from the Salesforce CLI:
@@ -42,7 +42,7 @@ sfdx omnistudio:migration:migrate -u [email protected]
 
 
 // To migrate/assess specific components: FlexCards, DataMappers, Integration Procedures, or OmniScripts, add the following parameters:
---only=dr
+--only=dm
 --only=ip
 --only=os
 --only=fc
@@ -53,8 +53,6 @@ sfdx omnistudio:migration:migrate -u [email protected]
 // To assess specific related objects:
 --relatedobjects=apex    // for Apex classes only
 
-// To specify the Velocity Namespace (Optional)
---namespace=VLOCITY_PACKAGE_NAMESPACE
 ```
 
 5. An HTML page will be open in your default browser with the results of your migration/assessment reports.
@@ -63,23 +61,16 @@ sfdx omnistudio:migration:migrate -u [email protected]
 
 ```
 USAGE
-  $ sf omnistudio:migration:assess [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
+  $ sf omnistudio:migration:assess [-f] [-v <string>] [-u <string>] [--loglevel
   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
 
 OPTIONS
-  -n, --namespace=namespace                                                         the namespace of the vertical package
-
   -u, --targetusername=targetusername                                               username or alias for the target
                                                                                     org; overrides default target org
 
   -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                     org; overrides default dev hub org
 
-  --apiversion=apiversion                                                           override the api version used for
-                                                                                    api requests made by this command
-
-  --json                                                                            format output as json
-
   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                     this command invocation
 
@@ -98,31 +89,24 @@ OPTIONS
 
 ```
 USAGE
-  $ sf omnistudio:migration:migrate [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
+  $ sf omnistudio:migration:migrate [-f] [-v <string>] [-u <string>] [--loglevel
   trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
 
 OPTIONS
-  -n, --namespace=namespace                                                         the namespace of the vertical package
-
   -u, --targetusername=targetusername                                               username or alias for the target
                                                                                     org; overrides default target org
 
   -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                     org; overrides default dev hub org
 
-  --apiversion=apiversion                                                           override the api version used for
-                                                                                    api requests made by this command
-
-  --json                                                                            format output as json
-
   --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                     this command invocation
 
   -a, --allversions                                                                 migrate all versions and not
                                                                                     and not just the active ones.
 
   --only=only                                                                       specify components to migrate:
-                                                                                    dr (DataRaptors), ip (Integration Procedures),
+                                                                                    dm (DataMappers), ip (Integration Procedures),
                                                                                     os (OmniScripts), fc (FlexCards)
 
   --relatedobjects=relatedobjects                                                   specify related objects to assess:

command-snapshot.json

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

messages/assess.json

@@ -10,8 +10,8 @@
   "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: os | ip | fc | dr",
-  "invalidOnlyFlag": "Invalid flag, valid options are: os | ip | fc | dr",
+  "onlyFlagDescription": "Migrate a single element: os | ip | fc | dm ",
+  "invalidOnlyFlag": "Invalid flag, valid options are: os | ip | fc | dm",
   "couldNotDeactivateOmniProcesses": "Could not deactivate current OmniProcesses",
   "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.",
@@ -105,7 +105,7 @@
   "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",

messages/migrate.json

@@ -50,7 +50,7 @@
   "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",

src/commands/omnistudio/migration/assess.ts

@@ -27,10 +27,6 @@ export default class Assess extends OmniStudioBaseCommand {
   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'),
@@ -56,27 +52,23 @@ 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);
     }
   }
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public async runAssess(): Promise<any> {
     DebugTimer.getInstance().start();
-    let apiVersion = this.flags.apiversion as string;
     const allVersions = (this.flags.allversions || false) as boolean;
     const assessOnly = (this.flags.only || '') as string;
     const relatedObjects = (this.flags.relatedobjects || '') as string;
     const conn = this.org.getConnection();
 
-    if (apiVersion) {
-      conn.setApiVersion(apiVersion);
-    } else {
-      apiVersion = conn.getApiVersion();
-    }
-    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn, this.flags.namespace);
+    const apiVersion = conn.getApiVersion();
+    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn);
 
     if (!orgs.hasValidNamespace && this.flags.namespace) {
       Logger.warn(messages.getMessage('invalidNamespace') + orgs.packageDetails.namespace);
@@ -120,10 +112,14 @@ export default class Assess extends OmniStudioBaseCommand {
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } catch (ex: any) {
       if (ex instanceof InvalidEntityTypeError) {
-        Logger.error(`${messages.getMessage('invalidTypeAssessErrorMessage', [namespace])}`);
+        Logger.error(messages.getMessage('invalidTypeAssessErrorMessage', [namespace]));
+        process.exit(1);
+      }
+
+      if (ex instanceof Error) {
+        Logger.error(messages.getMessage('errorRunningAssess', [ex.message]));
         process.exit(1);
       }
-      Logger.error('Error assessing object', ex);
     }
 
     let objectsToProcess: string[];

src/commands/omnistudio/migration/migrate.ts

@@ -44,10 +44,6 @@ export default class Migrate extends OmniStudioBaseCommand {
   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'),
@@ -75,30 +71,25 @@ 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);
     }
   }
 
   // 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;
     const allVersions = this.flags.allversions || (false as boolean);
     const relatedObjects = (this.flags.relatedobjects || '') as string;
 
     // this.org is guaranteed because requiresUsername=true, as opposed to supportsUsername
     const conn = this.org.getConnection();
-    if (apiVersion) {
-      conn.setApiVersion(apiVersion);
-    } else {
-      apiVersion = conn.getApiVersion();
-    }
+    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);
     }
 

src/utils/constants/stringContants.ts

@@ -3,7 +3,7 @@ export const Constants = {
   Omniscript: 'os',
   Flexcard: 'fc',
   IntegrationProcedure: 'ip',
-  DataMapper: 'dr',
+  DataMapper: 'dm',
   LWC: 'lwc',
   Apex: 'apex',
 

src/utils/orgUtils/index.ts

@@ -287,7 +287,7 @@ export class OrgUtils {
    * @param connection - Salesforce connection object
    * @returns Promise resolving to an array of PackageDetail objects
    */
-  public static async getOrgDetails(connection: Connection, namespace: string): Promise<OmnistudioOrgDetails> {
+  public static async getOrgDetails(connection: Connection): Promise<OmnistudioOrgDetails> {
     // Query all installed packages and cast the result to InstalledPackage[]
     const allInstalledPackages = (await QueryTools.queryAll(
       connection,
@@ -309,20 +309,10 @@ export class OrgUtils {
       namespace: '',
     };
 
-    for (const pkg of allInstalledPackages) {
-      if (namespace && namespace === pkg.NamespacePrefix) {
-        packageDetails.version = `${pkg.MajorVersion}.${pkg.MinorVersion}`;
-        packageDetails.namespace = pkg.NamespacePrefix;
-        break;
-      }
-    }
     const installedOmniPackages = [];
-    if (packageDetails.namespace === '') {
-      hasValidNamespace = false;
-      for (const pkg of allInstalledPackages) {
-        if ((namespace && namespace === pkg.NamespacePrefix) || this.namespaces.has(pkg.NamespacePrefix)) {
-          installedOmniPackages.push(pkg);
-        }
+    for (const pkg of allInstalledPackages) {
+      if (this.namespaces.has(pkg.NamespacePrefix)) {
+        installedOmniPackages.push(pkg);
       }
     }