@contentstack/cli-cm-export 0.1.1-beta.10 → 0.1.1-beta.13

package/README.md

@@ -10,6 +10,25 @@ It is Contentstack’s CLI plugin to export content from the stack. To learn how
 * [Commands](#commands)
 <!-- tocstop -->
 
+For switching to EU region update the hosts at config/default.js
+
+```js
+{
+  host:'https://eu-api.contentstack.com/v3',
+  cdn: 'https://eu-cdn.contentstack.com/v3',
+ ...
+}
+```
+
+For switching to AZURE-NA region update the hosts at config/default.js
+
+```js
+{
+  host:'https://azure-na-api.contentstack.com/v3',
+  cdn: 'https://azure-na-cdn.contentstack.com/v3',
+ ...
+}
+```
 # Usage
 
 <!-- usage -->
@@ -18,7 +37,7 @@ $ npm install -g @contentstack/cli-cm-export
 $ csdx COMMAND
 running command...
 $ csdx (-v|--version|version)
-@contentstack/cli-cm-export/0.1.1-beta.10 linux-x64 node-v12.22.7
+@contentstack/cli-cm-export/0.1.1-beta.13 linux-x64 node-v16.14.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -68,5 +87,5 @@ EXAMPLES
   csdx cm:export -A -B [optional] branch name
 ```
 
-_See code: [src/commands/cm/export.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.10/packages/contentstack-export/src/commands/cm/export.js)_
+_See code: [src/commands/cm/export.js](https://github.com/contentstack/cli/blob/v0.1.1-beta.13/packages/contentstack-export/src/commands/cm/export.js)_
 <!-- commandsstop -->

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.1.1-beta.10","commands":{"cm:export":{"id":"cm:export","description":"Export content from a stack\n...\nExport content from one stack to another\n","pluginName":"@contentstack/cli-cm-export","pluginType":"core","aliases":[],"examples":["csdx cm:export -A","csdx cm:export -A -s <stack_ApiKey> -d <path/of/export/destination/dir>","csdx cm:export -A -c <path/to/config/dir>","csdx cm:export -A -m <single module name>","csdx cm:export -A --secured-assets","csdx cm:export -a <management_token_alias>","csdx cm:export -a <management_token_alias> -d <path/to/export/destination/dir>","csdx cm:export -a <management_token_alias> -c <path/to/config/file>","csdx cm:export -A -m <single module name>","csdx cm:export -A -m <single module name> -t <content type>","csdx cm:export -A -B [optional] branch name"],"flags":{"config":{"name":"config","type":"option","char":"c","description":"[optional] path of the config"},"stack-uid":{"name":"stack-uid","type":"option","char":"s","description":"API key of the source stack"},"data":{"name":"data","type":"option","char":"d","description":"path or location to store the data"},"management-token-alias":{"name":"management-token-alias","type":"option","char":"a","description":"alias of the management token"},"auth-token":{"name":"auth-token","type":"boolean","char":"A","description":"to use auth token","allowNo":false},"module":{"name":"module","type":"option","char":"m","description":"[optional] specific module name"},"content-type":{"name":"content-type","type":"option","char":"t","description":"[optional] content type"},"branch":{"name":"branch","type":"option","char":"B","description":"[optional] branch name"},"secured-assets":{"name":"secured-assets","type":"boolean","description":"[optional] use when assets are secured","allowNo":false}},"args":[]}}}
+{"version":"0.1.1-beta.13","commands":{"cm:export":{"id":"cm:export","description":"Export content from a stack\n...\nExport content from one stack to another\n","pluginName":"@contentstack/cli-cm-export","pluginType":"core","aliases":[],"examples":["csdx cm:export -A","csdx cm:export -A -s <stack_ApiKey> -d <path/of/export/destination/dir>","csdx cm:export -A -c <path/to/config/dir>","csdx cm:export -A -m <single module name>","csdx cm:export -A --secured-assets","csdx cm:export -a <management_token_alias>","csdx cm:export -a <management_token_alias> -d <path/to/export/destination/dir>","csdx cm:export -a <management_token_alias> -c <path/to/config/file>","csdx cm:export -A -m <single module name>","csdx cm:export -A -m <single module name> -t <content type>","csdx cm:export -A -B [optional] branch name"],"flags":{"config":{"name":"config","type":"option","char":"c","description":"[optional] path of the config"},"stack-uid":{"name":"stack-uid","type":"option","char":"s","description":"API key of the source stack"},"data":{"name":"data","type":"option","char":"d","description":"path or location to store the data"},"management-token-alias":{"name":"management-token-alias","type":"option","char":"a","description":"alias of the management token"},"auth-token":{"name":"auth-token","type":"boolean","char":"A","description":"to use auth token","allowNo":false},"module":{"name":"module","type":"option","char":"m","description":"[optional] specific module name"},"content-type":{"name":"content-type","type":"option","char":"t","description":"[optional] content type"},"branch":{"name":"branch","type":"option","char":"B","description":"[optional] branch name"},"secured-assets":{"name":"secured-assets","type":"boolean","description":"[optional] use when assets are secured","allowNo":false}},"args":[]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@contentstack/cli-cm-export",
 	"description": "Contentstack CLI plugin to export content from stack",
-	"version": "0.1.1-beta.10",
+	"version": "0.1.1-beta.13",
 	"author": "Contentstack",
 	"bugs": "https://github.com/contentstack/cli/issues",
 	"dependencies": {

package/src/app.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-redeclare */
 var util = require("./lib/util");
 var login = require("./lib/util/login");
-var { addlogs } = require("./lib/util/log");
+var { addlogs, unlinkFileLogger } = require("./lib/util/log");
 const setupBranches = require("./lib/util/setup-branches");
 const chalk = require("chalk");
 let path = require("path");
@@ -46,6 +46,7 @@ exports.initial = async function (config) {
             console.log('failed export contents', error)
           }
         }
+        unlinkFileLogger()
         resolve()
       })
       .catch((error) => {

package/src/config/default.js

@@ -1,5 +1,10 @@
 module.exports = {
   versioning: false,
+  host: 'https://api.contentstack.io/v3',
+  // use below hosts for eu region
+  // host:'https://eu-api.contentstack.com/v3',
+  // use below hosts for azure-na region
+  // host:'https://azure-na-api.contentstack.com/v3',
   modules: {
     types: [
       'stack',

package/src/lib/export/assets.js

@@ -39,6 +39,8 @@ ExportAssets.prototype = {
   start: function (credentialConfig) {
     this.assetContents = {}
     this.folderData = []
+    this.assetDownloadRetry = {};
+    this.assetDownloadRetryLimit = 3;
     let  self = this
     config = credentialConfig
     assetsFolderPath = path.resolve(config.data, (config.branchName || ""), assetConfig.dirName)
@@ -69,9 +71,9 @@ ExportAssets.prototype = {
                   // log.success(chalk.white('The following asset has been downloaded successfully: ' +
                   //     assetJSON.uid))
                 }).catch(function (error) {
-                addlogs(self.configchalk.red('The following asset failed to download\n' + JSON.stringify(
+                  addlogs(config, chalk.red('The following asset failed to download\n' + JSON.stringify(
                   assetJSON)))
-                addlogs(config, error, 'error')
+                  addlogs(config, error, 'error')
               })
             }, {
               concurrency: vLimit,
@@ -210,6 +212,10 @@ ExportAssets.prototype = {
     let self = this
     let assetVersionInfo = bucket || []
     return new Promise(function (resolve, reject) {
+      if (self.assetDownloadRetry[uid + version] > self.assetDownloadRetryLimit) {
+        return reject(new Error('Asset Max download retry limit exceeded! ' + uid));
+      }
+
       if (version <= 0) {
         const assetVersionInfoFile = path.resolve(assetsFolderPath, uid, '_contentstack_' + uid + '.json')
         helper.writeFile(assetVersionInfoFile, assetVersionInfo)
@@ -231,8 +237,17 @@ ExportAssets.prototype = {
           assetVersionInfo = _.uniqWith(assetVersionInfo, _.isEqual)
           self.getVersionedAssetJSON(uid, --version, assetVersionInfo)
           .then(resolve)
-          .catch(reject)
+            .catch(reject)
         }).catch(reject)
+      }).catch((error) => {
+        if (error.status === 408) {
+          // retrying when timeout
+          (self.assetDownloadRetry[uid+version] ? ++self.assetDownloadRetry[uid+version] : self.assetDownloadRetry[uid+version] = 1 ) 
+          return self.getVersionedAssetJSON(uid, version, assetVersionInfo)
+          .then(resolve)
+            .catch(reject) 
+        }
+        reject(error);
       })
     })
   },
@@ -252,6 +267,7 @@ ExportAssets.prototype = {
           : asset.url,
       };
 
+      self.assetStream.url = encodeURI(self.assetStream.url);
       const assetStreamRequest = nativeRequest(self.assetStream)
       assetStreamRequest.on('response', function () {
         helper.makeDirectory(assetFolderPath)

package/src/lib/util/log.js

@@ -24,12 +24,11 @@ function returnString(args) {
 
 var myCustomLevels = {
   levels: {
-    error: 0,
     warn: 1,
     info: 2,
     debug: 3,
   },
-  colors: {
+  colors: { //colors aren't being used anywhere as of now, we're using chalk to add colors while logging
     info: 'blue',
     debug: 'green',
     warn: 'yellow',
@@ -37,26 +36,52 @@ var myCustomLevels = {
   },
 }
 
-function init (_logPath, logfileName) {
-  var logsDir = path.resolve(_logPath, 'logs', 'export')
-  // Create dir if doesn't already exist
-  mkdirp.sync(logsDir)
-  var logPath = path.join(logsDir, logfileName + '.log')
+let logger
+let errorLogger
 
-  var transports = [new (winston.transports.File)({
-    filename: logPath,
-    maxFiles: 20,
-    maxsize: 1000000,
-    tailable: true,
-    json: true,
-  })]
+let successTransport
+let errorTransport
 
-  transports.push(new (winston.transports.Console)())
+function init(_logPath) {
+  if (!logger || !errorLogger) {
+    var logsDir = path.resolve(_logPath, 'logs', 'export')
+    // Create dir if doesn't already exist
+    mkdirp.sync(logsDir)
 
-  var logger = new(winston.Logger)({
-    transports: transports,
-    levels: myCustomLevels.levels
-  })
+    successTransport = {
+      filename: path.join(logsDir, 'success.log'),
+      maxFiles: 20,
+      maxsize: 1000000,
+      tailable: true,
+      json: true,
+      level: 'info',
+    }
+
+    errorTransport = {
+      filename: path.join(logsDir, 'error.log'),
+      maxFiles: 20,
+      maxsize: 1000000,
+      tailable: true,
+      json: true,
+      level: 'error',
+    }
+
+    logger = new (winston.Logger)({
+      transports: [
+        new (winston.transports.File)(successTransport),
+        new (winston.transports.Console)()
+      ],
+      levels: myCustomLevels.levels
+    });
+
+    errorLogger = new (winston.Logger)({
+      transports: [
+        new (winston.transports.File)(errorTransport),
+        new (winston.transports.Console)({ level: 'error' })
+      ],
+      levels: { error: 0 }
+    })
+  }
 
   return {
     log: function () {
@@ -77,7 +102,7 @@ function init (_logPath, logfileName) {
       var args = slice.call(arguments)
       var logString = returnString(args)
       if (logString) {
-        logger.log('error', logString)
+        errorLogger.log('error', logString)
       }
     },
     debug: function () {
@@ -91,9 +116,23 @@ function init (_logPath, logfileName) {
 }
 
 exports.addlogs = async (config, message, type) => {
+  // ignoring the type argument, as we are not using it to create a logfile anymore
   if (type !== 'error') {
-    init(config.data, type).log(message)
+    // removed type argument from init method
+    init(config.data).log(message)
   } else {
-    init(config.data, type).error(message)
+    init(config.data).error(message)
   }
 }
+
+exports.unlinkFileLogger = () => {
+  if (logger) {
+    const fileLogger = logger.transports.file
+    logger.remove(fileLogger)
+  }
+
+  if (errorLogger) {
+    const fileLogger = errorLogger.transports.file
+    errorLogger.remove(fileLogger)
+  }
+}