fix: @W-19637353: Addressed review comments and test failure fixes

Author: sf-kishore-kurri

README.md

@@ -1,4 +1,4 @@
-# OmniStudio Migration Assistant
+# Omnistudio Migration Assistant
 
 The Omnistudio Migration Assistant is a command-line interface (CLI) plugin that you install via Salesforce CLI. It creates records for your omnistudio components on the Salesforce standard objects.
 

messages/migrate.json

@@ -281,5 +281,7 @@
   "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",
   "deploymentNonRetryableError": "Deployment failed with non-retryable error: %s. Please review and fix the issue manually",
-  "deploymentTriggeredSuccessfully": "Please monitor your Deployment: %s using deployment status page in Org"
+  "deploymentTriggeredSuccessfully": "Please monitor your Deployment: %s using deployment status page in Org",
+  "omniscriptPackageDeploymentFailedReturnedFalse": "Omniscript package deployment failed - deployment returned false. This may be due to missing package, permissions, or deployment timeout.",
+  "omniscriptPackageDeploymentFailedWithMessage": "Omniscript package deployment failed: %s"
 }

src/migration/deployer.ts

@@ -67,10 +67,11 @@ export class Deployer {
       if (success) {
         Logger.log(this.messages.getMessage('omniscriptPackageIntegrated'));
       } else {
-        const errorMsg =
-          'Omniscript package deployment failed - deployment returned false. This may be due to missing package, permissions, or deployment timeout.';
+        const errorMsg = this.messages.getMessage('omniscriptPackageDeploymentFailedReturnedFalse');
         Logger.error(errorMsg);
-        throw new OmniscriptPackageDeploymentError('Omniscript package deployment failed: ' + errorMsg);
+        throw new OmniscriptPackageDeploymentError(
+          this.messages.getMessage('omniscriptPackageDeploymentFailedWithMessage', [errorMsg])
+        );
       }
     } catch (error) {
       const errorMessage = error instanceof Error ? error.message : String(error);
@@ -80,7 +81,9 @@ export class Deployer {
       if (error instanceof OmniscriptPackageDeploymentError) {
         throw error;
       } else {
-        throw new OmniscriptPackageDeploymentError('Omniscript package deployment failed: ' + errorMessage);
+        throw new OmniscriptPackageDeploymentError(
+          this.messages.getMessage('omniscriptPackageDeploymentFailedWithMessage', [errorMessage])
+        );
       }
     }
   }

test/migration/deployer.test.ts

@@ -59,6 +59,14 @@ describe('Deployer', () => {
     getMessageStub
       .withArgs('deploymentNonRetryableError')
       .returns('Deployment failed with non-retryable error: %s. Please review and fix the issue manually.');
+    getMessageStub
+      .withArgs('omniscriptPackageDeploymentFailedReturnedFalse')
+      .returns(
+        'Omniscript package deployment failed - deployment returned false. This may be due to missing package, permissions, or deployment timeout.'
+      );
+    getMessageStub
+      .withArgs('omniscriptPackageDeploymentFailedWithMessage')
+      .callsFake((key: string, args: string[]) => `Omniscript package deployment failed: ${args[0]}`);
 
     // Mock Logger
     sandbox.stub(Logger, 'logVerbose');

test/migration/postMigrate.test.ts

@@ -4,6 +4,7 @@
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable camelcase */
 import * as fs from 'fs';
+import * as path from 'path';
 import { expect } from '@salesforce/command/lib/test';
 import { Connection, Messages, Org } from '@salesforce/core';
 import { UX } from '@salesforce/command';
@@ -124,6 +125,14 @@ describe('PostMigrate', () => {
     getMessageStub
       .withArgs('deploymentNonRetryableError')
       .returns('Deployment failed with non-retryable error: %s. Please review and fix the issue manually.');
+    getMessageStub
+      .withArgs('omniscriptPackageDeploymentFailedReturnedFalse')
+      .returns(
+        'Omniscript package deployment failed - deployment returned false. This may be due to missing package, permissions, or deployment timeout.'
+      );
+    getMessageStub
+      .withArgs('omniscriptPackageDeploymentFailedWithMessage')
+      .callsFake((key: string, args: string[]) => `Omniscript package deployment failed: ${args[0]}`);
     // Other messages referenced by implementation
     getMessageStub.withArgs('checkingStandardDesignerStatus', [testNamespace]).returns('Checking designer status');
     getMessageStub.withArgs('standardDesignerAlreadyEnabled', [testNamespace]).returns('Designer already enabled');
@@ -199,16 +208,31 @@ describe('PostMigrate', () => {
       // Use existing stubs from beforeEach setup
       const deployLogVerboseStub = Logger.logVerbose as sinon.SinonStub;
       const actionItems: string[] = [];
+      // Create a temporary package.xml file to ensure fs.existsSync returns true
+      const tempPackageXml = path.join(process.cwd(), 'package.xml');
+      fs.writeFileSync(tempPackageXml, '<?xml version="1.0" encoding="UTF-8"?><Package></Package>');
+
+      // Clean up after test
+      const cleanup = () => {
+        if (fs.existsSync(tempPackageXml)) {
+          fs.unlinkSync(tempPackageXml);
+        }
+      };
 
       // Act
       await postMigrate.deploy(actionItems);
 
-      // Assert
-      expect(deployerStub.called).to.be.true;
-      expect(logErrorStub.called).to.be.true;
-      expect(deployLogVerboseStub.called).to.be.true;
-      expect(actionItems.length).to.be.greaterThan(0);
-      expect(actionItems[0]).to.include('Omniscript customization package deployment failed');
+      try {
+        // Assert
+        expect(deployerStub.called).to.be.true;
+        expect(logErrorStub.called).to.be.true;
+        expect(deployLogVerboseStub.called).to.be.true;
+        expect(actionItems.length).to.be.greaterThan(0);
+        expect(actionItems[0]).to.include('Omniscript customization package deployment failed');
+      } finally {
+        // Always clean up the temporary file
+        cleanup();
+      }
     });
 
     it('should create Deployer with correct parameters', () => {