refactor: progress & summary manager

Author: aman19K

packages/contentstack-utilities/src/constants/logging.ts

@@ -2,16 +2,18 @@ export const logLevels = {
   error: 0,
   warn: 1,
   info: 2,
-  success: 2,  // Maps to info level but with different type
+  success: 2, // Maps to info level but with different type
   debug: 3,
-  verbose: 4
+  verbose: 4,
 } as const;
 
 // 2. Create color mappings (for console only)
 export const levelColors = {
   error: 'red',
   warn: 'yellow',
-  success: 'green',  // Custom color for success
+  success: 'green', // Custom color for success
   info: 'white',
-  debug: 'blue'
-};
+  debug: 'blue',
+};
+
+export const PROGRESS_SUPPORTED_MODULES = ['export', 'import'] as const;

packages/contentstack-utilities/src/index.ts

@@ -77,5 +77,5 @@ export { default as TablePrompt } from './inquirer-table-prompt';
 
 export { Logger };
 export { default as authenticationHandler } from './authentication-handler';
-export {v2Logger as log, cliErrorHandler, handleAndLogError, getLogPath} from './logger/log'
-export {CLIProgressManager, SummaryManager} from './progress-summary'
+export { v2Logger as log, cliErrorHandler, handleAndLogError, getLogPath } from './logger/log';
+export { CLIProgressManager, SummaryManager } from './progress-summary';

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

@@ -160,4 +160,5 @@ export interface ModuleResult {
 export interface SummaryOptions {
   operationName: string; // 'EXPORT', 'IMPORT', 'MIGRATION', etc.
   context?: any;
+  branchName?: string; // Optional branch name for operations
 }

packages/contentstack-utilities/src/logger/logger.ts

@@ -2,7 +2,7 @@ import traverse from 'traverse';
 import { klona } from 'klona/full';
 import { normalize } from 'path';
 import * as winston from 'winston';
-import { levelColors, logLevels } from '../constants/logging';
+import { levelColors, logLevels, PROGRESS_SUPPORTED_MODULES } from '../constants/logging';
 import { LoggerConfig, LogLevel, LogType } from '../interfaces/index';
 import { configHandler } from '..';
 
@@ -58,8 +58,22 @@ export default class Logger {
       }),
     ];
 
-    // Add console transport only if showConsoleLogs is true
-    if (configHandler && typeof configHandler.get === 'function' && configHandler.get('showConsoleLogs')) {
+    // Determine console logging based on configuration
+    let showConsoleLogs = true;
+
+    if (configHandler && typeof configHandler.get === 'function') {
+      const logConfig = configHandler.get('log') || {};
+      const hasProgressSupport = PROGRESS_SUPPORTED_MODULES.includes(logConfig.progressSupportedModule);
+      if (hasProgressSupport) {
+        // Plugin has progress bars - respect user's showConsoleLogs setting
+        showConsoleLogs = logConfig.showConsoleLogs ?? true;
+      } else {
+        // Plugin doesn't have progress support - always show console logs
+        showConsoleLogs = true;
+      }
+    }
+
+    if (showConsoleLogs) {
       transports.push(
         new winston.transports.Console({
           format: winston.format.combine(
@@ -110,9 +124,8 @@ export default class Logger {
 
   private shouldLog(level: LogType, target: 'console' | 'file'): boolean {
     const configLevel = target === 'console' ? this.config.consoleLogLevel : this.config.logLevel;
-    const minLevel = configLevel ? logLevels[configLevel] : logLevels['info']; // Default to info level
-    const currentLevel = logLevels[level] || logLevels['info']; // Handle undefined levels
-    return currentLevel <= minLevel;
+    const minLevel = configLevel ? logLevels[configLevel] : 2;
+    return logLevels[level] <= minLevel;
   }
 
   /* === Public Log Methods === */
@@ -137,7 +150,7 @@ export default class Logger {
 
   public success(message: string, meta?: any): void {
     if (this.shouldLog('success', 'console') || this.shouldLog('success', 'file')) {
-      this.loggers.success.info(message, { ...meta, type: 'success' });
+      this.loggers.success.log('success', message, { ...meta });
     }
   }
 
@@ -245,7 +258,7 @@ export default class Logger {
       },
     };
     if (this.shouldLog('success', 'console') || this.shouldLog('success', 'file')) {
-      this.loggers.success.info(logPayload);
+      this.loggers.success.log(logPayload);
     }
   }