@contentstack/cli-migration 1.10.3 → 1.11.0

package/src/utils/constants.js

@@ -1,223 +0,0 @@
-'use strict';
-
-exports.mapObject = new Map();
-
-exports.version = 3; // TODO: Fetch it from CMA
-
-exports.defaultDataType = 'text';
-
-exports.MANAGEMENT_SDK = 'MANAGEMENT_SDK';
-exports.MANAGEMENT_CLIENT = 'MANAGEMENT_CLIENT';
-exports.MANAGEMENT_TOKEN = 'MANAGEMENT_TOKEN';
-exports.AUTH_TOKEN = 'AUTH_TOKEN';
-exports.API_KEY = 'API_KEY';
-exports.BRANCH = 'BRANCH';
-exports.SOURCE_BRANCH = 'SOURCE_BRANCH';
-
-exports.data_type = 'data_type';
-exports.mandatory = 'mandatory';
-exports._default = 'default';
-exports.unique = 'unique';
-exports.display_name = 'display_name';
-exports.reference_to = 'reference_to';
-exports.field_metadata = 'field_metadata';
-exports.taxonomies = 'taxonomies';
-exports.multiple = 'multiple';
-
-exports.actions = {
-  CUSTOM_TASK: 'CUSTOM_TASK',
-  CREATE_CT: 'CREATE_CT',
-  DELETE_CT: 'DELETE_CT',
-  EDIT_CT: 'EDIT_CT',
-  LOCALES: 'LOCALES',
-  EDIT_FIELD: 'EDIT_FIELD',
-  DELETE_FIELD: 'DELETE_FIELD',
-  MOVE_FIELD: 'MOVE_FIELD',
-};
-
-// Http call max retry
-exports.MAX_RETRY = 3;
-
-// This key holds the value for http objects in map
-exports.requests = 'REQUESTS';
-
-exports.limit = 1; // Limit for concurrent tasks executed parallely
-
-exports.nonWritableMethods = ['GET', 'DELETE'];
-
-exports.ContentType = 'Content type';
-exports.Entry = 'Entry';
-
-exports.errorMessageHandler = {
-  POST: 'saving',
-  GET: 'fetching',
-  PUT: 'updating',
-  DELETE: 'deleting',
-};
-
-exports.successMessageHandler = {
-  POST: 'saved',
-  GET: 'fetched',
-  PUT: 'updated',
-  DELETE: 'deleted',
-};
-// map key
-exports.actionMapper = 'actions';
-
-exports.batchLimit = 20;
-
-exports.contentTypeProperties = ['description', 'title', 'uid', 'options', 'force', 'schema'];
-
-exports.validationAction = {
-  create: 'create',
-  edit: 'edit',
-  customTask: 'customTask',
-  transformEntries: 'transformEntries',
-  deriveLinkedEntries: 'deriveLinkedEntries',
-  transformEntriesToType: 'transformEntriesToType',
-  typeError: 'typeError',
-  apiError: 'apiError',
-  schema: 'schema',
-  __migrationError: 'migrationError',
-  field: 'field',
-};
-
-exports.transformEntriesProperties = [
-  {
-    name: 'contentType',
-    type: 'string',
-    mandatory: true,
-  },
-  {
-    name: 'from',
-    type: 'array',
-    mandatory: true,
-  },
-  {
-    name: 'to',
-    type: 'array',
-    mandatory: true,
-  },
-  {
-    name: 'shouldPublish',
-    type: 'boolean',
-    mandatory: false,
-    dependsOn: 'environments',
-  },
-  {
-    name: 'environments',
-    type: 'array',
-    mandatory: false,
-  },
-  {
-    name: 'transformEntryForLocale',
-    type: 'function',
-    mandatory: true,
-  },
-];
-
-exports.deriveLinkedEntriesProperties = [
-  {
-    name: 'contentType',
-    type: 'string',
-    mandatory: true,
-  },
-  {
-    name: 'derivedContentType',
-    type: 'string',
-    mandatory: true,
-  },
-  {
-    name: 'from',
-    type: 'array',
-    mandatory: true,
-  },
-  {
-    name: 'toReferenceField',
-    type: 'string',
-    mandatory: true,
-  },
-  {
-    name: 'derivedFields',
-    type: 'array',
-    mandatory: true,
-  },
-  {
-    name: 'identityKey',
-    type: 'function',
-    mandatory: true,
-  },
-  {
-    name: 'shouldPublish',
-    type: 'boolean',
-    mandatory: false,
-    dependsOn: 'environments',
-  },
-  {
-    name: 'environments',
-    type: 'array',
-    mandatory: false,
-  },
-  {
-    name: 'deriveEntryForLocale',
-    type: 'function',
-    mandatory: true,
-  },
-];
-
-exports.transformEntriesToTypeProperties = [
-  {
-    name: 'sourceContentType',
-    type: 'string',
-    mandatory: true,
-  },
-  {
-    name: 'targetContentType',
-    type: 'string',
-    mandatory: true,
-  },
-  {
-    name: 'from',
-    type: 'array',
-    mandatory: true,
-  },
-  {
-    name: 'shouldPublish',
-    type: 'boolean',
-    mandatory: false,
-    dependsOn: 'environments',
-  },
-  {
-    name: 'environments',
-    type: 'array',
-    mandatory: false,
-  },
-  {
-    name: 'removeOldEntries',
-    type: 'boolean',
-    mandatory: false,
-  },
-  {
-    name: 'identityKey',
-    type: 'function',
-    mandatory: true,
-  },
-  {
-    name: 'transformEntryForLocale',
-    type: 'function',
-    mandatory: true,
-  },
-];
-
-exports.SDK_ACTIONS = {
-  CONTENTTYPE_GET: 'CONTENTTYPE_GET',
-  CONTENTTYPE_POST: 'CONTENTTYPE_POST',
-  CONTENTTYPE_DELETE: 'CONTENTTYPE_GET',
-  CONTENTTYPE_PUT: 'CONTENTTYPE_PUT',
-  LOCALES_GET: 'LOCALES_GET',
-  ENTRY_GET: 'ENTRY_GET',
-  ENTRY_POST: 'ENTRY_POST',
-  ENTRY_PUT: 'ENTRY_PUT',
-  ENTRY_DELETE: 'ENTRY_DELETE',
-  ENTRY_PUBLISH: 'ENTRY_PUBLISH',
-};

package/src/utils/contentstack-sdk.js

@@ -1,70 +0,0 @@
-'use strict';
-/** Dependencies */
-
-// Map helper
-const { getMapInstance, getDataWithAction, get } = require('./map');
-// Constants
-const { MANAGEMENT_SDK, SDK_ACTIONS } = require('./constants');
-// List of actions
-const {
-  CONTENTTYPE_DELETE,
-  CONTENTTYPE_GET,
-  CONTENTTYPE_POST,
-  CONTENTTYPE_PUT,
-  LOCALES_GET,
-  ENTRY_DELETE,
-  ENTRY_GET,
-  ENTRY_POST,
-  ENTRY_PUBLISH,
-  ENTRY_PUT,
-} = SDK_ACTIONS;
-
-module.exports = ({ action, id, sdkAction }) => {
-  return async (_data) => {
-    _data = getData(_data, id, action);
-
-    const mapInstance = getMapInstance();
-    const managementSdk = get(MANAGEMENT_SDK, mapInstance);
-    const { stack } = managementSdk;
-
-    let response;
-
-    switch (sdkAction) {
-      case CONTENTTYPE_GET:
-        response = await stack.contentType(id).fetch();
-        return response;
-      case CONTENTTYPE_POST:
-        response = await stack.contentType().create(_data);
-        return response;
-      case CONTENTTYPE_PUT:
-        // const contentType = await stack.contentType(id).fetch();
-        response = await stack.contentType(_data).update();
-        return response;
-      case CONTENTTYPE_DELETE:
-        response = await stack.contentType(id).delete();
-        return response;
-      case LOCALES_GET:
-        return response;
-      case ENTRY_GET:
-        return response;
-      case ENTRY_POST:
-        return response;
-      case ENTRY_PUBLISH:
-        return response;
-      case ENTRY_DELETE:
-        return response;
-      case ENTRY_PUT:
-        return response;
-      default:
-    }
-  };
-};
-
-function getData(_data, id, action) {
-  let mapInstance = getMapInstance();
-
-  let data = _data ? _data : getDataWithAction(id, mapInstance, action);
-
-  // return stringify(data);
-  return data;
-}

package/src/utils/error-helper.js

@@ -1,105 +0,0 @@
-const { highlight } = require('cardinal');
-const { keys } = Object;
-const chalk = require('chalk');
-const isEmpty = require('lodash/isEmpty');
-const MigrationLogger = require('./migration-logger');
-const fs = require('fs');
-const { readFile } = require('./fs-helper');
-const groupBy = require('./group-by');
-
-const getLineWithContext = (lines, lineNumber, context) => {
-  const line = lineNumber - 1;
-
-  const firstLine = line > context ? line - context : 0;
-  const lastLine = line + context < lines.length ? line + context : lines.length;
-
-  return {
-    before: lines.slice(firstLine, line),
-    line: lines[line],
-    after: lines.slice(line + 1, lastLine + 1),
-  };
-};
-
-function removeSpecialCharacter(str) {
-  return str.replace(/\u001b\[\d+m/g, '');
-}
-
-module.exports = (errors, filePath) => {
-  const logger = new MigrationLogger(process.env.CS_CLI_LOG_PATH ?? process.cwd());
-
-  const errorsByFile = groupBy(errors, 'file');
-  const messages = [];
-  if (filePath) {
-    if (errors.request) {
-      errors.data = errors.request?.data;
-      delete errors.request;
-    }
-    if (errors.message) {
-      delete errors.message;
-    }
-    logger.log('error', { [filePath]: errors });
-  } else {
-    for (const file of keys(errorsByFile)) {
-      const errorLogs = {};
-      errorLogs[file] = {};
-      const fileContents = readFile(file);
-      const highlightedCode = highlight(fileContents, { linenos: true });
-      const lines = highlightedCode.split('\n');
-
-      const fileErrorsMessage = chalk`{red Errors in ${file}}\n\n`;
-      errorLogs[file].fileErrorsMessage = fileErrorsMessage.replace(/\u001b\[\d+m/g, '');
-      const errorMessages = errorsByFile[file]
-        .map((error) => {
-          const callsite = error.meta.callsite;
-          const context = 2;
-          let { before, line, after } = getLineWithContext(lines, callsite.line, context);
-
-          const beforeLines = before.map((_line) => chalk`${_line}\n`);
-          const afterLines = after.map((_line) => chalk`${_line}\n`);
-          const highlightedLine = chalk`{bold ${line}}\n`;
-
-          before = removeSpecialCharacter(before.join('\n'));
-          after = removeSpecialCharacter(after.join('\n'));
-          line = removeSpecialCharacter(line);
-          errorLogs[file].lines = { before, line, after };
-          if (error.request) {
-            error.data = error.request?.data;
-            delete error.request;
-          }
-          if (error.message) {
-            delete error.message;
-          }
-          const formattedCode = beforeLines + highlightedLine + afterLines;
-          if (error.payload?.apiError) {
-            errorLogs[file].apiError = true;
-            errorLogs[file].errorCode = error.payload.apiError.errorCode;
-            errorLogs[file].errors = error.payload.apiError.errors;
-            errorLogs[file].data = error.data;
-          }
-          if (error.message && !error.payload.apiError) {
-            errorLogs[file].apiError = false;
-            errorLogs[file].error = error.message;
-          }
-        })
-        .join('\n');
-
-      messages.push(`${fileErrorsMessage}${errorMessages}`);
-      logger.log('error', errorLogs);
-    }
-    if (errors?.request) {
-      errors.data = errors.request?.data;
-      delete errors.request;
-    }
-    if (errors?.message) {
-      delete errors.message;
-    }
-    if (isEmpty(messages) && errors !== undefined && isEmpty(errorsByFile)) {
-      logger.log('error', { errors: errors });
-      console.log(chalk`{bold.red migration unsuccessful}`);
-    } else {
-      logger.log('error', { error: messages.join('\n') });
-    }
-  }
-  // eslint-disable-next-line
-  // console.log(chalk`{bold.red Migration unsuccessful}`);
-};

package/src/utils/fs-helper.js

@@ -1,29 +0,0 @@
-'use strict';
-
-const { existsSync, mkdirSync, readFileSync, readFile } = require('fs');
-const path = require('path');
-const { pathValidator } = require('@contentstack/cli-utilities');
-
-exports.makeDir = (dirname) => {
-  !this.existsSync(dirname) && mkdirSync(dirname);
-};
-
-exports.existsSync = (filePath) => existsSync(filePath);
-
-exports.readFile = (filePath) => {
-  if (!existsSync(filePath)) throw new Error('File does not exist');
-  return readFileSync(filePath, 'utf-8');
-};
-
-exports.readJSONFile = (filePath) => {
-  return new Promise((resolve, reject) => {
-    filePath = pathValidator(filePath);
-    readFile(filePath, 'utf-8', (error, data) => {
-      if (error) {
-        reject(error);
-      } else {
-        resolve(JSON.parse(data));
-      }
-    });
-  });
-};

package/src/utils/get-batches.js

@@ -1,7 +0,0 @@
-'use strict';
-
-module.exports = (count, batchLimit) => {
-  const partitions = Math.ceil(count / batchLimit);
-  // Returns array filled with indexes
-  return new Array(partitions).fill(null).map((_, i) => i);
-};

package/src/utils/get-config.js

@@ -1,13 +0,0 @@
-'use strict';
-
-const { apiConfig } = require('../config');
-
-module.exports = ({ method, path, sdkAction }) => {
-  return {
-    ...apiConfig,
-    path: path ? `${apiConfig.version}${path}` : apiConfig.version,
-    method,
-    headers: { ...apiConfig.headers },
-    sdkAction,
-  };
-};

package/src/utils/group-by.js

@@ -1,38 +0,0 @@
-'use strict';
-
-module.exports = function groupBy(data, field, i = 0, finalObj = {}, originalArray = []) {
-  if (!data) return finalObj;
-
-  if (Array.isArray(data)) {
-    groupBy(data[i], field, 0, finalObj, data);
-  } else if (field in data) {
-    let dataField = data[field];
-    if (dataField in finalObj) {
-      finalObj[dataField].push(originalArray[i]);
-    } else {
-      finalObj[dataField] = [];
-      finalObj[dataField].push(originalArray[i]);
-    }
-
-    i++;
-
-    // Breaks when i has been incremented more than length of original array
-    if (i !== 0 && i >= originalArray.length) return finalObj;
-    /**
-     * After the field is found only then increment i and inspect next item
-     * This will restrict iterating through array just to the length of array
-     */
-    groupBy(originalArray[i], field, i, finalObj, originalArray);
-  } else {
-    for (let key in data) {
-      if (key) {
-        let dataKey = data[key];
-        if (!Array.isArray(dataKey) && typeof dataKey === 'object') {
-          groupBy(dataKey, field, i, finalObj, originalArray);
-        }
-      }
-    }
-  }
-
-  return finalObj;
-};

package/src/utils/index.js

@@ -1,21 +0,0 @@
-'use strict';
-
-module.exports = {
-  map: require('./map'),
-  constants: require('./constants'),
-  schemaHelper: require('./schema-helper'),
-  objectHelper: require('./object-helper'),
-  fsHelper: require('./fs-helper'),
-  logger: require('./logger'),
-  https: require('./request'),
-  safePromise: require('./safe-promise'),
-  getConfig: require('./get-config'),
-  successHandler: require('./success-handler'),
-  getCallsite: require('./callsite'),
-  errorHelper: require('./error-helper'),
-  groupBy: require('./group-by'),
-  getBatches: require('./get-batches'),
-  autoRetry: require('./auto-retry'),
-  contentstackSdk: require('./contentstack-sdk'),
-  installModules: require('./modules'),
-};

package/src/utils/logger.js

@@ -1,75 +0,0 @@
-'use strict';
-
-const { createLogger, format, transports } = require('winston');
-const { resolve, join } = require('path');
-const { slice } = Array.prototype;
-const { stringify } = JSON;
-const { pathValidator, sanitizePath } = require('@contentstack/cli-utilities');
-
-const { combine, label, printf, colorize } = format;
-
-// FS helper
-const { makeDir } = require('./fs-helper');
-
-const { NODE_ENV } = process.env;
-
-function getString(args) {
-  let str = '';
-  if (args && args.length > 0) {
-    str = args
-      .map((item) => (item && typeof item === 'object' ? stringify(item) : item))
-      .join(' ')
-      .trim();
-  }
-  return str;
-}
-
-const customFormat = printf(({ level, message }) => {
-  return `${level}: ${message}`;
-});
-
-function init(logFileName) {
-  const logsDir = resolve(process.env.CS_CLI_LOG_PATH?? process.cwd(),'logs');
-  // Create dir if does not exist
-  makeDir(logsDir);
-
-  const logPath = pathValidator(join(sanitizePath(logsDir), sanitizePath(logFileName) + '.log'));
-  const logger = createLogger({
-    format: combine(colorize(), label({ label: 'Migration' }), customFormat),
-    transports: [new transports.File({ filename: logPath })],
-  });
-
-  let args;
-  let logString;
-
-  return {
-    log: function () {
-      args = slice.call(arguments);
-      logString = getString(args);
-      logString && logger.log('info', logString);
-    },
-    warn: function () {
-      args = slice.call(arguments);
-      logString = getString(args);
-      logString && logger.log('warn', logString);
-    },
-    error: function () {
-      // args = slice.call(arguments);
-      // logString = getString(args);
-      // logString && logger.log('error', logString);
-    },
-    debug: function () {
-      args = slice.call(arguments);
-      logString = getString(args);
-      logString && logger.log('debug', logString);
-    },
-  };
-}
-
-exports.success = init('success').log;
-if (NODE_ENV === 'test') {
-  exports.error = init('warn').warn;
-} else {
-  exports.error = init('error').error;
-}
-exports.warn = init('warn').warn;

package/src/utils/map.js

@@ -1,40 +0,0 @@
-'use strict'
-
-const {mapObject, actionMapper, requests} = require('./constants')
-
-exports.getMapInstance = () => {
-  return mapObject
-}
-
-exports.get = (id, mapInstance, data = []) => {
-  // Create key if does not exist
-  let __data = mapInstance.get(id)
-
-  if (!__data) {
-    mapInstance.set(id, data)
-    __data = mapInstance.get(id)
-  }
-
-  return __data
-}
-
-exports.set = (id, mapInstance, data) => {
-  return mapInstance.set(id, data)
-}
-
-exports.remove = (id, mapInstance) => {
-  return mapInstance.delete(id)
-}
-
-exports.getDataWithAction = (id, mapInstance, action) => {
-  let data = this.get(id, mapInstance)
-  data = data[action]
-  return data
-}
-
-exports.resetMapInstance = mapInstance => {
-  this.set(actionMapper, mapInstance, [])
-  this.set(requests, mapInstance, [])
-}
-
-exports.delete = () => { }

package/src/utils/migration-logger.js

@@ -1,21 +0,0 @@
-const winston = require('winston');
-const path = require('path');
-const { sanitizePath } = require('@contentstack/cli-utilities');
-module.exports = class MigrationLogger {
-  constructor(filePath) {
-    this.filePath = path.join(sanitizePath(filePath), 'migration-logs');
-    this.logger = winston.createLogger({
-      levels: { error: 1 },
-      transports: [
-        new winston.transports.File({
-          level: 'error',
-          filename: path.join(sanitizePath(this.filePath), 'error.logs'),
-          format: winston.format.combine(winston.format.timestamp(), winston.format.json()),
-        }),
-      ],
-    });
-  }
-  log(level, message) {
-    this.logger.log('error', message);
-  }
-};