Merge pull request #358 from snehaljha-sf/auto-deploy

feat: auto deploy

Author: snehaljha-sf

.gitignore

@@ -47,4 +47,5 @@ omnistudio_migration
 
 assessment_reports/
 migration_report/
-.sfdx/
+.sfdx/
+package.xml

README.md

@@ -8,6 +8,8 @@ The Omnistudio Migration Assistant is a command-line interface (CLI) plugin that
 
 - Install Salesforce CLI on your computer. See : [Install Salesforce CLI](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm).
 
+- To deploy LWC as part of auto-deployment process, environment variable 'OMA_AUTH_KEY' should be set with requested NPM repository access key from Salesforce Customer Support.
+
 ## Install and Run the Omnistudio Migration Assistant
 
 1. Install SF cli using the official documentation located [here](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm).
@@ -168,12 +170,14 @@ OPTIONS
                                                                                     os (OmniScripts), fc (FlexCards)
 
   --relatedobjects=relatedobjects                                                   specify related objects to assess:
-                                                                                    'apex' for Apex classes
-```
+                                                                                    'apex'       for Apex classes
+'lwc'        for LWC (Lightning Web Components)
+'expsites'   for Experience Sites
+'flexipage'  for Lightning record pages
 
-> **Note:** LWC (Lightning Web Components) assessment/migration functionality is temporarily disabled in the current version. LWC features will be re-enabled in a future releases.
+```
 
-> Apex migration functionality remains fully available. The `--relatedobjects` flag only accepts values ('apex')
+> **Note:** LWC migration auto-deployment needs minimum node version of 18.17.1
 
 Terms:
 Notwithstanding anything stated in the terms and conditions agreed between Salesforce (‘SFDC’) and you (‘Customer’), the use of the OmniStudio Migration Assistant (‘Assistant’) is designed to facilitate the migration and it’s going to modify your custom code and by deploying and using the Assistant you hereby provide your consent to automate the migration process and enable a smooth transition. Customer shall access and use the Assistant only as permitted to the Customer and shall not compromise, break or circumvent any technical processes or security measures associated with the services provided by SFDC.

messages/assess.json

@@ -124,8 +124,7 @@
   "errorGeneratingHTML": "Error while generating HTML from template for %s with properties %s",
   "unexpectedError": "Unexpected Assessment error",
   "errorEvaluatingExpression": "Error evaluating expression: %s, %s",
-  "retrievingFlexiPages": "Retrieving FlexiPages",
-  "successfullyRetrievedFlexiPages": "Successfully retrieved %s FlexiPages",
+  "foundFlexiPages": "Found %s FlexiPages to assess",
   "assessingFlexiPages": "Assessing FlexiPages",
   "completedProcessingAllFlexiPages": "Completed processing all flexipage files. Total processed: %s",
   "completedProcessingFlexiPage": "Completed processing %s - Errors: %s",

messages/migrate.json

@@ -119,8 +119,7 @@
   "labelStatusComplete": "Complete",
   "migrationConsentNotGiven": "Couldn't confirm whether assessment errors are resolved",
   "migrationConsentMessage": "Ensure that all items in the assessment report are marked as Green before proceeding with the migration. Do you want to proceed?",
-  "retrievingFlexiPages": "Retrieving FlexiPages",
-  "successfullyRetrievedFlexiPages": "Successfully retrieved %s FlexiPages",
+  "foundFlexiPages": "Found %s FlexiPages to migrate",
   "migratingFlexiPages": "Migrating FlexiPages",
   "completedProcessingAllFlexiPages": "Completed processing all flexipage files. Total processed: %s",
   "completedProcessingFlexiPage": "Completed processing %s - Errors: %s",
@@ -196,16 +195,28 @@
   "missingInfo": "Info is missing",
   "errorCheckingGlobalAutoNumber": "We couldn’t check whether the Global Auto Number setting is enabled: %s. Try again later.",
   "errorMigrationMessage": "Error migrating object: %s",
+  "nameMappingUndefined": "Name Mapping is undefined",
+  "autoDeployConsentMessage": "Do you want to auto deploy the related objects? [y/n]",
+  "errorDeployingComponents": "Error deploying related objects post migration",
+  "installingDependency": "Installing node dependency %s",
+  "dependencyInstalled": "Node dependency %s installed",
+  "deployingFromManifest": "Deploying from metadata packages",
+  "manifestDeployFailed": "Metadata packages deployment failed, check logs or status for more details",
+  "installingRequiredDependencies": "Installing required node dependencies",
+  "creatingNPMConfigFile": "Creating npm config file",
+  "npmConfigFileCreated": "Npm config file created",
+  "authKeyEnvVarNotSet": "OMA_AUTH_KEY environment variable is not set, LWCs will not be deployed",
   "experienceSiteException": "Exception occurred while processing experience sites",
   "reservedKeysFoundInPropertySet": "Reserved keys found in any of output response transformation fields: %s.",
   "incompleteMigrationDetected": "We couldn't complete the migration process",
-  "nameMappingUndefined": "Name Mapping is undefined",
   "errorComponentMapping": "Error during component pre-processing: %s",
   "startingComponentPreProcessing": "Pre-processing components for name mapping",
   "completeComponentMappingMessage": "Registered name mappings for %s components",
   "componentMappingNotFound": "No registry mapping found for %s component: %s, using fallback cleaning",
   "flexCardWithAngularOmniScriptWarning": "FlexCard has dependencies on Angular OmniScript(s) which are not migrated. Please convert OmniScript(s) to LWC before migrating this FlexCard.",
   "angularOmniScriptDependencyWarning": "Element '%s' references Angular OmniScript '%s' which will not be migrated. Consider converting the referenced OmniScript to LWC",
   "skipFlexcardAngularOmniScriptDependencyWarning": "Skipping FlexCard %s due to Angular OmniScript dependencies",
-  "flexCardMigrationProcessingMessage": "Processing %s FlexCards for migration (%s skipped due to Angular dependencies)"
-}
+  "flexCardMigrationProcessingMessage": "Processing %s FlexCards for migration (%s skipped due to Angular dependencies)",
+  "noMetadataToDeploy": "No metadata to deploy",
+  "manifestDeployementStarted": "Manifest deployment started with id: %s"
+}

src/commands/omnistudio/migration/migrate.ts

@@ -130,11 +130,28 @@ export default class Migrate extends OmniStudioBaseCommand {
     const namespace = orgs.packageDetails.namespace;
     // Let's time every step
     DebugTimer.getInstance().start();
+    let projectPath: string;
+    let objectsToProcess: string[] = [];
+    let targetApexNamespace: string;
+    const preMigrate: PreMigrate = new PreMigrate(namespace, conn, this.logger, messages, this.ux);
+    const isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean } = { value: false };
 
-    // Handle related objects processing
-    const relatedObjectsResult = await this.processRelatedObjects(relatedObjects, conn, namespace);
-    const { projectPath, objectsToProcess, targetApexNamespace, isExperienceBundleMetadataAPIProgramaticallyEnabled } =
-      relatedObjectsResult;
+    let actionItems = [];
+
+    let deploymentConfig = { autoDeploy: false, authKey: undefined };
+    if (relatedObjects) {
+      const relatedObjectProcessResult = await this.processRelatedObjects(
+        relatedObjects,
+        preMigrate,
+        conn,
+        isExperienceBundleMetadataAPIProgramaticallyEnabled,
+        actionItems
+      );
+      objectsToProcess = relatedObjectProcessResult.objectsToProcess;
+      projectPath = relatedObjectProcessResult.projectPath;
+      targetApexNamespace = relatedObjectProcessResult.targetApexNamespace;
+      deploymentConfig = relatedObjectProcessResult.deploymentConfig;
+    }
 
     Logger.log(messages.getMessage('migrationInitialization', [String(namespace)]));
     Logger.log(messages.getMessage('apiVersionInfo', [apiVersion]));
@@ -181,15 +198,17 @@ export default class Migrate extends OmniStudioBaseCommand {
     const relatedObjectMigrationResult = omnistudioRelatedObjectsMigration.migrateAll(objectsToProcess);
 
     // POST MIGRATION
-    let actionItems = [];
+
     const postMigrate: PostMigrate = new PostMigrate(
       this.org,
       namespace,
       conn,
       this.logger,
       messages,
       this.ux,
-      objectsToProcess
+      objectsToProcess,
+      deploymentConfig,
+      projectPath
     );
 
     if (!migrateOnly) {
@@ -206,11 +225,19 @@ export default class Migrate extends OmniStudioBaseCommand {
 
     generatePackageXml.createChangeList(
       relatedObjectMigrationResult.apexAssessmentInfos,
-      relatedObjectMigrationResult.lwcAssessmentInfos,
+      deploymentConfig.autoDeploy && deploymentConfig.authKey ? relatedObjectMigrationResult.lwcAssessmentInfos : [],
       relatedObjectMigrationResult.experienceSiteAssessmentInfos,
-      relatedObjectMigrationResult.flexipageAssessmentInfos
+      relatedObjectMigrationResult.flexipageAssessmentInfos,
+      this.org.getConnection().version,
+      messages
     );
 
+    try {
+      postMigrate.deploy();
+    } catch (error) {
+      Logger.error(messages.getMessage('errorDeployingComponents'), error);
+    }
+
     await ResultsBuilder.generateReport(
       objectMigrationResults,
       relatedObjectMigrationResult,
@@ -222,52 +249,52 @@ export default class Migrate extends OmniStudioBaseCommand {
     );
 
     // Return results needed for --json flag
-    return { objectMigrationResults };
+    return { objectMigrationResults: [] };
   }
 
   private async processRelatedObjects(
     relatedObjects: string,
+    preMigrate: PreMigrate,
     conn: Connection,
-    namespace: string
+    isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean },
+    actionItems: string[]
   ): Promise<{
-    projectPath: string;
     objectsToProcess: string[];
+    projectPath: string;
     targetApexNamespace: string;
-    isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean };
+    deploymentConfig: { autoDeploy: boolean; authKey: string | undefined };
   }> {
+    const validOptions = [Constants.Apex, Constants.ExpSites, Constants.FlexiPage, Constants.LWC];
+    const objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
+    // Validate input
+    for (const obj of objectsToProcess) {
+      if (!validOptions.includes(obj)) {
+        Logger.error(messages.getMessage('invalidRelatedObjectsOption', [obj]));
+        process.exit(1);
+      }
+    }
+
+    let deploymentConfig = { autoDeploy: false, authKey: undefined };
     let projectPath: string;
-    let objectsToProcess: string[] = [];
     let targetApexNamespace: string;
-    const isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean } = { value: false };
-    if (relatedObjects) {
-      const validOptions = [Constants.Apex, Constants.ExpSites, Constants.FlexiPage, Constants.LWC];
-      objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
-      // Validate input
-      for (const obj of objectsToProcess) {
-        if (!validOptions.includes(obj)) {
-          Logger.error(messages.getMessage('invalidRelatedObjectsOption', [obj]));
-          process.exit(1);
-        }
-      }
-      // 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);
-        const preMigrate: PreMigrate = new PreMigrate(namespace, conn, this.logger, messages, this.ux);
-        await preMigrate.handleExperienceSitePrerequisites(
-          objectsToProcess,
-          conn,
-          isExperienceBundleMetadataAPIProgramaticallyEnabled
-        );
-        Logger.logVerbose(
-          'The objects to process after handleExpSitePrerequisite are ' + JSON.stringify(objectsToProcess)
-        );
-      } // TODO - What if general consent is no
+    // 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);
+      await preMigrate.handleExperienceSitePrerequisites(
+        objectsToProcess,
+        conn,
+        isExperienceBundleMetadataAPIProgramaticallyEnabled
+      );
+      deploymentConfig = await preMigrate.getAutoDeployConsent(objectsToProcess.includes(Constants.LWC), actionItems);
+      Logger.logVerbose(
+        'The objects to process after handleExpSitePrerequisite are ' + JSON.stringify(objectsToProcess)
+      );
     }
 
-    return { projectPath, objectsToProcess, targetApexNamespace, isExperienceBundleMetadataAPIProgramaticallyEnabled };
+    return { objectsToProcess, projectPath, targetApexNamespace, deploymentConfig };
   }
 
   private async getMigrationConsent(): Promise<boolean> {

src/migration/deployer.ts

@@ -0,0 +1,40 @@
+import * as path from 'path';
+import { Messages } from '@salesforce/core';
+import * as shell from 'shelljs';
+import { sfProject } from '../utils/sfcli/project/sfProject';
+import { Logger } from '../utils/logger';
+
+export class Deployer {
+  private readonly projectPath: string;
+  private readonly authKey: string;
+  private readonly omniscriptCustomizationPackage = '@omnistudio/omniscript_customization';
+  private readonly omniscriptCustomizationPackageVersion = '250.0.0';
+  private readonly username: string;
+  private readonly messages: Messages;
+
+  public constructor(projectPath: string, messages: Messages, username: string, authKey: string) {
+    this.projectPath = projectPath;
+    this.username = username;
+    this.messages = messages;
+    this.authKey = authKey;
+  }
+
+  public deploy(): void {
+    const pwd = shell.pwd();
+    shell.cd(this.projectPath);
+    try {
+      if (this.authKey) {
+        sfProject.createNPMConfigFile(this.authKey);
+        Logger.logVerbose(this.messages.getMessage('installingRequiredDependencies'));
+        sfProject.installDependency();
+        sfProject.installDependency(
+          `${this.omniscriptCustomizationPackage}@${this.omniscriptCustomizationPackageVersion}`
+        );
+      }
+      Logger.log(path.join(pwd.toString(), 'package.xml'));
+      sfProject.deployFromManifest(path.join(pwd.toString(), 'package.xml'), this.username);
+    } finally {
+      shell.cd(pwd);
+    }
+  }
+}

src/migration/postMigrate.ts

@@ -8,10 +8,15 @@ import { AnonymousApexRunner } from '../utils/apex/executor/AnonymousApexRunner'
 import { Constants } from '../utils/constants/stringContants';
 import { OrgPreferences } from '../utils/orgPreferences';
 import { BaseMigrationTool } from './base';
+import { Deployer } from './deployer';
+import * as fs from 'fs';
+import * as path from 'path';
 
 export class PostMigrate extends BaseMigrationTool {
   private readonly org: Org;
   private readonly relatedObjectsToProcess: string[];
+  private readonly projectPath: string;
+  private readonly deploymentConfig: { autoDeploy: boolean; authKey: string | undefined };
 
   // Source Custom Object Names
   constructor(
@@ -21,11 +26,15 @@ export class PostMigrate extends BaseMigrationTool {
     logger: Logger,
     messages: Messages,
     ux: UX,
-    relatedObjectsToProcess: string[]
+    relatedObjectsToProcess: string[],
+    deploymentConfig?: { autoDeploy: boolean; authKey: string | undefined },
+    projectPath?: string
   ) {
     super(namespace, connection, logger, messages, ux);
     this.org = org;
     this.relatedObjectsToProcess = relatedObjectsToProcess;
+    this.deploymentConfig = deploymentConfig;
+    this.projectPath = projectPath;
   }
 
   public async setDesignersToUseStandardDataModel(
@@ -77,4 +86,21 @@ export class PostMigrate extends BaseMigrationTool {
       }
     }
   }
+
+  public deploy(): void {
+    if (!this.deploymentConfig.autoDeploy || !fs.existsSync(path.join(process.cwd(), 'package.xml'))) {
+      return;
+    }
+    try {
+      const deployer = new Deployer(
+        this.projectPath,
+        this.messages,
+        this.org.getUsername(),
+        this.deploymentConfig.authKey
+      );
+      deployer.deploy();
+    } catch (error) {
+      Logger.error(this.messages.getMessage('errorDeployingComponents'), error);
+    }
+  }
 }