Merge pull request #2093 from contentstack/feat/DX-3302

refactor: ProgressManager to use centralized constants for process names and status messages in both export and import

Author: aman19K

.talismanrc

@@ -44,7 +44,17 @@ fileignoreconfig:
 - filename: packages/contentstack-variants/src/import/audiences.ts
   checksum: f24697ef86e928bb4d16f93c021b647639cc344a7f02463d79d69f9434ebed56
 - filename: packages/contentstack-variants/src/import/events.ts
-  checksum: 6cb014b5518ffe204a9f894ad801c05e2ef91a1692049168f74dd12a224363c4
+  checksum: 88256a99c8ff8d6904df2e3767b39f4761d35ce680b3cabd712c33889bd02fca
 - filename: packages/contentstack-import/src/import/modules/personalize.ts
   checksum: 1311a613177160637e21b3983b281b384c2cb15837d001a398b67afef30a393a
+- filename: packages/contentstack-export/src/export/modules/environments.ts
+  checksum: fd33318628321583dbeedd70ba7ba97f1e167d364dd26847771d745db295b16f
+- filename: packages/contentstack-import/src/import/modules/environments.ts
+  checksum: 25ec3da4b218c5bbabcfa1af59f26d62e99110bf361a77aab30bfa3ab402da05
+- filename: packages/contentstack-variants/src/utils/constants.ts
+  checksum: 0ceef8ec8489a05d8ecf07cfa7e92575b0da7d5a6c0ed65b64f46d23aab7074d
+- filename: packages/contentstack-export/src/utils/marketplace-app-helper.ts
+  checksum: fcd17c120a0359baeb61b7bd0f8d1ace2662f7f7293d355867f578312fe3a1a0
+- filename: packages/contentstack-variants/src/import/variant-entries.ts
+  checksum: 6e645a3d95903058f32306d306912353272e86e60571919a34125a9cd7b69a59
 version: "1.0"

packages/contentstack-export/src/export/modules/assets.ts

@@ -24,6 +24,7 @@ import {
 import config from '../../config';
 import { ModuleClassParams } from '../../types';
 import BaseClass, { CustomPromiseHandler, CustomPromiseHandlerInput } from './base-class';
+import { PROCESS_NAMES, MODULE_CONTEXTS, PROCESS_STATUS, MODULE_NAMES } from '../../utils';
 
 export default class ExportAssets extends BaseClass {
   private assetsRootPath: string;
@@ -33,8 +34,8 @@ export default class ExportAssets extends BaseClass {
 
   constructor({ exportConfig, stackAPIClient }: ModuleClassParams) {
     super({ exportConfig, stackAPIClient });
-    this.exportConfig.context.module = 'assets';
-    this.currentModuleName = 'Assets';
+    this.exportConfig.context.module = MODULE_CONTEXTS.ASSETS;
+    this.currentModuleName = MODULE_NAMES[MODULE_CONTEXTS.ASSETS];
   }
 
   get commonQueryParam(): Record<string, unknown> {
@@ -64,41 +65,59 @@ export default class ExportAssets extends BaseClass {
 
     // Add sub-processes
     if (typeof assetsFolderCount === 'number' && assetsFolderCount > 0) {
-      progress.addProcess('Folders', assetsFolderCount);
+      progress.addProcess(PROCESS_NAMES.ASSET_FOLDERS, assetsFolderCount);
     }
     if (typeof assetsCount === 'number' && assetsCount > 0) {
-      progress.addProcess('Metadata', assetsCount);
-      progress.addProcess('Downloads', assetsCount);
+      progress.addProcess(PROCESS_NAMES.ASSET_METADATA, assetsCount);
+      progress.addProcess(PROCESS_NAMES.ASSET_DOWNLOADS, assetsCount);
     }
 
     try {
       // Process asset folders
       if (typeof assetsFolderCount === 'number' && assetsFolderCount > 0) {
-        progress.startProcess('Folders').updateStatus('Fetching folder structure...', 'Folders');
+        progress
+          .startProcess(PROCESS_NAMES.ASSET_FOLDERS)
+          .updateStatus(
+            PROCESS_STATUS[PROCESS_NAMES.ASSET_FOLDERS].FETCHING,
+            PROCESS_NAMES.ASSET_FOLDERS,
+          );
         await this.getAssetsFolders(assetsFolderCount);
-        progress.completeProcess('Folders', true);
+        progress.completeProcess(PROCESS_NAMES.ASSET_FOLDERS, true);
       }
 
       // Process asset metadata
       if (typeof assetsCount === 'number' && assetsCount > 0) {
-        progress.startProcess('Metadata').updateStatus('Fetching asset information...', 'Metadata');
+        progress
+          .startProcess(PROCESS_NAMES.ASSET_METADATA)
+          .updateStatus(
+            PROCESS_STATUS[PROCESS_NAMES.ASSET_METADATA].FETCHING,
+            PROCESS_NAMES.ASSET_METADATA,
+          );
         await this.getAssets(assetsCount);
-        progress.completeProcess('Metadata', true);
+        progress.completeProcess(PROCESS_NAMES.ASSET_METADATA, true);
       }
 
       // Get versioned assets
       if (!isEmpty(this.versionedAssets) && this.assetConfig.includeVersionedAssets) {
         log.debug('Fetching versioned assets metadata...', this.exportConfig.context);
-        progress.updateStatus('Processing versioned assets...', 'Metadata');
+        progress.updateStatus(
+          PROCESS_STATUS[PROCESS_NAMES.ASSET_METADATA].FETCHING_VERSION,
+          PROCESS_NAMES.ASSET_METADATA,
+        );
         await this.getVersionedAssets();
       }
 
       // Download all assets
       if (typeof assetsCount === 'number' && assetsCount > 0) {
-        progress.startProcess('Downloads').updateStatus('Downloading asset files...', 'Downloads');
+        progress
+          .startProcess(PROCESS_NAMES.ASSET_DOWNLOADS)
+          .updateStatus(
+            PROCESS_STATUS[PROCESS_NAMES.ASSET_DOWNLOADS].DOWNLOADING,
+            PROCESS_NAMES.ASSET_DOWNLOADS,
+          );
         log.debug('Starting download of all assets...', this.exportConfig.context);
         await this.downloadAssets();
-        progress.completeProcess('Downloads', true);
+        progress.completeProcess(PROCESS_NAMES.ASSET_DOWNLOADS, true);
       }
 
       this.completeProgress(true);
@@ -128,13 +147,23 @@ export default class ExportAssets extends BaseClass {
       if (!isEmpty(items)) {
         this.assetsFolder.push(...items);
         items.forEach((folder: any) => {
-          this.progressManager?.tick(true, `folder: ${folder.name || folder.uid}`, null, 'Folders');
+          this.progressManager?.tick(
+            true,
+            `folder: ${folder.name || folder.uid}`,
+            null,
+            PROCESS_NAMES.ASSET_FOLDERS,
+          );
         });
       }
     };
 
     const onReject = ({ error }: any) => {
-      this.progressManager?.tick(false, 'asset folder', error?.message || 'Failed to fetch folder', 'Folders');
+      this.progressManager?.tick(
+        false,
+        'asset folder',
+        error?.message || PROCESS_STATUS[PROCESS_NAMES.ASSET_FOLDERS].FAILED,
+        PROCESS_NAMES.ASSET_FOLDERS,
+      );
       handleAndLogError(error, { ...this.exportConfig.context });
     };
 
@@ -197,7 +226,12 @@ export default class ExportAssets extends BaseClass {
     }
 
     const onReject = ({ error }: any) => {
-      this.progressManager?.tick(false, 'asset', error?.message || 'Failed to fetch asset', 'Metadata');
+      this.progressManager?.tick(
+        false,
+        'asset',
+        error?.message || PROCESS_STATUS[PROCESS_NAMES.ASSET_METADATA].FAILED,
+        PROCESS_NAMES.ASSET_METADATA,
+      );
       handleAndLogError(error, { ...this.exportConfig.context }, messageHandler.parse('ASSET_QUERY_FAILED'));
     };
 
@@ -219,7 +253,12 @@ export default class ExportAssets extends BaseClass {
         fs?.writeIntoFile(items, { mapKeyVal: true });
         // Track progress for each asset with process name
         items.forEach((asset: any) => {
-          this.progressManager?.tick(true, `asset: ${asset.filename || asset.uid}`, null, 'Metadata');
+          this.progressManager?.tick(
+            true,
+            `asset: ${asset.filename || asset.uid}`,
+            null,
+            PROCESS_NAMES.ASSET_METADATA,
+          );
         });
       }
     };
@@ -418,7 +457,12 @@ export default class ExportAssets extends BaseClass {
       } else {
         data.pipe(assetWriterStream);
       }
-      this.progressManager?.tick(true, `Downloaded asset: ${asset.filename || asset.uid}`, null, 'Downloads');
+      this.progressManager?.tick(
+        true,
+        `Downloaded asset: ${asset.filename || asset.uid}`,
+        null,
+        PROCESS_NAMES.ASSET_DOWNLOADS,
+      );
       log.success(messageHandler.parse('ASSET_DOWNLOAD_SUCCESS', asset.filename, asset.uid), this.exportConfig.context);
     };
 
@@ -428,7 +472,7 @@ export default class ExportAssets extends BaseClass {
         false,
         `Failed to download asset: ${asset.filename || asset.uid}`,
         null,
-        'Downloads',
+        PROCESS_NAMES.ASSET_DOWNLOADS,
       );
       handleAndLogError(
         error,

packages/contentstack-export/src/export/modules/content-types.ts

@@ -2,8 +2,8 @@ import * as path from 'path';
 import { ContentstackClient, handleAndLogError, messageHandler, log, sanitizePath } from '@contentstack/cli-utilities';
 
 import BaseClass from './base-class';
-import { fsUtil, executeTask } from '../../utils';
 import { ExportConfig, ModuleClassParams } from '../../types';
+import { fsUtil, executeTask, MODULE_CONTEXTS, MODULE_NAMES } from '../../utils';
 
 export default class ContentTypesExport extends BaseClass {
   private stackAPIClient: ReturnType<ContentstackClient['stack']>;
@@ -52,8 +52,8 @@ export default class ContentTypesExport extends BaseClass {
       sanitizePath(this.contentTypesConfig.dirName),
     );
     this.contentTypes = [];
-    this.exportConfig.context.module = 'content-types';
-    this.currentModuleName = 'Content Types';
+    this.exportConfig.context.module = MODULE_CONTEXTS.CONTENT_TYPES;
+    this.currentModuleName = MODULE_NAMES[MODULE_CONTEXTS.CONTENT_TYPES];
   }
 
   async start() {

packages/contentstack-export/src/export/modules/custom-roles.ts

@@ -6,7 +6,13 @@ import { resolve as pResolve } from 'node:path';
 import { handleAndLogError, messageHandler, log } from '@contentstack/cli-utilities';
 
 import BaseClass from './base-class';
-import { fsUtil } from '../../utils';
+import {
+  fsUtil,
+  PROCESS_NAMES,
+  MODULE_CONTEXTS,
+  PROCESS_STATUS,
+  MODULE_NAMES,
+} from '../../utils';
 import { CustomRoleConfig, ModuleClassParams } from '../../types';
 
 export default class ExportCustomRoles extends BaseClass {
@@ -25,8 +31,8 @@ export default class ExportCustomRoles extends BaseClass {
     this.existingRoles = { Admin: 1, Developer: 1, 'Content Manager': 1 };
     this.localesMap = {};
     this.sourceLocalesMap = {};
-    this.exportConfig.context.module = 'custom-roles';
-    this.currentModuleName = 'Custom Roles';
+    this.exportConfig.context.module = MODULE_CONTEXTS.CUSTOM_ROLES;
+    this.currentModuleName = MODULE_NAMES[MODULE_CONTEXTS.CUSTOM_ROLES];
   }
 
   async start(): Promise<void> {
@@ -66,21 +72,36 @@ export default class ExportCustomRoles extends BaseClass {
 
       // Create nested progress manager
       const progress = this.createNestedProgress(this.currentModuleName)
-        .addProcess('Fetch Roles', totalRoles)
-        .addProcess('Fetch Locales', totalLocales)
-        .addProcess('Process Mappings', 1);
-
-      progress.startProcess('Fetch Roles').updateStatus('Fetching custom roles...', 'Fetch Roles');
+        .addProcess(PROCESS_NAMES.FETCH_ROLES, totalRoles)
+        .addProcess(PROCESS_NAMES.FETCH_LOCALES, totalLocales)
+        .addProcess(PROCESS_NAMES.PROCESS_MAPPINGS, 1);
+
+      progress
+        .startProcess(PROCESS_NAMES.FETCH_ROLES)
+        .updateStatus(
+          PROCESS_STATUS[PROCESS_NAMES.FETCH_ROLES].FETCHING,
+          PROCESS_NAMES.FETCH_ROLES,
+        );
       await this.getCustomRoles();
-      progress.completeProcess('Fetch Roles', true);
+      progress.completeProcess(PROCESS_NAMES.FETCH_ROLES, true);
 
-      progress.startProcess('Fetch Locales').updateStatus('Fetching locales...', 'Fetch Locales');
+      progress
+        .startProcess(PROCESS_NAMES.FETCH_LOCALES)
+        .updateStatus(
+          PROCESS_STATUS[PROCESS_NAMES.FETCH_LOCALES].FETCHING,
+          PROCESS_NAMES.FETCH_LOCALES,
+        );
       await this.getLocales();
-      progress.completeProcess('Fetch Locales', true);
+      progress.completeProcess(PROCESS_NAMES.FETCH_LOCALES, true);
 
-      progress.startProcess('Process Mappings').updateStatus('Processing role-locale mappings...', 'Process Mappings');
+      progress
+        .startProcess(PROCESS_NAMES.PROCESS_MAPPINGS)
+        .updateStatus(
+          PROCESS_STATUS[PROCESS_NAMES.PROCESS_MAPPINGS].PROCESSING,
+          PROCESS_NAMES.PROCESS_MAPPINGS,
+        );
       await this.getCustomRolesLocales();
-      progress.completeProcess('Process Mappings', true);
+      progress.completeProcess(PROCESS_NAMES.PROCESS_MAPPINGS, true);
 
       log.debug(
         `Custom roles export completed. Total custom roles: ${Object.keys(this.customRoles).length}`,
@@ -124,7 +145,7 @@ export default class ExportCustomRoles extends BaseClass {
       log.info(messageHandler.parse('ROLES_EXPORTING_ROLE', role.name), this.exportConfig.context);
       this.customRoles[role.uid] = role;
 
-      this.progressManager?.tick(true, `role: ${role.name}`, null, 'Fetch Roles');
+      this.progressManager?.tick(true, `role: ${role.name}`, null, PROCESS_NAMES.FETCH_ROLES);
     });
 
     const customRolesFilePath = pResolve(this.rolesFolderPath, this.customRolesConfig.fileName);
@@ -153,7 +174,7 @@ export default class ExportCustomRoles extends BaseClass {
       this.sourceLocalesMap[locale.uid] = locale;
 
       // Track progress for each locale
-      this.progressManager?.tick(true, `locale: ${locale.name}`, null, 'Fetch Locales');
+      this.progressManager?.tick(true, `locale: ${locale.name}`, null, PROCESS_NAMES.FETCH_LOCALES);
     }
 
     log.debug(`Mapped ${Object.keys(this.sourceLocalesMap).length} locales`, this.exportConfig.context);
@@ -198,6 +219,6 @@ export default class ExportCustomRoles extends BaseClass {
     }
 
     // Track progress for mapping completion
-    this.progressManager?.tick(true, 'role-locale mappings', null, 'Process Mappings');
+    this.progressManager?.tick(true, 'role-locale mappings', null, PROCESS_NAMES.PROCESS_MAPPINGS);
   }
 }