@contentstack/cli-cm-export 0.1.1-beta.7 → 1.0.0

package/src/lib/export/assets.js

@@ -4,188 +4,235 @@
  * MIT Licensed
  */
 
-const nativeRequest = require('request')
-const mkdirp = require('mkdirp')
-const path = require('path')
-const fs = require('fs')
-const Promise = require('bluebird')
-const _ = require('lodash')
-const chalk = require('chalk')
+const mkdirp = require('mkdirp');
+const path = require('path');
+const fs = require('fs');
+const Promise = require('bluebird');
+const _ = require('lodash');
+const chalk = require('chalk');
+const progress = require('progress-stream');
+const { HttpClient } = require('@contentstack/cli-utilities');
 
-const helper = require('../util/helper')
-const {addlogs} = require('../util/log')
+const helper = require('../util/helper');
+const { addlogs } = require('../util/log');
 
-let config = require('../../config/default')
-const stack = require('../util/contentstack-management-sdk')
-const assetConfig = config.modules.assets
-const invalidKeys = assetConfig.invalidKeys
+let config = require('../../config/default');
+const stack = require('../util/contentstack-management-sdk');
+const assetConfig = config.modules.assets;
+const invalidKeys = assetConfig.invalidKeys;
+const httpClient = HttpClient.create();
 
 // The no. of assets fetched and processed in a batch
-const bLimit = assetConfig.batchLimit || 15
+const bLimit = assetConfig.batchLimit || 15;
 
 // The no. of asset files downloaded at a time
-const vLimit = assetConfig.downloadLimit || 3
-let assetsFolderPath
-let assetContentsFile
-let folderJSONPath
-let client
+const vLimit = assetConfig.downloadLimit || 3;
+let assetsFolderPath;
+let assetContentsFile;
+let folderJSONPath;
+let client;
 
 function ExportAssets() {
-  this.assetContents = {}
-  this.folderData = []
+  this.assetContents = {};
+  this.folderData = [];
 }
 
 ExportAssets.prototype = {
   start: function (credentialConfig) {
-    let  self = this
-    config = credentialConfig
-    assetsFolderPath = path.resolve(config.data, assetConfig.dirName)
-    assetContentsFile = path.resolve(assetsFolderPath, 'assets.json')
-    folderJSONPath = path.resolve(assetsFolderPath, 'folders.json')
-    client = stack.Client(config)
-    
-    addlogs(config, 'Starting assets export', 'success')
+    this.assetContents = {};
+    this.folderData = [];
+    this.assetDownloadRetry = {};
+    this.assetDownloadRetryLimit = 3;
+    let self = this;
+    config = credentialConfig;
+    assetsFolderPath = path.resolve(config.data, config.branchName || '', assetConfig.dirName);
+    assetContentsFile = path.resolve(assetsFolderPath, 'assets.json');
+    folderJSONPath = path.resolve(assetsFolderPath, 'folders.json');
+    client = stack.Client(config);
+
+    addlogs(config, 'Starting assets export', 'success');
     // Create asset folder
-    mkdirp.sync(assetsFolderPath)
+    mkdirp.sync(assetsFolderPath);
     return new Promise(function (resolve, reject) {
-      return self.getAssetCount().then(function (count) {
-        if (typeof count !== 'number' || count === 0) {
-          addlogs(config, 'No assets found', 'success')
-          return resolve()
-        }
-        const assetBatches = []
-        for (let i = 0; i <= count; i += bLimit) {
-          assetBatches.push(i)
-        }
-        return Promise.map(assetBatches, function (batch) {
-          return self.getAssetJSON(batch).then(function (assetsJSON) {
-            return Promise.map(assetsJSON, function (assetJSON) {
-              return self.getVersionedAssetJSON(assetJSON.uid, assetJSON._version).then(
-                function () {
-                  self.assetContents[assetJSON.uid] = assetJSON
-                  // 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(
-                  assetJSON)))
-                addlogs(config, error, 'error')
-              })
-            }, {
-              concurrency: vLimit,
-            }).then(function () {
-              addlogs(config, 'Batch no ' + (batch + 1) + ' of assets is complete', 'success')
-              helper.writeFile(assetContentsFile, self.assetContents)
-            }).catch(function (error) {
-              addlogs(config, 'Asset batch ' + (batch + 1) + ' failed to download', 'error')
-              addlogs(config, error, 'error')
-              // log this error onto a file - send over retries
+      //TBD: getting all the assets should have optimized
+      return self
+        .getAssetCount()
+        .then(function (count) {
+          if (typeof count !== 'number' || count === 0) {
+            addlogs(config, 'No assets found', 'success');
+            return resolve();
+          }
+          const assetBatches = [];
+          for (let i = 0; i <= count; i += bLimit) {
+            assetBatches.push(i);
+          }
+          return Promise.map(
+            assetBatches,
+            function (batch) {
+              return self
+                .getAssetJSON(batch)
+                .then(function (assetsJSON) {
+                  return Promise.map(
+                    assetsJSON,
+                    function (assetJSON) {
+                      return self
+                        .getVersionedAssetJSON(assetJSON.uid, assetJSON._version)
+                        .then(function () {
+                          self.assetContents[assetJSON.uid] = assetJSON;
+                          // log.success(chalk.white('The following asset has been downloaded successfully: ' +
+                          //     assetJSON.uid))
+                        })
+                        .catch(function (error) {
+                          addlogs(
+                            config,
+                            chalk.red('The following asset failed to download\n' + JSON.stringify(assetJSON)),
+                          );
+                          addlogs(config, error, 'error');
+                        });
+                    },
+                    {
+                      concurrency: vLimit,
+                    },
+                  )
+                    .then(function () {
+                      addlogs(config, 'Batch no ' + (batch + 1) + ' of assets is complete', 'success');
+                      helper.writeFile(assetContentsFile, self.assetContents);
+                    })
+                    .catch(function (error) {
+                      console.log('Error fetch/download the asset', error && error.message);
+                      addlogs(config, 'Asset batch ' + (batch + 1) + ' failed to download', 'error');
+                      addlogs(config, error, 'error');
+                      // log this error onto a file - send over retries
+                    });
+                })
+                .catch(function (error) {
+                  return reject(error);
+                });
+            },
+            {
+              concurrency: 1,
+            },
+          )
+            .then(function () {
+              return self
+                .exportFolders()
+                .then(function () {
+                  addlogs(config, chalk.green('Asset export completed successfully'), 'success');
+                  return resolve();
+                })
+                .catch(function (error) {
+                  return reject(error);
+                });
             })
-          }).catch(function (error) {
-            return reject(error)
-          })
-        }, {
-          concurrency: 1,
-        }).then(function () {
-          return self.exportFolders().then(function () {
-            addlogs(config, chalk.green('Asset export completed successfully'), 'success')
-            return resolve()
-          }).catch(function (error) {
-            return reject(error)
-          })
-        }).catch(function (error) {
-          addlogs(config, chalk.red('Asset export failed due to the following errrors ' + JSON.stringify(
-            error), 'error'))
-          return reject(error)
+            .catch(function (error) {
+              addlogs(
+                config,
+                chalk.red('Asset export failed due to the following errrors ' + JSON.stringify(error), 'error'),
+              );
+              return reject(error);
+            });
         })
-      }).catch(function (error) {
-        // addlogs(config, chalk.red('Failed to download assets due to the following error: ' + JSON.stringify(
-        //   error)));
-        return reject(error)
-      })
-    })
+        .catch(function (error) {
+          return reject(error);
+        });
+    });
   },
   exportFolders: function () {
-    let  self = this
+    let self = this;
     return new Promise(function (resolve, reject) {
-      return self.getAssetCount(true).then(function (fCount) {
-        if (fCount === 0) {
-          addlogs(config, 'No folders were found in the stack!', 'success')
-          return resolve()
-        }
-        return self.getFolderJSON(0, fCount).then(function () {
-          // asset folders have been successfully exported
-          addlogs(config, 'Asset-folders have been successfully exported!', 'success')
-          return resolve()
-        }).catch(function (error) {
-          addlogs(config, chalk.red('Error while exporting asset-folders!'), 'error')
-          return reject(error)
+      return self
+        .getAssetCount(true)
+        .then(function (fCount) {
+          if (fCount === 0) {
+            addlogs(config, 'No folders were found in the stack!', 'success');
+            return resolve();
+          }
+          return self
+            .getFolderJSON(0, fCount)
+            .then(function () {
+              // asset folders have been successfully exported
+              addlogs(config, 'Asset-folders have been successfully exported!', 'success');
+              return resolve();
+            })
+            .catch(function (error) {
+              addlogs(config, chalk.red('Error while exporting asset-folders!'), 'error');
+              return reject(error);
+            });
         })
-      }).catch(function (error) {
-        addlogs(config, error, 'error')
-        // error while fetching asset folder count
-        return reject(error)
-      })
-    })
+        .catch(function (error) {
+          addlogs(config, error, 'error');
+          // error while fetching asset folder count
+          return reject(error);
+        });
+    });
   },
   getFolderJSON: function (skip, fCount) {
-    let  self = this
+    let self = this;
     return new Promise(function (resolve, reject) {
       if (typeof skip !== 'number') {
-        skip = 0
+        skip = 0;
       }
       if (skip >= fCount) {
-        helper.writeFile(folderJSONPath, self.folderData)
-        return resolve()
+        helper.writeFile(folderJSONPath, self.folderData);
+        return resolve();
       }
 
       const queryRequestObj = {
         include_folders: true,
-        query: {'is_dir': true},
+        query: { is_dir: true },
         skip: skip,
-      }
+      };
 
-      client.stack({api_key: config.source_stack, management_token: config.management_token}).asset().query(queryRequestObj).find()
-      .then(response => {
-        response.items.forEach(function (folder) {
-          self.folderData.push(folder)
-        })
-        skip += 100
-        return self.getFolderJSON(skip, fCount)
-        .then(resolve)
-        .catch(reject)
-      })
-    })
+      client
+        .stack({ api_key: config.source_stack, management_token: config.management_token })
+        .asset()
+        .query(queryRequestObj)
+        .find()
+        .then((response) => {
+          response.items.forEach(function (folder) {
+            self.folderData.push(folder);
+          });
+          skip += 100;
+          return self.getFolderJSON(skip, fCount).then(resolve).catch(reject);
+        });
+    });
   },
   getAssetCount: function (folder) {
-    let self = this
     return new Promise(function (resolve, reject) {
       if (folder && typeof folder === 'boolean') {
-        let queryOptions = {include_folders: true, query: {'is_dir': true}, include_count: true}
-        client.stack({api_key: config.source_stack, management_token: config.management_token}).asset().query(queryOptions).find()
-        .then(asset => {
-          return resolve(asset.count)
-        })
-        .catch(error => {
-          addlogs(config, error, 'error')
-        })
+        let queryOptions = { include_folders: true, query: { is_dir: true }, include_count: true };
+        client
+          .stack({ api_key: config.source_stack, management_token: config.management_token })
+          .asset()
+          .query(queryOptions)
+          .find()
+          .then((asset) => {
+            return resolve(asset.count);
+          })
+          .catch((error) => {
+            addlogs(config, error, 'error');
+          });
       } else {
-        let queryOptions = {include_count: true}
-        client.stack({api_key: config.source_stack, management_token: config.management_token}).asset().query(queryOptions).find()
-        .then(asset => {
-          return resolve(asset.count)
-        })
-        .catch(error => {
-          addlogs(config, error, 'error')
-          return reject()
-        })
+        let queryOptions = { include_count: true };
+        client
+          .stack({ api_key: config.source_stack, management_token: config.management_token })
+          .asset()
+          .query(queryOptions)
+          .find()
+          .then((asset) => {
+            return resolve(asset.count);
+          })
+          .catch((error) => {
+            addlogs(config, error, 'error');
+            return reject();
+          });
       }
-    })
+    });
   },
   getAssetJSON: function (skip) {
-    let  self = this
     return new Promise(function (resolve, reject) {
       if (typeof skip !== 'number') {
-        skip = 0
+        skip = 0;
       }
       const queryRequestObj = {
         skip: skip,
@@ -194,25 +241,35 @@ ExportAssets.prototype = {
         except: {
           BASE: invalidKeys,
         },
-      }
+      };
 
-      client.stack({api_key: config.source_stack, management_token: config.management_token}).asset().query(queryRequestObj).find()
-      .then(assetResponse => {
-        return resolve(assetResponse.items)
-      }).catch(error => {
-        addlogs(config, error, 'error')
-        return reject()
-      })
-    })
+      client
+        .stack({ api_key: config.source_stack, management_token: config.management_token })
+        .asset()
+        .query(queryRequestObj)
+        .find()
+        .then((assetResponse) => {
+          return resolve(assetResponse.items);
+        })
+        .catch((error) => {
+          addlogs(config, error, 'error');
+          return reject();
+        });
+    });
   },
   getVersionedAssetJSON: function (uid, version, bucket) {
-    let self = this
-    let assetVersionInfo = bucket || []
+    let self = this;
+    let assetVersionInfo = bucket || [];
     return new Promise(function (resolve, reject) {
+      if (self.assetDownloadRetry[uid + version] > self.assetDownloadRetryLimit) {
+        console.log('Reached max', self.assetDownloadRetry[uid + version]);
+        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)
-        return resolve()
+        const assetVersionInfoFile = path.resolve(assetsFolderPath, uid, '_contentstack_' + uid + '.json');
+        helper.writeFile(assetVersionInfoFile, assetVersionInfo);
+        return resolve();
       }
       let queryrequestOption = {
         version: version,
@@ -220,97 +277,142 @@ ExportAssets.prototype = {
         except: {
           BASE: invalidKeys,
         },
-      }
+      };
 
-      client.stack({ api_key: config.source_stack, management_token: config.management_token}).asset(uid).fetch(queryrequestOption)
-      .then(versionedAssetJSONResponse => {
-        self.downloadAsset(versionedAssetJSONResponse).then(function () {
-          assetVersionInfo.splice(0, 0, versionedAssetJSONResponse)
-          // Remove duplicates
-          assetVersionInfo = _.uniqWith(assetVersionInfo, _.isEqual)
-          self.getVersionedAssetJSON(uid, --version, assetVersionInfo)
-          .then(resolve)
-          .catch(reject)
-        }).catch(reject)
-      })
-    })
+      client
+        .stack({ api_key: config.source_stack, management_token: config.management_token })
+        .asset(uid)
+        .fetch(queryrequestOption)
+        .then((versionedAssetJSONResponse) => {
+          self
+            .downloadAsset(versionedAssetJSONResponse)
+            .then(function () {
+              assetVersionInfo.splice(0, 0, versionedAssetJSONResponse);
+              // Remove duplicates
+              assetVersionInfo = _.uniqWith(assetVersionInfo, _.isEqual);
+              self
+                .getVersionedAssetJSON(uid, --version, assetVersionInfo)
+                .then(resolve)
+                .catch(reject);
+            })
+            .catch(reject);
+        })
+        .catch((error) => {
+          console.log('Error on  fetch', error && error.message);
+          if (error.status === 408) {
+            console.log('retrying', uid);
+            // 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);
+        });
+    });
   },
   downloadAsset: function (asset) {
-    let  self = this
-    return new Promise(function (resolve, reject) {
-      const assetFolderPath = path.resolve(assetsFolderPath, asset.uid)
-      const assetFilePath = path.resolve(assetFolderPath, asset.filename)
+    let self = this;
+    return new Promise(async function (resolve, reject) {
+      const assetFolderPath = path.resolve(assetsFolderPath, asset.uid);
+      const assetFilePath = path.resolve(assetFolderPath, asset.filename);
       if (fs.existsSync(assetFilePath)) {
-        addlogs(config, 'Skipping download of { title: ' + asset.filename + ', uid: ' +
-          asset.uid + ' }, as they already exist', 'success')
-        return resolve()
+        addlogs(
+          config,
+          'Skipping download of { title: ' + asset.filename + ', uid: ' + asset.uid + ' }, as they already exist',
+          'success',
+        );
+        return resolve();
       }
       self.assetStream = {
-        url: config.securedAssets
-          ? `${asset.url}?authtoken=${config.authtoken || config.auth_token}`
-          : asset.url,
+        url: config.securedAssets ? `${asset.url}?authtoken=${config.authtoken || config.auth_token}` : asset.url,
       };
 
-      const assetStreamRequest = nativeRequest(self.assetStream)
-      assetStreamRequest.on('response', function () {
-        helper.makeDirectory(assetFolderPath)
-        const assetFileStream = fs.createWriteStream(assetFilePath)
-        assetStreamRequest.pipe(assetFileStream)
-        assetFileStream.on('close', function () {
-          addlogs(config, 'Downloaded ' + asset.filename + ': ' + asset.uid + ' successfully!', 'success')
-          return resolve()
+      helper.makeDirectory(assetFolderPath);
+      const assetFileStream = fs.createWriteStream(assetFilePath);
+      self.assetStream.url = encodeURI(self.assetStream.url);
+      httpClient
+        .options({ responseType: 'stream' })
+        .get(self.assetStream.url)
+        .then(({ data: assetStreamRequest }) => {
+          if (assetConfig.enableDownloadStatus) {
+            const str = progress({
+              time: 5000,
+              length: assetStreamRequest.headers['content-length'],
+            });
+            str.on('progress', function (progressData) {
+              console.log(`${asset.filename}: ${Math.round(progressData.percentage)}%`);
+            });
+            assetStreamRequest.pipe(str).pipe(assetFileStream);
+          }
+          assetStreamRequest.pipe(assetFileStream);
+        })
+        .catch(reject);
+      assetFileStream
+        .on('close', function () {
+          addlogs(config, 'Downloaded ' + asset.filename + ': ' + asset.uid + ' successfully!', 'success');
+          return resolve();
         })
-      }).on('error', reject)
-    })
+        .on('error', reject);
+    });
   },
   getFolders: function () {
-    let  self = this
+    let self = this;
     return new Promise(function (resolve, reject) {
-      return self.getAssetCount(true).then(function (count) {
-        if (count === 0) {
-          addlogs(config, 'No folders were found in the stack', 'success')
-          return resolve()
-        }
-        return self.getFolderDetails(0, count).then(function () {
-          addlogs(config, chalk.green('Exported asset-folders successfully!'), 'success')
-          return resolve()
-        }).catch(function (error) {
-          return reject(error)
+      return self
+        .getAssetCount(true)
+        .then(function (count) {
+          if (count === 0) {
+            addlogs(config, 'No folders were found in the stack', 'success');
+            return resolve();
+          }
+          return self
+            .getFolderDetails(0, count)
+            .then(function () {
+              addlogs(config, chalk.green('Exported asset-folders successfully!'), 'success');
+              return resolve();
+            })
+            .catch(function (error) {
+              return reject(error);
+            });
         })
-      }).catch(function (error) {
-        return reject(error)
-      })
-    })
+        .catch(function (error) {
+          return reject(error);
+        });
+    });
   },
   getFolderDetails: function (skip, tCount) {
-    let  self = this
+    let self = this;
     return new Promise(function (resolve, reject) {
       if (typeof skip !== 'number') {
-        skip = 0
+        skip = 0;
       }
       if (skip > tCount) {
-        helper.writeFile(folderJSONPath, self.folderContents)
-        return resolve()
+        helper.writeFile(folderJSONPath, self.folderContents);
+        return resolve();
       }
       let queryRequestObj = {
         include_folders: true,
-        query: {'is_dir': true},
+        query: { is_dir: true },
         skip: skip,
-      }
-      client.stack({api_key: config.source_stack, management_token: config.management_token}).asset().query(queryRequestObj).find()
-      .then(folderDetailsResponse => {
-        for(let i in folderDetailsResponse.items) {
-          self.folderContents.push(folderDetailsResponse.items[i])
-        }
-        skip += 100
-        return self.getFolderDetails(skip, tCount)
-        .then(resolve)
-        .catch(reject)
-      }).catch(error => {
-        addlogs(config, error, 'error')
-      })
-    })
+      };
+      client
+        .stack({ api_key: config.source_stack, management_token: config.management_token })
+        .asset()
+        .query(queryRequestObj)
+        .find()
+        .then((folderDetailsResponse) => {
+          for (let i in folderDetailsResponse.items) {
+            self.folderContents.push(folderDetailsResponse.items[i]);
+          }
+          skip += 100;
+          return self.getFolderDetails(skip, tCount).then(resolve).catch(reject);
+        })
+        .catch((error) => {
+          addlogs(config, error, 'error');
+        });
+    });
   },
-}
+};
 
-module.exports = new ExportAssets()
+module.exports = new ExportAssets();