@automattic/vip 2.4.0 → 2.5.0

package/README.md

@@ -27,6 +27,12 @@ By default, we record information about the usage of this tool using an in-house
 
 ## Changelog
 
+### 2.5.0 (9 November 2021)
+- #919  [dev-env] Expose lando core logs
+- #916  [dev-env] Save instance data state
+- #914  [dev-env] update help wording for dev env
+- #915  Add warning message when an envvar is set/deleted
+
 ### 2.4.0 (5 November 2021)
 - #913  [dev-env] No login required for dev-env
 - #911  Adds more release instructions

package/dist/bin/vip-config-envvar-delete.js

@@ -82,6 +82,10 @@ async function deleteEnvVarCommand(arg, opt) {
   });
   await (0, _tracker.trackEvent)('envvar_delete_command_success', trackingParams);
   console.log(_chalk.default.green(`Successfully deleted environment variable ${JSON.stringify(name)}`));
+
+  if (!opt.skipConfirmation) {
+    console.log(_chalk.default.bgYellow(_chalk.default.bold('Important:')), 'Updates to environment variables will not be available until the application’s next deploy.');
+  }
 }
 
 (0, _command.default)({

package/dist/bin/vip-config-envvar-set.js

@@ -101,6 +101,10 @@ async function setEnvVarCommand(arg, opt) {
   });
   await (0, _tracker.trackEvent)('envvar_set_command_success', trackingParams);
   console.log(_chalk.default.green(`Successfully set environment variable ${JSON.stringify(name)}`));
+
+  if (!opt.skipConfirmation) {
+    console.log(_chalk.default.bgYellow(_chalk.default.bold('Important:')), 'Updates to environment variables will not be available until the application’s next deploy.');
+  }
 }
 
 (0, _command.default)({

package/dist/bin/vip-dev-env-create.js

@@ -50,11 +50,11 @@ const examples = [{
   usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} create --multisite --wordpress "5.8" --client-code "~/git/my_code"`,
   description: 'Creates a local multisite dev environment using WP 5.8 and client code is expected to be in "~/git/my_code"'
 }];
-(0, _command.default)().option('slug', 'Custom name of the dev environment').option('title', 'Title for the WordPress site (default: "VIP Dev")').option('multisite', 'Enable multisite install', undefined, value => {
+(0, _command.default)().option('slug', 'Custom name of the dev environment').option('title', 'Title for the WordPress site').option('multisite', 'Enable multisite install', 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('wordpress', 'Use a specific WordPress version or local directory (default: last stable)').option(['u', 'mu-plugins'], 'Use a specific mu-plugins changeset or local directory (default: "auto": last commit in master)').option('client-code', 'Use the client code from a local directory or VIP skeleton (default: use the VIP skeleton)').option('statsd', 'Enable statsd component. By default it is disabled', undefined, value => {
+}).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$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));

package/dist/bin/vip-dev-env-update.js

@@ -0,0 +1,72 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+"use strict";
+
+var _debug = _interopRequireDefault(require("debug"));
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
+
+var _devEnvironment = require("../lib/constants/dev-environment");
+
+var _devEnvironmentCore = require("../lib/dev-environment/dev-environment-core");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Internal dependencies
+ */
+const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment');
+const examples = [{
+  usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} update`,
+  description: 'Retriggers setup wizard in order to change environment configuration'
+}];
+const cmd = (0, _command.default)().option('slug', 'Custom name of the dev environment');
+(0, _devEnvironmentCli.addDevEnvConfigurationOptions)(cmd);
+cmd.examples(examples);
+cmd.argv(process.argv, async (arg, opt) => {
+  const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
+
+  try {
+    const environmentAlreadyExists = (0, _devEnvironmentCore.doesEnvironmentExist)(slug);
+
+    if (!environmentAlreadyExists) {
+      throw new Error(_devEnvironment.DEV_ENVIRONMENT_NOT_FOUND);
+    }
+
+    const currentInstanceData = (0, _devEnvironmentCore.readEnvironmentData)(slug);
+    debug('Read instance data', currentInstanceData);
+    const preselectedOptions = {
+      // Title and multisite can't be changed during update
+      title: currentInstanceData.wpTitle,
+      multisite: currentInstanceData.multisite,
+      ...opt
+    };
+    debug('Combined preselected data are', preselectedOptions);
+    const instanceData = await (0, _devEnvironmentCli.promptForArguments)(preselectedOptions, {}); // const instanceDataWithSlug = {
+    // 	...currentInstanceData,
+    // 	siteSlug: slug,
+    // 	statsd: opt.statsd || false,
+    // 	phpmyadmin: opt.phpmyadmin || false,
+    // 	xdebug: opt.xdebug || false,
+    // };
+  } catch (error) {
+    if ('ENOENT' === error.code) {
+      const message = 'Environment was created before update was supported.\n\nTo update environment please destroy it and create a new one.';
+      (0, _devEnvironmentCli.handleCLIException)(new Error(message));
+    } else {
+      (0, _devEnvironmentCli.handleCLIException)(error);
+    }
+  }
+});

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

@@ -64,6 +64,7 @@ const nginxFileTemplatePath = _path.default.join(__dirname, '..', '..', '..', 'a
 
 const landoFileName = '.lando.yml';
 const nginxFileName = 'extra.conf';
+const instanceDataFileName = 'instance_data.json';
 const homeDirPathInsideContainers = '/user';
 const uploadPathString = 'uploads';
 const nginxPathString = 'nginx';
@@ -207,6 +208,7 @@ function doesEnvironmentExist(slug) {
 async function prepareLandoEnv(instanceData, instancePath) {
   const landoFile = await _ejs.default.renderFile(landoFileTemplatePath, instanceData);
   const nginxFile = await _ejs.default.renderFile(nginxFileTemplatePath, instanceData);
+  const instanceDataFile = JSON.stringify(instanceData);
 
   const landoFileTargetPath = _path.default.join(instancePath, landoFileName);
 
@@ -214,6 +216,8 @@ async function prepareLandoEnv(instanceData, instancePath) {
 
   const nginxFileTargetPath = _path.default.join(nginxFolderPath, nginxFileName);
 
+  const instanceDataTargetPath = _path.default.join(instancePath, instanceDataFileName);
+
   _fs.default.mkdirSync(instancePath, {
     recursive: true
   });
@@ -226,8 +230,11 @@ async function prepareLandoEnv(instanceData, instancePath) {
 
   _fs.default.writeFileSync(nginxFileTargetPath, nginxFile);
 
+  _fs.default.writeFileSync(instanceDataTargetPath, instanceDataFile);
+
   debug(`Lando file created in ${landoFileTargetPath}`);
   debug(`Nginx file created in ${nginxFileTargetPath}`);
+  debug(`Instance data file created in ${instanceDataTargetPath}`);
 }
 
 function getAllEnvironmentNames() {

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

@@ -42,14 +42,16 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * This file will hold all the interactions with lando library
  */
-const debug = (0, _debug.default)('@automattic/vip:bin:dev-environment-lando');
+const DEBUG_KEY = '@automattic/vip:bin:dev-environment-lando';
+const debug = (0, _debug.default)(DEBUG_KEY);
 
 function getLandoConfig() {
   const landoPath = _path.default.join(__dirname, '..', '..', '..', 'node_modules', 'lando');
 
   debug(`Getting lando config, using path '${landoPath}' for plugins`);
+  const logLevelConsole = (process.env.DEBUG || '').includes(DEBUG_KEY) ? 'debug' : 'warn';
   return {
-    logLevelConsole: 'warn',
+    logLevelConsole,
     landoFile: '.lando.yml',
     preLandoFiles: ['.lando.base.yml', '.lando.dist.yml', '.lando.upstream.yml'],
     postLandoFiles: ['.lando.local.yml'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {