@contentstack/cli-migration 0.1.1-beta.3 → 1.0.1

package/src/commands/cm/stacks/migration.js

@@ -0,0 +1,305 @@
+/* eslint-disable no-unused-expressions */
+/* eslint-disable no-warning-comments */
+/* eslint-disable camelcase */
+'use strict';
+
+// Dependencies
+const Listr = require('listr');
+const { resolve, extname } = require('path');
+const { Command, flags } = require('@contentstack/cli-command');
+const { waterfall } = require('async');
+const { Parser } = require('../../../modules');
+const { ActionList } = require('../../../actions');
+const fs = require('fs');
+const chalk = require('chalk');
+const { configHandler } = require('@contentstack/cli-utilities');
+const { printFlagDeprecation } = require('@contentstack/cli-utilities');
+
+const { ApiError, SchemaValidator, MigrationError, FieldValidator } = require('../../../validators');
+
+// Utils
+const { map: _map, constants, safePromise, errorHelper } = require('../../../utils');
+const { success } = require('../../../utils/logger');
+
+// Properties
+const { get, set, getMapInstance, resetMapInstance } = _map;
+const {
+  requests: _requests,
+  actionMapper,
+  MANAGEMENT_SDK,
+  MANAGEMENT_TOKEN,
+  AUTH_TOKEN,
+  API_KEY,
+  BRANCH,
+  MANAGEMENT_CLIENT,
+} = constants;
+
+class MigrationCommand extends Command {
+  static examples = [
+    '$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>',
+    '$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>',
+    '$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>',
+    '$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>',
+    '$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path> ',
+    '$ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>',
+  ];
+
+  async run() {
+    // TODO: filePath validation required.
+    const migrationCommandFlags = this.parse(MigrationCommand).flags;
+    const { branch } = migrationCommandFlags;
+    const filePath = migrationCommandFlags['file-path'] || migrationCommandFlags.filePath;
+    const multi = migrationCommandFlags.multiple || migrationCommandFlags.multi;
+    const authtoken = configHandler.get('authtoken');
+    const apiKey = migrationCommandFlags['api-key'] || migrationCommandFlags['stack-api-key'];
+    const alias = migrationCommandFlags['alias'] || migrationCommandFlags['management-token-alias'];
+    const config = migrationCommandFlags['config'];
+
+    if (!authtoken && !alias) {
+      this.log(
+        "AuthToken is not present in local drive, Hence use 'csdx auth:login' command for login or provide management token alias",
+      );
+      this.exit();
+    }
+
+    if (!filePath) {
+      this.log('Please provide the migration script file path, use --file-path flag');
+      this.exit();
+    }
+
+    // Reset map instance
+    const mapInstance = getMapInstance();
+    resetMapInstance(mapInstance);
+    if (migrationCommandFlags['config-file']) {
+      set('config-path', mapInstance, migrationCommandFlags['config-file']);
+    }
+
+    if (Array.isArray(config) && config.length > 0) {
+      let configObj = config.reduce((a, v) => {
+        let objArr = v.split(':');
+        return { ...a, [objArr[0]]: objArr[1] };
+      }, {});
+      set('config', mapInstance, configObj);
+    }
+
+    let stackSDKInstance;
+    if (branch) {
+      set(BRANCH, mapInstance, branch);
+    }
+
+    if (alias) {
+      let managementToken = this.getToken(alias);
+      if (managementToken) {
+        set(MANAGEMENT_TOKEN, mapInstance, managementToken);
+        set(API_KEY, mapInstance, managementToken.apiKey);
+        if (branch) {
+          stackSDKInstance = this.managementAPIClient.stack({
+            management_token: managementToken.token,
+            api_key: managementToken.apiKey,
+            branch_uid: branch,
+          });
+        } else {
+          stackSDKInstance = this.managementAPIClient.stack({
+            management_token: managementToken.token,
+            api_key: managementToken.apiKey,
+          });
+        }
+      }
+    } else if (authtoken) {
+      set(AUTH_TOKEN, mapInstance, authtoken);
+      set(API_KEY, mapInstance, apiKey);
+      this.managementAPIClient = { authtoken: this.authToken };
+      if (branch) {
+        stackSDKInstance = this.managementAPIClient.stack({
+          api_key: apiKey,
+          branch_uid: branch,
+        });
+      } else {
+        stackSDKInstance = this.managementAPIClient.stack({ api_key: apiKey });
+      }
+    }
+
+    set(MANAGEMENT_SDK, mapInstance, stackSDKInstance);
+    set(MANAGEMENT_CLIENT, mapInstance, this.managementAPIClient);
+
+    if (multi) {
+      await this.execMultiFiles(filePath, mapInstance);
+    } else {
+      await this.execSingleFile(filePath, mapInstance);
+    }
+  }
+
+  async execSingleFile(filePath, mapInstance) {
+    // Resolved absolute path
+    const resolvedMigrationPath = resolve(filePath);
+    // User provided migration function
+    const migrationFunc = require(resolvedMigrationPath);
+
+    const parser = new Parser();
+
+    try {
+      const migrationParser = await parser.getMigrationParser(migrationFunc);
+      if (migrationParser.hasErrors) {
+        errorHelper(migrationParser.hasErrors);
+        // When the process is child, send error message to parent
+        if (process.send) process.send({ errorOccurred: true });
+        this.exit(1);
+      }
+
+      // Make calls from here
+      const requests = get(_requests, mapInstance);
+      // Fetches tasks array
+      const tasks = this.getTasks(requests);
+
+      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 });
+      });
+      requests.splice(0, requests.length);
+    } catch (error) {
+      // errorHandler(null, null, null, error)
+      this.log(error);
+    }
+  }
+
+  async execMultiFiles(filePath, mapInstance) {
+    // Resolved absolute path
+    const resolvedMigrationPath = resolve(filePath);
+    try {
+      const files = fs.readdirSync(resolvedMigrationPath);
+      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(resolve(filePath, file), mapInstance);
+        }
+      }
+    } catch (error) {
+      errorHelper(error);
+    }
+  }
+
+  getTasks(requests) {
+    const _tasks = [];
+    const results = [];
+
+    const taskFn = (reqObj) => {
+      const { failedTitle, successTitle, tasks } = reqObj;
+
+      return async (ctx, task) => {
+        const [err, result] = await safePromise(waterfall(tasks));
+        if (err) {
+          ctx.error = true;
+          task.title = failedTitle;
+          throw err;
+        }
+        result && results.push(result);
+        task.title = successTitle;
+        return result;
+      }
+    }
+
+    for (const element of requests) {
+      let reqObj = element;
+      const { title } = reqObj;
+      const taskObj = {
+        title: title,
+        task: taskFn(reqObj)
+      };
+      _tasks.push(taskObj);
+    }
+    return _tasks;
+  }
+
+  handleErrors() {
+    const mapInstance = getMapInstance();
+    const actions = get(actionMapper, mapInstance);
+    const actionList = new ActionList(actions);
+
+    actionList.addValidators(new ApiError());
+    actionList.addValidators(new SchemaValidator());
+    actionList.addValidators(new MigrationError());
+    actionList.addValidators(new FieldValidator());
+
+    const errors = actionList.validate();
+    errorHelper(errors);
+  }
+}
+
+MigrationCommand.description = 'Contentstack migration script.';
+
+MigrationCommand.flags = {
+  'api-key': flags.string({
+    char: 'k',
+    description: 'With this flag add the API key of your stack.',
+    dependsOn: ['authtoken'],
+    exclusive: ['alias'],
+    parse: printFlagDeprecation(['--api-key'], ['-k', '--stack-api-key']),
+    hidden: true,
+  }),
+  'stack-api-key': flags.string({
+    char: 'k',
+    description: 'With this flag add the API key of your stack.',
+    dependsOn: ['authtoken'],
+    exclusive: ['alias'],
+  }),
+  authtoken: flags.boolean({
+    char: 'A',
+    description:
+      'Use this flag to use the auth token of the current session. After logging in CLI, an auth token is generated for each new session.',
+    dependsOn: ['api-key'],
+    exclusive: ['alias'],
+    parse: printFlagDeprecation(['-A', '--authtoken']),
+    hidden: true,
+  }),
+  alias: flags.string({
+    char: 'a',
+    description: 'Use this flag to add the management token alias.',
+    exclusive: ['authtoken'],
+  }),
+  'management-token-alias': flags.string({
+    description: 'alias of the management token',
+    exclusive: ['authtoken'],
+    hidden: true,
+    parse: printFlagDeprecation(['--management-token-alias'], ['-a', '--alias']),
+  }),
+  filePath: flags.string({
+    char: 'n',
+    description: 'Use this flag to provide the path of the file of the migration script provided by the user.',
+    parse: printFlagDeprecation(['-n', '--filePath'], ['--file-path']),
+    hidden: true,
+  }),
+  'file-path': flags.string({
+    description: 'Use this flag to provide the path of the file of the migration script provided by the user.',
+  }),
+  branch: flags.string({
+    char: 'B',
+    description: 'Use this flag to add the branch name where you want to perform the migration.',
+    parse: printFlagDeprecation(['-B'], ['--branch']),
+  }),
+  'config-file': flags.string({
+    description: '[optional] Path of the JSON configuration file',
+  }),
+  config: flags.string({
+    description: '[optional] inline configuration, <key1>:<value1>',
+    multiple: true,
+  }),
+  multi: flags.boolean({
+    description: 'This flag helps you to migrate multiple content files in a single instance.',
+    parse: printFlagDeprecation(['--multi'], ['--multiple']),
+    hidden: true,
+  }),
+  multiple: flags.boolean({
+    description: 'This flag helps you to migrate multiple content files in a single instance.',
+  }),
+};
+
+MigrationCommand.aliases = ['cm:migration'];
+
+MigrationCommand.usage = 'cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]';
+
+module.exports = MigrationCommand;

package/src/config/api-config.js

@@ -1,17 +1,16 @@
 /* eslint-disable camelcase */
-"use strict";
+'use strict';
 
 const { CONTENTSTACK_API_KEY, CONTENTSTACK_AUTHTOKEN } = process.env;
-const { version } = require("../../package.json");
+const { version } = require('../../package.json');
 module.exports = {
-  hostname: "dev9-app.contentstack.com",
-  // hostname: 'stag-app.contentstack.com',
-  version: "/v3",
-  method: "GET", // Default Http method
+  hostname: 'api.contentstack.io',
+  version: '/v3',
+  method: 'GET', // Default Http method
   headers: {
-    "Content-Type": "application/json",
-    "Content-Length": null,
-    "X-User-Agent": `@contentstack-migration/v${version}`,
+    'Content-Type': 'application/json',
+    'Content-Length': null,
+    'X-User-Agent': `@contentstack-migration/v${version}`,
     authtoken: CONTENTSTACK_AUTHTOKEN,
     api_key: CONTENTSTACK_API_KEY,
     // management_token: CONTENTSTACK_MANAGEMENT_TOKEN

package/src/config/default-options.js

@@ -1,7 +1,7 @@
 /* eslint-disable camelcase */
-'use strict'
+'use strict';
 
 module.exports = {
   is_page: true,
   singleton: false,
-}
+};

package/src/config/index.js

@@ -1,7 +1,7 @@
-'use strict'
+'use strict';
 
 module.exports = {
   apiConfig: require('./api-config'),
   defaultOptions: require('./default-options'),
   masterLocale: require('./master-locale'),
-}
+};

package/src/config/master-locale.js

@@ -1,5 +1,5 @@
 /* eslint-disable camelcase */
-'use strict'
+'use strict';
 
 module.exports = {
   master_locale: {
@@ -7,4 +7,4 @@ module.exports = {
     name: 'English - United States',
     code: 'en-us',
   },
-}
+};

package/src/modules/base.js

@@ -1,12 +1,12 @@
-'use strict'
+'use strict';
 
 // Utils
-const {map: _map, constants} = require('../utils')
+const { map: _map, constants } = require('../utils');
 // Actions
-const {actionCreators} = require('../actions')
+const { actionCreators } = require('../actions');
 // Utils properties
-const {getMapInstance, get} = _map
-const {actionMapper} = constants
+const { getMapInstance, get } = _map;
+const { actionMapper } = constants;
 
 /**
  * Base class for module classes
@@ -15,9 +15,9 @@ const {actionMapper} = constants
  */
 class Base {
   constructor(id, action) {
-    this.id = id
-    this.action = action
-    this.actions = []
+    this.id = id;
+    this.action = action;
+    this.actions = [];
   }
 
   /**
@@ -26,14 +26,14 @@ class Base {
    * @returns {Base} current instance of inherited class
    */
   title(value) {
-    const mapInstance = getMapInstance()
-    const {id, action} = this
+    const mapInstance = getMapInstance();
+    const { id, action } = this;
 
-    const contentType = get(id, mapInstance)
+    const contentType = get(id, mapInstance);
 
-    contentType[action].content_type.title = value
+    contentType[action].content_type.title = value;
 
-    return this
+    return this;
   }
 
   /**
@@ -42,11 +42,11 @@ class Base {
    * @returns {Base} current instance of inherited class
    */
   description(value) {
-    const mapInstance = getMapInstance()
-    const {id, action} = this
-    const contentType = get(id, mapInstance)
-    contentType[action].content_type.description = value
-    return this
+    const mapInstance = getMapInstance();
+    const { id, action } = this;
+    const contentType = get(id, mapInstance);
+    contentType[action].content_type.description = value;
+    return this;
   }
 
   /**
@@ -55,14 +55,14 @@ class Base {
    * @returns {Base} current instance of inherited class
    */
   force(value) {
-    const mapInstance = getMapInstance()
-    const {id, action} = this
+    const mapInstance = getMapInstance();
+    const { id, action } = this;
 
-    const contentType = get(id, mapInstance)
+    const contentType = get(id, mapInstance);
 
-    contentType[action].content_type.force = value
+    contentType[action].content_type.force = value;
 
-    return this
+    return this;
   }
 
   /**
@@ -75,21 +75,21 @@ class Base {
    */
   dispatch(callsite, id, opts, method) {
     if (!id && !opts) {
-      let mapInstance = getMapInstance()
-      let actions = get(actionMapper, mapInstance) // Returns an array if empty
-      let action = actionCreators.customTasks(callsite, opts)
-      actions.push(action)
+      let mapInstance = getMapInstance();
+      let actions = get(actionMapper, mapInstance); // Returns an array if empty
+      let action = actionCreators.customTasks(callsite, opts);
+      actions.push(action);
     } else {
-      let mapInstance = getMapInstance()
-      let actions = get(actionMapper, mapInstance) // Returns an array if empty
-      let action = actionCreators.contentType[method](callsite, id, {...opts, id})
-      actions.push(action)
+      let mapInstance = getMapInstance();
+      let actions = get(actionMapper, mapInstance); // Returns an array if empty
+      let action = actionCreators.contentType[method](callsite, id, { ...opts, id });
+      actions.push(action);
     }
   }
 
   getActions() {
-    return this.actions
+    return this.actions;
   }
 }
 
-module.exports = Base
+module.exports = Base;