feat: adds partial deployment if authKeydoesn't exist

Author: snehaljha-sf

messages/migrate.json

@@ -199,13 +199,14 @@
   "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 migrated components? [y/n]",
-  "errorDeployingComponents": "Error deploying components post migration",
+  "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",
   "manifestDeployed": "Metadata packages are deployed",
   "installingRequiredDependencies": "Installing required node dependencies",
   "creatingNPMConfigFile": "Creating npm config file",
-  "npmConfigFileCreated": "Npm config file created"
+  "npmConfigFileCreated": "Npm config file created",
+  "authKeyEnvVarNotSet": "OMA_AUTH_KEY environment variable is not set, LWCs will not be deployed"
 }

src/commands/omnistudio/migration/assess.ts

@@ -177,7 +177,7 @@ export default class Assess extends OmniStudioBaseCommand {
       messages,
       this.ux,
       objectsToProcess,
-      false,
+      undefined,
       undefined
     );
 

src/commands/omnistudio/migration/migrate.ts

@@ -33,6 +33,8 @@ import { GlobalAutoNumberMigrationTool } from '../../../migration/globalautonumb
 // Initialize Messages with the current plugin directory
 Messages.importMessagesDirectory(__dirname);
 
+const authEnvKey = 'OMA_AUTH_KEY';
+
 // Load the specific messages for this file. Messages from @salesforce/command, @salesforce/core,
 // or any library that is using the messages framework can also be loaded this way.
 const messages = Messages.loadMessages('@salesforce/plugin-omnistudio-migration-tool', 'migrate');
@@ -135,7 +137,7 @@ export default class Migrate extends OmniStudioBaseCommand {
     const preMigrate: PreMigrate = new PreMigrate(this.org, namespace, conn, this.logger, messages, this.ux);
     const isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean } = { value: false };
 
-    let autoDeploy = false;
+    let deploymentConfig = { autoDeploy: false, authKey: undefined };
     if (relatedObjects) {
       const relatedObjectMigrationResult = await this.migrateRelatedObjects(
         relatedObjects,
@@ -146,7 +148,7 @@ export default class Migrate extends OmniStudioBaseCommand {
       objectsToProcess = relatedObjectMigrationResult.objectsToProcess;
       projectPath = relatedObjectMigrationResult.projectPath;
       targetApexNamespace = relatedObjectMigrationResult.targetApexNamespace;
-      autoDeploy = relatedObjectMigrationResult.autoDeploy;
+      deploymentConfig = relatedObjectMigrationResult.deploymentConfig;
     }
 
     Logger.log(messages.getMessage('migrationInitialization', [String(namespace)]));
@@ -192,16 +194,10 @@ export default class Migrate extends OmniStudioBaseCommand {
       messages,
       this.ux,
       objectsToProcess,
-      autoDeploy,
+      deploymentConfig,
       projectPath
     );
 
-    try {
-      postMigrate.deploy();
-    } catch (error) {
-      Logger.error(messages.getMessage('errorDeployingComponents'), error);
-    }
-
     if (!migrateOnly) {
       await postMigrate.setDesignersToUseStandardDataModel(namespace, actionItems);
     }
@@ -216,12 +212,18 @@ export default class Migrate extends OmniStudioBaseCommand {
 
     generatePackageXml.createChangeList(
       relatedObjectMigrationResult.apexAssessmentInfos,
-      relatedObjectMigrationResult.lwcAssessmentInfos,
+      deploymentConfig.autoDeploy && deploymentConfig.authKey ? relatedObjectMigrationResult.lwcAssessmentInfos : [],
       relatedObjectMigrationResult.experienceSiteAssessmentInfos,
       relatedObjectMigrationResult.flexipageAssessmentInfos,
       this.org.getConnection().version
     );
 
+    try {
+      postMigrate.deploy();
+    } catch (error) {
+      Logger.error(messages.getMessage('errorDeployingComponents'), error);
+    }
+
     await ResultsBuilder.generateReport(
       objectMigrationResults,
       relatedObjectMigrationResult,
@@ -241,7 +243,12 @@ export default class Migrate extends OmniStudioBaseCommand {
     preMigrate: PreMigrate,
     conn: Connection,
     isExperienceBundleMetadataAPIProgramaticallyEnabled: { value: boolean }
-  ): Promise<{ objectsToProcess: string[]; projectPath: string; targetApexNamespace: string; autoDeploy: boolean }> {
+  ): Promise<{
+    objectsToProcess: string[];
+    projectPath: string;
+    targetApexNamespace: string;
+    deploymentConfig: { autoDeploy: boolean; authKey: string | undefined };
+  }> {
     const validOptions = [Constants.Apex, Constants.ExpSites, Constants.FlexiPage];
     const objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
     // Validate input
@@ -252,7 +259,7 @@ export default class Migrate extends OmniStudioBaseCommand {
       }
     }
 
-    const autoDeploy = await this.getAutoDeployConsent();
+    const deploymentConfig = await this.getAutoDeployConsent();
     let projectPath: string;
     let targetApexNamespace: string;
     // Check for general consent to make modifications with OMT
@@ -271,10 +278,10 @@ export default class Migrate extends OmniStudioBaseCommand {
       );
     }
 
-    return { objectsToProcess, projectPath, targetApexNamespace, autoDeploy };
+    return { objectsToProcess, projectPath, targetApexNamespace, deploymentConfig };
   }
 
-  private async getAutoDeployConsent(): Promise<boolean> {
+  private async getAutoDeployConsent(): Promise<{ autoDeploy: boolean; authKey: string | undefined }> {
     const askWithTimeOut = PromptUtil.askWithTimeOut(messages);
     let validResponse = false;
     let consent = false;
@@ -299,7 +306,18 @@ export default class Migrate extends OmniStudioBaseCommand {
       }
     }
 
-    return consent;
+    const deploymentConfig = {
+      autoDeploy: consent,
+      authKey: undefined,
+    };
+    if (consent) {
+      deploymentConfig.authKey = process.env[authEnvKey];
+      if (!deploymentConfig.authKey) {
+        Logger.error(messages.getMessage('authKeyEnvVarNotSet'));
+      }
+    }
+
+    return deploymentConfig;
   }
 
   private async getMigrationConsent(): Promise<boolean> {

src/migration/deployer.ts

@@ -6,29 +6,26 @@ 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) {
+  public constructor(projectPath: string, messages: Messages, username: string, authKey: 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`);
-    }
+    this.authKey = authKey;
   }
 
   public deploy(): void {
     shell.cd(this.projectPath);
-    sfProject.createNPMConfigFile(this.authKey);
-    Logger.logVerbose(this.messages.getMessage('installingRequiredDependencies'));
-    sfProject.installDependency();
-    sfProject.installDependency(this.requiredNodeDependency);
+    if (this.authKey) {
+      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

@@ -14,7 +14,7 @@ export class PostMigrate extends BaseMigrationTool {
   private readonly org: Org;
   private readonly relatedObjectsToProcess: string[];
   private readonly projectPath: string;
-  private readonly autoDeploy: boolean;
+  private readonly deploymentConfig: { autoDeploy: boolean; authKey: string | undefined };
 
   // Source Custom Object Names
   constructor(
@@ -25,13 +25,13 @@ export class PostMigrate extends BaseMigrationTool {
     messages: Messages,
     ux: UX,
     relatedObjectsToProcess: string[],
-    autoDeploy: boolean,
+    deploymentConfig: { autoDeploy: boolean; authKey: string | undefined },
     projectPath: string
   ) {
     super(namespace, connection, logger, messages, ux);
     this.org = org;
     this.relatedObjectsToProcess = relatedObjectsToProcess;
-    this.autoDeploy = autoDeploy;
+    this.deploymentConfig = deploymentConfig;
     this.projectPath = projectPath;
   }
 
@@ -86,11 +86,16 @@ export class PostMigrate extends BaseMigrationTool {
   }
 
   public deploy(): void {
-    if (!this.autoDeploy) {
+    if (!this.deploymentConfig.autoDeploy) {
       return;
     }
     try {
-      const deployer = new Deployer(this.projectPath, this.messages, this.org.getUsername());
+      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);

test/migration/deployer.test.ts

@@ -44,7 +44,7 @@ describe('Deployer', () => {
     sandbox.stub(sfProject, 'installDependency');
     sandbox.stub(sfProject, 'deployFromManifest');
 
-    deployer = new Deployer(testProjectPath, messages, testUsername);
+    deployer = new Deployer(testProjectPath, messages, testUsername, testAuthKey);
   });
 
   afterEach(() => {
@@ -62,24 +62,6 @@ describe('Deployer', () => {
       expect((deployer as any).messages).to.equal(messages);
       expect((deployer as any).requiredNodeDependency).to.equal('@omnistudio/[email protected]');
     });
-
-    it('should throw error when OMA_AUTH_KEY environment variable is not set', () => {
-      // Remove the environment variable
-      delete process.env.OMA_AUTH_KEY;
-
-      expect(() => {
-        new Deployer(testProjectPath, messages, testUsername);
-      }).to.throw('OMA_AUTH_KEY environment variable is not set');
-    });
-
-    it('should throw error when OMA_AUTH_KEY environment variable is empty', () => {
-      // Set empty environment variable
-      Object.assign(process.env, { OMA_AUTH_KEY: '' });
-
-      expect(() => {
-        new Deployer(testProjectPath, messages, testUsername);
-      }).to.throw('OMA_AUTH_KEY environment variable is not set');
-    });
   });
 
   describe('deploy', () => {
@@ -152,10 +134,6 @@ describe('Deployer', () => {
   });
 
   describe('private properties', () => {
-    it('should have correct authEnvKey', () => {
-      expect((deployer as any).authEnvKey).to.equal('OMA_AUTH_KEY');
-    });
-
     it('should have correct requiredNodeDependency', () => {
       expect((deployer as any).requiredNodeDependency).to.equal('@omnistudio/[email protected]');
     });

test/migration/postMigrate.test.ts

@@ -29,12 +29,13 @@ describe('PostMigrate', () => {
   const testRelatedObjectsToProcess = ['Flexipage', 'expsites'];
   const testProjectPath = '/test/project/path';
   const testUsername = '[email protected]';
+  const testAuthKey = 'test-auth-key';
 
   beforeEach(() => {
     sandbox = sinon.createSandbox();
 
     // Set up environment variable for Deployer
-    process.env.OMA_AUTH_KEY = 'test-auth-key';
+    process.env.OMA_AUTH_KEY = testAuthKey;
 
     // Mock org
     org = {
@@ -103,7 +104,7 @@ describe('PostMigrate', () => {
       messages,
       ux,
       testRelatedObjectsToProcess,
-      true,
+      { autoDeploy: true, authKey: testAuthKey },
       testProjectPath
     );
   });
@@ -119,7 +120,8 @@ describe('PostMigrate', () => {
       expect((postMigrate as any).org).to.equal(org);
       expect((postMigrate as any).relatedObjectsToProcess).to.deep.equal(testRelatedObjectsToProcess);
       expect((postMigrate as any).projectPath).to.equal(testProjectPath);
-      expect((postMigrate as any).autoDeploy).to.be.true;
+      expect((postMigrate as any).deploymentConfig.autoDeploy).to.be.true;
+      expect((postMigrate as any).deploymentConfig.authKey).to.equal(testAuthKey);
       expect((postMigrate as any).namespace).to.equal(testNamespace);
       expect((postMigrate as any).connection).to.equal(connection);
       expect((postMigrate as any).logger).to.equal(logger);
@@ -128,35 +130,6 @@ describe('PostMigrate', () => {
     });
 
     it('should initialize with autoDeploy set to false', () => {
-      const postMigrateNoDeploy = new PostMigrate(
-        org,
-        testNamespace,
-        connection,
-        logger,
-        messages,
-        ux,
-        testRelatedObjectsToProcess,
-        false,
-        testProjectPath
-      );
-
-      expect((postMigrateNoDeploy as any).autoDeploy).to.be.false;
-    });
-  });
-
-  describe('deploy', () => {
-    it('should deploy when autoDeploy is true', () => {
-      // Arrange
-      const deployerStub = sandbox.stub(Deployer.prototype, 'deploy');
-
-      // Act
-      postMigrate.deploy();
-
-      // Assert
-      expect(deployerStub.called).to.be.true;
-    });
-
-    it('should not deploy when autoDeploy is false', () => {
       // Arrange
       const postMigrateNoDeploy = new PostMigrate(
         org,
@@ -166,7 +139,7 @@ describe('PostMigrate', () => {
         messages,
         ux,
         testRelatedObjectsToProcess,
-        false,
+        { autoDeploy: false, authKey: testAuthKey },
         testProjectPath
       );
       const deployerStub = sandbox.stub(Deployer.prototype, 'deploy');
@@ -175,6 +148,7 @@ describe('PostMigrate', () => {
       postMigrateNoDeploy.deploy();
 
       // Assert
+      expect((postMigrateNoDeploy as any).deploymentConfig.autoDeploy).to.be.false;
       expect(deployerStub.called).to.be.false;
     });
 
@@ -308,7 +282,7 @@ describe('PostMigrate', () => {
         messages,
         ux,
         undefined as any,
-        true,
+        { autoDeploy: true, authKey: testAuthKey },
         testProjectPath
       );
       const userActionMessage: string[] = [];
@@ -339,7 +313,7 @@ describe('PostMigrate', () => {
         messages,
         ux,
         null as any,
-        true,
+        { autoDeploy: true, authKey: testAuthKey },
         testProjectPath
       );
       const userActionMessage: string[] = [];
@@ -370,7 +344,7 @@ describe('PostMigrate', () => {
         messages,
         ux,
         ['Flexipage'], // No expsites
-        true,
+        { autoDeploy: true, authKey: testAuthKey },
         testProjectPath
       );
       const userActionMessage: string[] = [];
@@ -466,7 +440,7 @@ describe('PostMigrate', () => {
         messages,
         ux,
         testRelatedObjectsToProcess,
-        false,
+        { autoDeploy: false, authKey: testAuthKey },
         testProjectPath
       );
       const deployerStub = sandbox.stub(Deployer.prototype, 'deploy');