@contentstack/cli-cm-bulk-publish 0.1.1-beta.3 → 1.0.0

package/src/util/index.js

@@ -2,11 +2,11 @@ const chalk = require('chalk')
 const fs = require('fs')
 
 function prettyPrint(data) {
-	console.log(chalk.yellow('Configuration to be used for executing this command:'))
-	Object.keys(data).forEach((key, index) => {
-		console.log(chalk.grey(`${key}: ${data[key]}`))
-	})
-	console.log('\n')
+  console.log(chalk.yellow('Configuration to be used for executing this command:'))
+  Object.keys(data).forEach((key, _index) => {
+    console.log(chalk.grey(`${key}: ${data[key]}`))
+  })
+  console.log('\n')
 }
 
 function formatError(error) {
@@ -14,13 +14,11 @@ function formatError(error) {
     if (typeof error === 'string') {
       error = JSON.parse(error)
     } else {
-    	error = JSON.parse(error.message)
+      error = JSON.parse(error.message)
     }
-  } catch(e) {
-    error = error.message
-  }
-  let message = (error.errorMessage) ? error.errorMessage : (error.error_message) ? error.error_message : error
-  if (error.errors && Object.keys(error.errors).length > 0){
+  } catch (e) {}
+  let message = error.errorMessage || error.error_message || error
+  if (error.errors && Object.keys(error.errors).length > 0) {
     Object.keys(error.errors).forEach((e) => {
       let entity = e
       if (e === 'authorization')
@@ -41,7 +39,8 @@ function formatHostname(hostname) {
   return hostname.split('//').pop()
 }
 
-function setDelayForBulkPublish(queue) {
+function setDelayForBulkPublish(_queue) {
+  // empty block
   // queue.requestBatchSize = 1
   // queue.delay = 1
 }
@@ -50,13 +49,13 @@ function getNumberOfBulkPublishRequests(count) {
   // for example, if the total count of elements is 738
   // then the number of requets that'll be required are (if there are 10 elements per request)
   // (738 - 8)/10 + 1 = 74 requests
-  return (count - (count % 10))/10 + 1
+  return (count - (count % 10)) / 10 + 1
 }
 
 function isEmpty(file) {
   return new Promise((resolve) => {
-    fs.readFile(file, (err, data) => {
-      if (data.length === 0){
+    fs.readFile(file, (_err, data) => {
+      if (data.length === 0) {
         return resolve(true)
       }
       return resolve(false)
@@ -64,4 +63,4 @@ function isEmpty(file) {
   })
 }
 
-module.exports = { prettyPrint, formatError, formatHostname, setDelayForBulkPublish, getNumberOfBulkPublishRequests, isEmpty}
+module.exports = { prettyPrint, formatError, formatHostname, setDelayForBulkPublish, getNumberOfBulkPublishRequests, isEmpty }

package/src/util/logger.js

@@ -1,45 +1,41 @@
 const path = require('path');
 const winston = require('winston');
-const homedir = require('os').homedir()
-const logsDir = path.join(homedir, 'contentstack-cli-logs', 'bulk-publish')
+const cwd = process.cwd();
+const logsDir = path.join(cwd, 'contentstack-cli-logs', 'bulk-publish');
 
 let filename;
 
 module.exports.getLoggerInstance = (fileName) => {
   filename = path.join(logsDir, fileName);
-  const logger = winston.createLogger({
+  return winston.createLogger({
     transports: [
       new winston.transports.File({ filename: `${filename}.error`, level: 'error' }),
       new winston.transports.File({ filename: `${filename}.success`, level: 'info' }),
     ],
   });
-  return logger;
 };
 
 /* eslint-disable no-multi-assign */
-const getFileLoggerInstance = module.exports.getFileLoggerInstance = (fileName) => {
+const getFileLoggerInstance = (module.exports.getFileLoggerInstance = (fileName) => {
   filename = path.join(logsDir, fileName);
-  const logger = winston.createLogger({
-    transports: [
-      new winston.transports.File({ filename }),
-    ],
+  return winston.createLogger({
+    transports: [new winston.transports.File({ filename })],
   });
-  return logger;
-};
-
+});
 
-module.exports.getAllLogs = (fname) => new Promise((resolve, reject) => {
-  const options = {
-    limit: 1000000000000,
-    start: 0,
-    order: 'desc',
-  };
-  const logger = getFileLoggerInstance(fname);
-  logger.query(options, async (err, result) => {
-    if (err) return reject(err);
-    return resolve(result);
+module.exports.getAllLogs = (fname) =>
+  new Promise((resolve, reject) => {
+    const options = {
+      limit: 1000000000000,
+      start: 0,
+      order: 'desc',
+    };
+    const logger = getFileLoggerInstance(fname);
+    logger.query(options, async (err, result) => {
+      if (err) return reject(err);
+      return resolve(result);
+    });
   });
-});
 
 module.exports.addLogs = (logger, data, Type) => {
   switch (Type) {
@@ -55,5 +51,5 @@ module.exports.addLogs = (logger, data, Type) => {
 };
 
 module.exports.getLogsDirPath = () => {
-  return logsDir
-}
+  return logsDir;
+};

package/src/util/queue.js

@@ -7,8 +7,8 @@ class Queue extends EventEmitter {
     this.count = 0;
     this.store = [];
     this.config = {};
-    this.delay = 1
-    this.requestBatchSize = 1
+    this.delay = 1;
+    this.requestBatchSize = 1;
     this.on('dequeue', this.check);
   }
 
@@ -20,16 +20,16 @@ class Queue extends EventEmitter {
 
   Enqueue(obj) {
     if (!obj.retry) {
-      obj = {obj, retry: 0}
+      obj = { obj, retry: 0 };
     }
     if (this.count === this.requestBatchSize) {
       return this.sleep(this.delay).then(() => {
-        this.count = 1 // reset the count to 1. Because the current object will be processed too, and that counts as one request
+        this.count = 1; // reset the count to 1. Because the current object will be processed too, and that counts as one request
         this.store.push(obj);
         this.check();
-      })
+      });
     } else {
-      this.count++
+      this.count++;
       this.store.push(obj);
       this.check();
     }
@@ -44,14 +44,14 @@ class Queue extends EventEmitter {
   }
 
   sleep(seconds) {
-    return new Promise(resolve => {
-      setTimeout(resolve, seconds * 1000)
-    })
+    return new Promise((resolve) => {
+      setTimeout(resolve, seconds * 1000);
+    });
   }
 }
 
 module.exports = {
-  getQueue: function() {
-    return new Queue()
-  }
-}
+  getQueue: function () {
+    return new Queue();
+  },
+};

package/src/util/retryfailed.js

@@ -1,12 +1,12 @@
 const { getAllLogs } = require('./logger');
-const {getStack} = require('./client.js')
+const { getStack } = require('./client.js');
 
 module.exports = async (filename, queue, Type) => {
   const logs = await getAllLogs(filename);
   if (logs.file.length > 0) {
     logs.file.forEach((log) => {
       if (Type === 'bulk') {
-        log.message.options.stack = getStack({alias: log.message.alias, host: log.message.host})
+        log.message.options.stack = getStack({ alias: log.message.alias, host: log.message.host });
         queue.Enqueue(log.message.options);
       }
       if (Type === 'publish') {
@@ -18,11 +18,15 @@ module.exports = async (filename, queue, Type) => {
             entryUid: log.message.options.entryUid,
             locale: log.message.options.locale,
             Type: 'entry',
-            stack: getStack({alias: log.message.alias, host: log.message.host})
+            stack: getStack({ alias: log.message.alias, host: log.message.host }),
           });
         } else {
           queue.assetQueue.Enqueue({
-            assetUid: log.message.options.assetUid, publish_details: log.message.options.publish_assets, environments: log.message.options.environments, Type: 'asset', stack: getStack({alias: log.message.alias, host: log.message.host})
+            assetUid: log.message.options.assetUid,
+            publish_details: log.message.options.publish_assets,
+            environments: log.message.options.environments,
+            Type: 'asset',
+            stack: getStack({ alias: log.message.alias, host: log.message.host }),
           });
         }
       }

package/src/util/store.js

@@ -1,72 +1,64 @@
-const fs = require('fs')
-const path = require('path')
-const config = require('../config/index.js')
-const chalk = require('chalk')
+const fs = require('fs');
+const path = require('path');
+const config = require('../config/index.js');
+const chalk = require('chalk');
 
 function save(key, data) {
-  let bulkPublish = (config) ? config : {}
-  let filePath = path.join(process.cwd(), config.json)
-  bulkPublish[key] = data
+  let bulkPublish = config ? config : {};
+  let filePath = path.join(process.cwd(), config.json);
+  bulkPublish[key] = data;
   fs.writeFile(filePath, JSON.stringify(bulkPublish), (error) => {
-    if(error) {
-      console.log(chalk.red(error))
+    if (error) {
+      console.log(chalk.red(error));
       return;
     }
-    console.log(chalk.green(`Configuration file has been successfully created at ${filePath}`))
-  })
+    console.log(chalk.green(`Configuration file has been successfully created at ${filePath}`));
+  });
 }
 
 function get(key, filePath) {
   try {
-    const missing = []
-    const bulkPublish = require(filePath)
-    // const bulkPublish = JSON.parse(fs.readFileSync(filePath, 'utf-8'))
+    const missing = [];
+    const bulkPublish = require(filePath);
     if (!bulkPublish) {
-      throw new Error('Unable to read config file')
+      throw new Error('Unable to read config file');
     }
-    if (!bulkPublish.alias){
-      missing.push('alias')
+    if (!bulkPublish.alias) {
+      missing.push('alias');
     }
-    if (missing.length > 0){ 
-      throw new Error(`Please update the following values in the config file: ${missing.join(', ')}`)
+    if (missing.length > 0) {
+      throw new Error(`Please update the following values in the config file: ${missing.join(', ')}`);
     }
-    if (key === 'revert')
-      bulkPublish[key] = {}
-    if (key === 'Unpublish' || key === 'cross_env_publish')
-      bulkPublish[key] = handleFilterObj(bulkPublish[key])
+    if (key === 'revert') bulkPublish[key] = {};
+    if (key === 'Unpublish' || key === 'cross_env_publish') bulkPublish[key] = handleFilterObj(bulkPublish[key]);
     if (!bulkPublish[key] || Object.keys(bulkPublish[key]).length === 0) {
       if (key !== 'revert') {
-        throw new Error(`Config is empty for ${key} case`)
+        throw new Error(`Config is empty for ${key} case`);
       }
     }
     return {
       alias: bulkPublish.alias,
-      ...bulkPublish[key]
-    }
-  } catch(error) {
-    if(error.code === 'ENOENT' || error.code === 'MODULE_NOT_FOUND')
-      throw new Error('The given config file was not found')
-    throw error
+      ...bulkPublish[key],
+    };
+  } catch (error) {
+    if (error.code === 'ENOENT' || error.code === 'MODULE_NOT_FOUND')
+      throw new Error('The given config file was not found');
+    throw error;
   }
 }
 
 function updateMissing(key, flags) {
-  let savedConfig
-  try {
-    savedConfig = get(key, path.resolve(flags.config))
-  } catch(error) {
-    throw error
-  }
-  Object.keys(savedConfig).forEach(element => {
+  let savedConfig;
+  savedConfig = get(key, path.resolve(flags.config));
+  Object.keys(savedConfig).forEach((element) => {
     if (flags[element] === undefined) {
-      console.log(`Using ${element} from config file`)
-      flags[element] = savedConfig[element]
+      console.log(`Using ${element} from config file`);
+      flags[element] = savedConfig[element];
     }
-  })
-  if (flags.publishAllContentTypes)
-    delete savedConfig.contentTypes
-  console.log('\n')
-  return flags
+  });
+  if (flags.publishAllContentTypes) delete savedConfig.contentTypes;
+  console.log('\n');
+  return flags;
 }
 
 // a fix for handling filter object in Unpublish and cross publish cases
@@ -74,17 +66,17 @@ function updateMissing(key, flags) {
 // because both unpublish and cross-publish commands build the filter object
 // internally, and in the original bulk-publish script the filter object was
 // mentioned in the config file itself
-function handleFilterObj(config) {
-  config.environment = config.filter.environment
-  config.contentType = config.filter.content_type_uid
-  config.locale = config.filter.locale
-  config.f_types = config.filter.type // adding f_types to differentiate the types specified in the config.js, and the types defined internally in Unpublish and Cross Publish
-  delete config.filter
-  return config
+function handleFilterObj(config1) {
+  config1.environment = config1.filter.environment;
+  config1.contentType = config1.filter.content_type_uid;
+  config1.locale = config1.filter.locale;
+  config1.f_types = config1.filter.type; // adding f_types to differentiate the types specified in the config.js, and the types defined internally in Unpublish and Cross Publish
+  delete config1.filter;
+  return config1;
 }
 
 module.exports = {
   save: save,
   get: get,
   updateMissing: updateMissing,
-}
+};

package/src/commands/cm/bulk-publish/add-fields.js

@@ -1,117 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const {start} = require('../../../producer/add-fields')
-const store = require('../../../util/store.js')
-const {cli} = require('cli-ux')
-const configKey = 'addFields'
-const { prettyPrint, formatError } = require('../../../util')
-const { getStack } = require('../../../util/client.js')
-let config
-
-class AddFieldsCommand extends Command {
-  async run() {
-    const {flags} = this.parse(AddFieldsCommand)
-    let updatedFlags
-    try {
-      updatedFlags = (flags.config) ? store.updateMissing(configKey, flags) : flags
-    } catch(error) {
-      this.error(error.message, {exit: 2})
-    }
-    if (this.validate(updatedFlags)) {
-      let stack
-      if (!updatedFlags.retryFailed) {
-        if(!updatedFlags.alias) {
-          updatedFlags.alias = await cli.prompt('Please enter the management token alias to be used')
-        }
-        updatedFlags.bulkPublish = (updatedFlags.bulkPublish === 'false') ? false : true
-        await this.config.runHook('validateManagementTokenAlias', {alias: updatedFlags.alias})
-        config = { 
-          alias: updatedFlags.alias,
-          host: this.config.userConfig.getRegion().cma
-        }
-        stack = getStack(config)
-      }
-      if (await this.confirmFlags(updatedFlags)) {
-        try {
-          if (!updatedFlags.retryFailed) {
-            await start(updatedFlags, stack, config)
-          } else {
-            await start(updatedFlags)
-          }
-        } catch(error) {
-          let message = formatError(error)
-          this.error(message, {exit: 2})
-        }
-      } else {
-        this.exit(0)
-      }
-    }
-  }
-
-  validate({contentTypes, locales, environments, retryFailed}) {
-    let missing = []
-    if (retryFailed) {
-      return true
-    }
-
-    if (!contentTypes || contentTypes.length === 0) {
-      missing.push('Content Types')
-    }
-
-    if (!locales || locales.length === 0) {
-      missing.push('Locales')
-    }
-
-    if (!environments || environments.length === 0) {
-      missing.push('Environments')
-    }
-
-    if (missing.length > 0) {
-      this.error(`${missing.join(', ')} are required for processing this command. Please check --help for more details`, {exit: 2})
-    } else {
-      return true
-    }
-  }
-
-  async confirmFlags(flags) {
-    prettyPrint(flags)
-    if(flags.yes) {
-      return true
-    }
-    const confirmation = await cli.confirm('Do you want to continue with this configuration ? [yes or no]')
-    return confirmation
-  }
-}
-
-AddFieldsCommand.description = `Add fields from updated content types to their respective entries
-The add-fields command is used for updating already existing entries with the updated schema of their respective Content Type
-
-Content Types, Environments and Locales are required for executing the command successfully
-But, if retryFailed flag is set, then only a logfile is required
-`
-
-AddFieldsCommand.flags = {
-  alias: flags.string({char: 'a', description: 'Alias for the management token to be used'}),
-  retryFailed: flags.string({char: 'r', description: 'Retry publishing failed entries from the logfile (optional, overrides all other flags)'}),
-  bulkPublish: flags.string({char: 'b', description: 'This flag is set to true by default. It indicates that contentstack\'s bulkpublish API will be used for publishing the entries', default: 'true'}),
-  contentTypes: flags.string({char: 't', description: 'The Content-Types from which entries need to be published', multiple: true}),
-  locales: flags.string({char: 'l', description: 'Locales to which entries need to be published', multiple: true}),
-  environments: flags.string({char: 'e', description: 'Environments to which entries need to be published', multiple: true}),
-  config: flags.string({char: 'c', description: 'Path to config file to be used'}),
-  yes: flags.boolean({char: 'y', description: 'Agree to process the command with the current configuration' }),
-}
-
-AddFieldsCommand.examples = [
-  'General Usage',
-  'csdx cm:bulk-publish:add-fields -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]',
-  '',
-  'Using --config or -c flag',
-  'Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`',
-  'csdx cm:bulk-publish:add-fields --config [PATH TO CONFIG FILE]',
-  'csdx cm:bulk-publish:add-fields -c [PATH TO CONFIG FILE]',
-  '',
-  'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:add-fields --retryFailed [LOG FILE NAME]',
-  'csdx cm:bulk-publish:add-fields -r [LOG FILE NAME]'
-]
-
-module.exports = AddFieldsCommand

package/src/commands/cm/bulk-publish/assets.js

@@ -1,117 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const {start} = require('../../../producer/publish-assets')
-const store = require('../../../util/store.js')
-const {cli} = require('cli-ux')
-const configKey = 'publish_assets'
-const { prettyPrint, formatError } = require('../../../util')  
-const { getStack } = require('../../../util/client.js')
-let config
-
-class AssetsCommand extends Command {
-  async run() {
-    const {flags} = this.parse(AssetsCommand)
-    let updatedFlags
-    try {
-      updatedFlags = (flags.config) ? store.updateMissing(configKey, flags) : flags
-    } catch(error) {
-      this.error(error.message, {exit: 2})
-    }
-    if (this.validate(updatedFlags)) {
-      let stack
-      if (!updatedFlags.retryFailed) {
-        if(!updatedFlags.alias) {
-          updatedFlags.alias = await cli.prompt('Please enter the management token alias to be used')
-        }
-        updatedFlags.bulkPublish = (updatedFlags.bulkPublish === 'false') ? false : true
-        if (updatedFlags.folderUid === undefined) {
-          // set default value for folderUid
-          updatedFlags.folderUid = 'cs_root'
-        }
-        await this.config.runHook('validateManagementTokenAlias', {alias: updatedFlags.alias})
-        config = { 
-          alias: updatedFlags.alias,
-          host: this.config.userConfig.getRegion().cma
-        }
-        stack = getStack(config)
-      }
-      if (await this.confirmFlags(updatedFlags)) {
-        try {
-          if (!updatedFlags.retryFailed) {
-            await start(updatedFlags, stack, config)
-          } else {
-            await start(updatedFlags)
-          }
-        } catch(error) {
-          let message = formatError(error)
-          this.error(message, {exit: 2})
-        }
-      } else {
-        this.exit(0)
-      }
-    }
-  }
-
-  validate({environments, retryFailed, locales}) {
-    let missing = []
-    if (retryFailed) {
-      return true
-    }
-
-    if (!environments || environments.length === 0) {
-      missing.push('Environments')
-    }
-
-    if (!locales || locales.length === 0) {
-      missing.push('Locales')
-    }
-
-    if (missing.length > 0) {
-      this.error(`${missing.join(', ')} are required for processing this command. Please check --help for more details`, {exit: 2})
-    } else {
-      return true
-    }
-  }
-
-  async confirmFlags(flags) {
-    prettyPrint(flags)
-    if(flags.yes) {
-      return true
-    }
-    const confirmation = await cli.confirm('Do you want to continue with this configuration ? [yes or no]')
-    return confirmation
-  }
-}
-
-AssetsCommand.description = `Publish assets to specified environments
-The assets command is used for publishing assets from the specified stack, to the specified environments
-
-Environment(s) and Locale(s) are required for executing the command successfully
-But, if retryFailed flag is set, then only a logfile is required
-`
-
-AssetsCommand.flags = {
-  alias: flags.string({char: 'a', description: 'Alias for the management token to be used'}),
-  retryFailed: flags.string({char: 'r', description: 'Retry publishing failed assets from the logfile (optional, will override all other flags)'}),
-  environments: flags.string({char: 'e', description: 'Environments to which assets need to be published', multiple: true}),
-  folderUid: flags.string({char: 'u', description: '[default: cs_root] Folder-uid from which the assets need to be published'}),
-  bulkPublish: flags.string({char: 'b', description: 'This flag is set to true by default. It indicates that contentstack\'s bulkpublish API will be used for publishing the entries', default: 'true'}),
-  config: flags.string({char: 'c', description: 'Path to config file to be used'}),
-  yes: flags.boolean({char: 'y', description: 'Agree to process the command with the current configuration' }),
-  locales: flags.string({char: 'l', description: 'Locales to which assets need to be published', multiple: true }),
-}
-
-AssetsCommand.examples = [
-  'General Usage',
-  'csdx cm:bulk-publish:assets -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE] -a [MANAGEMENT TOKEN ALIAS]',
-  '',
-  'Using --config or -c flag',
-  'Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`',
-  'csdx cm:bulk-publish:assets --config [PATH TO CONFIG FILE]',
-  'csdx cm:bulk-publish:assets -c [PATH TO CONFIG FILE]',
-  '',
-  'Using --retryFailed or -r flag',
-  'csdx cm:bulk-publish:assets --retryFailed [LOG FILE NAME]',
-  'csdx cm:bulk-publish:assets -r [LOG FILE NAME]'
-]
-
-module.exports = AssetsCommand

package/src/commands/cm/bulk-publish/clear.js

@@ -1,63 +0,0 @@
-const fs = require('fs')
-const {cli} = require('cli-ux')
-const {Command, flags} = require('@oclif/command')
-const {getLogsDirPath} = require('../../../util/logger.js')
-
-class ClearCommand extends Command {
-  async run() {
-    const {flags} = this.parse(ClearCommand)
-  	let dirPath = getLogsDirPath()
-    if (flags.list) {
-    	this.listFiles(dirPath)
-    } else if (flags.yes) {
-    	this.rmDir(dirPath, false)
-    } else {
-	    const confirmation = await cli.prompt('Proceed to delete all log files (y/n)?')
-	    if (confirmation) {
-	    	this.rmDir(dirPath, false)
-	    }
-    }
-  }
-
-	rmDir(dirPath, removeSelf) {
-		if (fs.existsSync(dirPath)) {
-			if (removeSelf === undefined)
-		    removeSelf = true;
-		  try { var files = fs.readdirSync(dirPath); }
-		  catch(e) { return; }
-		  if (files.length > 0)
-		    for (var i = 0; i < files.length; i++) {
-		      var filePath = dirPath + '/' + files[i];
-		      if (fs.statSync(filePath).isFile())
-		        fs.unlinkSync(filePath);
-		      else
-		        rmDir(filePath);
-		    }
-		  if (removeSelf)
-		    fs.rmdirSync(dirPath);
-		  this.log('Log files have been cleared')
-		} else {
-			this.error(`The log directory doesn't exist.`)
-		}
-	};
-
-	listFiles(dirPath) {
-		if (fs.existsSync(dirPath)) {
-			fs.readdir(dirPath, (err, files) => {
-				this.log(files.length)
-			})	
-		} else {
-			this.error(`The log directory doesn't exist.`)
-		}
-	}
-}
-
-ClearCommand.description = `Clear the log folder
-`
-
-ClearCommand.flags = {
-  list: flags.boolean({char: 'l', description: 'List number of log files'}),
-  yes: flags.boolean({char: 'y', description: 'Delete all files without asking for confirmation'})
-}
-
-module.exports = ClearCommand