CS-44174 - added logger for errors for multiple files errors, version bump

packages/contentstack-branches/src/utils/entry-create-script.ts

@@ -9,7 +9,6 @@ export function entryCreateScript(contentType) {
   const omit = require('lodash/omit');
   const compact = require('lodash/compact')
   const isPlainObject = require('lodash/isPlainObject');
-  const {cliux, LoggerService} = require('@contentstack/cli-utilities')
   module.exports = async ({ migration, stackSDKInstance, managementAPIClient, config, branch, apiKey }) => {
     const keysToRemove = [
       'content_type_uid',
@@ -41,7 +40,6 @@ export function entryCreateScript(contentType) {
     let assetRefPath = {};
     let downloadedAssets = [];
     let parent=[];
-    let logger;
 
     function getValueByPath(obj, path) {
       return path.split('[').reduce((o, key) => o && o[key.replace(/\]$/, '')], obj);
@@ -470,10 +468,6 @@ export function entryCreateScript(contentType) {
         successTitle: 'Entries Created Successfully',
         failedTitle: 'Failed to create entries',
         task: async () => {
-          //logger file
-          if(!fs.existsSync(path.join(filePath, 'entry-migration'))){
-            logger = new LoggerService(filePath, 'entry-migration');
-          }
 
           const compareBranchEntries = await managementAPIClient
             .stack({ api_key: stackSDKInstance.api_key, branch_uid: compareBranch })
@@ -521,15 +515,7 @@ export function entryCreateScript(contentType) {
           async function updateEntry(entry, entryDetails) {
             Object.assign(entry, { ...entryDetails });
             await entry.update().catch(err => {
-              let errorMsg = 'Entry update failed for uid: ' + entry?.uid + ', title: ' + entry?.title + '. ';
-              if(err?.errors?.title){
-                errorMsg +=  'title'+ err?.errors?.title;
-              }else if(err?.errors?.entry){
-                errorMsg +=  err?.errors?.entry;
-              }else{
-                errorMsg +=  (err?.entry?.errorMessage || err?.errorMessage || err?.message) ?? 'Something went wrong!';
-              }
-              logger.error(errorMsg)
+              throw err;
             });
           }
 
@@ -563,15 +549,7 @@ export function entryCreateScript(contentType) {
                 if(entryDetails !== undefined){
                   entryDetails = updateAssetDetailsInEntries(entryDetails);
                   let createdEntry = await stackSDKInstance.contentType('${contentType}').entry().create({ entry: entryDetails }).catch(err => {
-                    let errorMsg = 'Entry creation failed for contentType: ' + contentType + ', title: ' + entryDetails?.title + '. ';
-                    if(err?.errors?.title){
-                      errorMsg +=  err?.errors?.title;
-                    }else if(err?.errors?.entry){
-                      errorMsg +=  err?.errors?.entry;
-                    }else{
-                      errorMsg +=  (err?.entry?.errorMessage || err?.errorMessage || err?.message) ?? 'Something went wrong!';
-                    }
-                    logger.error(errorMsg)
+                    throw err
                   });
                   if(createdEntry){
                     if (flag.references) {

packages/contentstack-branches/src/utils/entry-create-update-script.ts

@@ -9,7 +9,6 @@ export function entryCreateUpdateScript(contentType) {
   const omit = require('lodash/omit');
   const compact = require('lodash/compact')
   const isPlainObject = require('lodash/isPlainObject');
-  const {cliux, LoggerService} = require('@contentstack/cli-utilities')
   module.exports = async ({ migration, stackSDKInstance, managementAPIClient, config, branch, apiKey }) => {
     const keysToRemove = [
       'content_type_uid',
@@ -42,7 +41,6 @@ export function entryCreateUpdateScript(contentType) {
     let assetUrlMapper = {};
     let assetRefPath = {};
     let parent=[];
-    let logger;
 
     function converter(data) {
       let arr = [];
@@ -485,10 +483,6 @@ export function entryCreateUpdateScript(contentType) {
         successMessage: 'Entries Updated Successfully',
         failedMessage: 'Failed to update entries',
         task: async () => {
-        //logger file
-        if(!fs.existsSync(path.join(filePath, 'entry-migration'))){
-          logger = new LoggerService(filePath, 'entry-migration');
-        }
           let compareBranchEntries = await managementAPIClient
           .stack({ api_key: stackSDKInstance.api_key, branch_uid: compareBranch })
           .contentType('${contentType}')
@@ -540,15 +534,7 @@ export function entryCreateUpdateScript(contentType) {
             if (entry) {
               Object.assign(entry, { ...entryDetails });
               await entry.update().catch(err => {
-                let errorMsg = 'Entry update failed for uid: ' + entry?.uid + ', title: ' + entry?.title + '.';
-                if(err?.errors?.title){
-                  errorMsg +=  err?.errors?.title;
-                }else if(err?.errors?.entry){
-                  errorMsg +=  err?.errors?.entry;
-                }else{
-                  errorMsg +=  (err?.entry?.errorMessage || err?.errorMessage || err?.message) ?? 'Something went wrong!';
-                }
-                logger.error(errorMsg)
+                throw err
               });
             }
           }
@@ -623,7 +609,7 @@ export function entryCreateUpdateScript(contentType) {
                     .entry()
                     .create({ entry: entryDetails })
                     .catch(err => {
-                      (err?.errorMessage || err?.message) ? err?.errorMessage || err?.message : 'Something went wrong!'
+                      throw err;
                     })
 
                     if(createdEntry){

packages/contentstack-branches/src/utils/entry-update-script.ts

@@ -9,7 +9,6 @@ export function entryUpdateScript(contentType) {
   const omit = require('lodash/omit');
   const compact = require('lodash/compact')
   const isPlainObject = require('lodash/isPlainObject');
-  const {cliux, LoggerService} = require('@contentstack/cli-utilities')
   module.exports = async ({ migration, stackSDKInstance, managementAPIClient, config, branch, apiKey }) => {
     const keysToRemove = [
       'content_type_uid',
@@ -42,7 +41,6 @@ export function entryUpdateScript(contentType) {
     let assetUrlMapper = {};
     let assetRefPath = {};
     let parent=[];
-    let logger;
 
     function converter(data) {
       let arr = [];
@@ -484,10 +482,6 @@ export function entryUpdateScript(contentType) {
         successMessage: 'Entries Updated Successfully',
         failedMessage: 'Failed to update entries',
         task: async () => {
-          //logger file
-          if(!fs.existsSync(path.join(filePath, 'entry-migration'))){
-            logger = new LoggerService(filePath, 'entry-migration');
-          }
 
           let compareBranchEntries = await managementAPIClient
           .stack({ api_key: stackSDKInstance.api_key, branch_uid: compareBranch })
@@ -539,15 +533,7 @@ export function entryUpdateScript(contentType) {
           async function updateEntry(entry, entryDetails) {
             Object.assign(entry, { ...entryDetails });
             await entry.update().catch(err => {
-              let errorMsg = 'Entry update failed for uid: ' + entry?.uid + ', title: ' + entry?.title + '.';
-              if(err?.errors?.title){
-                errorMsg +=  err?.errors?.title;
-              }else if(err?.errors?.entry){
-                errorMsg +=  err?.errors?.entry;
-              }else{
-                errorMsg +=  (err?.entry?.errorMessage || err?.errorMessage || err?.message) ?? 'Something went wrong!';
-              }
-              logger.error(errorMsg)
+              throw err
             });
           }
 
@@ -620,7 +606,7 @@ export function entryUpdateScript(contentType) {
                     .entry()
                     .create({ entry: entryDetails })
                     .catch(err => {
-                      (err?.errorMessage || err?.message) ? err?.errorMessage || err?.message : 'Something went wrong!'
+                      throw err;
                     })
 
                     if(createdEntry){

packages/contentstack-migration/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
@@ -66,4 +66,4 @@
       "cm:migration": "O-MGRTN"
     }
   }
-}
+}

packages/contentstack-migration/src/utils/error-helper.js

@@ -1,8 +1,10 @@
 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 logger = new MigrationLogger(process.cwd());
 const { readFile } = require('./fs-helper');
 const groupBy = require('./group-by');
 
@@ -19,41 +21,58 @@ const getLineWithContext = (lines, lineNumber, context) => {
   };
 };
 
+function removeSpecialCharacter(str) {
+  return str.replace(/\u001b\[\d+m/g, '');
+}
+
 module.exports = (errors) => {
   const errorsByFile = groupBy(errors, 'file');
   const messages = [];
   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;
-        const { before, line, after } = getLineWithContext(lines, callsite.line, context);
+        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 };
+
         const formattedCode = beforeLines + highlightedLine + afterLines;
         if (error.payload.apiError) {
-          return chalk`{red Line ${String(callsite.line)}:} {bold ${error.payload.apiError.message}}\n${formattedCode}`;
+          errorLogs[file].apiError = true;
+          errorLogs[file].errorCode = error.payload.apiError.errorCode;
+          errorLogs[file].errors = error.payload.apiError.errors;
         }
-        if (error.message) {
-          return chalk`{red Line ${String(callsite.line)}:} {bold ${error.message}}\n${formattedCode}`;
+        if (error.message && !error.payload.apiError) {
+          errorLogs[file].apiError = false;
+          errorLogs[file].error = error.message;
         }
-        return chalk`{red Line ${String(callsite.line)}:} {bold something went wrong here.}\n${formattedCode}`;
       })
       .join('\n');
 
     messages.push(`${fileErrorsMessage}${errorMessages}`);
+    logger.log('error', errorLogs);
   }
   if (isEmpty(messages) && errors !== undefined && isEmpty(errorsByFile)) {
     console.error('Migration error---', errors);
+    logger.log('error', errors);
   } else {
+    logger.log('error', { error: messages.join('\n') });
     console.log(messages.join('\n'));
   }
   // eslint-disable-next-line

packages/contentstack-migration/src/utils/migration-logger.js

@@ -0,0 +1,28 @@
+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: { info: 1, error: 2 },
+      transports: [
+        new winston.transports.File({
+          level: 'error',
+          filename: path.join(this.filePath, 'error.logs'),
+          format: winston.format.combine(winston.format.timestamp(), winston.format.json()),
+        }),
+        new winston.transports.File({
+          level: 'info',
+          filename: path.join(this.filePath, 'info.logs'),
+          format: winston.format.combine(winston.format.timestamp(), winston.format.json()),
+        }),
+      ],
+    });
+  }
+  log(level, message) {
+    if (level === 'info') {
+      this.logger.log('info', message);
+    }
+    this.logger.log('error', message);
+  }
+};

packages/contentstack/package.json

@@ -36,7 +36,7 @@
     "@contentstack/cli-command": "~1.2.17",
     "@contentstack/cli-config": "~1.6.3",
     "@contentstack/cli-launch": "~1.0.17",
-    "@contentstack/cli-migration": "~1.5.0",
+    "@contentstack/cli-migration": "~1.5.2",
     "@contentstack/cli-utilities": "~1.6.0",
     "@contentstack/management": "~1.15.3",
     "@oclif/core": "^2.9.3",