@automattic/vip 2.7.0-dev1 → 2.8.0-alpha

package/README.md

@@ -27,6 +27,13 @@ By default, we record information about the usage of this tool using an in-house
 
 ## Changelog
 
+### 2.7.0 (07 December 2021)
+- #941  [dev-env] Bump lando CLI dependency
+- #938  Hide roll back message after SQL Import failure for launched sites
+- #936  Sets jest maxWorkers to 4
+
+https://github.com/Automattic/vip/releases/tag/v2.7.0
+
 ### 2.6.0 (23 November 2021)
 - #921  [dev-env] Introuces update to change existing environment
 - #928  [dev-env] Switch lando to use our fork

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

@@ -36,7 +36,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
-const baseUsage = 'vip config envvar set'; // Command examples
+const baseUsage = 'vip config envvar set';
+const NEW_RELIC_ENVVAR_KEY = 'NEW_RELIC_LICENSE_KEY'; // Command examples
 
 const examples = [{
   usage: `${baseUsage} MY_VARIABLE`,
@@ -63,6 +64,12 @@ async function setEnvVarCommand(arg, opt) {
     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) {

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

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _devEnvironmentCore = require("../lib/dev-environment/dev-environment-core");
+
+var _devEnvironmentCli = require("../lib/dev-environment/dev-environment-cli");
+
+var _devEnvironment = require("../lib/constants/dev-environment");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const examples = [{
+  usage: `${_devEnvironment.DEV_ENVIRONMENT_FULL_COMMAND} list`,
+  description: 'Return information about all local dev environments'
+}];
+(0, _command.default)().examples(examples).argv(process.argv, async () => {
+  try {
+    await (0, _devEnvironmentCore.printAllEnvironmentsInfo)();
+  } catch (error) {
+    (0, _devEnvironmentCli.handleCLIException)(error);
+  }
+});

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

@@ -20,4 +20,4 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 (0, _command.default)({
   requiredArgs: 1
-}).command('create', 'Create a new local dev environment').command('update', 'Update an already created local dev environment').command('start', 'Start a local dev environment').command('stop', 'Stop a local dev environment').command('destroy', 'Remove containers, networks, volumes and configuration files of a local dev environment').command('info', 'Provides basic info about one or multiple local dev environments').command('exec', 'Execute an operation on a dev environment').command('import', 'Import data into a local WordPress environment').argv(process.argv);
+}).command('create', 'Create a new local dev environment').command('update', 'Update an already created local dev environment').command('start', 'Start a local dev environment').command('stop', 'Stop a local dev environment').command('destroy', 'Remove containers, networks, volumes and configuration files of a local dev environment').command('info', 'Provides basic info about one or multiple local dev environments').command('list', 'Provides basic info about all local dev environments').command('exec', 'Execute an operation on a dev environment').command('import', 'Import data into a local WordPress environment').argv(process.argv);

package/dist/bin/vip-logs.js

@@ -9,6 +9,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getLogs = getLogs;
+exports.followLogs = followLogs;
 exports.validateInputs = validateInputs;
 exports.appQuery = void 0;
 
@@ -18,7 +19,7 @@ var _rollbar = require("../lib/rollbar");
 
 var _tracker = require("../lib/tracker");
 
-var logsLib = _interopRequireWildcard(require("../lib/logs/logs"));
+var logsLib = _interopRequireWildcard(require("../lib/app-logs/app-logs"));
 
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
 
@@ -30,26 +31,25 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const LIMIT_MAX = 5000;
 const LIMIT_MIN = 1;
+const LIMIT_MAX = 5000;
 const ALLOWED_TYPES = ['app', 'batch'];
 const ALLOWED_FORMATS = ['csv', 'json', 'text'];
+const DEFAULT_POLLING_DELAY_IN_SECONDS = 30;
+const MIN_POLLING_DELAY_IN_SECONDS = 5;
+const MAX_POLLING_DELAY_IN_SECONDS = 300;
 
 async function getLogs(arg, opt) {
   validateInputs(opt.type, opt.limit, opt.format);
-  const trackingParams = {
-    command: 'vip logs',
-    org_id: opt.app.organization.id,
-    app_id: opt.app.id,
-    env_id: opt.env.id,
-    type: opt.type,
-    limit: opt.limit,
-    format: opt.format
-  };
+  const trackingParams = getBaseTrackingParams(opt);
   await (0, _tracker.trackEvent)('logs_command_execute', trackingParams);
-  let logs = [];
+  let logs;
 
   try {
+    if (opt.follow) {
+      return await followLogs(opt);
+    }
+
     logs = await logsLib.getRecentLogs(opt.app.id, opt.env.id, opt.type, opt.limit);
   } catch (error) {
     _rollbar.rollbar.error(error);
@@ -61,15 +61,91 @@ async function getLogs(arg, opt) {
   }
 
   await (0, _tracker.trackEvent)('logs_command_success', { ...trackingParams,
-    logs_output: logs.length
+    total: logs.nodes.length
   });
 
-  if (!logs.length) {
+  if (!logs.nodes.length) {
     console.error('No logs found');
     return;
-  } // Strip out __typename
+  }
+
+  printLogs(logs.nodes, opt.format);
+}
+
+async function followLogs(opt) {
+  let after = null;
+  let isFirstRequest = true; // How many times have we polled?
+
+  let requestNumber = 0;
+  const trackingParams = getBaseTrackingParams(opt); // Set an initial default delay
+
+  let delay = DEFAULT_POLLING_DELAY_IN_SECONDS;
+
+  while (true) {
+    const limit = isFirstRequest ? opt.limit : LIMIT_MAX;
+    requestNumber++;
+    trackingParams.request_number = requestNumber;
+    trackingParams.request_delay = delay;
+    trackingParams.limit = limit;
+    let logs;
+
+    try {
+      var _logs;
+
+      logs = await logsLib.getRecentLogs(opt.app.id, opt.env.id, opt.type, limit, after);
+      await (0, _tracker.trackEvent)('logs_command_follow_success', { ...trackingParams,
+        total: (_logs = logs) === null || _logs === void 0 ? void 0 : _logs.nodes.length
+      });
+    } catch (error) {
+      await (0, _tracker.trackEvent)('logs_command_follow_error', { ...trackingParams,
+        error: error.message
+      }); // If the first request fails we don't want to retry (it's probably not recoverable)
+
+      if (isFirstRequest) {
+        console.error('Error fetching initial logs');
+        break;
+      } // Increase the delay on errors to avoid overloading the server, up to a max of 5 minutes
 
 
+      delay += DEFAULT_POLLING_DELAY_IN_SECONDS;
+      delay = Math.min(delay, MAX_POLLING_DELAY_IN_SECONDS);
+      console.error(`Failed to fetch logs. Trying again in ${delay} seconds`);
+
+      _rollbar.rollbar.error(error);
+    }
+
+    if (logs) {
+      var _logs2, _logs3, _logs4;
+
+      if ((_logs2 = logs) !== null && _logs2 !== void 0 && _logs2.nodes.length) {
+        printLogs(logs.nodes, opt.format);
+      }
+
+      after = (_logs3 = logs) === null || _logs3 === void 0 ? void 0 : _logs3.nextCursor;
+      isFirstRequest = false; // Keep a sane lower limit of MIN_POLLING_DELAY_IN_SECONDS just in case something goes wrong in the server-side
+
+      delay = Math.max(((_logs4 = logs) === null || _logs4 === void 0 ? void 0 : _logs4.pollingDelaySeconds) || DEFAULT_POLLING_DELAY_IN_SECONDS, MIN_POLLING_DELAY_IN_SECONDS);
+    }
+
+    await new Promise(resolve => setTimeout(resolve, delay * 1000));
+  }
+}
+
+function getBaseTrackingParams(opt) {
+  return {
+    command: 'vip logs',
+    org_id: opt.app.organization.id,
+    app_id: opt.app.id,
+    env_id: opt.env.id,
+    type: opt.type,
+    limit: opt.limit,
+    follow: opt.follow || false,
+    format: opt.format
+  };
+}
+
+function printLogs(logs, format) {
+  // Strip out __typename
   logs = logs.map(log => {
     const {
       timestamp,
@@ -82,7 +158,7 @@ async function getLogs(arg, opt) {
   });
   let output = '';
 
-  if (opt.format && 'text' === opt.format) {
+  if (format && 'text' === format) {
     const rows = [];
 
     for (const {
@@ -93,7 +169,7 @@ async function getLogs(arg, opt) {
       output = rows.join('\n');
     }
   } else {
-    output = (0, _format.formatData)(logs, opt.format);
+    output = (0, _format.formatData)(logs, format);
   }
 
   console.log(output);
@@ -108,8 +184,8 @@ function validateInputs(type, limit, format) {
     exit.withError(`Invalid format: ${format}. The supported formats are: ${ALLOWED_FORMATS.join(', ')}.`);
   }
 
-  if (!Number.isInteger(limit) || limit < LIMIT_MIN || limit > LIMIT_MAX) {
-    exit.withError(`Invalid limit: ${limit}. It should be a number between ${LIMIT_MIN} and ${LIMIT_MAX}.`);
+  if (!Number.isInteger(limit) || limit < LIMIT_MIN || limit > logsLib.LIMIT_MAX) {
+    exit.withError(`Invalid limit: ${limit}. It should be a number between ${LIMIT_MIN} and ${logsLib.LIMIT_MAX}.`);
   }
 }
 
@@ -133,7 +209,7 @@ exports.appQuery = appQuery;
   appQuery,
   envContext: true,
   module: 'logs'
-}).option('type', 'The type of logs to be returned: "app" or "batch"', 'app').option('limit', 'The maximum number of log lines', 500).option('format', 'Output the log lines in CSV or JSON format', 'text').examples([{
+}).option('type', 'The type of logs to be returned: "app" or "batch"', 'app').option('limit', 'The maximum number of log lines', 500).option('follow', 'Keep fetching new logs as they are generated').option('format', 'Output the log lines in CSV or JSON format', 'text').examples([{
   usage: 'vip @mysite.production logs',
   description: 'Get the most recent app logs'
 }, {

package/dist/bin/vip-whoami.js

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.whoamiCommand = whoamiCommand;
+
+var _user = require("../lib/api/user");
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _tracker = require("../lib/tracker");
+
+var exit = _interopRequireWildcard(require("../lib/cli/exit"));
+
+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 }; }
+
+async function whoamiCommand() {
+  const trackingParams = {
+    command: 'vip whoami'
+  };
+  await (0, _tracker.trackEvent)('whoami_command_execute', trackingParams);
+  let currentUser = {};
+
+  try {
+    currentUser = await (0, _user.getCurrentUserInfo)();
+  } catch (err) {
+    await (0, _tracker.trackEvent)('whoami_command_error', { ...trackingParams,
+      error: err.message
+    });
+    exit.withError(`Failed to fetch information about the currently logged-in user error: ${err.message}`);
+  }
+
+  await (0, _tracker.trackEvent)('whoami_command_success', trackingParams);
+  const output = [`- Howdy ${currentUser.displayName}!`, `- Your user ID is ${currentUser.id}`];
+
+  if (currentUser.isVIP) {
+    output.push('- Your account has VIP Staff permissions');
+  }
+
+  console.log(output.join('\n'));
+}
+
+(0, _command.default)({
+  usage: 'vip whoami'
+}).examples([{
+  usage: 'vip whoami',
+  description: 'Display details about the currently logged-in user.'
+}]).argv(process.argv, whoamiCommand);

package/dist/bin/vip.js

@@ -48,7 +48,7 @@ const runCmd = async function () {
     await _token.default.purge();
     await (0, _tracker.trackEvent)('logout_command_execute');
     console.log('You are successfully logged out.');
-  }).command('app', 'List and modify your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('sync', 'Sync production to a development environment').command('wp', 'Run WP CLI commands against an environment');
+  }).command('app', 'List and modify your VIP applications').command('config', 'Set configuration for your VIP applications').command('dev-env', 'Use local dev-environment').command('import', 'Import media or SQL files into your VIP applications').command('logs', 'Get logs from your VIP applications').command('search-replace', 'Perform search and replace tasks on files').command('sync', 'Sync production to a development environment').command('whoami', 'Display details about the currently logged-in user').command('wp', 'Run WP CLI commands against an environment');
   cmd.argv(process.argv);
 };
 

package/dist/lib/api/user.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getCurrentUserInfo = getCurrentUserInfo;
+
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+
+var _api = _interopRequireDefault(require("../api"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+const QUERY_CURRENT_USER = (0, _graphqlTag.default)`
+	query Me {
+		me {
+			id
+			displayName
+			isVIP
+			organizationRoles {
+				nodes {
+					organizationId
+					roleId
+				}
+			}
+		}
+	}
+`;
+
+async function getCurrentUserInfo() {
+  const api = await (0, _api.default)();
+  const response = await api.query({
+    query: QUERY_CURRENT_USER
+  });
+  const {
+    data: {
+      me
+    }
+  } = response;
+
+  if (!me) {
+    throw new Error('The API did not return any information about the user.');
+  }
+
+  return me;
+}

package/dist/lib/api.js

@@ -52,7 +52,9 @@ function disableGlobalGraphQLErrorHandling() {
   globalGraphQLErrorHandlingEnabled = false;
 }
 
-async function API() {
+async function API({
+  exitOnError = true
+} = {}) {
   const authToken = await _token.default.get();
   const headers = {
     'User-Agent': _env.default.userAgent,
@@ -71,7 +73,10 @@ async function API() {
       graphQLErrors.forEach(error => {
         console.error(_chalk.default.red('Error:'), error.message);
       });
-      process.exit();
+
+      if (exitOnError) {
+        process.exit();
+      }
     }
   });
   const withToken = (0, _context.setContext)(async () => {

package/dist/lib/app-logs/app-logs.js

@@ -0,0 +1,70 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getRecentLogs = getRecentLogs;
+exports.LIMIT_MAX = void 0;
+
+var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
+
+var _api = _interopRequireDefault(require("../api"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+const LIMIT_MAX = 5000;
+exports.LIMIT_MAX = LIMIT_MAX;
+const QUERY_ENVIRONMENT_LOGS = (0, _graphqlTag.default)`
+	query GetAppLogs( $appId: Int, $envId: Int, $type: AppEnvironmentLogType, $limit: Int, $after: String ) {
+		app( id: $appId ) {
+			environments( id: $envId ) {
+				id
+				logs( type: $type, limit: $limit, after: $after ) {
+					nodes {
+						timestamp
+						message
+					}
+					nextCursor
+					pollingDelaySeconds
+				}
+			}
+		}
+	}
+`;
+
+async function getRecentLogs(appId, envId, type, limit, after) {
+  var _response$data, _response$data$app, _response$data$app$en;
+
+  const api = await (0, _api.default)({
+    exitOnError: false
+  });
+  const response = await api.query({
+    query: QUERY_ENVIRONMENT_LOGS,
+    variables: {
+      appId,
+      envId,
+      type,
+      limit,
+      after
+    }
+  });
+  const logs = response === null || response === void 0 ? void 0 : (_response$data = response.data) === null || _response$data === void 0 ? void 0 : (_response$data$app = _response$data.app) === null || _response$data$app === void 0 ? void 0 : (_response$data$app$en = _response$data$app.environments[0]) === null || _response$data$app$en === void 0 ? void 0 : _response$data$app$en.logs;
+
+  if (!(logs !== null && logs !== void 0 && logs.nodes)) {
+    throw new Error('Unable to query logs');
+  }
+
+  return logs;
+}

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

@@ -370,5 +370,5 @@ function addDevEnvConfigurationOptions(command) {
 }
 
 function getWordpressImageTags() {
-  return ['5.8.1', '5.8', '5.7.3', '5.7.2'];
+  return ['5.9', '5.8.3', '5.8.2', '5.8.1', '5.8', '5.7.3', '5.7.2'];
 }

package/dist/lib/site-import/status.js

@@ -48,6 +48,7 @@ const IMPORT_SQL_PROGRESS_QUERY = (0, _graphqlTag.default)`
 			environments(id: $envId) {
 				id
 				isK8sResident
+				launched
 				jobs(types: "sql_import") {
 					id
 					type
@@ -106,7 +107,8 @@ async function getStatus(api, appId, envId) {
   const [environment] = environments;
   const {
     importStatus,
-    jobs
+    jobs,
+    launched
   } = environment;
 
   if (!environment.isK8sResident && !(jobs !== null && jobs !== void 0 && jobs.length)) {
@@ -116,15 +118,16 @@ async function getStatus(api, appId, envId) {
   const [importJob] = jobs;
   return {
     importStatus,
-    importJob
+    importJob,
+    launched
   };
 }
 
-function getErrorMessage(importFailed) {
+function getErrorMessage(importFailed, launched = false) {
   debug({
     importFailed
   });
-  const rollbackMessage = `Your site is ${_chalk.default.blue('automatically being rolled back')} to the last backup prior to your import job.
+  const rollbackMessage = launched ? '' : `Your site is ${_chalk.default.blue('automatically being rolled back')} to the last backup prior to your import job.
 `;
   let message = importFailed.error;
 
@@ -262,7 +265,8 @@ ${maybeExitPrompt}
       }
 
       const {
-        importStatus
+        importStatus,
+        launched
       } = status;
       let {
         importJob
@@ -352,7 +356,8 @@ ${maybeExitPrompt}
 
       if (!jobSteps.length) {
         return reject({
-          error: 'Could not enumerate the import job steps'
+          error: 'Could not enumerate the import job steps',
+          launched
         });
       }
 
@@ -375,7 +380,8 @@ ${maybeExitPrompt}
           commandOutput: failedImportStep.output,
           error: 'Import step failed',
           stepName: failedImportStep.name,
-          errorText: failedImportStep.error
+          errorText: failedImportStep.error,
+          launched
         });
       }
 
@@ -385,7 +391,8 @@ ${maybeExitPrompt}
       if (jobStatus === 'error') {
         return reject({
           error: 'Import job failed',
-          steps: jobSteps
+          steps: jobSteps,
+          launched
         });
       }
 
@@ -425,7 +432,7 @@ ${maybeExitPrompt}
     progressTracker.print({
       clearAfter: true
     });
-    exit.withError(getErrorMessage(importFailed));
+    exit.withError(getErrorMessage(importFailed, importFailed.launched));
   }
 }