@automattic/vip 2.11.0 → 2.11.2

package/README.md

@@ -26,6 +26,14 @@ By default, we record information about the usage of this tool using an in-house
 
 ## Changelog
 
+### 2.11.2 (12 May 2022)
+
+- Hotfix to use correct production config.json in the NPM published package caused by a different NPM version in the build process.
+
+### 2.11.1 (12 May 2022)
+
+- Hotfix to use correct production config.json in the NPM published package
+
 ### 2.11.0 (11 May 2022)
 
 - #1022 [dev-env] Validate docker installed

package/config/config.json

@@ -1,6 +1,6 @@
 {
   "tracksUserType": "vip:user_id",
   "tracksAnonUserType": "anon",
-  "tracksEventPrefix": "vip_cli_dev_",
-  "environment": "development"
+  "tracksEventPrefix": "vip_cli_",
+  "environment": "production"
 }

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.11.0",
+  "version": "2.11.2",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package/dist/bin/vip-app-list.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+
+/**
+ * External dependencies
+ */
+"use strict";
+
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _api = _interopRequireDefault(require("../lib/api"));
+
+var _tracker = require("../lib/tracker");
+
+var _rollbar = require("../lib/rollbar");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Internal dependencies
+ */
+(0, _command.default)({
+  format: true
+}).argv(process.argv, async () => {
+  const api = await (0, _api.default)();
+  await (0, _tracker.trackEvent)('app_list_command_execute');
+  let response;
+
+  try {
+    response = await api.query({
+      // $FlowFixMe: gql template is not supported by flow
+      query: (0, _graphqlTag.default)`query Apps( $first: Int, $after: String ) {
+						apps( first: $first, after: $after ) {
+							total,
+							nextCursor
+							edges {
+								id,
+								name,
+								repo
+							}
+						}
+					}`,
+      variables: {
+        first: 100,
+        after: null // TODO make dynamic
+
+      }
+    });
+  } catch (err) {
+    const message = err.toString();
+    await (0, _tracker.trackEvent)('app_list_command_fetch_error', {
+      error: message
+    });
+
+    _rollbar.rollbar.error(err);
+
+    console.log('Failed to fetch apps: %s', message);
+    return;
+  }
+
+  if (!response || !response.data || !response.data.apps || !response.data.apps.edges || !response.data.apps.edges.length) {
+    const message = 'No apps found';
+    await (0, _tracker.trackEvent)('app_list_command_fetch_error', {
+      error: message
+    });
+    console.log(message);
+    return;
+  }
+
+  await (0, _tracker.trackEvent)('app_list_command_success');
+  return response.data.apps.edges;
+});

package/package/dist/bin/vip-app.js

@@ -0,0 +1,76 @@
+#!/usr/bin/env node
+
+/**
+ * External dependencies
+ */
+"use strict";
+
+var _chalk = _interopRequireDefault(require("chalk"));
+
+var _command = _interopRequireWildcard(require("../lib/cli/command"));
+
+var _app = _interopRequireDefault(require("../lib/api/app"));
+
+var _tracker = require("../lib/tracker");
+
+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 }; }
+
+/**
+ * Internal dependencies
+ */
+(0, _command.default)({
+  requiredArgs: 1,
+  format: true
+}).example('vip app <app>', 'Pass an app name or ID to get details about that app').example('vip app 123', 'Get details about the app with ID 123').example('vip app vip-test', 'Get details about the app named vip-test').command('list', 'List your VIP applications').argv(process.argv, async arg => {
+  await (0, _tracker.trackEvent)('app_command_execute');
+  let res;
+
+  try {
+    res = await (0, _app.default)(arg[0], 'id,repo,name,environments{id,appId,name,type,branch,currentCommit,primaryDomain{name},launched}');
+  } catch (err) {
+    await (0, _tracker.trackEvent)('app_command_fetch_error', {
+      error: `App ${arg[0]} does not exist`
+    });
+    console.log(`App ${_chalk.default.blueBright(arg[0])} does not exist`);
+    return;
+  }
+
+  if (!res || !res.environments) {
+    await (0, _tracker.trackEvent)('app_command_fetch_error', {
+      error: `App ${arg[0]} does not exist`
+    });
+    console.log(`App ${_chalk.default.blueBright(arg[0])} does not exist`);
+    return;
+  }
+
+  await (0, _tracker.trackEvent)('app_command_success'); // Clone the read-only response object so we can modify it
+
+  const clonedResponse = Object.assign({}, res);
+  const header = [{
+    key: 'id',
+    value: res.id
+  }, {
+    key: 'name',
+    value: res.name
+  }, {
+    key: 'repo',
+    value: res.repo
+  }];
+  clonedResponse.environments = clonedResponse.environments.map(env => {
+    const clonedEnv = Object.assign({}, env);
+    clonedEnv.name = (0, _command.getEnvIdentifier)(env); // Use the short version of git commit hash
+
+    clonedEnv.currentCommit = clonedEnv.currentCommit.substring(0, 7); // Flatten object
+
+    clonedEnv.primaryDomain = clonedEnv.primaryDomain.name;
+    return clonedEnv;
+  });
+  return {
+    header,
+    data: clonedResponse.environments
+  };
+});

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

@@ -0,0 +1,97 @@
+#!/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)}`));
+
+  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)({
+  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/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/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/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/package/dist/bin/vip-config-envvar-set.js

@@ -0,0 +1,123 @@
+#!/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';
+const NEW_RELIC_ENVVAR_KEY = 'NEW_RELIC_LICENSE_KEY'; // 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);
+  }
+
+  if (NEW_RELIC_ENVVAR_KEY === name) {
+    await (0, _tracker.trackEvent)('envvar_set_newrelic_key', trackingParams);
+    console.log(_chalk.default.bold.red('Setting the New Relic key is not permitted.'), 'If you want to set your own New Relic key, please contact our support team through the usual channels.');
+    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)}`));
+
+  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)({
+  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/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);