@automattic/vip 2.9.5 → 2.11.2

package/package/dist/lib/dev-environment/dev-environment-cli.js

@@ -0,0 +1,508 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.handleCLIException = handleCLIException;
+exports.getEnvironmentName = getEnvironmentName;
+exports.getEnvironmentStartCommand = getEnvironmentStartCommand;
+exports.printTable = printTable;
+exports.processComponentOptionInput = processComponentOptionInput;
+exports.getOptionsFromAppInfo = getOptionsFromAppInfo;
+exports.promptForArguments = promptForArguments;
+exports.resolvePath = resolvePath;
+exports.promptForText = promptForText;
+exports.promptForBoolean = promptForBoolean;
+exports.promptForPhpVersion = promptForPhpVersion;
+exports.promptForComponent = promptForComponent;
+exports.addDevEnvConfigurationOptions = addDevEnvConfigurationOptions;
+exports.getTagChoices = getTagChoices;
+exports.getEnvTrackingInfo = getEnvTrackingInfo;
+exports.validateDependencies = void 0;
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _formatters = _interopRequireDefault(require("lando/lib/formatters"));
+
+var _enquirer = require("enquirer");
+
+var _debug = _interopRequireDefault(require("debug"));
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _os = _interopRequireDefault(require("os"));
+
+var exit = _interopRequireWildcard(require("../cli/exit"));
+
+var _tracker = require("../tracker");
+
+var _devEnvironment = require("../constants/dev-environment");
+
+var _devEnvironmentCore = require("./dev-environment-core");
+
+var _devEnvironmentLando = require("./dev-environment-lando");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
+const DEFAULT_SLUG = 'vip-local';
+
+async function handleCLIException(exception, trackKey, trackBaseInfo = {}) {
+  const errorPrefix = _chalk.default.red('Error:');
+
+  if (_devEnvironment.DEV_ENVIRONMENT_NOT_FOUND === exception.message) {
+    const createCommand = _chalk.default.bold(_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND + ' create');
+
+    const message = `Environment doesn't exist.\n\n\nTo create a new environment run:\n\n${createCommand}\n`;
+    console.log(errorPrefix, message);
+  } else {
+    let message = exception.message; // if the message has already ERROR prefix we should drop it as we are adding our own cool red Error-prefix
+
+    message = message.replace('ERROR: ', '');
+    console.log(errorPrefix, message);
+
+    if (trackKey) {
+      try {
+        const errorTrackingInfo = { ...trackBaseInfo,
+          failure: message
+        };
+        await (0, _tracker.trackEvent)(trackKey, errorTrackingInfo);
+      } catch (trackException) {
+        console.log(errorPrefix, `Failed to record track event ${trackKey}`, trackException.message);
+      }
+    }
+
+    if (!process.env.DEBUG) {
+      console.log(`Please re-run the command with "--debug ${_chalk.default.bold('@automattic/vip:bin:dev-environment')}" appended to it and provide the stack trace on the support ticket.`);
+      console.log(_chalk.default.bold('\nExample:\n'));
+      console.log('vip dev-env create --debug @automattic/vip:bin:dev-environment \n');
+    }
+
+    debug(exception);
+  }
+}
+
+const validateDependencies = async () => {
+  try {
+    await (0, _devEnvironmentLando.validateDockerInstalled)();
+  } catch (exception) {
+    exit.withError(exception.message);
+  }
+};
+
+exports.validateDependencies = validateDependencies;
+
+function getEnvironmentName(options) {
+  if (options.slug) {
+    return options.slug;
+  }
+
+  if (options.app) {
+    const envSuffix = options.env ? `-${options.env}` : '';
+    return options.app + envSuffix;
+  }
+
+  return DEFAULT_SLUG;
+}
+
+function getEnvironmentStartCommand(options) {
+  if (options.slug) {
+    return `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} start --slug ${options.slug}`;
+  }
+
+  if (options.app) {
+    let application = `@${options.app}`;
+
+    if (options.env) {
+      application += `.${options.env}`;
+    }
+
+    return `vip ${application} ${_devEnvironment.DEV_ENVIRONMENT_SUBCOMMAND} start`;
+  }
+
+  return `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} start`;
+}
+
+function printTable(data) {
+  const formattedData = _formatters.default.formatData(data, {
+    format: 'table'
+  }, {
+    border: false
+  });
+
+  console.log(formattedData);
+}
+
+function processComponentOptionInput(passedParam, allowLocal) {
+  // cast to string
+  const param = passedParam + '';
+
+  if (allowLocal && param.includes('/')) {
+    return {
+      mode: 'local',
+      dir: param
+    };
+  }
+
+  return {
+    mode: 'image',
+    tag: param
+  };
+}
+
+function getOptionsFromAppInfo(appInfo) {
+  var _appInfo$environment, _appInfo$environment2, _appInfo$environment3;
+
+  return {
+    title: ((_appInfo$environment = appInfo.environment) === null || _appInfo$environment === void 0 ? void 0 : _appInfo$environment.name) || appInfo.name || '',
+    multisite: !!(appInfo !== null && appInfo !== void 0 && (_appInfo$environment2 = appInfo.environment) !== null && _appInfo$environment2 !== void 0 && _appInfo$environment2.isMultisite),
+    mediaRedirectDomain: (_appInfo$environment3 = appInfo.environment) === null || _appInfo$environment3 === void 0 ? void 0 : _appInfo$environment3.primaryDomain
+  };
+}
+/**
+ * Prompt for arguments
+ * @param {InstanceOptions} preselectedOptions - options to be used without prompt
+ * @param {InstanceOptions} defaultOptions - options to be used as default values for prompt
+ * @returns {any} instance data
+ */
+
+
+async function promptForArguments(preselectedOptions, defaultOptions) {
+  debug('Provided preselected', preselectedOptions, 'and default', defaultOptions);
+  console.log(_devEnvironment.DEV_ENVIRONMENT_PROMPT_INTRO);
+  let multisiteText = 'Multisite';
+  let multisiteDefault = _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.multisite;
+
+  if (defaultOptions.title) {
+    multisiteText += ` (${defaultOptions.title} ${defaultOptions.multisite ? 'IS' : 'is NOT'} multisite)`;
+    multisiteDefault = defaultOptions.multisite;
+  }
+
+  const instanceData = {
+    wpTitle: preselectedOptions.title || (await promptForText('WordPress site title', defaultOptions.title || _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.title)),
+    multisite: 'multisite' in preselectedOptions ? preselectedOptions.multisite : await promptForBoolean(multisiteText, !!multisiteDefault),
+    elasticsearch: preselectedOptions.elasticsearch || defaultOptions.elasticsearch || _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.elasticsearchVersion,
+    php: preselectedOptions.php ? resolvePhpVersion(preselectedOptions.php) : await promptForPhpVersion(resolvePhpVersion(defaultOptions.php || _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.phpVersion)),
+    mariadb: preselectedOptions.mariadb || defaultOptions.mariadb || _devEnvironment.DEV_ENVIRONMENT_DEFAULTS.mariadbVersion,
+    mediaRedirectDomain: preselectedOptions.mediaRedirectDomain || '',
+    wordpress: {
+      mode: 'image'
+    },
+    muPlugins: {
+      mode: 'image'
+    },
+    clientCode: {
+      mode: 'image'
+    },
+    statsd: false,
+    phpmyadmin: false,
+    xdebug: false,
+    siteSlug: '',
+    enterpriseSearchEnabled: preselectedOptions.enterpriseSearchEnabled || defaultOptions.enterpriseSearchEnabled
+  };
+  const promptLabels = {
+    xdebug: 'XDebug',
+    phpmyadmin: 'phpMyAdmin'
+  };
+
+  if (!instanceData.mediaRedirectDomain && defaultOptions.mediaRedirectDomain) {
+    const mediaRedirectPromptText = `Would you like to redirect to ${defaultOptions.mediaRedirectDomain} for missing media files?`;
+    const setMediaRedirectDomain = await promptForBoolean(mediaRedirectPromptText, true);
+
+    if (setMediaRedirectDomain) {
+      var _defaultOptions$media;
+
+      instanceData.mediaRedirectDomain = (_defaultOptions$media = defaultOptions.mediaRedirectDomain) !== null && _defaultOptions$media !== void 0 ? _defaultOptions$media : '';
+    }
+  }
+
+  for (const component of _devEnvironment.DEV_ENVIRONMENT_COMPONENTS) {
+    var _preselectedOptions$c, _defaultOptions$compo;
+
+    const option = ((_preselectedOptions$c = preselectedOptions[component]) !== null && _preselectedOptions$c !== void 0 ? _preselectedOptions$c : '').toString();
+    const defaultValue = ((_defaultOptions$compo = defaultOptions[component]) !== null && _defaultOptions$compo !== void 0 ? _defaultOptions$compo : '').toString();
+    const result = await processComponent(component, option, defaultValue);
+
+    if (null === result) {
+      throw new Error('processComponent() returned null');
+    }
+
+    instanceData[component] = result;
+  }
+
+  instanceData.enterpriseSearchEnabled = await promptForBoolean('Enable Enterprise Search?', defaultOptions.enterpriseSearchEnabled);
+
+  if (instanceData.enterpriseSearchEnabled) {
+    instanceData.statsd = preselectedOptions.statsd || defaultOptions.statsd || false;
+  } else {
+    instanceData.statsd = false;
+  }
+
+  for (const service of ['phpmyadmin', 'xdebug']) {
+    if (service in instanceData) {
+      instanceData[service] = await promptForBoolean(`Enable ${promptLabels[service] || service}`, instanceData[service]);
+    }
+  }
+
+  debug('Instance data after prompts', instanceData);
+  return instanceData;
+}
+
+async function processComponent(component, preselectedValue, defaultValue) {
+  debug(`processing a component '${component}', with preselected/deafault - ${preselectedValue}/${defaultValue}`);
+  let result = null;
+  const allowLocal = component !== 'wordpress';
+  const defaultObject = defaultValue ? processComponentOptionInput(defaultValue, allowLocal) : null;
+
+  if (preselectedValue) {
+    result = processComponentOptionInput(preselectedValue, allowLocal);
+  } else {
+    result = await promptForComponent(component, allowLocal, defaultObject);
+  }
+
+  while ('local' === ((_result = result) === null || _result === void 0 ? void 0 : _result.mode)) {
+    var _result;
+
+    const resolvedPath = resolvePath(result.dir || '');
+    result.dir = resolvedPath;
+
+    const isDirectory = resolvedPath && _fs.default.existsSync(resolvedPath) && _fs.default.lstatSync(resolvedPath).isDirectory();
+
+    const isEmpty = isDirectory ? _fs.default.readdirSync(resolvedPath).length === 0 : true;
+
+    if (isDirectory && !isEmpty) {
+      break;
+    } else {
+      const message = `Provided path "${resolvedPath}" does not point to a valid or existing directory.`;
+      console.log(_chalk.default.yellow('Warning:'), message);
+      result = await promptForComponent(component, allowLocal, defaultObject);
+    }
+  }
+
+  return result;
+}
+
+function resolvePath(input) {
+  // Resolve does not do ~ reliably
+  const resolvedPath = input.replace(/^~/, _os.default.homedir()); // And resolve to handle relative paths
+
+  return _path.default.resolve(resolvedPath);
+}
+
+async function promptForText(message, initial) {
+  const nonEmptyValidator = value => {
+    if ((value || '').trim()) {
+      return true;
+    }
+
+    return 'value needs to be provided';
+  };
+
+  const result = await (0, _enquirer.prompt)({
+    type: 'input',
+    name: 'input',
+    message,
+    initial,
+    validate: nonEmptyValidator
+  });
+  return ((result === null || result === void 0 ? void 0 : result.input) || '').trim();
+}
+
+async function promptForBoolean(message, initial) {
+  const confirm = new _enquirer.Confirm({
+    message,
+    initial
+  });
+  return confirm.run();
+}
+
+function resolvePhpVersion(version) {
+  debug(`Resolving PHP version '${version}'`);
+  const versions = Object.keys(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS);
+  const images = Object.values(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS); // eslint-disable-next-line eqeqeq -- use loose comparison because commander resolves '8.0' to '8'
+
+  const index = versions.findIndex(value => value == version);
+
+  if (index === -1) {
+    const image = images.find(value => value === version);
+    return image !== null && image !== void 0 ? image : images[0];
+  }
+
+  return images[index];
+}
+
+async function promptForPhpVersion(initialValue) {
+  debug(`Prompting for PHP version, preselected option is ${initialValue}`);
+  const choices = Object.keys(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS);
+  const images = Object.values(_devEnvironment.DEV_ENVIRONMENT_PHP_VERSIONS);
+  const initial = images.findIndex(version => version === initialValue);
+  const select = new _enquirer.Select({
+    message: 'PHP version to use',
+    choices,
+    initial
+  });
+  const answer = await select.run();
+  return resolvePhpVersion(answer);
+}
+
+const componentDisplayNames = {
+  wordpress: 'WordPress',
+  muPlugins: 'vip-go-mu-plugins',
+  clientCode: 'site-code'
+};
+
+async function promptForComponent(component, allowLocal, defaultObject) {
+  debug(`Prompting for ${component} with default:`, defaultObject);
+  const componentDisplayName = componentDisplayNames[component] || component;
+  const modChoices = [];
+
+  if (allowLocal) {
+    modChoices.push({
+      message: `local folder - where you already have ${componentDisplayName} code`,
+      value: 'local'
+    });
+  }
+
+  modChoices.push({
+    message: 'image - that gets automatically fetched',
+    value: 'image'
+  });
+  let initialMode = 'image';
+
+  if ('clientCode' === component) {
+    initialMode = 'local';
+  }
+
+  if (defaultObject !== null && defaultObject !== void 0 && defaultObject.mode) {
+    initialMode = defaultObject.mode;
+  }
+
+  let modeResult = initialMode;
+  const selectMode = modChoices.length > 1;
+
+  if (selectMode) {
+    const initialModeIndex = modChoices.findIndex(choice => choice.value === initialMode);
+    const select = new _enquirer.Select({
+      message: `How would you like to source ${componentDisplayName}`,
+      choices: modChoices,
+      initial: initialModeIndex
+    });
+    modeResult = await select.run();
+  }
+
+  const messagePrefix = selectMode ? '\t' : `${componentDisplayName} - `;
+
+  if ('local' === modeResult) {
+    const directoryPath = await promptForText(`${messagePrefix}What is a path to your local ${componentDisplayName}`, (defaultObject === null || defaultObject === void 0 ? void 0 : defaultObject.dir) || '');
+    return {
+      mode: modeResult,
+      dir: directoryPath
+    };
+  } // image with selection
+
+
+  if (component === 'wordpress') {
+    const message = `${messagePrefix}Which version would you like`;
+    const tagChoices = await getTagChoices();
+    const selectTag = new _enquirer.Select({
+      message,
+      choices: tagChoices
+    });
+    const option = await selectTag.run();
+    return {
+      mode: modeResult,
+      tag: option
+    };
+  } // image
+
+
+  return {
+    mode: modeResult
+  };
+}
+
+function addDevEnvConfigurationOptions(command) {
+  return command.option('wordpress', 'Use a specific WordPress version').option(['u', 'mu-plugins'], 'Use a specific mu-plugins changeset or local directory').option('client-code', 'Use the client code from a local directory or VIP skeleton').option('statsd', 'Enable statsd component. By default it is disabled', undefined, value => {
+    var _value$toLowerCase;
+
+    return 'false' !== (value === null || value === void 0 ? void 0 : (_value$toLowerCase = value.toLowerCase) === null || _value$toLowerCase === void 0 ? void 0 : _value$toLowerCase.call(value));
+  }).option('phpmyadmin', 'Enable PHPMyAdmin component. By default it is disabled', undefined, value => {
+    var _value$toLowerCase2;
+
+    return 'false' !== (value === null || value === void 0 ? void 0 : (_value$toLowerCase2 = value.toLowerCase) === null || _value$toLowerCase2 === void 0 ? void 0 : _value$toLowerCase2.call(value));
+  }).option('xdebug', 'Enable XDebug. By default it is disabled', undefined, value => {
+    var _value$toLowerCase3;
+
+    return 'false' !== (value === null || value === void 0 ? void 0 : (_value$toLowerCase3 = value.toLowerCase) === null || _value$toLowerCase3 === void 0 ? void 0 : _value$toLowerCase3.call(value));
+  }).option('elasticsearch', 'Explicitly choose Elasticsearch version to use').option('mariadb', 'Explicitly choose MariaDB version to use').option(['r', 'media-redirect-domain'], 'Domain to redirect for missing media files. This can be used to still have images without the need to import them locally.').option('php', 'Explicitly choose PHP version to use');
+}
+/**
+ * Provides the list of tag choices for selection
+ */
+
+
+async function getTagChoices() {
+  const versions = await (0, _devEnvironmentCore.getVersionList)();
+
+  if (versions.length < 1) {
+    return ['5.9', '5.8', '5.7', '5.6', '5.5'];
+  }
+
+  return versions.map(version => {
+    let mapping;
+    const tagFormatted = version.tag.padEnd(8 - version.tag.length);
+    const prerelease = version.prerelease ? '(Pre-Release)' : '';
+
+    if (version.tag !== version.ref) {
+      mapping = `→ ${prerelease} ${version.ref}`;
+    } else {
+      mapping = '';
+    }
+
+    return {
+      name: version.tag,
+      message: `${tagFormatted} ${mapping}`,
+      value: version.tag
+    };
+  });
+}
+
+function getEnvTrackingInfo(slug) {
+  try {
+    const envData = (0, _devEnvironmentCore.readEnvironmentData)(slug);
+    const result = {
+      slug
+    };
+
+    for (const key of Object.keys(envData)) {
+      // track doesnt like camelCase
+      const snakeCasedKey = key.replace(/[A-Z]/g, letter => `_${letter.toLowerCase()}`);
+      const value = _devEnvironment.DEV_ENVIRONMENT_COMPONENTS.includes(key) ? JSON.stringify(envData[key]) : envData[key];
+      result[snakeCasedKey] = value;
+    }
+
+    return result;
+  } catch (err) {
+    return {
+      slug
+    };
+  }
+}