Merge branch 'v2-dev' into fix/dx-7341-fix-chalk-load-error

Author: harshitha-cstk

.github/workflows/unit-test.yml

@@ -31,6 +31,6 @@ jobs:
         working-directory: ./packages/contentstack-auth
         run: pnpm test
       # Commented out in v2-beta production
-      # - name: Test contentstack-utilities
-      #   working-directory: ./packages/contentstack-utilities
-      #   run: pnpm test
+      - name: Test contentstack-utilities
+        working-directory: ./packages/contentstack-utilities
+        run: pnpm test

packages/contentstack-config/src/commands/config/set/region.ts

@@ -46,8 +46,8 @@ export default class RegionSetCommand extends BaseCommand<typeof RegionSetComman
     studio: _flags.string({
       description: 'Custom host to set for Studio API',
     }),
-    'asset-management': _flags.string({
-      description: 'Custom host to set for Asset Management API',
+    'cs-assets': _flags.string({
+      description: 'Custom host to set for Contentstack Assets API',
     }),
   };
   static examples = [
@@ -64,7 +64,7 @@ export default class RegionSetCommand extends BaseCommand<typeof RegionSetComman
     '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --personalize <custom_personalize_url>',
     '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --launch <custom_launch_url>',
     '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --studio <custom_studio_url>',
-    '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --asset-management <asset_management_url>',
+    '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --cs-assets <cs_assets_url>',
     '$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url>',
   ];
 
@@ -82,7 +82,7 @@ export default class RegionSetCommand extends BaseCommand<typeof RegionSetComman
     let personalizeUrl = regionSetFlags['personalize'];
     let launchHubUrl = regionSetFlags['launch'];
     let composableStudioUrl = regionSetFlags['studio'];
-    let assetManagementUrl = regionSetFlags['asset-management'];
+    let csAssetsUrl = regionSetFlags['cs-assets'];
     let selectedRegion = args.region;
     if (!(cda && cma && uiHost && name) && !selectedRegion) {
       selectedRegion = await interactive.askRegions();
@@ -113,8 +113,8 @@ export default class RegionSetCommand extends BaseCommand<typeof RegionSetComman
         if (!composableStudioUrl) {
           composableStudioUrl = this.transformUrl(cma, 'composable-studio-api');
         }
-        if (!assetManagementUrl) {
-          assetManagementUrl = this.transformUrl(cma, 'am-api');
+        if (!csAssetsUrl) {
+          csAssetsUrl = this.transformUrl(cma, 'am-api');
         }
         let customRegion: Region = {
           cda,
@@ -125,7 +125,7 @@ export default class RegionSetCommand extends BaseCommand<typeof RegionSetComman
           personalizeUrl,
           launchHubUrl,
           composableStudioUrl,
-          assetManagementUrl,
+          csAssetsUrl,
         };
         customRegion = regionHandler.setCustomRegion(customRegion);
         await authHandler.setConfigData('logout'); //Todo: Handle this logout flow well through logout command call
@@ -137,7 +137,7 @@ export default class RegionSetCommand extends BaseCommand<typeof RegionSetComman
         cliux.success(`Personalize URL: ${customRegion.personalizeUrl}`);
         cliux.success(`Launch URL: ${customRegion.launchHubUrl}`);
         cliux.success(`Studio URL: ${customRegion.composableStudioUrl}`);
-        cliux.success(`Asset Management URL: ${customRegion.assetManagementUrl}`);
+        cliux.success(`Contentstack Assets URL: ${customRegion.csAssetsUrl}`);
       } catch (error) {
         handleAndLogError(error, { ...this.contextDetails, module: 'config-set-region' });
       }
@@ -156,7 +156,7 @@ export default class RegionSetCommand extends BaseCommand<typeof RegionSetComman
       cliux.success(`Personalize URL: ${regionDetails.personalizeUrl}`);
       cliux.success(`Launch URL: ${regionDetails.launchHubUrl}`);
       cliux.success(`Studio URL: ${regionDetails.composableStudioUrl}`);
-      cliux.success(`Asset Management URL: ${regionDetails.assetManagementUrl}`);
+      cliux.success(`Contentstack Assets URL: ${regionDetails.csAssetsUrl}`);
     } else {
       cliux.error(`Invalid region specified.`);
     }

packages/contentstack-config/src/interfaces/index.ts

@@ -19,7 +19,7 @@ export interface Region {
   personalizeUrl: string;
   launchHubUrl: string;
   composableStudioUrl: string;
-  assetManagementUrl?: string;
+  csAssetsUrl?: string;
 }
 
 export interface Limit {

packages/contentstack-config/src/utils/region-handler.ts

@@ -40,7 +40,7 @@ function getRegionObject(regionKey: string): Region {
       launchHubUrl: endpoints.launch,
       personalizeUrl: endpoints.personalizeManagement,
       composableStudioUrl: endpoints.composableStudio,
-      assetManagementUrl: endpoints.assetManagement,
+      csAssetsUrl: endpoints.assetManagement,
     };
   } catch {
     return null;
@@ -156,7 +156,7 @@ class UserConfig {
       personalizeUrl: regionObject['personalizeUrl'],
       launchHubUrl: regionObject['launchHubUrl'],
       composableStudioUrl: regionObject['composableStudioUrl'],
-      assetManagementUrl: regionObject['assetManagementUrl'],
+      csAssetsUrl: regionObject['csAssetsUrl'],
     };
 
     return sanitizedRegion;

packages/contentstack-config/test/unit/commands/region.test.ts

@@ -17,7 +17,7 @@ describe('Region command', function () {
     launchHubUrl: 'https://launch-api.contentstack.com',
     personalizeUrl: 'https://personalization-api.contentstack.com',
     composableStudioUrl: 'https://composable-studio-api.contentstack.com',
-    assetManagementUrl: 'https://am-api.contentstack.com',
+    csAssetsUrl: 'https://am-api.contentstack.com',
   };
   let cliuxPrintStub: sinon.SinonStub;
   let configGetStub: sinon.SinonStub;
@@ -310,7 +310,7 @@ describe('Region command', function () {
       personalizeUrl: 'https://custom-personalize.com',
       launchHubUrl: 'https://custom-launch.com',
       composableStudioUrl: 'https://custom-composable-studio.com',
-      assetManagementUrl: 'https://custom-asset-management.com',
+      csAssetsUrl: 'https://custom-asset-management.com',
     };
     const result = UserConfig.setCustomRegion(customRegion);
     expect(result).to.deep.equal(customRegion);

packages/contentstack-utilities/test/unit/auth-handler.test.ts

@@ -1,7 +1,7 @@
 //@ts-nocheck
 import { expect } from 'chai';
 import { assert, stub, createSandbox } from 'sinon';
-import { cliux } from '@contentstack/cli-utilities';
+import cliux from '../../src/cli-ux';
 import authHandler from '../../src/auth-handler';
 import configHandler from '../../src/config-handler';
 import { HttpClient } from '../../src/http-client';
@@ -32,15 +32,18 @@ describe('Auth Handler', () => {
   describe('oauth', () => {
     let createHTTPServerStub;
     let openOAuthURLStub;
+    let initSDKStub;
 
     beforeEach(() => {
+      initSDKStub = stub(authHandler, 'initSDK').resolves();
       createHTTPServerStub = stub(authHandler, 'createHTTPServer');
       openOAuthURLStub = stub(authHandler, 'openOAuthURL');
     });
 
     afterEach(() => {
       createHTTPServerStub.restore();
       openOAuthURLStub.restore();
+      initSDKStub.restore();
     });
 
     it('should reject with an error when createHTTPServer fails', async () => {
@@ -167,16 +170,21 @@ describe('Auth Handler', () => {
       };
 
       const exchangeStub = sandbox.stub().resolves(userData);
-      sandbox.stub(authHandler, 'oauthHandler').value({
+      const prevOAuthHandler = authHandler.oauthHandler;
+      authHandler.oauthHandler = {
         exchangeCodeForToken: exchangeStub,
-      });
+      };
       const getUserDetailsStub = sandbox.stub(authHandler, 'getUserDetails').resolves(userData);
       const setConfigDataStub = sandbox.stub(authHandler, 'setConfigData').resolves();
-      await authHandler.getAccessToken(code);
-      // Verify the actual calls made:
-      assert.calledWith(exchangeStub, code); // exchangeCodeForToken called with code
-      assert.calledWith(getUserDetailsStub, userData); // getUserDetails called with result from exchange
-      assert.calledWith(setConfigDataStub, 'oauth', userData); // setConfigData called with 'oauth' and userData
+      try {
+        await authHandler.getAccessToken(code);
+        // Verify the actual calls made:
+        assert.calledWith(exchangeStub, code); // exchangeCodeForToken called with code
+        assert.calledWith(getUserDetailsStub, userData); // getUserDetails called with result from exchange
+        assert.calledWith(setConfigDataStub, 'oauth', userData); // setConfigData called with 'oauth' and userData
+      } finally {
+        authHandler.oauthHandler = prevOAuthHandler;
+      }
     });
   });
 
@@ -296,51 +304,59 @@ describe('Auth Handler', () => {
       };
       // Stub oauthHandler with refreshAccessToken method
       const refreshAccessTokenStub = sandbox.stub().resolves(expectedData);
-      sandbox.stub(authHandler, 'oauthHandler').value({
+      const prevOAuthHandler = authHandler.oauthHandler;
+      authHandler.oauthHandler = {
         refreshAccessToken: refreshAccessTokenStub,
-      });
-      // Stub configHandler.get to return proper values
-      sandbox
-        .stub(configHandler, 'get')
-        .withArgs(authHandler.oauthRefreshTokenKeyName)
-        .returns(configOauthRefreshToken)
-        .withArgs(authHandler.authorisationTypeKeyName)
-        .returns(configAuthorisationType);
-      // Stub setConfigData
-      sandbox.stub(authHandler, 'setConfigData').resolves(expectedData);
-      const result = await authHandler.refreshToken();
-      // Verify calls
-      assert.calledWith(refreshAccessTokenStub, configOauthRefreshToken);
-      assert.calledWith(authHandler.setConfigData, 'refreshToken', expectedData);
-      expect(result).to.deep.equal(expectedData);
+      };
+      try {
+        // Stub configHandler.get to return proper values
+        sandbox
+          .stub(configHandler, 'get')
+          .withArgs(authHandler.oauthRefreshTokenKeyName)
+          .returns(configOauthRefreshToken)
+          .withArgs(authHandler.authorisationTypeKeyName)
+          .returns(configAuthorisationType);
+        // Stub setConfigData
+        sandbox.stub(authHandler, 'setConfigData').resolves(expectedData);
+        const result = await authHandler.refreshToken();
+        // Verify calls
+        assert.calledWith(refreshAccessTokenStub, configOauthRefreshToken);
+        assert.calledWith(authHandler.setConfigData, 'refreshToken', expectedData);
+        expect(result).to.deep.equal(expectedData);
+      } finally {
+        authHandler.oauthHandler = prevOAuthHandler;
+      }
     });
   });
 
   describe('getUserDetails', () => {
     let sandbox;
-    let managementAPIClientStub;
 
     beforeEach(() => {
       sandbox = createSandbox();
-      managementAPIClientStub = sandbox.stub();
     });
 
     afterEach(() => {
       sandbox.restore();
+      authHandler.managementAPIClient = undefined;
     });
 
-    it('should reject with error when access token is invalid/empty', async () => {
+    it('should reject when Management SDK getUser fails', async () => {
       const data = {
         access_token: config.invalid_access_token,
       };
       const expectedError = new Error('The provided access token is invalid or expired or revoked');
 
       const getUserStub = sandbox.stub().rejects(expectedError);
-      managementAPIClientStub.returns({ getUser: getUserStub });
+      authHandler.managementAPIClient = { getUser: getUserStub };
 
-      authHandler.contentstackManagementSDKClient = managementAPIClientStub;
-
-      authHandler.getUserDetails(data);
+      try {
+        await authHandler.getUserDetails(data);
+        expect.fail('Expected getUserDetails to reject');
+      } catch (error) {
+        expect(error).to.equal(expectedError);
+      }
+      assert.calledOnce(getUserStub);
     });
 
     it('should reject with error when access token is invalid/empty', async () => {

packages/contentstack-utilities/test/unit/cliProgressManager.test.ts

@@ -223,12 +223,28 @@ describe('CLIProgressManager', () => {
 
     fancy.it('should create simple progress manager', () => {
       const simple = CLIProgressManager.createSimple('testModule', 50, true);
-      expect(simple).to.be.instanceOf(CLIProgressManager);
+      try {
+        expect(simple).to.be.instanceOf(CLIProgressManager);
+      } finally {
+        try {
+          simple.stop();
+        } catch (e) {
+          // ignore
+        }
+      }
     });
 
     fancy.it('should create nested progress manager', () => {
       const nested = CLIProgressManager.createNested('testModule', false);
-      expect(nested).to.be.instanceOf(CLIProgressManager);
+      try {
+        expect(nested).to.be.instanceOf(CLIProgressManager);
+      } finally {
+        try {
+          nested.stop();
+        } catch (e) {
+          // ignore
+        }
+      }
     });
 
     fancy.it('should validate static factory methods exist', () => {
@@ -253,15 +269,16 @@ describe('CLIProgressManager', () => {
       }
     });
 
-    fancy.it('should skip global summary when showConsoleLogs is true (pure console log mode)', () => {
+    // printGlobalSummary always calls printFinalSummary; log.showConsoleLogs only gates the header in initializeGlobalSummary.
+    fancy.it('should print global summary when showConsoleLogs is true (same as printGlobalSummary behavior)', () => {
       const summaryStub = sinon.stub(SummaryManager.prototype, 'printFinalSummary');
       const configGetStub = sinon.stub(configHandler, 'get').callThrough();
       configGetStub.withArgs('log').returns({ showConsoleLogs: true });
 
       try {
         CLIProgressManager.initializeGlobalSummary('SKIP_SUMMARY_TEST', '');
         CLIProgressManager.printGlobalSummary();
-        expect(summaryStub.called).to.be.false;
+        expect(summaryStub.calledOnce).to.be.true;
       } finally {
         configGetStub.restore();
         summaryStub.restore();
@@ -305,8 +322,16 @@ describe('CLIProgressManager', () => {
 
     fancy.it('should handle non-nested mode gracefully', () => {
       const simpleManager = new CLIProgressManager({ enableNestedProgress: false });
-      const result = simpleManager.addProcess('process1', 50);
-      expect(result).to.equal(simpleManager);
+      try {
+        const result = simpleManager.addProcess('process1', 50);
+        expect(result).to.equal(simpleManager);
+      } finally {
+        try {
+          simpleManager.stop();
+        } catch (e) {
+          // ignore
+        }
+      }
     });
   });
 
@@ -334,10 +359,18 @@ describe('CLIProgressManager', () => {
         enableNestedProgress: true,
         moduleName: 'TEST',
       });
-      nestedManager.addProcess('process1', 10);
-      nestedManager.startProcess('process1');
-      const result = nestedManager.tick(true, 'item1', null, 'process1');
-      expect(result).to.equal(nestedManager);
+      try {
+        nestedManager.addProcess('process1', 10);
+        nestedManager.startProcess('process1');
+        const result = nestedManager.tick(true, 'item1', null, 'process1');
+        expect(result).to.equal(nestedManager);
+      } finally {
+        try {
+          nestedManager.stop();
+        } catch (e) {
+          // ignore
+        }
+      }
     });
 
     fancy.it('should update status message', () => {
@@ -432,8 +465,18 @@ describe('CLIProgressManager', () => {
         showConsoleLogs: false,
         moduleName: 'TEST',
       });
-      silentManager.log('Test message');
-      expect(consoleLogStub.called).to.be.false;
+      try {
+        // Ignore prior tests in this describe; only assert console.log for this log() call.
+        consoleLogStub.resetHistory();
+        silentManager.log('Test message');
+        expect(consoleLogStub.callCount).to.equal(0);
+      } finally {
+        try {
+          silentManager.stop();
+        } catch (e) {
+          // ignore
+        }
+      }
     });
 
     fancy.it('should not print Progress Manager summary when showConsoleLogs is true (pure console log mode)', () => {