feat: auto deploy

Author: snehaljha-sf

messages/migrate.json

@@ -198,5 +198,14 @@
   "incompleteMigrationDetected": "We couldn’t complete the migration process",
   "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"
+  "nameMappingUndefined": "Name Mapping is undefined",
+  "autoDeployConsentMessage": "Do you want to auto deploy the migrated components? [y/n]",
+  "errorDeployingComponents": "Error deploying components post migration",
+  "installingDependency": "Installing node dependency %s",
+  "dependencyInstalled": "Node dependency %s installed",
+  "deployingFromManifest": "Deploying from metadata packages",
+  "manifestDeployed": "Metadata packages are deployed",
+  "installingRequiredDependencies": "Installing required node dependencies",
+  "creatingNPMConfigFile": "Creating npm config file",
+  "npmConfigFileCreated": "Npm config file created"
 }

src/commands/omnistudio/migration/assess.ts

@@ -176,7 +176,9 @@ export default class Assess extends OmniStudioBaseCommand {
       this.logger,
       messages,
       this.ux,
-      objectsToProcess
+      objectsToProcess,
+      false,
+      undefined
     );
 
     const userActionMessages: string[] = [];

src/commands/omnistudio/migration/migrate.ts

@@ -9,7 +9,7 @@
  */
 import * as os from 'os';
 import { flags } from '@salesforce/command';
-import { Messages } from '@salesforce/core';
+import { Connection, Messages } from '@salesforce/core';
 import OmniStudioBaseCommand from '../../basecommand';
 import { DataRaptorMigrationTool } from '../../../migration/dataraptor';
 import { DebugTimer, MigratedObject, MigratedRecordInfo } from '../../../utils';
@@ -134,32 +134,19 @@ export default class Migrate extends OmniStudioBaseCommand {
     let targetApexNamespace: string;
     const preMigrate: PreMigrate = new PreMigrate(this.org, namespace, conn, this.logger, messages, this.ux);
     const isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean } = { value: false };
+
+    let autoDeploy = false;
     if (relatedObjects) {
-      // To-Do: Add LWC to valid options when GA is released
-      const validOptions = [Constants.Apex, Constants.ExpSites, Constants.FlexiPage];
-      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);
-        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
+      const relatedObjectMigrationResult = await this.migrateRelatedObjects(
+        relatedObjects,
+        preMigrate,
+        conn,
+        isExperienceBundleMetadataAPIProgramaticallyEnabled
+      );
+      objectsToProcess = relatedObjectMigrationResult.objectsToProcess;
+      projectPath = relatedObjectMigrationResult.projectPath;
+      targetApexNamespace = relatedObjectMigrationResult.targetApexNamespace;
+      autoDeploy = relatedObjectMigrationResult.autoDeploy;
     }
 
     Logger.log(messages.getMessage('migrationInitialization', [String(namespace)]));
@@ -204,9 +191,17 @@ export default class Migrate extends OmniStudioBaseCommand {
       this.logger,
       messages,
       this.ux,
-      objectsToProcess
+      objectsToProcess,
+      autoDeploy,
+      projectPath
     );
 
+    try {
+      postMigrate.deploy();
+    } catch (error) {
+      Logger.error(messages.getMessage('errorDeployingComponents'), error);
+    }
+
     if (!migrateOnly) {
       await postMigrate.setDesignersToUseStandardDataModel(namespace, actionItems);
     }
@@ -223,7 +218,8 @@ export default class Migrate extends OmniStudioBaseCommand {
       relatedObjectMigrationResult.apexAssessmentInfos,
       relatedObjectMigrationResult.lwcAssessmentInfos,
       relatedObjectMigrationResult.experienceSiteAssessmentInfos,
-      relatedObjectMigrationResult.flexipageAssessmentInfos
+      relatedObjectMigrationResult.flexipageAssessmentInfos,
+      this.org.getConnection().version
     );
 
     await ResultsBuilder.generateReport(
@@ -237,7 +233,73 @@ export default class Migrate extends OmniStudioBaseCommand {
     );
 
     // Return results needed for --json flag
-    return { objectMigrationResults };
+    return { objectMigrationResults: [] };
+  }
+
+  private async migrateRelatedObjects(
+    relatedObjects: string,
+    preMigrate: PreMigrate,
+    conn: Connection,
+    isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean }
+  ): Promise<{ objectsToProcess: string[]; projectPath: string; targetApexNamespace: string; autoDeploy: boolean }> {
+    const validOptions = [Constants.Apex, Constants.ExpSites, Constants.FlexiPage];
+    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);
+      }
+    }
+
+    const autoDeploy = await this.getAutoDeployConsent();
+    let projectPath: string;
+    let targetApexNamespace: string;
+    // 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
+      );
+      Logger.logVerbose(
+        'The objects to process after handleExpSitePrerequisite are ' + JSON.stringify(objectsToProcess)
+      );
+    }
+
+    return { objectsToProcess, projectPath, targetApexNamespace, autoDeploy };
+  }
+
+  private async getAutoDeployConsent(): Promise<boolean> {
+    const askWithTimeOut = PromptUtil.askWithTimeOut(messages);
+    let validResponse = false;
+    let consent = false;
+
+    while (!validResponse) {
+      try {
+        const resp = await askWithTimeOut(Logger.prompt.bind(Logger), messages.getMessage('autoDeployConsentMessage'));
+        const response = typeof resp === 'string' ? resp.trim().toLowerCase() : '';
+
+        if (response === YES_SHORT || response === YES_LONG) {
+          consent = true;
+          validResponse = true;
+        } else if (response === NO_SHORT || response === NO_LONG) {
+          consent = false;
+          validResponse = true;
+        } else {
+          Logger.error(messages.getMessage('invalidYesNoResponse'));
+        }
+      } catch (err) {
+        Logger.error(messages.getMessage('requestTimedOut'));
+        process.exit(1);
+      }
+    }
+
+    return consent;
   }
 
   private async getMigrationConsent(): Promise<boolean> {

src/migration/deployer.ts

@@ -0,0 +1,34 @@
+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 authEnvKey = 'OMA_AUTH_KEY';
+  private readonly authKey: string;
+  private readonly requiredNodeDependency = '@omnistudio/[email protected]';
+  private readonly username: string;
+  private readonly messages: Messages;
+
+  public constructor(projectPath: string, messages: Messages, username: string) {
+    this.projectPath = projectPath;
+    this.username = username;
+    this.authKey = process.env[this.authEnvKey];
+    this.messages = messages;
+
+    if (!this.authKey) {
+      throw new Error(`${this.authEnvKey} environment variable is not set`);
+    }
+  }
+
+  public deploy(): void {
+    shell.cd(this.projectPath);
+    sfProject.createNPMConfigFile(this.authKey);
+    Logger.logVerbose(this.messages.getMessage('installingRequiredDependencies'));
+    sfProject.installDependency();
+    sfProject.installDependency(this.requiredNodeDependency);
+    sfProject.deployFromManifest(path.join(process.cwd(), 'package.xml'), this.username);
+  }
+}

src/migration/postMigrate.ts

@@ -8,10 +8,13 @@ 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';
 
 export class PostMigrate extends BaseMigrationTool {
   private readonly org: Org;
   private readonly relatedObjectsToProcess: string[];
+  private readonly projectPath: string;
+  private readonly autoDeploy: boolean;
 
   // Source Custom Object Names
   constructor(
@@ -21,11 +24,15 @@ export class PostMigrate extends BaseMigrationTool {
     logger: Logger,
     messages: Messages,
     ux: UX,
-    relatedObjectsToProcess: string[]
+    relatedObjectsToProcess: string[],
+    autoDeploy: boolean,
+    projectPath: string
   ) {
     super(namespace, connection, logger, messages, ux);
     this.org = org;
     this.relatedObjectsToProcess = relatedObjectsToProcess;
+    this.autoDeploy = autoDeploy;
+    this.projectPath = projectPath;
   }
 
   public async setDesignersToUseStandardDataModel(
@@ -77,4 +84,16 @@ export class PostMigrate extends BaseMigrationTool {
       }
     }
   }
+
+  public deploy(): void {
+    if (!this.autoDeploy) {
+      return;
+    }
+    try {
+      const deployer = new Deployer(this.projectPath, this.messages, this.org.getUsername());
+      deployer.deploy();
+    } catch (error) {
+      Logger.error(this.messages.getMessage('errorDeployingComponents'), error);
+    }
+  }
 }

src/utils/generatePackageXml.ts

@@ -13,7 +13,8 @@ export class generatePackageXml {
     apexAssementInfos: ApexAssessmentInfo[],
     lwcAssessmentInfos: LWCAssessmentInfo[],
     experienceSiteAssessmentInfo: ExperienceSiteAssessmentInfo[],
-    flexipageAssessmentInfos: FlexiPageAssessmentInfo[]
+    flexipageAssessmentInfos: FlexiPageAssessmentInfo[],
+    version: string
   ): void {
     const apexXml = generatePackageXml.getXmlElementforMembers(this.getApexclasses(apexAssementInfos), 'ApexClass');
     const lwcXml = generatePackageXml.getXmlElementforMembers(
@@ -31,38 +32,18 @@ export class generatePackageXml {
       'FlexiPage'
     );
 
-    const additionalTypes = `
-    <types>
-        <members>*</members>
-        <name>OmniDataTransform</name>
-    </types>
-    <types>
-        <members>*</members>
-        <name>OmniIntegrationProcedure</name>
-    </types>
-    <types>
-        <members>*</members>
-        <name>OmniScript</name>
-    </types>
-    <types>
-        <members>*</members>
-        <name>OmniUiCard</name>
-    </types>
-  `;
-
     const packageXmlContent = `
 <?xml version="1.0" encoding="UTF-8"?>
 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
       ${apexXml}
       ${lwcXml}
       ${expsiteXml}
       ${flexipageXml}
-      ${additionalTypes}
-    <version>57.0</version>
+    <version>${version}</version>
 </Package>
 `;
 
-    const filePath = path.join(__dirname, 'package.xml');
+    const filePath = path.join(process.cwd(), 'package.xml');
     fs.writeFileSync(filePath, packageXmlContent.trim());
   }
 

src/utils/sfcli/project/sfProject.ts

@@ -1,3 +1,4 @@
+import * as fs from 'fs';
 import { Messages } from '@salesforce/core';
 import { Logger } from '../../logger';
 import { cli } from '../../shell/cli';
@@ -27,9 +28,32 @@ export class sfProject {
     Logger.log(messages.getMessage('metadataDeployed', [metadataName, username]));
   }
 
+  public static installDependency(dependency?: string): void {
+    Logger.logVerbose(messages.getMessage('installingDependency', [dependency]));
+    const cmd = `npm install ${dependency || ''}`;
+    sfProject.executeCommand(cmd);
+    Logger.logVerbose(messages.getMessage('dependencyInstalled', [dependency]));
+  }
+
+  public static deployFromManifest(manifestPath: string, username: string): void {
+    Logger.logVerbose(messages.getMessage('deployingFromManifest'));
+    const cmd = `sf project deploy start --manifest ${manifestPath} --target-org ${username}`;
+    sfProject.executeCommand(cmd);
+    Logger.logVerbose(messages.getMessage('manifestDeployed'));
+  }
+
+  public static createNPMConfigFile(authKey: string): void {
+    Logger.logVerbose(messages.getMessage('creatingNPMConfigFile'));
+    fs.writeFileSync(
+      '.npmrc',
+      `always-auth=true\nregistry=https://repo.vlocity.com/repository/npm-public/\n//repo.vlocity.com/repository/npm-public/:_auth="${authKey}"`
+    );
+    Logger.logVerbose(messages.getMessage('npmConfigFileCreated'));
+  }
+
   private static executeCommand(cmd: string): void {
     try {
-      cli.exec(`${cmd} --json > /dev/null 2>&1`);
+      cli.exec(`${cmd} --json`);
     } catch (error) {
       Logger.error(messages.getMessage('sfProjectCommandError', [String(error)]));
       throw error;

src/utils/shell/cli.ts

@@ -6,14 +6,10 @@ import * as shell from 'shelljs';
 
 export class cli {
   public static exec(cmd: string): string {
-    const exec = shell.exec(cmd);
-    let stdout: string;
+    const exec = shell.exec(cmd, { silent: true });
     if (exec.code !== 0) {
-      stdout = exec.stderr;
-    } else {
-      stdout = exec.stdout;
+      throw new Error(`Command failed with exit code ${exec.code}: ${exec.stderr || exec.stdout}`);
     }
-
-    return stdout;
+    return exec.stdout;
   }
 }