@contentstack/cli-migration 1.5.0 → 1.5.2

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @contentstack/cli-migration
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-migration/1.5.0 darwin-arm64 node-v20.8.0
+@contentstack/cli-migration/1.5.1 darwin-arm64 node-v20.8.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.2.16",
-    "@contentstack/cli-utilities": "~1.5.12",
+    "@contentstack/cli-utilities": "~1.6.0",
     "async": "^3.2.4",
     "callsites": "^3.1.0",
     "cardinal": "^2.1.1",
@@ -66,4 +66,4 @@
       "cm:migration": "O-MGRTN"
     }
   }
-}
+}

package/src/commands/cm/stacks/migration.js

@@ -12,14 +12,19 @@ const { Parser } = require('../../../modules');
 const { ActionList } = require('../../../actions');
 const fs = require('fs');
 const chalk = require('chalk');
-const { printFlagDeprecation, managementSDKClient, flags, isAuthenticated } = require('@contentstack/cli-utilities');
+const isEmpty = require('lodash/isEmpty');
+const {
+  printFlagDeprecation,
+  managementSDKClient,
+  flags,
+  isAuthenticated,
+  pathValidator,
+} = require('@contentstack/cli-utilities');
 
 const { ApiError, SchemaValidator, MigrationError, FieldValidator } = require('../../../validators');
 
 // Utils
 const { map: _map, constants, safePromise, errorHelper } = require('../../../utils');
-const { success } = require('../../../utils/logger');
-
 // Properties
 const { get, set, getMapInstance, resetMapInstance } = _map;
 const {
@@ -77,7 +82,7 @@ class MigrationCommand extends Command {
       let configObj = config.reduce((a, v) => {
         //NOTE: Temp code to handle only one spilt(Window absolute path issue).Need to replace with hardcoded config key
         let [key, ...value] = v.split(':');
-        value = value?.length > 1 ? value?.join(':') : value?.join( );
+        value = value?.length > 1 ? value?.join(':') : value?.join();
         return { ...a, [key]: value };
       }, {});
       set('config', mapInstance, configObj);
@@ -128,11 +133,15 @@ class MigrationCommand extends Command {
     } else {
       await this.execSingleFile(filePath, mapInstance);
     }
+    const errLogPath = `${process.cwd()}/migration-logs`;
+    if (fs.existsSync(errLogPath)) {
+      this.log(`The log has been stored at: `, errLogPath);
+    }
   }
 
   async execSingleFile(filePath, mapInstance) {
     // Resolved absolute path
-    const resolvedMigrationPath = resolve(filePath);
+    const resolvedMigrationPath = pathValidator(filePath);
     // User provided migration function
     const migrationFunc = require(resolvedMigrationPath);
 
@@ -154,35 +163,24 @@ class MigrationCommand extends Command {
 
       const listr = new Listr(tasks);
 
-      await listr.run().catch((error) => {
-        this.handleErrors(error);
-        // When the process is child, send error message to parent
-        if (process.send) process.send({ errorOccurred: true });
-      });
+      await listr.run();
       requests.splice(0, requests.length);
     } catch (error) {
-      // errorHandler(null, null, null, error)
-      if (error.message) {
-        this.log(error.message);
-      } else if (error.errorMessage) {
-        this.log(error.errorMessage);
-      }else{
-        this.log(error)
-      }
+      errorHelper(error, filePath);
+      if (process.send) process.send({ errorOccurred: true });
     }
   }
 
   async execMultiFiles(filePath, mapInstance) {
     // Resolved absolute path
-    const resolvedMigrationPath = resolve(filePath);
+    const resolvedMigrationPath = pathValidator(filePath);
     try {
       const files = fs.readdirSync(resolvedMigrationPath);
       for (const element of files) {
         const file = element;
         if (extname(file) === '.js') {
-          success(chalk`{white Executing file:} {grey {bold ${file}}}`);
           // eslint-disable-next-line no-await-in-loop
-          await this.execSingleFile(resolve(filePath, file), mapInstance);
+          await this.execSingleFile(pathValidator(resolve(filePath, file)), mapInstance);
         }
       }
     } catch (error) {

package/src/services/content-types.js

@@ -4,7 +4,7 @@
 
 const Base = require('../modules/base');
 // Utils
-const { map: _map, safePromise, successHandler, errorHandler, constants } = require('../utils');
+const { map: _map, safePromise, successHandler, errorHandler, constants, errorHelper } = require('../utils');
 // Map methods
 const { get, getMapInstance, getDataWithAction } = _map;
 const mapInstance = getMapInstance();
@@ -23,7 +23,7 @@ class ContentTypeService {
 
     const [err, result] = await safePromise(this.stackSDKInstance.contentType(id).fetch());
     if (err) {
-      errorHandler(id, ContentType, method, err);
+      errorHelper(err);
       this.base.dispatch(callsite, id, err, 'apiError');
       throw err;
     }
@@ -36,7 +36,7 @@ class ContentTypeService {
     const data = getDataWithAction(id, mapInstance, action);
     const [err, result] = await safePromise(this.stackSDKInstance.contentType().create(data));
     if (err) {
-      errorHandler(id, ContentType, 'POST', err);
+      errorHelper(err);
       this.base.dispatch(callsite, id, err, 'apiError');
       throw err;
     }
@@ -51,7 +51,7 @@ class ContentTypeService {
     const method = 'PUT';
     const [err, result] = await safePromise(data.update());
     if (err) {
-      errorHandler(data.uid, ContentType, method, err);
+      errorHelper(err);
       this.base.dispatch(callsite, data.uid, err, 'apiError');
       throw err;
     }
@@ -66,7 +66,7 @@ class ContentTypeService {
     const [err, result] = await safePromise(this.stackSDKInstance.contentType(id).delete());
 
     if (err) {
-      errorHandler(id, ContentType, method, err);
+      errorHelper(err);
       this.base.dispatch(callsite, id, err, 'apiError');
       throw err;
     }
@@ -306,7 +306,7 @@ class ContentTypeService {
     }
 
     // Handling both the scenarios
-    if ((found === 0) || (against && (found === 1))) {
+    if (found === 0 || (against && found === 1)) {
       isValid = false;
     }
 

package/src/utils/callsite.js

@@ -2,9 +2,10 @@
 
 const getCallsites = require('callsites');
 const { parse, resolve } = require('path');
+const { pathValidator } = require('@contentstack/cli-utilities');
 
 function getFileDirectory(path) {
-  const parentPath = resolve(path, '../'); // Assuming that will be 2 folders up
+  const parentPath = pathValidator(resolve(path, '../')); // Assuming that will be 2 folders up
   return parse(parentPath).dir;
 }
 

package/src/utils/error-helper.js

@@ -1,8 +1,9 @@
 const { highlight } = require('cardinal');
 const { keys } = Object;
 const chalk = require('chalk');
-const isEmpty = require('lodash/isEmpty')
-
+const isEmpty = require('lodash/isEmpty');
+const MigrationLogger = require('./migration-logger');
+const fs = require('fs');
 const { readFile } = require('./fs-helper');
 const groupBy = require('./group-by');
 
@@ -19,43 +20,86 @@ const getLineWithContext = (lines, lineNumber, context) => {
   };
 };
 
-module.exports = (errors) => {
+function removeSpecialCharacter(str) {
+  return str.replace(/\u001b\[\d+m/g, '');
+}
+
+module.exports = (errors, filePath) => {
+  const logger = new MigrationLogger(process.cwd());
+
   const errorsByFile = groupBy(errors, 'file');
   const messages = [];
-  for (const file of keys(errorsByFile)) {
-    const fileContents = readFile(file);
-    const highlightedCode = highlight(fileContents, { linenos: true });
-    const lines = highlightedCode.split('\n');
-
-    const fileErrorsMessage = chalk`{red Errors in ${file}}\n\n`;
-    const errorMessages = errorsByFile[file]
-      .map((error) => {
-        const callsite = error.meta.callsite;
-        const context = 2;
-        const { before, line, after } = getLineWithContext(lines, callsite.line, context);
-
-        const beforeLines = before.map((_line) => chalk`${_line}\n`);
-        const afterLines = after.map((_line) => chalk`${_line}\n`);
-        const highlightedLine = chalk`{bold ${line}}\n`;
-
-        const formattedCode = beforeLines + highlightedLine + afterLines;
-        if (error.payload.apiError) {
-          return chalk`{red Line ${String(callsite.line)}:} {bold ${error.payload.apiError.message}}\n${formattedCode}`;
-        }
-        if (error.message) {
-          return chalk`{red Line ${String(callsite.line)}:} {bold ${error.message}}\n${formattedCode}`;
-        }
-        return chalk`{red Line ${String(callsite.line)}:} {bold something went wrong here.}\n${formattedCode}`;
-      })
-      .join('\n');
-
-    messages.push(`${fileErrorsMessage}${errorMessages}`);
-  }
-  if (isEmpty(messages) && errors !== undefined && isEmpty(errorsByFile)) {
-    console.error('Migration error---', errors);
+  if (filePath) {
+    if (errors.request) {
+      errors.data = errors.request?.data;
+      delete errors.request;
+    }
+    if (errors.message) {
+      delete errors.message;
+    }
+    logger.log('error', { [filePath]: errors });
   } else {
-    console.log(messages.join('\n'));
+    for (const file of keys(errorsByFile)) {
+      const errorLogs = {};
+      errorLogs[file] = {};
+      const fileContents = readFile(file);
+      const highlightedCode = highlight(fileContents, { linenos: true });
+      const lines = highlightedCode.split('\n');
+
+      const fileErrorsMessage = chalk`{red Errors in ${file}}\n\n`;
+      errorLogs[file].fileErrorsMessage = fileErrorsMessage.replace(/\u001b\[\d+m/g, '');
+      const errorMessages = errorsByFile[file]
+        .map((error) => {
+          const callsite = error.meta.callsite;
+          const context = 2;
+          let { before, line, after } = getLineWithContext(lines, callsite.line, context);
+
+          const beforeLines = before.map((_line) => chalk`${_line}\n`);
+          const afterLines = after.map((_line) => chalk`${_line}\n`);
+          const highlightedLine = chalk`{bold ${line}}\n`;
+
+          before = removeSpecialCharacter(before.join('\n'));
+          after = removeSpecialCharacter(after.join('\n'));
+          line = removeSpecialCharacter(line);
+          errorLogs[file].lines = { before, line, after };
+          if (error.request) {
+            error.data = error.request?.data;
+            delete error.request;
+          }
+          if (error.message) {
+            delete error.message;
+          }
+          const formattedCode = beforeLines + highlightedLine + afterLines;
+          if (error.payload?.apiError) {
+            errorLogs[file].apiError = true;
+            errorLogs[file].errorCode = error.payload.apiError.errorCode;
+            errorLogs[file].errors = error.payload.apiError.errors;
+            errorLogs[file].data = error.data;
+          }
+          if (error.message && !error.payload.apiError) {
+            errorLogs[file].apiError = false;
+            errorLogs[file].error = error.message;
+          }
+        })
+        .join('\n');
+
+      messages.push(`${fileErrorsMessage}${errorMessages}`);
+      logger.log('error', errorLogs);
+    }
+    if (errors?.request) {
+      errors.data = errors.request?.data;
+      delete errors.request;
+    }
+    if (errors?.message) {
+      delete errors.message;
+    }
+    if (isEmpty(messages) && errors !== undefined && isEmpty(errorsByFile)) {
+      logger.log('error', { errors: errors });
+      console.log(chalk`{bold.red Migration unsuccessful}`);
+    } else {
+      logger.log('error', { error: messages.join('\n') });
+    }
   }
   // eslint-disable-next-line
-  console.log(chalk`{bold.red Migration unsuccessful}`);
+  // console.log(chalk`{bold.red Migration unsuccessful}`);
 };

package/src/utils/fs-helper.js

@@ -2,6 +2,7 @@
 
 const { existsSync, mkdirSync, readFileSync, readFile } = require('fs');
 const path = require('path');
+const { pathValidator } = require('@contentstack/cli-utilities');
 
 exports.makeDir = (dirname) => {
   !this.existsSync(dirname) && mkdirSync(dirname);
@@ -16,7 +17,7 @@ exports.readFile = (filePath) => {
 
 exports.readJSONFile = (filePath) => {
   return new Promise((resolve, reject) => {
-    filePath = path.resolve(filePath);
+    filePath = pathValidator(filePath);
     readFile(filePath, 'utf-8', (error, data) => {
       if (error) {
         reject(error);

package/src/utils/index.js

@@ -11,7 +11,6 @@ module.exports = {
   safePromise: require('./safe-promise'),
   getConfig: require('./get-config'),
   successHandler: require('./success-handler'),
-  errorHandler: require('./error-handler'),
   getCallsite: require('./callsite'),
   errorHelper: require('./error-helper'),
   groupBy: require('./group-by'),

package/src/utils/logger.js

@@ -4,6 +4,7 @@ const { createLogger, format, transports } = require('winston');
 const { resolve, join } = require('path');
 const { slice } = Array.prototype;
 const { stringify } = JSON;
+const { pathValidator } = require('@contentstack/cli-utilities');
 
 const { combine, label, printf, colorize } = format;
 
@@ -32,10 +33,10 @@ function init(logFileName) {
   // Create dir if does not exist
   makeDir(logsDir);
 
-  const logPath = join(logsDir, logFileName + '.log');
+  const logPath = pathValidator(join(logsDir, logFileName + '.log'));
   const logger = createLogger({
     format: combine(colorize(), label({ label: 'Migration' }), customFormat),
-    transports: [new transports.File({ filename: logPath }), new transports.Console()],
+    transports: [new transports.File({ filename: logPath })],
   });
 
   let args;
@@ -53,9 +54,9 @@ function init(logFileName) {
       logString && logger.log('warn', logString);
     },
     error: function () {
-      args = slice.call(arguments);
-      logString = getString(args);
-      logString && logger.log('error', logString);
+      // args = slice.call(arguments);
+      // logString = getString(args);
+      // logString && logger.log('error', logString);
     },
     debug: function () {
       args = slice.call(arguments);

package/src/utils/migration-logger.js

@@ -0,0 +1,20 @@
+const winston = require('winston');
+const path = require('path');
+module.exports = class MigrationLogger {
+  constructor(filePath) {
+    this.filePath = path.join(filePath, 'migration-logs');
+    this.logger = winston.createLogger({
+      levels: { error: 1 },
+      transports: [
+        new winston.transports.File({
+          level: 'error',
+          filename: path.join(this.filePath, 'error.logs'),
+          format: winston.format.combine(winston.format.timestamp(), winston.format.json()),
+        }),
+      ],
+    });
+  }
+  log(level, message) {
+    this.logger.log('error', message);
+  }
+};

package/src/utils/error-handler.js

@@ -1,21 +0,0 @@
-'use strict';
-
-const { error } = require('./logger');
-const { errorMessageHandler } = require('./constants');
-
-module.exports = (data, type, method, err) => {
-  if (data && type && method) {
-    error(`Error occurred while ${errorMessageHandler[method]} ${type}: ${data}.`);
-  }
-
-  if (err.errorMessage) {
-    error(err.errorMessage);
-  }
-  if (err instanceof Error && err && err.message && err.stack) {
-    error(err.message);
-    // error(err.stack)
-  } else {
-    error(err);
-  }
-  // throw new Error(err);
-};