Merge pull request #326 from mdmehran-qureshi/prerelease/alpha

Project directory enhancement in Migrate mode

Author: mdmehran-qureshi

messages/assess.json

@@ -104,6 +104,8 @@
   "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",
   "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",

messages/migrate.json

@@ -36,9 +36,24 @@
   "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.",
-  "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]",
+  "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:",
+  "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:",
+  "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",
+  "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",
   "projectPathConfirmation": "Do you have a sfdc project where %s files are already retrieved from org - y\nor you want tool to create a project omnistudio_migration in current directory for processing - n ? [y/n]",
   "enterProjectPath": "Enter the project path for processing %s :",
   "projectJsonNotFound": "Could not find any %s in  %s.",

src/commands/omnistudio/migration/assess.ts

@@ -1,6 +1,4 @@
 import * as os from 'os';
-import * as path from 'path';
-import * as fs from 'fs';
 import { flags } from '@salesforce/command';
 import { Messages, Connection } from '@salesforce/core';
 import OmniStudioBaseCommand from '../../basecommand';
@@ -15,31 +13,11 @@ import OmnistudioRelatedObjectMigrationFacade from '../../../migration/related/O
 import { OmnistudioOrgDetails, OrgUtils } from '../../../utils/orgUtils';
 import { OrgPreferences } from '../../../utils/orgPreferences';
 import { Constants } from '../../../utils/constants/stringContants';
-import { sfProject } from '../../../utils/sfcli/project/sfProject';
-import { PromptUtil } from '../../../utils/promptUtil';
+import { ProjectPathUtil } from '../../../utils/projectPathUtil';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-omnistudio-migration-tool', 'assess');
 
-const EXISTING_MODE = 'existing';
-const EMPTY_MODE = 'empty';
-const YES_SHORT = 'y';
-const NO_SHORT = 'n';
-const YES_LONG = 'yes';
-const NO_LONG = 'no';
-
-// Helper to create SFDX project if needed
-function createSfdxProject(folderPath: string): void {
-  const projectName = path.basename(folderPath);
-  const parentDir = path.dirname(folderPath);
-  sfProject.create(projectName, parentDir);
-}
-
-function isSfdxProject(folderPath: string): boolean {
-  const sfdxProjectJson = path.join(folderPath, 'sfdx-project.json');
-  return fs.existsSync(sfdxProjectJson);
-}
-
 export default class Assess extends OmniStudioBaseCommand {
   public static description = messages.getMessage('commandDescription');
 
@@ -78,7 +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('Error running assess');
+      Logger.error(messages.getMessage('errorRunningAssess'));
       Logger.error(error);
       process.exit(1);
     }
@@ -116,7 +94,7 @@ export default class Assess extends OmniStudioBaseCommand {
     const namespace = orgs.packageDetails.namespace;
     let projectPath = '';
     if (relatedObjects) {
-      projectPath = await this.getProjectPath();
+      projectPath = await ProjectPathUtil.getProjectPath(messages, true);
     }
 
     const assesmentInfo: AssessmentInfo = {
@@ -252,74 +230,4 @@ export default class Assess extends OmniStudioBaseCommand {
     );
     Logger.log(messages.getMessage('omniScriptAssessmentCompleted'));
   }
-
-  private async getProjectPath(): Promise<string> {
-    let projectPath = '';
-    let mode: string = EXISTING_MODE;
-
-    // Prompt for project type
-    const askWithTimeout = PromptUtil.askWithTimeOut(messages);
-    // Prompt: Existing project?
-    let response = '';
-    let validResponse = false;
-
-    while (!validResponse) {
-      try {
-        const resp = await askWithTimeout(Logger.prompt.bind(Logger), messages.getMessage('existingApexPrompt'));
-        response = typeof resp === 'string' ? resp.trim().toLowerCase() : '';
-      } catch (err) {
-        Logger.error(messages.getMessage('requestTimedOut'));
-        process.exit(1);
-      }
-
-      if (response === YES_SHORT || response === YES_LONG) {
-        mode = EXISTING_MODE;
-        validResponse = true;
-      } else if (response === NO_SHORT || response === NO_LONG) {
-        mode = EMPTY_MODE;
-        validResponse = true;
-      } else {
-        Logger.error(messages.getMessage('invalidYesNoResponse'));
-      }
-    }
-
-    // Prompt for project path
-    let gotValidPath = false;
-    while (!gotValidPath) {
-      let folderPath = '';
-      try {
-        const resp = await askWithTimeout(
-          Logger.prompt.bind(Logger),
-          mode === EXISTING_MODE
-            ? messages.getMessage('enterExistingProjectPath')
-            : messages.getMessage('enterEmptyProjectPath')
-        );
-        folderPath = typeof resp === 'string' ? resp.trim() : '';
-      } catch (err) {
-        Logger.error(messages.getMessage('requestTimedOut'));
-        process.exit(1);
-      }
-      folderPath = path.resolve(folderPath);
-
-      if (!fs.existsSync(folderPath) || !fs.lstatSync(folderPath).isDirectory()) {
-        Logger.error(messages.getMessage('invalidProjectFolderPath'));
-        continue;
-      }
-      if (mode === EMPTY_MODE && fs.readdirSync(folderPath).length > 0) {
-        Logger.error(messages.getMessage('notEmptyProjectFolderPath'));
-        continue;
-      }
-      // If empty, create SFDX project
-      if (mode === EMPTY_MODE) {
-        createSfdxProject(folderPath);
-      } else if (!isSfdxProject(folderPath)) {
-        Logger.error(messages.getMessage('notSfdxProjectFolderPath'));
-        continue;
-      }
-      projectPath = folderPath;
-      gotValidPath = true;
-    }
-
-    return projectPath;
-  }
 }

src/commands/omnistudio/migration/migrate.ts

@@ -8,7 +8,6 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import * as os from 'os';
-import * as fs from 'fs';
 import { flags } from '@salesforce/command';
 import { Messages } from '@salesforce/core';
 import { ExecuteAnonymousResult } from 'jsforce';
@@ -26,6 +25,7 @@ import { OmnistudioOrgDetails, OrgUtils } from '../../../utils/orgUtils';
 import { Constants } from '../../../utils/constants/stringContants';
 import { OrgPreferences } from '../../../utils/orgPreferences';
 import { AnonymousApexRunner } from '../../../utils/apex/executor/AnonymousApexRunner';
+import { ProjectPathUtil } from '../../../utils/projectPathUtil';
 
 // Initialize Messages with the current plugin directory
 Messages.importMessagesDirectory(__dirname);
@@ -135,13 +135,11 @@ export default class Migrate extends OmniStudioBaseCommand {
           process.exit(1);
         }
       }
-      // Ask for user consent
-      const consent = await Logger.confirm(messages.getMessage('userConsentMessage'));
-      if (!consent) {
-        Logger.error(messages.getMessage('userDeclinedConsent', [relatedObjects]));
-      } else {
-        Logger.info(messages.getMessage('userConsentedToProceed'));
-        projectPath = await this.getProjectPath(relatedObjects, projectPath);
+      // Check for general consent to make modifications with OMT
+      const generalConsent = await this.getGeneralConsent();
+      if (generalConsent) {
+        // Use ProjectPathUtil for APEX project folder selection (matches assess.ts logic)
+        projectPath = await ProjectPathUtil.getProjectPath(messages, true);
         targetApexNamespace = await this.getTargetApexNamespace(objectsToProcess, targetApexNamespace);
       }
     }
@@ -333,22 +331,6 @@ export default class Migrate extends OmniStudioBaseCommand {
     return migrationObjects;
   }
 
-  private async getProjectPath(relatedObjects: string, projectPath: string): Promise<string> {
-    const projectPathConfirmation = await Logger.confirm(
-      messages.getMessage('projectPathConfirmation', [relatedObjects])
-    );
-    if (projectPathConfirmation) {
-      Logger.info(messages.getMessage('userConsentedToProceed'));
-      projectPath = await Logger.prompt(messages.getMessage('enterProjectPath', [relatedObjects]));
-      const projectJsonFile = 'sfdx-project.json';
-      if (!fs.existsSync(projectPath + '/' + projectJsonFile)) {
-        throw new Error(messages.getMessage('projectJsonNotFound', [projectJsonFile, projectPath]));
-      }
-      Logger.log(messages.getMessage('usingProjectPath', [projectPath]));
-    }
-    return projectPath;
-  }
-
   private async getTargetApexNamespace(objectsToProcess: string[], targetApexNamespace: string): Promise<string> {
     if (objectsToProcess.includes(Constants.Apex)) {
       targetApexNamespace = await this.ux.prompt(messages.getMessage('enterTargetNamespace'));
@@ -357,6 +339,21 @@ export default class Migrate extends OmniStudioBaseCommand {
     return targetApexNamespace;
   }
 
+  private async getGeneralConsent(): Promise<boolean> {
+    let consent: boolean | null = null;
+
+    while (consent === null) {
+      try {
+        consent = await Logger.confirm(messages.getMessage('userConsentMessage'));
+      } catch (error) {
+        Logger.log(messages.getMessage('invalidYesNoResponse'));
+        consent = null;
+      }
+    }
+
+    return consent;
+  }
+
   private mergeRecordAndUploadResults(
     migrationResults: MigrationResult,
     migrationTool: MigrationTool

src/utils/orgUtils/index.ts

@@ -329,7 +329,7 @@ export class OrgUtils {
     // Handle multiple packages by prompting user to select one
     if (installedOmniPackages.length > 1) {
       Logger.log(messages.getMessage('multiplePackagesFound'));
-
+      installedOmniPackages.sort((a, b) => a.NamespacePrefix.localeCompare(b.NamespacePrefix));
       // Display available packages
       for (let i = 0; i < installedOmniPackages.length; i++) {
         const pkg = installedOmniPackages[i];