Merge pull request #2307 from contentstack/feat/DX-3864

feat: add new logger in config

Author: naman-contentstack

.talismanrc

@@ -1,8 +1,8 @@
 fileignoreconfig:
   - filename: package-lock.json
-    checksum: 0cac869eb2f174e45751388de3eb46d48fbc8f5dbc56faf06000dbad7b5e8466
+    checksum: 26be769c9d3bcc7095237527dd0004c3981be0dc7bf5c01f650b05a0ea09ecb6
   - filename: pnpm-lock.yaml
-    checksum: cf7ddbd499ceb5d26ceb94381db0ecd576745b96b4deedd7442d3c8aa820ba92
+    checksum: 44d84111971dd7c108417a3e6e35bb3c61347d3eff4ea113a636429085d8502b
   - filename: packages/contentstack-import-setup/test/unit/backup-handler.test.ts
     checksum: 0582d62b88834554cf12951c8690a73ef3ddbb78b82d2804d994cf4148e1ef93
   - filename: packages/contentstack-import-setup/test/config.json
@@ -273,4 +273,8 @@ fileignoreconfig:
     checksum: 6912e5ea32b4456ad04d1645750c72bbb29ab1895368c3a242ab39e9350ec531
   - filename: packages/contentstack-audit/test/unit/mock/contents/composable_studio/invalid_composable_studio.json
     checksum: e6465aa0011d1565a2de848d9cca74395d11419e6ac840e7dfb52e1d255b1c4f
+  - filename: packages/contentstack-audit/src/modules/modulesData.ts
+    checksum: 1e6c1fba1172512401038d5454c8d218201ec62262449c5c878609592e0124c4
+  - filename: packages/contentstack-audit/src/modules/composable-studio.ts
+    checksum: 4fc97ff582d6dff9a54b3a50dfa3cbb5febd38a55aeb8737034b97188ad543ba
 version: '1.0'

package-lock.json

@@ -1,5 +1,12 @@
 import { Command } from '@contentstack/cli-command';
-import { configHandler, createLogContext, Flags, getAuthenticationMethod, Interfaces, log } from '@contentstack/cli-utilities';
+import {
+  configHandler,
+  createLogContext,
+  Flags,
+  getAuthenticationMethod,
+  Interfaces,
+  log,
+} from '@contentstack/cli-utilities';
 import { Context } from './interfaces';
 
 export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
@@ -17,8 +24,9 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
   public async init(): Promise<void> {
     await super.init();
     // this.contextDetails = { ...this.createExportContext() };
-    this.contextDetails = { ...createLogContext(this.context?.info?.command || 'auth', '',) };
-
+    this.contextDetails = {
+      ...createLogContext(this.context?.info?.command || 'auth', '', configHandler.get('authenticationMethod')),
+    };
   }
 
   /**

packages/contentstack-auth/src/base-command.ts

@@ -1,30 +1,30 @@
-import { join, resolve } from "path";
-import { existsSync, readdirSync } from "fs";
-import config from "./config.json" with { type: "json" };
-import filter from "lodash/filter.js";
-import forEach from "lodash/forEach.js";
-import isEmpty from "lodash/isEmpty.js";
-import isArray from "lodash/isArray.js";
-import includes from "lodash/includes.js";
+import { join, resolve } from 'path';
+import { existsSync, readdirSync } from 'fs';
+import config from './config.json';
+import filter from 'lodash/filter.js';
+import forEach from 'lodash/forEach.js';
+import isEmpty from 'lodash/isEmpty.js';
+import isArray from 'lodash/isArray.js';
+import includes from 'lodash/includes.js';
 import dotenv from 'dotenv';
 
 // NOTE init env variables
 dotenv.config();
 
 const { IS_TS, UNIT_EXECUTION_ORDER, INTEGRATION_EXECUTION_ORDER } = config;
 
-const testFileExtension = IS_TS ? ".ts" : ".js";
-process.env.TS_NODE_PROJECT = resolve("test/tsconfig.json");
+const testFileExtension = IS_TS ? '.ts' : '.js';
+process.env.TS_NODE_PROJECT = resolve('test/tsconfig.json');
 
 /**
  * @method getFileName
  * @param {string} file
  * @returns {string}
  */
 const getFileName = (file: string): string => {
-  if (includes(file, ".test") && includes(file, testFileExtension)) return file;
-  else if (includes(file, ".test")) return `${file}${testFileExtension}`;
-  else if (!includes(file, ".test")) return `${file}.test${testFileExtension}`;
+  if (includes(file, '.test') && includes(file, testFileExtension)) return file;
+  else if (includes(file, '.test')) return `${file}${testFileExtension}`;
+  else if (!includes(file, '.test')) return `${file}.test${testFileExtension}`;
   else return `${file}.test${testFileExtension}`;
 };
 
@@ -33,7 +33,7 @@ const getFileName = (file: string): string => {
  * @param {Array<string>} files
  * @param {string} basePath
  */
-const includeTestFiles = (files: Array<string>, basePath = "integration") => {
+const includeTestFiles = (files: Array<string>, basePath = 'integration') => {
   forEach(files, (file) => {
     const filename = getFileName(file);
     const filePath = join(__dirname, basePath, filename);
@@ -52,27 +52,24 @@ const includeTestFiles = (files: Array<string>, basePath = "integration") => {
  * @param {Array<string> | undefined | null} executionOrder
  * @param {boolean} isIntegrationTest
  */
-const run = (
-  executionOrder: Array<string> | undefined | null,
-  isIntegrationTest = true
-) => {
-  const testFolder = isIntegrationTest ? "integration" : "unit";
+const run = (executionOrder: Array<string> | undefined | null, isIntegrationTest = true) => {
+  const testFolder = isIntegrationTest ? 'integration' : 'unit';
 
   if (executionOrder && isArray(executionOrder) && !isEmpty(executionOrder)) {
     includeTestFiles(executionOrder, testFolder);
   } else {
     const basePath = join(__dirname, testFolder);
     const allIntegrationTestFiles = filter(readdirSync(basePath), (file) =>
-      includes(file, `.test${testFileExtension}`)
+      includes(file, `.test${testFileExtension}`),
     );
     includeTestFiles(allIntegrationTestFiles);
   }
 };
 
 const args = process.argv.slice(2);
 
-if (includes(args, "--integration-test")) {
+if (includes(args, '--integration-test')) {
   run(INTEGRATION_EXECUTION_ORDER);
-} else if (includes(args, "--unit-test")) {
+} else if (includes(args, '--unit-test')) {
   // run(UNIT_EXECUTION_ORDER, false);
 }

packages/contentstack-auth/test/run.test.ts

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-cm-bulk-publish
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-bulk-publish/1.10.4 darwin-arm64 node-v22.14.0
+@contentstack/cli-cm-bulk-publish/1.10.5 darwin-arm64 node-v22.14.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

packages/contentstack-bulk-publish/README.md

@@ -1,12 +1,12 @@
 {
   "name": "@contentstack/cli-cm-bulk-publish",
   "description": "Contentstack CLI plugin for bulk publish actions",
-  "version": "1.10.4",
+  "version": "1.10.5",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.7.1",
-    "@contentstack/cli-config": "~1.16.2",
+    "@contentstack/cli-config": "~1.17.0",
     "@contentstack/cli-utilities": "~1.16.0",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",

packages/contentstack-bulk-publish/package.json

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/1.16.2 darwin-arm64 node-v22.14.0
+@contentstack/cli-config/1.17.0 darwin-arm64 node-v22.14.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

packages/contentstack-config/README.md

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-config",
   "description": "Contentstack CLI plugin for configuration",
-  "version": "1.16.2",
+  "version": "1.17.0",
   "author": "Contentstack",
   "scripts": {
     "build": "npm run clean && npm run compile",

packages/contentstack-config/package.json

@@ -1,24 +1,35 @@
 import { Command } from '@contentstack/cli-command';
-import { ArgInput, FlagInput, Flags, Interfaces, LoggerService } from '@contentstack/cli-utilities';
+import { ArgInput, FlagInput, Flags, Interfaces, configHandler, createLogContext } from '@contentstack/cli-utilities';
 
 export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
 export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BaseCommand)['baseFlags'] & T['flags']>;
 
 export abstract class BaseCommand<T extends typeof Command> extends Command {
-  public logger!: LoggerService;
+  public contextDetails!: {
+    command: string;
+    module: string;
+    userId: string;
+    email: string;
+    sessionId: string;
+    apiKey: string;
+    orgId: string;
+    authenticationMethod: string;
+  };
   protected args!: Args<T>;
   protected flags!: Flags<T>;
 
-  static args: ArgInput<{ [arg: string]: any; }>;
+  static args: ArgInput<{ [arg: string]: any }>;
   /**
    * The `init` function initializes the command by parsing arguments and flags, registering search
    * plugins, registering the configuration, and initializing the logger.
    */
   public async init(): Promise<void> {
     await super.init();
 
-    // Init logger
-    this.logger = new LoggerService(process.cwd(), 'cli-log');
+    // Init logger context
+    this.contextDetails = {
+      ...createLogContext(this.context?.info?.command || 'config', '', configHandler.get('authenticationMethod')),
+    };
   }
 
   /**
@@ -46,4 +57,4 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
     // called after run and catch regardless of whether or not the command errored
     return super.finally(_);
   }
-}
+}

packages/contentstack-config/src/base-command.ts

@@ -1,5 +1,5 @@
 import { Command } from '@contentstack/cli-command';
-import { cliux, configHandler, messageHandler, TableHeader } from '@contentstack/cli-utilities';
+import { cliux, configHandler, messageHandler, TableHeader, handleAndLogError } from '@contentstack/cli-utilities';
 
 export default class BranchGetCommand extends Command {
   static description = 'Get current branch set for CLI';
@@ -25,7 +25,7 @@ export default class BranchGetCommand extends Command {
         cliux.print(`error: ${messageHandler.parse('CLI_CONFIG_BRANCH_LIST_NO_BRANCHES')}`, { color: 'red' });
       }
     } catch (error) {
-      cliux.error('Error', error);
+      handleAndLogError(error, { module: 'config-get-base-branch' });
     }
   }
 }