@automattic/vip 2.6.0 → 2.7.1

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-logs.js

@@ -0,0 +1,151 @@
+#!/usr/bin/env node
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getLogs = getLogs;
+exports.validateInputs = validateInputs;
+exports.appQuery = void 0;
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _rollbar = require("../lib/rollbar");
+
+var _tracker = require("../lib/tracker");
+
+var logsLib = _interopRequireWildcard(require("../lib/app-logs/app-logs"));
+
+var exit = _interopRequireWildcard(require("../lib/cli/exit"));
+
+var _format = require("../lib/cli/format");
+
+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 }; }
+
+const LIMIT_MAX = 5000;
+const LIMIT_MIN = 1;
+const ALLOWED_TYPES = ['app', 'batch'];
+const ALLOWED_FORMATS = ['csv', 'json', 'text'];
+
+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
+  };
+  await (0, _tracker.trackEvent)('logs_command_execute', trackingParams);
+  let logs = [];
+
+  try {
+    logs = await logsLib.getRecentLogs(opt.app.id, opt.env.id, opt.type, opt.limit);
+  } catch (error) {
+    _rollbar.rollbar.error(error);
+
+    await (0, _tracker.trackEvent)('logs_command_error', { ...trackingParams,
+      error: error.message
+    });
+    return exit.withError(error.message);
+  }
+
+  await (0, _tracker.trackEvent)('logs_command_success', { ...trackingParams,
+    logs_output: logs.length
+  });
+
+  if (!logs.length) {
+    console.error('No logs found');
+    return;
+  } // Strip out __typename
+
+
+  logs = logs.map(log => {
+    const {
+      timestamp,
+      message
+    } = log;
+    return {
+      timestamp,
+      message
+    };
+  });
+  let output = '';
+
+  if (opt.format && 'text' === opt.format) {
+    const rows = [];
+
+    for (const {
+      timestamp,
+      message
+    } of logs) {
+      rows.push(`${timestamp} ${message}`);
+      output = rows.join('\n');
+    }
+  } else {
+    output = (0, _format.formatData)(logs, opt.format);
+  }
+
+  console.log(output);
+}
+
+function validateInputs(type, limit, format) {
+  if (!ALLOWED_TYPES.includes(type)) {
+    exit.withError(`Invalid type: ${type}. The supported types are: ${ALLOWED_TYPES.join(', ')}.`);
+  }
+
+  if (!ALLOWED_FORMATS.includes(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}.`);
+  }
+}
+
+const appQuery = `
+	id
+	name
+	environments {
+		id
+		appId
+		name
+		type
+	}
+	organization {
+		id
+		name
+	}
+`;
+exports.appQuery = appQuery;
+(0, _command.default)({
+  appContext: true,
+  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([{
+  usage: 'vip @mysite.production logs',
+  description: 'Get the most recent app logs'
+}, {
+  usage: 'vip @mysite.production logs --type batch',
+  description: 'Get the most recent batch logs'
+}, {
+  usage: 'vip @mysite.production logs --limit 100',
+  description: 'Get the most recent 100 log entries'
+}, {
+  usage: 'vip @mysite.production logs --limit 100 --format csv',
+  description: 'Get the most recent 100 log entries formatted as comma-separated values (CSV)'
+}, {
+  usage: 'vip @mysite.production logs --limit 100 --format json',
+  description: 'Get the most recent 100 log entries formatted as JSON'
+}]).argv(process.argv, getLogs);

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('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('wp', 'Run WP CLI commands against an environment');
   cmd.argv(process.argv);
 };
 

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

@@ -0,0 +1,62 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getRecentLogs = getRecentLogs;
+
+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_ENVIRONMENT_LOGS = (0, _graphqlTag.default)`
+	query GetAppLogs( $appId: Int, $envId: Int, $type: AppEnvironmentLogType, $limit: Int ) {
+		app( id: $appId ) {
+			environments( id: $envId ) {
+				id
+				logs( type: $type, limit: $limit ) {
+					nodes {
+						timestamp
+						message
+					}
+				}
+			}
+		}
+	}
+`;
+
+async function getRecentLogs(appId, envId, type, limit) {
+  var _response$data, _response$data$app, _response$data$app$en, _response$data$app$en2;
+
+  const api = await (0, _api.default)();
+  const response = await api.query({
+    query: QUERY_ENVIRONMENT_LOGS,
+    variables: {
+      appId,
+      envId,
+      type,
+      limit
+    }
+  });
+  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$en2 = _response$data$app$en.logs) === null || _response$data$app$en2 === void 0 ? void 0 : _response$data$app$en2.nodes;
+
+  if (!logs) {
+    throw new Error('Unable to query logs');
+  }
+
+  return logs;
+}

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));
   }
 }