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

@W-18432119 [Assess Mode][Tooling Enhancements] Project directory enhancements

Author: mdmehran-qureshi

messages/assess.json

@@ -92,6 +92,17 @@
   "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",
+  "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 Assistant 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",
+  "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",
+  "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",

src/commands/omnistudio/migration/assess.ts

@@ -1,4 +1,6 @@
 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';
@@ -13,10 +15,30 @@ 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';
 
 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');
 
@@ -44,7 +66,7 @@ export default class Assess extends OmniStudioBaseCommand {
     }),
     verbose: flags.builtin({
       type: 'builtin',
-      description: 'Enable verbose output',
+      description: messages.getMessage('enableVerboseOutput'),
     }),
   };
 
@@ -92,6 +114,91 @@ export default class Assess extends OmniStudioBaseCommand {
 
     const namespace = orgs.packageDetails.namespace;
 
+    let projectPath = '';
+    let mode: string = EXISTING_MODE;
+
+    // Prompt for project type
+    const askWithTimeout = async (
+      promptFn: (...args: unknown[]) => Promise<unknown>,
+      ...args: unknown[]
+    ): Promise<string> => {
+      const TIMEOUT_MS = 5 * 60 * 1000; // 5 minutes
+      let timeoutHandle: NodeJS.Timeout;
+      const timeoutPromise = new Promise((_, reject) => {
+        timeoutHandle = setTimeout(() => {
+          reject(new Error(messages.getMessage('requestTimedOut')));
+        }, TIMEOUT_MS);
+      });
+      try {
+        const result = await Promise.race([promptFn(...args), timeoutPromise]);
+        clearTimeout(timeoutHandle);
+        if (typeof result === 'string') {
+          return result;
+        } else {
+          throw new Error('Prompt did not return a string');
+        }
+      } catch (err) {
+        clearTimeout(timeoutHandle);
+        throw err;
+      }
+    };
+
+    // Prompt: Existing project?
+    let response = '';
+    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;
+    } else if (response === NO_SHORT || response === NO_LONG) {
+      mode = EMPTY_MODE;
+    } else {
+      Logger.error(messages.getMessage('invalidYesNoResponse'));
+      return;
+    }
+
+    // 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;
+    }
+
     const assesmentInfo: AssessmentInfo = {
       lwcAssessmentInfos: [],
       apexAssessmentInfos: [],
@@ -128,7 +235,8 @@ export default class Assess extends OmniStudioBaseCommand {
         namespace,
         assessOnly,
         allVersions,
-        this.org
+        this.org,
+        projectPath
       );
       const relatedObjectAssessmentResult = omnistudioRelatedObjectsMigration.assessAll(objectsToProcess);
       assesmentInfo.lwcAssessmentInfos = relatedObjectAssessmentResult.lwcAssessmentInfos;