Merge pull request #1344 from contentstack/feat/CS-44174

CS-44174 - added logger for errors for multiple files errors, version bump
contentstack · Mar 21, 2024 · d502179 · d502179
2 parents 3d5ba00 + 47212a7
commit d502179
Show file tree

Hide file tree

Showing 15 changed files with 124 additions and 166 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/contentstack-branches/package.json b/packages/contentstack-branches/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-cm-branches",
   "description": "Contentstack CLI plugin to do branches operations",
-  "version": "1.0.23",
+  "version": "1.0.24",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
@@ -95,4 +95,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}
diff --git a/packages/contentstack-branches/src/utils/asset-folder-create-script.ts b/packages/contentstack-branches/src/utils/asset-folder-create-script.ts
@@ -114,9 +114,9 @@ export function assetFolderCreateScript(contentType) {
 
   const createAssetTask = () => {
     return {
-      title: 'Create Assets Folder',
+      title: 'Check and create asset folder in base branch',
       successTitle: 'Assets folder Created Successfully',
-      failedTitle: 'Failed to create assets folder',
+      failedTitle: 'Failed to create assets folder in base branch',
       task: async () => {
         try {
           const baseAssetsFolderCount = await getAssetCount(branch, true);

diff --git a/packages/contentstack-branches/src/utils/entry-create-script.ts b/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 })
@@ -520,17 +514,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)
-            });
+            await entry.update()
           }
 
           async function updateReferences(entryDetails, baseEntry, references) {
@@ -558,29 +542,21 @@ export function entryCreateScript(contentType) {
           }
 
           try {
-            compareFilteredProperties.length !== 0 &&
-              compareFilteredProperties.forEach(async (entryDetails) => {
-                if(entryDetails !== undefined){
+            if (compareFilteredProperties.length !== 0) {
+              for (let i = 0; i < compareFilteredProperties.length; i++) {
+                let entryDetails = compareFilteredProperties[i];
+                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)
-                  });
-                  if(createdEntry){
+                  let createdEntry = await stackSDKInstance.contentType('${contentType}').entry().create({ entry: entryDetails })
+                  if (createdEntry) {
                     if (flag.references) {
                       await updateReferences(entryDetails, createdEntry, references);
                     }
-                    await updateEntry(createdEntry, entryDetails);
+                    await updateEntry(createdEntry, entryDetails)
                   }
                 }
-              });
+              }
+            }
           } catch (error) {
             throw error;
           }

diff --git a/packages/contentstack-branches/src/utils/entry-create-update-script.ts b/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}')
@@ -539,17 +533,7 @@ export function entryCreateUpdateScript(contentType) {
           async function updateEntry(entry, entryDetails) {
             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)
-              });
+              await entry.update();
             }
           }
 
@@ -622,9 +606,6 @@ export function entryCreateUpdateScript(contentType) {
                     .contentType('${contentType}')
                     .entry()
                     .create({ entry: entryDetails })
-                    .catch(err => {
-                      (err?.errorMessage || err?.message) ? err?.errorMessage || err?.message : 'Something went wrong!'
-                    })
 
                     if(createdEntry){
                       if (flag.references) {

diff --git a/packages/contentstack-branches/src/utils/entry-update-script.ts b/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 })
@@ -538,17 +532,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)
-            });
+            await entry.update();
           }
 
           async function updateReferences(entryDetails, baseEntry, references) {
@@ -619,9 +603,6 @@ export function entryUpdateScript(contentType) {
                     .contentType('${contentType}')
                     .entry()
                     .create({ entry: entryDetails })
-                    .catch(err => {
-                      (err?.errorMessage || err?.message) ? err?.errorMessage || err?.message : 'Something went wrong!'
-                    })
                   
                     if(createdEntry){
                       if (flag.references) {

diff --git a/packages/contentstack-migration/package.json b/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"
     }
   }
-}
+}
diff --git a/packages/contentstack-migration/src/commands/cm/stacks/migration.js b/packages/contentstack-migration/src/commands/cm/stacks/migration.js
@@ -12,6 +12,7 @@ const { Parser } = require('../../../modules');
 const { ActionList } = require('../../../actions');
 const fs = require('fs');
 const chalk = require('chalk');
+const isEmpty = require('lodash/isEmpty');
 const {
   printFlagDeprecation,
   managementSDKClient,
@@ -24,8 +25,6 @@ const { ApiError, SchemaValidator, MigrationError, FieldValidator } = require('.
 
 // Utils
 const { map: _map, constants, safePromise, errorHelper } = require('../../../utils');
-const { success } = require('../../../utils/logger');
-
 // Properties
 const { get, set, getMapInstance, resetMapInstance } = _map;
 const {
@@ -134,6 +133,10 @@ 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) {
@@ -160,21 +163,11 @@ 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 });
     }
   }
 
@@ -186,7 +179,6 @@ class MigrationCommand extends Command {
       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(pathValidator(resolve(filePath, file)), mapInstance);
         }

diff --git a/packages/contentstack-migration/src/utils/error-handler.js b/packages/contentstack-migration/src/utils/error-handler.js