Merge pull request #1948 from contentstack/feat/DX-3077-v2Logger-integration-export

feat: integrated v2Logger in export plugin

Author: aman19K

.talismanrc

@@ -134,4 +134,14 @@ fileignoreconfig:
     checksum: 023cf08f215cd0778599fb8478c94419373d4687f04421c4eb99d87de86a4a3e
   - filename: packages/contentstack-utilities/src/logger/logger.ts
     checksum: 09f3b73dd995bafc253265c676f06308513e6b1842d9bc01d39e6b6945a54c7d
+  - filename: packages/contentstack-export/src/export/modules/environments.ts
+    checksum: 10cb048a8f30e2645a4c949fd2a51d0c741b7fdacb377768d2c0cfe34bdaf4e2
+  - filename: packages/contentstack-export/src/utils/basic-login.ts
+    checksum: f95d4c0976729bd17238bf64713b3851d8852dbf60591210412c12ddaddd60c9
+  - filename: packages/contentstack-utilities/src/interfaces/index.ts
+    checksum: 70079d81524ae4c196ffc77f13306184a8944b2903b881947dd06120150f31b0
+  - filename: packages/contentstack-export/src/commands/cm/stacks/export.ts
+    checksum: 941c6a8d59ba58e2004030202ee6282cdd2a424cf8b089aef70a85198553fefe
+  - filename: packages/contentstack-utilities/src/logger/logger.ts
+    checksum: b56504c1e4fb31b676cc1931eb30afc7b9466f03890fe3c76977309e1fd066a6
 version: "1.0"

packages/contentstack-audit/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.12.2 darwin-arm64 node-v22.14.0
+@contentstack/cli-audit/1.13.0 darwin-arm64 node-v22.14.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -305,7 +305,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:add PLUGIN`
 
@@ -379,7 +379,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN`
 
@@ -428,7 +428,7 @@ EXAMPLES
     $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PATH`
 
@@ -459,7 +459,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:remove [PLUGIN]`
 
@@ -500,7 +500,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/reset.ts)_
 
 ## `csdx plugins:uninstall [PLUGIN]`
 
@@ -528,7 +528,7 @@ EXAMPLES
   $ csdx plugins:uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:unlink [PLUGIN]`
 
@@ -572,5 +572,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.38/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

packages/contentstack-export/messages/index.json

@@ -1 +1,69 @@
-{}
+{
+"ASSET_EXPORT_COMPLETE": "Asset export process completed successfully",
+"ASSET_FOLDERS_EXPORT_COMPLETE": "Asset folder structure exported successfully",
+"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",
+"ASSET_DOWNLOAD_SUCCESS": "Asset '%s' (UID: %s) downloaded successfully",
+"ASSET_DOWNLOAD_FAILED": "Failed to download asset '%s' (UID: %s)",
+"ASSET_WRITE_FAILED": "Failed to write asset file '%s' (UID: %s)",
+"ASSET_QUERY_FAILED": "Failed to query asset data from the API",
+"ASSET_VERSIONED_QUERY_FAILED": "Failed to query versioned asset data from the API",
+"ASSET_COUNT_QUERY_FAILED": "Failed to retrieve total asset count",
+
+"CONTENT_TYPE_EXPORT_COMPLETE": "Content types exported successfully",
+"CONTENT_TYPE_NO_TYPES": "No content types found",
+"CONTENT_TYPE_EXPORT_FAILED": "Failed to export content types",
+"CONTENT_TYPE_NO_TYPES_RETURNED": "API returned no content types for the given query",
+
+"ENVIRONMENT_EXPORT_COMPLETE": "Successfully exported %s environment(s)",
+"ENVIRONMENT_EXPORT_SUCCESS": "Environment '%s' exported successfully",
+"ENVIRONMENT_NOT_FOUND": "No environments found in the current stack",
+
+"EXTENSION_EXPORT_COMPLETE": "Successfully exported %s extension(s)",
+"EXTENSION_EXPORT_SUCCESS": "Extension '%s' exported successfully",
+"EXTENSION_NOT_FOUND": "No extensions found in the current stack",
+
+"GLOBAL_FIELDS_EXPORT_COMPLETE": "Successfully exported %s global field(s)",
+
+"LABELS_EXPORT_COMPLETE": "Successfully exported %s label(s)",
+"LABEL_EXPORT_SUCCESS": "Label '%s' exported successfully",
+"LABELS_NOT_FOUND": "No labels found in the current stack",
+
+"LOCALES_EXPORT_COMPLETE": "Successfully exported %s locale(s) including %s master locale(s)",
+
+"TAXONOMY_EXPORT_COMPLETE": "Successfully exported %s taxonomy entries",
+"TAXONOMY_EXPORT_SUCCESS": "Taxonomy '%s' exported successfully",
+"TAXONOMY_NOT_FOUND": "No taxonomies found in the current stack",
+
+"WEBHOOK_EXPORT_COMPLETE": "Successfully exported %s webhook(s)",
+"WEBHOOK_EXPORT_SUCCESS": "Webhook '%s' exported successfully",
+"WEBHOOK_NOT_FOUND": "No webhooks found in the current stack",
+
+"WORKFLOW_EXPORT_COMPLETE": "Successfully exported %s workflow(s)",
+"WORKFLOW_EXPORT_SUCCESS": "Workflow '%s' exported successfully",
+"WORKFLOW_NOT_FOUND": "No workflows found in the current stack",
+
+"PERSONALIZE_URL_NOT_SET": "Cannot export Personalize project: URL not configured",
+"PERSONALIZE_SKIPPING_WITH_MANAGEMENT_TOKEN": "Skipping Personalize project export: Management token not supported",
+"PERSONALIZE_MODULE_NOT_IMPLEMENTED": "Module '%s' implementation not found",
+"PERSONALIZE_NOT_ENABLED": "Personalize feature is not enabled for this organization",
+
+"MARKETPLACE_APPS_EXPORT_COMPLETE": "Successfully exported %s marketplace app(s)",
+"MARKETPLACE_APP_CONFIG_EXPORT": "Exporting configuration for app '%s'",
+"MARKETPLACE_APP_CONFIG_SUCCESS": "Successfully exported configuration for app '%s'",
+"MARKETPLACE_APP_EXPORT_SUCCESS": "Successfully exported app '%s'",
+"MARKETPLACE_APPS_NOT_FOUND": "No marketplace apps found in the current stack",
+"MARKETPLACE_APP_CONFIG_EXPORT_FAILED": "Failed to export configuration for app '%s'",
+"MARKETPLACE_APP_MANIFEST_EXPORT_FAILED": "Failed to export manifest for app '%s'",
+
+"ENTRIES_EXPORT_COMPLETE": "Successfully exported entries (Content Type: %s, Locale: %s)",
+"ENTRIES_EXPORT_SUCCESS": "All entries exported successfully",
+"ENTRIES_VERSIONED_EXPORT_SUCCESS": "Successfully exported versioned entry (Content Type: %s, UID: %s, Locale: %s)",
+"ENTRIES_EXPORT_VERSIONS_FAILED": "Failed to export versions for content type '%s' (UID: %s)",
+
+"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'"
+}

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

@@ -1,4 +1,3 @@
-import path from 'path';
 import { Command } from '@contentstack/cli-command';
 import {
   cliux,
@@ -10,10 +9,15 @@ import {
   FlagInput,
   pathValidator,
   sanitizePath,
+  configHandler,
+  log,
+  handleAndLogError,
+  getLogPath
 } from '@contentstack/cli-utilities';
+
 import { ModuleExporter } from '../../../export';
-import { setupExportConfig, log, formatError, writeExportMetaFile } from '../../../utils';
-import { ExportConfig } from '../../../types';
+import { Context, ExportConfig } from '../../../types';
+import { setupExportConfig, writeExportMetaFile } from '../../../utils';
 
 export default class ExportCommand extends Command {
   static description: string = messageHandler.parse('Export content from a stack');
@@ -72,19 +76,22 @@ export default class ExportCommand extends Command {
     }),
     module: flags.string({
       char: 'm',
-      description: '[optional] Specific module name. If not specified, the export command will export all the modules to the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, and taxonomies.',
+      description:
+        '[optional] Specific module name. If not specified, the export command will export all the modules to the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, and taxonomies.',
       parse: printFlagDeprecation(['-m'], ['--module']),
     }),
     'content-types': flags.string({
       char: 't',
-      description: '[optional]  The UID of the content type(s) whose content you want to export. In case of multiple content types, specify the IDs separated by spaces.',
+      description:
+        '[optional]  The UID of the content type(s) whose content you want to export. In case of multiple content types, specify the IDs separated by spaces.',
       multiple: true,
       parse: printFlagDeprecation(['-t'], ['--content-types']),
     }),
     branch: flags.string({
       char: 'B',
       // default: 'main',
-      description: '[optional] The name of the branch where you want to export your content. If you don\'t mention the branch name, then by default the content will be exported from all the branches of your stack.',
+      description:
+        "[optional] The name of the branch where you want to export your content. If you don't mention the branch name, then by default the content will be exported from all the branches of your stack.",
       parse: printFlagDeprecation(['-B'], ['--branch']),
     }),
     'secured-assets': flags.boolean({
@@ -101,30 +108,57 @@ export default class ExportCommand extends Command {
 
   async run(): Promise<void> {
     let exportDir: string = pathValidator('logs');
+    let exportConfig: ExportConfig;
     try {
       const { flags } = await this.parse(ExportCommand);
-      let exportConfig = await setupExportConfig(flags);
-      // Note setting host to create cma client
-      exportConfig.host = this.cmaHost;
-      exportConfig.region = this.region;
-      if(this.developerHubUrl) exportConfig.developerHubBaseUrl = this.developerHubUrl;
-      if (this.personalizeUrl) exportConfig.modules.personalize.baseURL[exportConfig.region.name] = this.personalizeUrl;
+      exportConfig = await setupExportConfig(flags);
+      // Prepare the context object
+      const context = this.createExportContext(exportConfig.apiKey);
+      exportConfig.context = context;
+
+      // Assign exportConfig variables
+      this.assignExportConfig(exportConfig);
+
       exportDir = sanitizePath(exportConfig.cliLogsPath || exportConfig.data || exportConfig.exportDir);
       const managementAPIClient: ContentstackClient = await managementSDKClient(exportConfig);
       const moduleExporter = new ModuleExporter(managementAPIClient, exportConfig);
       await moduleExporter.start();
       if (!exportConfig.branches?.length) {
         writeExportMetaFile(exportConfig);
       }
-      log(exportConfig, `The content of the stack ${exportConfig.apiKey} has been exported successfully!`, 'success');
-      log(
-        exportConfig,
-        `The log has been stored at '${pathValidator(path.join(exportDir, 'logs', 'export'))}'`,
-        'success',
-      );
+      log.success(`The content of the stack ${exportConfig.apiKey} has been exported successfully!`,exportConfig.context)
+      log.success(`The log has been stored at '${getLogPath()}'`, exportConfig.context)
     } catch (error) {
-      log({ data: exportDir } as ExportConfig, `Failed to export stack content - ${formatError(error)}`, 'error');
-      log({ data: exportDir } as ExportConfig, `The log has been stored at ${exportDir}`, 'info');
+      handleAndLogError(error, { ...exportConfig.context });
+    }
+  }
+  
+  // Create export context object
+  private createExportContext(apiKey: string): Context {
+    return {
+      command: this.context.info.command,
+      module: '',
+      userId: configHandler.get('userId'),
+      email: configHandler.get('email'),
+      sessionId: this.context.sessionId,
+      clientId: this.context.clientId,
+      apiKey: apiKey || '',
+      orgId: configHandler.get('organization_uid') || '',
+    };
+  }
+
+  // Assign values to exportConfig
+  private assignExportConfig(exportConfig: ExportConfig): void {
+    // Note setting host to create cma client
+    exportConfig.host = this.cmaHost;
+    exportConfig.region = this.region;
+
+    if (this.developerHubUrl) {
+      exportConfig.developerHubBaseUrl = this.developerHubUrl;
+    }
+
+    if (this.personalizeUrl) {
+      exportConfig.modules.personalize.baseURL[exportConfig.region.name] = this.personalizeUrl;
     }
   }
 }

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

@@ -1,6 +1,6 @@
 import * as path from 'path';
-import { ContentstackClient } from '@contentstack/cli-utilities';
-import { setupBranches, setupExportDir, log, formatError, writeExportMetaFile } from '../utils';
+import { ContentstackClient, handleAndLogError, messageHandler, log } from '@contentstack/cli-utilities';
+import { setupBranches, setupExportDir, writeExportMetaFile } from '../utils';
 import startModuleExport from './modules';
 import startJSModuleExport from './modules-js';
 import { ExportConfig, Modules } from '../types';
@@ -38,19 +38,29 @@ class ModuleExporter {
         this.exportConfig.branchName = branch.uid;
         this.stackAPIClient.stackHeaders.branch = branch.uid;
         this.exportConfig.branchDir = path.join(this.exportConfig.exportDir, branch.uid);
-        log(this.exportConfig, `Exporting content from branch ${branch.uid}`, 'success');
+        log.info(`Exporting content from branch ${branch.uid}`, this.exportConfig.context);
         writeExportMetaFile(this.exportConfig, this.exportConfig.branchDir);
         await this.export();
-        log(this.exportConfig, `The content of branch ${branch.uid} has been exported successfully!`, 'success');
+        log.success(
+          `The content of branch ${branch.uid} has been exported successfully!`,
+          this.exportConfig.context,
+        );
       } catch (error) {
-        log(this.exportConfig, formatError(error), 'error');
-        throw new Error(`Failed to export contents from branch ${branch.uid}`);
+        handleAndLogError(
+          error,
+          { ...this.exportConfig.context, branch: branch.uid },
+          messageHandler.parse('FAILED_EXPORT_CONTENT_BRANCH', { branch: branch.uid }),
+        );
+        throw new Error(messageHandler.parse('FAILED_EXPORT_CONTENT_BRANCH', { branch: branch.uid }));
       }
     }
   }
 
   async export() {
-    log(this.exportConfig, `Started to export content, version is ${this.exportConfig.contentVersion}`, 'info');
+    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);
@@ -59,7 +69,7 @@ class ModuleExporter {
   }
 
   async exportByModuleByName(moduleName: Modules) {
-    log(this.exportConfig, `Starting export of ${moduleName} module`, 'info');
+    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;