fix: review comments

Author: rajender-kumar-salesforce

messages/migrate.json

@@ -187,6 +187,11 @@
   "creatingNPMConfigFile": "Creating npm configuration file",
   "npmConfigFileCreated": "Npm config file created",
   "authKeyEnvVarNotSet": "The OMA_AUTH_KEY environment variable isn’t set. LWCs won't be deployed.",
+  "npmNotInstalled": "npm is not installed on this system. LWC auto-deployment requires npm.",
+  "lwcDeployPrerequisitesMissing": "LWC auto-deployment prerequisites are not met: %s",
+  "manualLwcDeploymentPrompt": "Manual LWC deployment will be required. Do you want to proceed with the migration? [y/n]",
+  "manualLwcDeploymentProceeding": "Proceeding with migration. LWC components will need to be deployed manually.",
+  "npmAndAuthKeyRequired": "Please install npm and set the OMA_AUTH_KEY environment variable, then re-run the migration.",
   "manualDeploymentSteps": "<a href='%s' target='_blank'>Please refer to this documentation for manual deployment process</a>",
   "deploymentConsentNotGiven": "Deployment consent not given, manual deployment is required",
   "experienceSiteException": "We’ve encountered an exception while processing Experience Cloud sites.",
@@ -330,4 +335,4 @@
   "processingNotRequired": "Migration is not required for orgs on standard data model with the Omnistudio Metadata setting turned on.",
   "skippingTruncation": "Skipping truncation as the org is on standard data model.",
   "loglevelFlagDeprecated": "loglevel is deprecated. Use --verbose instead."
-}
+}

src/migration/premigrate.ts

@@ -8,6 +8,7 @@ import { YES_SHORT, YES_LONG, NO_SHORT, NO_LONG } from '../utils/projectPathUtil
 import { documentRegistry } from '../utils/constants/documentRegistry';
 import { OmniStudioMetadataCleanupService } from '../utils/config/OmniStudioMetadataCleanupService';
 import { isStandardDataModelWithMetadataAPIEnabled } from '../utils/dataModelService';
+import { sfProject } from '../utils/sfcli/project/sfProject';
 import { BaseMigrationTool } from './base';
 
 const authEnvKey = 'OMA_AUTH_KEY';
@@ -132,15 +133,9 @@ export class PreMigrate extends BaseMigrationTool {
       authKey: undefined,
     };
     if (consent && includeLwc) {
-      deploymentConfig.authKey = process.env[authEnvKey];
-      if (!deploymentConfig.authKey) {
-        Logger.warn(this.messages.getMessage('authKeyEnvVarNotSet'));
-        actionItems.push(
-          `${this.messages.getMessage('authKeyEnvVarNotSet')}\n${this.messages.getMessage('manualDeploymentSteps', [
-            documentRegistry.manualDeploymentSteps,
-          ])}`
-        );
-      }
+      const lwcPrereqResult = await this.checkLwcDeployPrerequisites(actionItems);
+      deploymentConfig.authKey = lwcPrereqResult.authKey;
+      deploymentConfig.autoDeploy = lwcPrereqResult.autoDeploy;
     }
 
     if (!consent) {
@@ -215,6 +210,70 @@ export class PreMigrate extends BaseMigrationTool {
     return await omniStudioMetadataCleanupService.cleanupOmniStudioMetadataTables();
   }
 
+  private async checkLwcDeployPrerequisites(
+    actionItems: string[]
+  ): Promise<{ autoDeploy: boolean; authKey: string | undefined }> {
+    const missingPrerequisites: string[] = [];
+
+    const isNpmAvailable = sfProject.isNpmInstalled();
+    if (!isNpmAvailable) {
+      missingPrerequisites.push(this.messages.getMessage('npmNotInstalled'));
+    }
+
+    const authKey = process.env[authEnvKey];
+    if (!authKey) {
+      missingPrerequisites.push(this.messages.getMessage('authKeyEnvVarNotSet'));
+    }
+
+    if (missingPrerequisites.length === 0) {
+      return { autoDeploy: true, authKey };
+    }
+
+    Logger.warn(this.messages.getMessage('lwcDeployPrerequisitesMissing', [missingPrerequisites.join(' ')]));
+
+    const proceedWithManual = await this.getManualLwcDeploymentConsent();
+
+    if (proceedWithManual) {
+      Logger.log(this.messages.getMessage('manualLwcDeploymentProceeding'));
+      actionItems.push(
+        `${missingPrerequisites.join(' ')}\n${this.messages.getMessage('manualDeploymentSteps', [
+          documentRegistry.manualDeploymentSteps,
+        ])}`
+      );
+      return { autoDeploy: true, authKey: undefined };
+    }
+
+    Logger.error(this.messages.getMessage('npmAndAuthKeyRequired'));
+    process.exit(1);
+  }
+
+  private async getManualLwcDeploymentConsent(): Promise<boolean> {
+    const askWithTimeOut = PromptUtil.askWithTimeOut(this.messages);
+    const validResponse = false;
+
+    while (!validResponse) {
+      try {
+        const resp = await askWithTimeOut(
+          Logger.prompt.bind(Logger),
+          this.messages.getMessage('manualLwcDeploymentPrompt')
+        );
+        const response = typeof resp === 'string' ? resp.trim().toLowerCase() : '';
+
+        if (response === YES_SHORT || response === YES_LONG) {
+          return true;
+        } else if (response === NO_SHORT || response === NO_LONG) {
+          return false;
+        } else {
+          Logger.error(this.messages.getMessage('invalidYesNoResponse'));
+        }
+      } catch (err) {
+        Logger.error(this.messages.getMessage('requestTimedOut'));
+        process.exit(1);
+      }
+    }
+    return false;
+  }
+
   // This needs to be behind timeout
   private async getExpSiteMetadataEnableConsent(): Promise<boolean> {
     const question = this.messages.getMessage('consentForExperienceSites');

src/utils/sfcli/project/sfProject.ts

@@ -1,4 +1,5 @@
 import * as fs from 'fs';
+import * as shell from 'shelljs';
 import { Messages } from '@salesforce/core';
 import { Logger } from '../../logger';
 import { cli } from '../../shell/cli';
@@ -103,6 +104,10 @@ export class sfProject {
     }
   }
 
+  public static isNpmInstalled(): boolean {
+    return !!shell.which('npm');
+  }
+
   public static createNPMConfigFile(authKey: string): void {
     Logger.logVerbose(messages.getMessage('creatingNPMConfigFile'));
     fs.writeFileSync(