Merge branch 'release260omnistudiopackage' of https://github.com/salesforcecli/plugin-omnistudio-migration-tool into u/rajender-kumar/w-21274482/deployment

Author: rajender-kumar-salesforce

messages/assess.json

@@ -220,6 +220,8 @@
   "packagesHaveSameValue": "Both TheFirstInstalledOmniPackage and InstalledIndustryPackage have the same value.",
   "packagesHaveDifferentValue": "Both the InstalledIndustryPackage and TheFirstInstalledOmniPackage have different values.",
   "failedToCheckPackagesValue": "Failed to check the value of packages in Omni Interaction Configuration.",
+  "omniStudioPermissionsNotEnabled": "The org doesn’t have Omnistudio permissions enabled. These permissions are required to migrate components. You can still run the assessment.",
+  "skippingLicenseCheckForAssessment": "Skipping OmniStudio license check for assessment",
   "packageDetails": "Your org contains only the TheFirstInstalledOmniPackage Omni Interaction Configuration.",
   "orgUsecaseDetails": "The org is on %s data model with %s and the Omnistudio Metadata setting turned %s",
   "globalAutoNumberUnSupportedInOmnistudioPackage": "Feature not supported - Omni Global Auto Number is not supported in Omnistudio Foundation package orgs.",

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": "We couldn't find npm on this system. LWC auto-deployment requires npm.",
+  "lwcDeployPrerequisitesMissing": "LWC auto-deployment prerequisites aren't met: %s",
+  "manualLwcDeploymentPrompt": "Manual LWC deployment is required. Do you want to continue with the migration? [y/n]",
+  "manualLwcDeploymentProceeding": "Continuing the migration. Deploy the LWC components manually.",
+  "npmAndAuthKeyRequired": "Install npm and set the OMA_AUTH_KEY environment variable, and then run the migration again.",
   "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.",
@@ -284,6 +289,7 @@
   "deployComponentsManually": "Metadata Components deployment failed. Please deploy using generated package.xml manually using Salesforce CLI or Workbench. Check the logs for detailed error information.",
   "omniscriptDeploymentFailedContinuing": "Omniscript package deployment failed, continuing with report generation. Manual deployment required.",
   "deploymentFailedContinuing": "Deployment failed, continuing with report generation. Manual deployment required.",
+  "manualDeploymentNeeded": "Manual deployment needed",
   "ensurePackageInstalled": "Please ensure omniscript customization package is properly installed: %s",
   "packageDeploymentFailedWithError": "Omniscript package deployment failed after %s attempts. Error: %s. Please check deployment logs and org settings.",
   "maxRetryAttemptsExceeded": "Maximum retry attempts (%s) exceeded for omniscript package deployment",
@@ -322,6 +328,7 @@
   "packagesHaveSameValue": "Both TheFirstInstalledOmniPackage and InstalledIndustryPackage have the same value.",
   "packagesHaveDifferentValue": "Both the InstalledIndustryPackage and TheFirstInstalledOmniPackage have different values.",
   "failedToCheckPackagesValue": "Failed to check the value of packages in Omni Interaction Configuration.",
+  "omniStudioPermissionsNotEnabled": "The org doesn’t have Omnistudio permissions enabled. These permissions are required to migrate components. You can still run the assessment.",
   "packageDetails": "Your org contains only the TheFirstInstalledOmniPackage Omni Interaction Configuration.",
   "globalAutoNumberUnSupportedInOmnistudioPackage": "Feature not supported - Omni Global Auto Number is not supported in Omnistudio Foundation package orgs.",
   "orgUsecaseDetails": "The org is on %s data model with %s and the Omnistudio Metadata setting turned %s",

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/plugin-omnistudio-migration-tool",
   "description": "This SFDX plugin migrates FlexCard, OmniScript, DataRaptor, and Integration Procedure custom objects to standard objects.",
-  "version": "2.0.0-preview.28",
+  "version": "2.0.0-preview.30",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {

src/commands/omnistudio/migration/assess.ts

@@ -131,7 +131,8 @@ export default class Assess extends SfCommand<AssessmentInfo> {
 
     // Perform comprehensive validation using ValidatorService
     const validator = new ValidatorService(orgs, messages, conn);
-    const isValidationPassed = await validator.validate();
+    // Pass true to skip OmniStudio license check for assessment
+    const isValidationPassed = await validator.validate(true);
 
     if (!isValidationPassed) {
       return;

src/commands/omnistudio/migration/migrate.ts

@@ -279,9 +279,11 @@ export default class Migrate extends SfCommand<MigrateResult> {
     );
     generatePackageXml.createOmnistudioDeploymentXml(org.getConnection().version);
 
+    let deploymentFailed = false;
     try {
       await postMigrate.deploy(actionItems);
     } catch (error) {
+      deploymentFailed = true;
       Logger.error(messages.getMessage('errorDeployingComponents'), error);
       Logger.logVerbose(error);
       // Even if deployment fails completely, continue with report generation
@@ -296,7 +298,8 @@ export default class Migrate extends SfCommand<MigrateResult> {
       messages,
       actionItems,
       objectsToProcess,
-      migrateOnly
+      migrateOnly,
+      deploymentFailed
     );
     Logger.log(
       messages.getMessage('migrationSuccessfulMessage', [

src/migration/postMigrate.ts

@@ -234,6 +234,9 @@ export class PostMigrate extends BaseMigrationTool {
 
       // Log the specific error details for troubleshooting
       Logger.logVerbose(`Deployment error details: ${errorMessage}`);
+
+      // Re-throw so callers (migrate.ts) can track deploymentFailed state
+      throw error;
     }
   }
 }

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/constants/stringContants.ts

@@ -82,3 +82,14 @@ export const Constants = {
   OmniDataTransformConfigTable: 'OmniDataTransformConfig',
   OmniUiCardConfigTable: 'OmniUiCardConfig',
 };
+
+export const Status = {
+  SuccessfullyMigrated: 'Successfully migrated',
+  Failed: 'Failed',
+  Skipped: 'Skipped',
+  Complete: 'Complete',
+  ReadyForMigration: 'Ready for migration',
+  NeedsManualIntervention: 'Needs manual intervention',
+  ManualDeploymentNeeded: 'Manual deployment needed',
+  SuccessfullyCompleted: 'Successfully Completed',
+};

src/utils/orgPreferences.ts

@@ -1,4 +1,4 @@
-import { Connection } from '@salesforce/core';
+import { Connection, Messages } from '@salesforce/core';
 import {
   OmniStudioSettingsMetadata,
   ExperienceBundleSettingsMetadata,
@@ -9,6 +9,10 @@ import {
 import { Logger } from './logger';
 import { Constants } from './constants/stringContants';
 
+// Load messages
+Messages.importMessagesDirectory(__dirname);
+const messages = Messages.loadMessages('@salesforce/plugin-omnistudio-migration-tool', 'migrate');
+
 /**
  * Class to manage OmniStudio organization preferences
  *
@@ -90,7 +94,14 @@ export class OrgPreferences {
         }
       }
       return enabledFlags;
-    } catch (error) {
+    } catch (error: unknown) {
+      // Check if error is INVALID_TYPE for OmniInteractionConfig (indicating no OmniStudio permissions)
+      if (this.isOmniInteractionConfigInvalidTypeError(error)) {
+        Logger.warn(messages.getMessage('omniStudioPermissionsNotEnabled'));
+        return []; // Return empty array instead of throwing
+      }
+
+      // Generic error handling for other errors
       throw new Error(`Failed to check rollback flags: ${error instanceof Error ? error.message : String(error)}`);
     }
   }
@@ -204,8 +215,14 @@ export class OrgPreferences {
       } else {
         return false;
       }
-    } catch (error) {
-      // TODO: What should be the default behavior if the query fails?
+    } catch (error: unknown) {
+      // Check if error is INVALID_TYPE for OmniInteractionConfig (indicating no OmniStudio permissions)
+      if (this.isOmniInteractionConfigInvalidTypeError(error)) {
+        Logger.warn(messages.getMessage('omniStudioPermissionsNotEnabled'));
+        return false; // Fall back to use case 1 since the org doesn't have OmniStudio permissions enabled
+      }
+
+      // Generic error handling for other errors
       const errMsg = error instanceof Error ? error.message : String(error);
       Logger.error(`Error checking standard designer for namespace ${namespaceToModify}: ${errMsg}`);
       return false;
@@ -227,10 +244,38 @@ export class OrgPreferences {
       }
 
       return false;
-    } catch (error) {
+    } catch (error: unknown) {
+      // Check if error is INVALID_TYPE for OmniInteractionConfig (indicating no OmniStudio permissions)
+      if (this.isOmniInteractionConfigInvalidTypeError(error)) {
+        Logger.warn(messages.getMessage('omniStudioPermissionsNotEnabled'));
+        return false; // Fall back to use case 1 since the org doesn't have OmniStudio permissions enabled
+      }
+
+      // Generic error handling for other errors
       const errMsg = error instanceof Error ? error.message : String(error);
       Logger.error(`Error checking foundation package : ${errMsg}`);
       return false;
     }
   }
+
+  /**
+   * Checks if an error is an INVALID_TYPE error for OmniInteractionConfig
+   * This indicates that the org doesn't have OmniStudio permissions enabled
+   *
+   * @private
+   * @static
+   * @param {unknown} error - The error to check
+   * @returns {boolean} True if the error is an INVALID_TYPE error for OmniInteractionConfig
+   */
+  private static isOmniInteractionConfigInvalidTypeError(error: unknown): boolean {
+    return (
+      error !== null &&
+      error !== undefined &&
+      typeof error === 'object' &&
+      'errorCode' in error &&
+      (error as { errorCode: unknown }).errorCode === 'INVALID_TYPE' &&
+      'message' in error &&
+      String((error as { message: unknown }).message).includes('OmniInteractionConfig')
+    );
+  }
 }