Merge pull request #2037 from contentstack/feat/DX-3288

feat: Integrated CLIProgressManager and SummaryManager in export

Author: aman19K

.talismanrc

@@ -1,6 +1,6 @@
 fileignoreconfig:
   - filename: pnpm-lock.yaml
-    checksum: 8f1591ae8c7da0f3415c0132c1585491b481dab49e1dda2a95ff29c014590c61
+    checksum: 0bfb05bb772a26be604bab6c93a58f93bcdc564b26547a1e8365222a679ae23d
   - filename: packages/contentstack-import/test/integration/auth-token-modules/environments.test.js
     checksum: bc6f06b75d082aaf99e2f2f4b932b143765e2f14086967fb8973fe1b2ca6c03e
   - filename: packages/contentstack-import/test/integration/environments.test.js

packages/contentstack-config/src/commands/config/get/log.ts

@@ -11,18 +11,21 @@ export default class LogGetCommand extends Command {
       const currentLoggingConfig = configHandler.get('log') || {};
       const logLevel = currentLoggingConfig?.level;
       const logPath = currentLoggingConfig?.path;
+      const showConsoleLogs = currentLoggingConfig?.showConsoleLogs;
 
       if (logLevel || logPath) {
         const logConfigList = [
           {
             'Log Level': logLevel || 'Not set',
             'Log Path': logPath || 'Not set',
+            'Show Console Logs': showConsoleLogs !== undefined ? String(showConsoleLogs) : 'Not set',
           },
         ];
 
         const headers: TableHeader[] = [
           { value: 'Log Level' },
           { value: 'Log Path' },
+          { value: 'Show Console Logs' },
         ];
 
         cliux.table(headers, logConfigList);

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

@@ -34,7 +34,9 @@ export default class LogSetCommand extends Command {
       let logLevel: string = flags['level'];
       let logPath: string = flags['path'];
       const showConsoleLogs: boolean = flags['show-console-logs'];
-
+      const currentLoggingConfig = configHandler.get('log') || {};
+      logLevel = logLevel || currentLoggingConfig?.level;
+      logPath = logPath || currentLoggingConfig?.path;
       // Interactive prompts if not passed via flags
       if (!logLevel) {
         logLevel = await interactive.askLogLevel();
@@ -44,10 +46,9 @@ export default class LogSetCommand extends Command {
         logPath = await interactive.askLogPath();
       }
 
-      const currentLoggingConfig = configHandler.get('log') || {};
       if (logLevel) currentLoggingConfig.level = logLevel;
       if (logPath) currentLoggingConfig.path = logPath;
-      currentLoggingConfig['show-console-logs'] = showConsoleLogs;
+      currentLoggingConfig.showConsoleLogs = showConsoleLogs;
 
       configHandler.set('log', currentLoggingConfig);
 

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

@@ -45,7 +45,7 @@ describe('Log Commands', () => {
         setStub.calledWith('log', {
           level: 'debug',
           path: './logs/app.log',
-          'show-console-logs': false,
+          showConsoleLogs: false,
         }),
       ).to.be.true;
 
@@ -74,7 +74,7 @@ describe('Log Commands', () => {
         setStub.calledWith('log', {
           level: 'info',
           path: './custom/logs/app.log',
-          'show-console-logs': false,
+          showConsoleLogs: false,
         }),
       ).to.be.true;
 
@@ -103,7 +103,7 @@ describe('Log Commands', () => {
         setStub.calledWith('log', {
           level: 'warn',
           path: './existing/logs/app.log',
-          'show-console-logs': false,
+          showConsoleLogs: false,
         }),
       ).to.be.true;
 
@@ -132,7 +132,7 @@ describe('Log Commands', () => {
         setStub.calledWith('log', {
           level: 'error',
           path: './new/logs/app.log',
-          'show-console-logs': false,
+          showConsoleLogs: false,
         }),
       ).to.be.true;
 
@@ -159,7 +159,7 @@ describe('Log Commands', () => {
         setStub.calledWith('log', {
           level: 'info',
           path: './logs/app.log',
-          'show-console-logs': true,
+          showConsoleLogs: true,
         }),
       ).to.be.true;
 
@@ -184,7 +184,7 @@ describe('Log Commands', () => {
         setStub.calledWith('log', {
           level: 'info',
           path: './logs/app.log',
-          'show-console-logs': false,
+          showConsoleLogs: false,
         }),
       ).to.be.true;
 
@@ -210,7 +210,7 @@ describe('Log Commands', () => {
         setStub.calledWith('log', {
           level: 'warn',
           path: './logs/warnings.log',
-          'show-console-logs': true,
+          showConsoleLogs: true,
         }),
       ).to.be.true;
 
@@ -241,7 +241,7 @@ describe('Log Commands', () => {
         setStub.calledWith('log', {
           level: 'info',
           path: './logs/app.log',
-          'show-console-logs': false,
+          showConsoleLogs: false,
         }),
       ).to.be.true;
 
@@ -290,11 +290,12 @@ describe('Log Commands', () => {
       await cmd.run();
 
       expect(tableMessage).to.have.length(1);
-      expect(tableMessage[0].headers).to.deep.equal([{ value: 'Log Level' }, { value: 'Log Path' }]);
+      expect(tableMessage[0].headers).to.deep.equal([{ value: 'Log Level' }, { value: 'Log Path' }, { value: 'Show Console Logs' }]);
       expect(tableMessage[0].data).to.deep.equal([
         {
           'Log Level': 'debug',
           'Log Path': './logs/app.log',
+          'Show Console Logs': 'Not set',
         },
       ]);
     });
@@ -306,11 +307,12 @@ describe('Log Commands', () => {
       await cmd.run();
 
       expect(tableMessage).to.have.length(1);
-      expect(tableMessage[0].headers).to.deep.equal([{ value: 'Log Level' }, { value: 'Log Path' }]);
+      expect(tableMessage[0].headers).to.deep.equal([{ value: 'Log Level' }, { value: 'Log Path' }, { value: 'Show Console Logs' }]);
       expect(tableMessage[0].data).to.deep.equal([
         {
           'Log Level': 'info',
           'Log Path': 'Not set',
+          'Show Console Logs': 'Not set',
         },
       ]);
     });
@@ -322,11 +324,12 @@ describe('Log Commands', () => {
       await cmd.run();
 
       expect(tableMessage).to.have.length(1);
-      expect(tableMessage[0].headers).to.deep.equal([{ value: 'Log Level' }, { value: 'Log Path' }]);
+      expect(tableMessage[0].headers).to.deep.equal([{ value: 'Log Level' }, { value: 'Log Path' }, { value: 'Show Console Logs' }]);
       expect(tableMessage[0].data).to.deep.equal([
         {
           'Log Level': 'Not set',
           'Log Path': './custom/logs/app.log',
+          'Show Console Logs': 'Not set',
         },
       ]);
     });

packages/contentstack-export/messages/index.json

@@ -1,6 +1,6 @@
 {
 "ASSET_EXPORT_COMPLETE": "Asset export process completed successfully",
-"ASSET_FOLDERS_EXPORT_COMPLETE": "Asset folder structure exported successfully",
+"ASSET_FOLDERS_EXPORT_COMPLETE": "Asset folder structure exported successfully with %s folder(s)",
 "ASSET_METADATA_EXPORT_COMPLETE": "Asset metadata exported successfully",
 "ASSET_VERSIONED_METADATA_EXPORT_COMPLETE": "Versioned asset metadata exported successfully",
 "ASSET_DOWNLOAD_COMPLETE": "Asset download completed successfully",
@@ -65,5 +65,7 @@
 "BRANCH_EXPORT_FAILED": "Failed to export contents from branch (UID: %s)",
 
 "ROLES_NO_CUSTOM_ROLES": "No custom roles found in the current stack",
-"ROLES_EXPORTING_ROLE": "Exporting role '%s'"
+"ROLES_EXPORTING_ROLE": "Exporting role '%s'",
+
+"GLOBAL_FIELDS_NOT_FOUND": "No global fields found in the current stack"
 }

packages/contentstack-export/src/commands/cm/stacks/export.ts

@@ -13,6 +13,7 @@ import {
   log,
   handleAndLogError,
   getLogPath,
+  CLIProgressManager,
 } from '@contentstack/cli-utilities';
 
 import { ModuleExporter } from '../../../export';
@@ -136,9 +137,18 @@ export default class ExportCommand extends Command {
       );
       log.info(`The exported content has been stored at '${exportDir}'`, exportConfig.context);
       log.success(`The log has been stored at '${getLogPath()}'`, exportConfig.context);
+
+      // Print comprehensive summary at the end
+      if (!exportConfig.branches) CLIProgressManager.printGlobalSummary();
+      if (!configHandler.get('log')?.showConsoleLogs) {
+        cliux.print(`The log has been stored at '${getLogPath()}'`, { color: 'green' });
+      }
     } catch (error) {
       handleAndLogError(error);
-      log.info(`The log has been stored at '${getLogPath()}'`)
+      if (!configHandler.get('log')?.showConsoleLogs) {
+        cliux.print(`Error: ${error}`, { color: 'red' });
+        cliux.print(`The log has been stored at '${getLogPath()}'`, { color: 'green' });
+      }
     }
   }
 

packages/contentstack-export/src/export/module-exporter.ts

@@ -1,5 +1,11 @@
 import * as path from 'path';
-import { ContentstackClient, handleAndLogError, messageHandler, log } from '@contentstack/cli-utilities';
+import {
+  ContentstackClient,
+  handleAndLogError,
+  messageHandler,
+  log,
+  CLIProgressManager,
+} from '@contentstack/cli-utilities';
 import { setupBranches, setupExportDir, writeExportMetaFile } from '../utils';
 import startModuleExport from './modules';
 import startJSModuleExport from './modules-js';
@@ -28,23 +34,35 @@ class ModuleExporter {
       this.exportConfig.branchEnabled = true;
       return this.exportByBranches();
     }
+    // If branches disabled then initialize the global summary
+    CLIProgressManager.initializeGlobalSummary('EXPORT', this.exportConfig.branchName);
     return this.export();
   }
 
   async exportByBranches(): Promise<void> {
     // loop through the branches and export it parallel
-    for (const branch of this.exportConfig.branches) {
+    for (const [index, branch] of this.exportConfig.branches.entries()) {
       try {
         this.exportConfig.branchName = branch.uid;
         this.stackAPIClient.stackHeaders.branch = branch.uid;
         this.exportConfig.branchDir = path.join(this.exportConfig.exportDir, branch.uid);
+
+        // Reset progress manager for each branch (except the first one which was initialized in export command)
+        if (index >= 0) {
+          CLIProgressManager.clearGlobalSummary();
+          CLIProgressManager.initializeGlobalSummary(`EXPORT-${branch.uid}`, branch.uid);
+        }
+
         log.info(`Exporting content from branch ${branch.uid}`, this.exportConfig.context);
         writeExportMetaFile(this.exportConfig, this.exportConfig.branchDir);
         await this.export();
-        log.success(
-          `The content of branch ${branch.uid} has been exported successfully!`,
-          this.exportConfig.context,
-        );
+
+        // Print branch-specific summary
+        if (index <= this.exportConfig.branches.length - 1) {
+          CLIProgressManager.printGlobalSummary();
+        }
+
+        log.success(`The content of branch ${branch.uid} has been exported successfully!`, this.exportConfig.context);
       } catch (error) {
         handleAndLogError(
           error,
@@ -57,10 +75,7 @@ class ModuleExporter {
   }
 
   async export() {
-    log.info(
-      `Started to export content, version is ${this.exportConfig.contentVersion}`,
-      this.exportConfig.context,
-    );
+    log.info(`Started to export content, version is ${this.exportConfig.contentVersion}`, this.exportConfig.context);
     // checks for single module or all modules
     if (this.exportConfig.singleModuleExport) {
       return this.exportSingleModule(this.exportConfig.moduleName);
@@ -72,28 +87,22 @@ class ModuleExporter {
     log.info(`Exporting module: ${moduleName}`, this.exportConfig.context);
     // export the modules by name
     // calls the module runner which inturn calls the module itself
-    let exportedModuleResponse;
     if (this.exportConfig.contentVersion === 2) {
-      exportedModuleResponse = await startModuleExport({
+      await startModuleExport({
         stackAPIClient: this.stackAPIClient,
         exportConfig: this.exportConfig,
         moduleName,
       });
     } else {
       //NOTE - new modules support only ts
       if (this.exportConfig.onlyTSModules.indexOf(moduleName) === -1) {
-        exportedModuleResponse = await startJSModuleExport({
+       await startJSModuleExport({
           stackAPIClient: this.stackAPIClient,
           exportConfig: this.exportConfig,
           moduleName,
         });
       }
     }
-
-    // set master locale to config
-    if (moduleName === 'stack' && exportedModuleResponse?.code) {
-      this.exportConfig.master_locale = { code: exportedModuleResponse.code };
-    }
   }
 
   async exportSingleModule(moduleName: Modules): Promise<void> {