@automattic/vip 2.1.0 → 2.2.0

package/CONTRIBUTING.md

@@ -34,6 +34,30 @@ VIP_PROXY="" API_HOST=http://localhost:4000 node ./dist/bin/vip -- wp option get
 
 New libraries should generally support both CLI and web contexts, though some cases that won't make sense (e.g. formatting for CLI output). Ensuring the libraries are useful everywhere will allow us to offer consistent experiences regardless of the interface.
 
+## Release & Deployment Process
+
+Our release flow for VIP CLI follows this pattern:
+
+**_feature branch -> develop branch -> master branch -> NPM release_**
+
+- For feature branches, please follow A8C branch naming conventions (e.g.- `add/data-sync-command`, `fix/subsite-launch-command`, etc.)
+- Include a Changelog for all npm version releases, including any minor or major versions
+- This is a public repository. Please do not include any internal links in PRs, changelogs, testing instructions, etc.
+- Merge changes from your feature branch to the `develop` branch
+- Please do not merge any changes into the `master` branch yet. All features/changes that are not ready to be public should stay in the `develop` branch to avoid conflicts when releasing urgent fixes.
+- Changes from the `develop` branch are merged to `master` and released on NPM following our release schedule
+- Any team member that is part of our NPM organization can release new minor or major versions, but please have a Customer Experience (Pâtisserie) team member look over the changes first.
+
+### Changelogs
+Changelogs allow customers to keep up with all the changes happening across our VIP Platform. Changelogs for VIP CLI are posted to the V[VIP Cloud Changelog P2](https://wpvipchangelog.wordpress.com/), along with the repository’s `README.md`.
+
+### Release Schedule
+We deploy changes from our `develop` branch to the `master` branch on Tuesdays from 4AM to 5PM Pacific Time.
+
+Changes that are not ready to be publicly released should stay in the `develop` branch to avoid conflicts with any urgent fixes we may need to roll out. Fixes for urgent or breaking bugs may be merged straight to the `master` branch and released publicly via npm at any time outside of our release schedule.
+
+All other changes should follow the schedule so that we can monitor the newly released changes.
+
 ## Releasing / Publishing
 
 ### Pre-publish Checks

package/README.md

@@ -27,6 +27,40 @@ By default, we record information about the usage of this tool using an in-house
 
 ## Changelog
 
+### 2.2.0 (27 October 2021)
+
+New: Environment variables command
+- #896 Open config envvar command for all customers
+- #876 Update envvar list command to only show names
+- #879 Add config envvar get and get-all commands
+- #875 Temporarily gate access to new config command to VIP staff
+- #858 Environment variable CLI commands (list, set, delete)
+
+Fixes:
+- #901 Don't mark import as failed until restore has completed
+- #899 Proxy fix + healthchecks
+- #894 support windows db import
+- #889 Proxy config change
+- #888 mount wordpress code
+- #872 Auto flush cache after import and add vipgo user
+- #869 Media redirect to production site.
+- #885 Make search data persistent between restarts
+- #844 Expose DB and expose extra services in info table
+- #865 spawn WP-CLI as root to allow for FS operations
+- #895 Fix rmdir deprecation warning
+- #870 Add the VIP CLI release process and release schedule
+
+Dependencies updates:
+- #778 Update dependency ini to v2
+- #786 Update dependency keytar to v7
+- #884 Update dependency cli-columns to v4
+- #887 Update dependency lando to v3.4.3
+- #874 Update dependency lando to v3.4.0
+- #750 Bump hosted-git-info from 2.8.8 to 2.8.9
+- #877 Bump tmpl from 1.0.4 to 1.0.5
+
+https://github.com/Automattic/vip/releases/tag/v2.2.0
+
 ### 2.1.0 (16 September 2021)
 
 - #857  Remove select DB checks

package/assets/{dev-environment.lando.template.yml.ejs → dev-env.lando.template.yml.ejs}

@@ -12,7 +12,7 @@ services:
   devtools:
     type: compose
     services:
-      image: ghcr.io/automattic/vip-container-images/dev-tools:0.6
+      image: ghcr.io/automattic/vip-container-images/dev-tools:0.7
       command: sleep infinity
       volumes:
         - devtools:/dev-tools
@@ -27,6 +27,7 @@ services:
       image: ghcr.io/automattic/vip-container-images/nginx:1.21.3
       command: nginx -g "daemon off;"
       volumes:
+        - ./nginx/extra.conf:/etc/nginx/conf.extra/extra.conf
 <% wpVolumes() %>
 
   php:
@@ -46,15 +47,21 @@ services:
           volume:
             nocopy: true
 <% wpVolumes() %>
-
-    run_as_root:
+    run:
       - sh /dev-tools/setup.sh database root "http://<%= siteSlug %>.vipdev.lndo.site/" "<%= wpTitle %>" <% if ( multisite ) { %> <%= siteSlug %>.vipdev.lndo.site <% } %>
+    run_as_root:
+      - echo "Copying dev-env-plugin.php to mu-plugins"
+      - cp /dev-tools/dev-env-plugin.php /wp/wp-content/mu-plugins/
 
   database:
     type: compose
     services:
       image: mariadb:<%= mariadb %>
       command: docker-entrypoint.sh mysqld
+      ports:
+        - ":3306"
+      healthcheck:
+        test: 'mysql -uroot --silent --execute "SHOW DATABASES;"'
       environment:
         MARIADB_ALLOW_EMPTY_ROOT_PASSWORD: 'true'
       volumes:
@@ -79,9 +86,8 @@ services:
 <% } %>
 
   vip-search:
-    type: elasticsearch:custom
-    portforward: true
-    overrides:
+    type: compose
+    services:
       image: elasticsearch:<%= elasticsearch %>
       command: /usr/local/bin/docker-entrypoint.sh
       environment:
@@ -90,6 +96,14 @@ services:
         ELASTICSEARCH_NODE_NAME: 'lando'
         ELASTICSEARCH_PORT_NUMBER: 9200
         discovery.type: 'single-node'
+      ports:
+        - ":9200"
+      healthcheck:
+        test: "curl --noproxy '*' -XGET localhost:9200"
+      volumes:
+        - search_data:/usr/share/elasticsearch/data
+    volumes:
+      search_data:
 
 <% if ( statsd ) { %>
   statsd:
@@ -99,17 +113,13 @@ services:
       command: node stats.js /config/statsd-config.js
 <% } %>
 
-<% if ( wordpress.mode == 'image' ) { %>
   wordpress:
     type: compose
     services:
       image: <%= wordpress.image %>:<%= wordpress.tag %>
       command: sh -c "rsync -a /wp/ /shared/; sleep infinity"
       volumes:
-        - wordpress:/shared
-    volumes:
-      wordpress: {}
-<% } %>
+        - ./wordpress:/shared
 
 <% if ( muPlugins.mode == 'image' ) { %>
   mu-plugins:
@@ -151,8 +161,9 @@ tooling:
   wp:
     service: php
     description: "Run WP-CLI command"
+    user: root
     cmd:
-      - wp
+      - wp --allow-root
 
   add-site:
     service: php
@@ -170,15 +181,7 @@ tooling:
         - ./config:/wp/config
         - ./log:/wp/log
         - ./uploads:/wp/wp-content/uploads
-<% if ( wordpress.mode == 'image' ) { %>
-        - type: volume
-          source: wordpress
-          target: /wp
-          volume:
-            nocopy: true
-<% } else { %>
-        - <%= wordpress.dir %>:/wp
-<% } %>
+        - ./wordpress:/wp
 <% if ( muPlugins.mode == 'image' ) { %>
         - type: volume
           source: mu-plugins

package/assets/dev-env.nginx.template.conf.ejs

@@ -0,0 +1,13 @@
+<% if ( mediaRedirectDomain ) { %>
+
+location ~* /wp-content/uploads {
+    expires max;
+    log_not_found off;
+    try_files $uri @prod_site;
+}
+
+location @prod_site {
+    rewrite ^/(.*)$ <%= mediaRedirectDomain %>/$1 redirect;
+}
+
+<% } %>

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

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deleteEnvVarCommand = deleteEnvVarCommand;
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _api = require("../lib/envvar/api");
+
+var _input = require("../lib/envvar/input");
+
+var _logging = require("../lib/envvar/logging");
+
+var _rollbar = require("../lib/rollbar");
+
+var _tracker = require("../lib/tracker");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Internal dependencies
+ */
+const baseUsage = 'vip config envvar delete'; // Command examples
+
+const examples = [{
+  usage: `${baseUsage} MY_VARIABLE`,
+  description: 'Permanently deletes the environment variable "MY_VARIABLE"'
+}];
+
+async function deleteEnvVarCommand(arg, opt) {
+  // Help the user by uppercasing input.
+  const name = arg[0].trim().toUpperCase();
+  const trackingParams = {
+    app_id: opt.app.id,
+    command: `${baseUsage} ${name}`,
+    env_id: opt.env.id,
+    org_id: opt.app.organization.id,
+    skip_confirm: !!opt.skipConfirmation,
+    variable_name: name
+  };
+  (0, _logging.debug)(`Request: Delete environment variable ${JSON.stringify(name)} for ${(0, _logging.getEnvContext)(opt.app, opt.env)}`);
+  await (0, _tracker.trackEvent)('envvar_delete_command_execute', trackingParams);
+
+  if (!(0, _api.validateNameWithMessage)(name)) {
+    await (0, _tracker.trackEvent)('envvar_delete_invalid_name', trackingParams);
+    process.exit(1);
+  }
+
+  if (!opt.skipConfirmation) {
+    await (0, _input.promptForValue)(`Type ${name} to confirm deletion:`, name).catch(async () => {
+      await (0, _tracker.trackEvent)('envvar_delete_user_cancelled_input', trackingParams);
+      (0, _input.cancel)();
+    });
+
+    if (!(await (0, _input.confirm)(`Are you sure? ${_chalk.default.bold.red('Deletion is permanent')} (y/N)`))) {
+      await (0, _tracker.trackEvent)('envvar_delete_user_cancelled_confirmation', trackingParams);
+      (0, _input.cancel)();
+    }
+  }
+
+  await (0, _api.deleteEnvVar)(opt.app.id, opt.env.id, name).catch(async err => {
+    _rollbar.rollbar.error(err);
+
+    await (0, _tracker.trackEvent)('envvar_delete_mutation_error', { ...trackingParams,
+      error: err.message
+    });
+    throw err;
+  });
+  await (0, _tracker.trackEvent)('envvar_delete_command_success', trackingParams);
+  console.log(_chalk.default.green(`Successfully deleted environment variable ${JSON.stringify(name)}`));
+}
+
+(0, _command.default)({
+  appContext: true,
+  appQuery: _api.appQuery,
+  envContext: true,
+  requiredArgs: 1,
+  usage: `${baseUsage} <VARIABLE_NAME>`
+}).examples(examples).option('skip-confirmation', 'Skip manual confirmation of input (USE WITH CAUTION)', false).argv(process.argv, deleteEnvVarCommand);

package/dist/bin/vip-config-envvar-get-all.js

@@ -0,0 +1,94 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getAllEnvVarsCommand = getAllEnvVarsCommand;
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _format = require("../lib/cli/format");
+
+var _api = require("../lib/envvar/api");
+
+var _logging = require("../lib/envvar/logging");
+
+var _rollbar = require("../lib/rollbar");
+
+var _tracker = require("../lib/tracker");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Internal dependencies
+ */
+const usage = 'vip config envvar get-all'; // Command examples
+
+const examples = [{
+  usage,
+  description: 'Get the values of all environment variables'
+}];
+
+async function getAllEnvVarsCommand(arg, opt) {
+  const trackingParams = {
+    app_id: opt.app.id,
+    command: usage,
+    env_id: opt.env.id,
+    format: opt.format,
+    org_id: opt.app.organization.id
+  };
+  (0, _logging.debug)(`Request: Get all environment variables for ${(0, _logging.getEnvContext)(opt.app, opt.env)}`);
+  await (0, _tracker.trackEvent)('envvar_get_all_command_execute', trackingParams);
+  const envvars = await (0, _api.getEnvVars)(opt.app.id, opt.env.id).catch(async err => {
+    _rollbar.rollbar.error(err);
+
+    await (0, _tracker.trackEvent)('envvar_get_all_query_error', { ...trackingParams,
+      error: err.message
+    });
+    throw err;
+  });
+  await (0, _tracker.trackEvent)('envvar_get_all_command_success', trackingParams);
+
+  if (0 === envvars.length) {
+    console.log(_chalk.default.yellow('There are no environment variables'));
+    process.exit();
+  } // Vary data by expected format.
+
+
+  let key = 'name';
+
+  if ('keyValue' === opt.format) {
+    key = 'key';
+  } else if ('ids' === opt.format) {
+    key = 'id';
+  }
+
+  const envvarsObject = envvars.map(({
+    name: envvarName,
+    value
+  }) => ({
+    [key]: envvarName,
+    value
+  }));
+  console.log((0, _format.formatData)(envvarsObject, opt.format));
+}
+
+(0, _command.default)({
+  appContext: true,
+  appQuery: _api.appQuery,
+  envContext: true,
+  format: true,
+  usage
+}).examples(examples).argv(process.argv, getAllEnvVarsCommand);

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

@@ -0,0 +1,79 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getEnvVarCommand = getEnvVarCommand;
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _api = require("../lib/envvar/api");
+
+var _logging = require("../lib/envvar/logging");
+
+var _rollbar = require("../lib/rollbar");
+
+var _tracker = require("../lib/tracker");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Internal dependencies
+ */
+const baseUsage = 'vip config envvar get'; // Command examples
+
+const examples = [{
+  usage: `${baseUsage} MY_VARIABLE`,
+  description: 'Get the value of the environment variable "MY_VARIABLE"'
+}];
+
+async function getEnvVarCommand(arg, opt) {
+  // Help the user by uppercasing input.
+  const name = arg[0].trim().toUpperCase();
+  const trackingParams = {
+    app_id: opt.app.id,
+    command: `${baseUsage} ${name}`,
+    env_id: opt.env.id,
+    org_id: opt.app.organization.id,
+    variable_name: name
+  };
+  (0, _logging.debug)(`Request: Get environment variable ${JSON.stringify(name)} for ${(0, _logging.getEnvContext)(opt.app, opt.env)}`);
+  await (0, _tracker.trackEvent)('envvar_get_command_execute', trackingParams);
+  const envvar = await (0, _api.getEnvVar)(opt.app.id, opt.env.id, name).catch(async err => {
+    _rollbar.rollbar.error(err);
+
+    await (0, _tracker.trackEvent)('envvar_get_query_error', { ...trackingParams,
+      error: err.message
+    });
+    throw err;
+  });
+  await (0, _tracker.trackEvent)('envvar_get_command_success', trackingParams);
+
+  if (!envvar) {
+    const message = `The environment variable ${JSON.stringify(name)} does not exist`;
+    console.log(_chalk.default.yellow(message));
+    process.exit();
+  }
+
+  console.log(envvar.value);
+}
+
+(0, _command.default)({
+  appContext: true,
+  appQuery: _api.appQuery,
+  envContext: true,
+  requiredArgs: 1,
+  usage: `${baseUsage} <VARIABLE_NAME>`
+}).examples(examples).argv(process.argv, getEnvVarCommand);

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

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.listEnvVarsCommand = listEnvVarsCommand;
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _format = require("../lib/cli/format");
+
+var _api = require("../lib/envvar/api");
+
+var _logging = require("../lib/envvar/logging");
+
+var _rollbar = require("../lib/rollbar");
+
+var _tracker = require("../lib/tracker");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Internal dependencies
+ */
+const usage = 'vip config envvar list'; // Command examples
+
+const examples = [{
+  usage,
+  description: 'Lists all environment variables (names only)'
+}];
+
+async function listEnvVarsCommand(arg, opt) {
+  const trackingParams = {
+    app_id: opt.app.id,
+    command: usage,
+    env_id: opt.env.id,
+    format: opt.format,
+    org_id: opt.app.organization.id
+  };
+  (0, _logging.debug)(`Request: list environment variables for ${(0, _logging.getEnvContext)(opt.app, opt.env)}`);
+  await (0, _tracker.trackEvent)('envvar_list_command_execute', trackingParams);
+  const envvars = await (0, _api.listEnvVars)(opt.app.id, opt.env.id).catch(async err => {
+    _rollbar.rollbar.error(err);
+
+    await (0, _tracker.trackEvent)('envvar_list_query_error', { ...trackingParams,
+      error: err.message
+    });
+    throw err;
+  });
+  await (0, _tracker.trackEvent)('envvar_list_command_success', trackingParams);
+
+  if (0 === envvars.length) {
+    console.log(_chalk.default.yellow('There are no environment variables'));
+    process.exit();
+  } // Vary data by expected format.
+
+
+  let key = 'name';
+
+  if ('keyValue' === opt.format) {
+    key = 'key';
+  } else if ('ids' === opt.format) {
+    key = 'id';
+  } // Format as an object for formatData.
+
+
+  const envvarsObject = envvars.map(name => ({
+    [key]: name
+  }));
+  console.log((0, _format.formatData)(envvarsObject, opt.format));
+}
+
+(0, _command.default)({
+  appContext: true,
+  appQuery: _api.appQuery,
+  envContext: true,
+  format: true,
+  usage
+}).examples(examples).argv(process.argv, listEnvVarsCommand);

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

@@ -0,0 +1,112 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setEnvVarCommand = setEnvVarCommand;
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _api = require("../lib/envvar/api");
+
+var _input = require("../lib/envvar/input");
+
+var _logging = require("../lib/envvar/logging");
+
+var _readFile = require("../lib/envvar/read-file");
+
+var _rollbar = require("../lib/rollbar");
+
+var _tracker = require("../lib/tracker");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Internal dependencies
+ */
+const baseUsage = 'vip config envvar set'; // Command examples
+
+const examples = [{
+  usage: `${baseUsage} MY_VARIABLE`,
+  description: 'Sets the environment variable "MY_VARIABLE" and prompts for its value'
+}];
+
+async function setEnvVarCommand(arg, opt) {
+  // Help the user by uppercasing input.
+  const name = arg[0].trim().toUpperCase();
+  const trackingParams = {
+    app_id: opt.app.id,
+    command: `${baseUsage} ${name}`,
+    env_id: opt.env.id,
+    from_file: !!opt.fromFile,
+    org_id: opt.app.organization.id,
+    skip_confirm: !!opt.skipConfirmation,
+    variable_name: name
+  };
+  (0, _logging.debug)(`Request: Set environment variable ${JSON.stringify(name)} for ${(0, _logging.getEnvContext)(opt.app, opt.env)}`);
+  await (0, _tracker.trackEvent)('envvar_set_command_execute', trackingParams);
+
+  if (!(0, _api.validateNameWithMessage)(name)) {
+    await (0, _tracker.trackEvent)('envvar_set_invalid_name', trackingParams);
+    process.exit(1);
+  }
+
+  let value;
+
+  if (opt.fromFile) {
+    value = await (0, _readFile.readVariableFromFile)(opt.fromFile);
+  } else {
+    console.log(`For multiline input, use the ${_chalk.default.bold('--from-file')} option.`);
+    console.log();
+    value = await (0, _input.promptForValue)(`Enter the value for ${name}:`).catch(async () => {
+      await (0, _tracker.trackEvent)('envvar_set_user_cancelled_input', trackingParams);
+      (0, _input.cancel)();
+    });
+  }
+
+  if (!opt.skipConfirmation) {
+    // Print input if it was loaded from file.
+    if (opt.fromFile) {
+      console.log('===== Received value printed below =====');
+      console.log(value);
+      console.log('===== Received value printed above =====');
+      console.log();
+    }
+
+    if (!(await (0, _input.confirm)(`Please ${_chalk.default.bold('confirm')} the input value above (y/N)`))) {
+      await (0, _tracker.trackEvent)('envvar_set_user_cancelled_confirmation', trackingParams);
+      (0, _input.cancel)();
+    }
+  }
+
+  await (0, _api.setEnvVar)(opt.app.id, opt.env.id, name, value).catch(async err => {
+    _rollbar.rollbar.error(err);
+
+    await (0, _tracker.trackEvent)('envvar_set_mutation_error', { ...trackingParams,
+      error: err.message
+    });
+    throw err;
+  });
+  await (0, _tracker.trackEvent)('envvar_set_command_success', trackingParams);
+  console.log(_chalk.default.green(`Successfully set environment variable ${JSON.stringify(name)}`));
+}
+
+(0, _command.default)({
+  appContext: true,
+  appQuery: _api.appQuery,
+  envContext: true,
+  requiredArgs: 1,
+  usage: `${baseUsage} <VARIABLE_NAME>`
+}).option('from-file', 'Read environment variable value from file (useful for multiline input)').option('skip-confirmation', 'Skip manual confirmation of input (USE WITH CAUTION)', false).examples(examples).argv(process.argv, setEnvVarCommand);

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

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+(0, _command.default)({
+  requiredArgs: 1
+}).command('delete', 'Permanently delete an environment variable').command('get', 'Get the value of an environment variable').command('get-all', 'Get the values of all environment variable').command('list', 'List the names of all environment variables').command('set', 'Add or update an environment variable').argv(process.argv);