@automattic/vip 2.12.0 → 2.14.0

package/README.md

@@ -14,7 +14,7 @@ Then, launch the command and follow the prompts:
 vip
 ```
 
-If you need more information, check out our [VIP CLI documentation](https://docs.wpvip.com/technical-references/vip-cli/).
+If you need more information, check out our [VIP-CLI documentation](https://docs.wpvip.com/technical-references/vip-cli/).
 
 ## Contributing
 
@@ -26,6 +26,30 @@ By default, we record information about the usage of this tool using an in-house
 
 ## Changelog
 
+### 2.14.0 (19 Jul 2022)
+
+- #1059 Update engines to show support for npm > 6
+- #1058 [dev-env] switch dev-env error during import to warning
+- #1057 [dev-env] Update debug instruction example
+- #1055 [dev-env] Makes exec attempt to run the task even if env seems to be down
+
+### 2.13.1 (20 Jun 2022)
+
+- #1052 [dev-env] Update/lando compose version
+- #1045 README: Fix Typo `VIP CLI` => `VIP-CLI`
+- #1048 Switch to GitHub Actions
+
+### 2.13.0 (16 Jun 2022)
+
+- #1046	Add Cache Purge Command
+- #1050	[dev-env] Change docs link
+- #1047	[dev-env] Bump lando package
+- #1044	[dev-env] Fix healthchecks No. 2
+- #1043	[dev-env] add docker-compose v2 support
+- #1042	[dev-env] Fix search popup during wizard
+- #1038	[dev-env] Adds domain validation during sql import
+- #1040	[dev-env] track dev-env start time in seconds
+
 ### 2.12.0 (19 May 2022)
 
 - #1035 and #1032 Improved publishing checks to publish on npm
@@ -35,7 +59,7 @@ By default, we record information about the usage of this tool using an in-house
 - #1033 [dev-env] Bump lando in order to support node 18
 
 #### Special thanks
-frank-cerny for the contribution on #1036
+frank-cerny for the contribution on #999
 
 ### 2.11.2 (12 May 2022)
 
@@ -212,7 +236,7 @@ Fixes:
 - #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
+- #870 Add the VIP-CLI release process and release schedule
 
 Dependencies updates:
 

package/dist/bin/vip-cache-purge-url.js

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.cachePurgeCommand = cachePurgeCommand;
+
+var _cachePurge = require("../lib/api/cache-purge");
+
+var _command = _interopRequireDefault(require("../lib/cli/command"));
+
+var _tracker = require("../lib/tracker");
+
+var _readFile = require("../lib/read-file");
+
+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 }; }
+
+const examples = [{
+  usage: 'vip cache purge-url <URL>',
+  description: 'Purge a URL from page cache'
+}, {
+  usage: 'vip cache purge-url --from-file=/dev/vip/urls.txt',
+  description: 'Purge multiple URLs from page cache'
+}];
+
+async function cachePurgeCommand(urls = [], opt = {}) {
+  const trackingParams = {
+    app_id: opt.app.id,
+    command: 'vip cache purge-url',
+    env_id: opt.env.id,
+    from_file: !!opt.fromFile
+  };
+  await (0, _tracker.trackEvent)('cache_purge_url_command_execute', trackingParams);
+
+  if (opt.fromFile) {
+    const value = await (0, _readFile.readFromFile)(opt.fromFile);
+
+    if (value) {
+      urls = value.split('\n').map(url => url.trim());
+    }
+  }
+
+  if (!urls.length) {
+    await (0, _tracker.trackEvent)('cache_purge_url_command_error', { ...trackingParams,
+      error: 'No URL provided'
+    });
+    exit.withError('Please supply at least one URL.');
+  }
+
+  let purgeCacheObject = {};
+
+  try {
+    purgeCacheObject = await (0, _cachePurge.purgeCache)(opt.app.id, opt.env.id, urls);
+  } catch (err) {
+    await (0, _tracker.trackEvent)('cache_purge_url_command_error', { ...trackingParams,
+      error: err.message
+    });
+    exit.withError(`Failed to purge URL(s) from page cache: ${err.message}`);
+  }
+
+  await (0, _tracker.trackEvent)('cache_purge_url_command_success', trackingParams);
+  purgeCacheObject.urls.forEach(url => {
+    console.log(`- Purged URL: ${url}`);
+  });
+}
+
+(0, _command.default)({
+  appContext: true,
+  appQuery: _cachePurge.appQuery,
+  envContext: true,
+  wildcardCommand: true,
+  usage: 'vip cache purge-url <URL>'
+}).option('from-file', 'Read URLs from file (useful to purge multiple URLs)').examples(examples).argv(process.argv, cachePurgeCommand);

package/{package/dist/bin/vip-config.js → dist/bin/vip-cache.js}

@@ -1,5 +1,10 @@
 #!/usr/bin/env node
 
+/**
+ * 
+ * @format
+ */
+
 /**
  * External dependencies
  */
@@ -15,6 +20,4 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 (0, _command.default)({
   requiredArgs: 2
-}).command('envvar', 'Manage environment variables for an application environment').argv(process.argv, async () => {
-  process.exit(0);
-});
+}).command('purge-url', 'Purge page cache').argv(process.argv);

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

@@ -38,7 +38,11 @@ const examples = [{
 }];
 (0, _command.default)({
   wildcardCommand: true
-}).option('slug', 'Custom name of the dev environment').examples(examples).argv(process.argv, async (unmatchedArgs, opt) => {
+}).option('slug', 'Custom name of the dev environment').option('force', 'Disabling validations before task execution', 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));
+}).examples(examples).argv(process.argv, async (unmatchedArgs, opt) => {
   await (0, _devEnvironmentCli.validateDependencies)();
   const slug = (0, _devEnvironmentCli.getEnvironmentName)(opt);
   const trackingInfo = (0, _devEnvironmentCli.getEnvTrackingInfo)(slug);
@@ -59,7 +63,10 @@ const examples = [{
       arg = process.argv.slice(argSplitterIx + 1);
     }
 
-    await (0, _devEnvironmentCore.exec)(slug, arg);
+    const options = {
+      force: opt.force
+    };
+    await (0, _devEnvironmentCore.exec)(slug, arg, options);
     await (0, _tracker.trackEvent)('dev_env_exec_command_success', trackingInfo);
   } catch (error) {
     (0, _devEnvironmentCli.handleCLIException)(error, 'dev_env_exec_command_error', trackingInfo);

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

@@ -62,7 +62,14 @@ const examples = [{
     } = await (0, _devEnvironmentCore.resolveImportPath)(slug, fileName, searchReplace, inPlace);
 
     if (!opt.skipValidate) {
-      await (0, _sql.validate)(fileName, []);
+      const expectedDomain = `${slug}.vipdev.lndo.site`;
+      await (0, _sql.validate)(resolvedPath, {
+        isImport: false,
+        skipChecks: [],
+        extraCheckParams: {
+          siteHomeUrlLando: expectedDomain
+        }
+      });
     }
 
     const importArg = ['wp', 'db', 'import', inContainerPath];

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

@@ -66,7 +66,8 @@ const examples = [{
     }
 
     await (0, _devEnvironmentCore.startEnvironment)(slug, options);
-    const processingTime = new Date() - startProcessing;
+    const processingTime = Math.ceil((new Date() - startProcessing) / 1000); // in seconds
+
     const successTrackingInfo = { ...trackingInfo,
       processing_time: processingTime
     };

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

@@ -68,6 +68,7 @@ cmd.argv(process.argv, async (arg, opt) => {
       statsd: currentInstanceData.statsd,
       phpmyadmin: currentInstanceData.phpmyadmin,
       xdebug: currentInstanceData.xdebug,
+      enterpriseSearchEnabled: currentInstanceData.enterpriseSearchEnabled,
       mediaRedirectDomain: currentInstanceData.mediaRedirectDomain,
       multisite: false,
       title: ''

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('whoami', 'Display details about the currently logged-in user').command('wp', 'Run WP CLI commands against an environment');
+  }).command('app', 'List and modify your VIP applications').command('cache', 'Manage page cache for 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/cache-purge.js

@@ -0,0 +1,76 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.purgeCache = purgeCache;
+exports.appQuery = 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 mutation = (0, _graphqlTag.default)`
+	mutation PurgePageCacheMutation(
+		$appId: Int!
+		$envId: Int!
+		$urls: [String!]!
+	) {
+		purgePageCache( input: {
+			appId: $appId
+			environmentId: $envId
+			urls: $urls
+		} ) {
+			success
+			urls
+		}
+	}
+`; // The subquery for environments lets users choose any environment, including production.
+
+const appQuery = `
+	id
+	name
+	environments {
+		id
+		appId
+		name
+		primaryDomain {
+			name
+		}
+		type
+	}
+`;
+exports.appQuery = appQuery;
+
+async function purgeCache(appId, envId, urls) {
+  const api = await (0, _api.default)();
+  const variables = {
+    appId,
+    envId,
+    urls
+  };
+  const response = await api.mutate({
+    mutation,
+    variables
+  });
+  const {
+    data: {
+      purgePageCache
+    }
+  } = response;
+  return purgePageCache;
+}

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

@@ -91,9 +91,9 @@ async function handleCLIException(exception, trackKey, trackBaseInfo = {}) {
     }
 
     if (!process.env.DEBUG) {
-      console.log(`Please re-run the command with "--debug ${_chalk.default.bold('@automattic/vip:bin:dev-environment')}" appended to it and provide the stack trace on the support ticket.`);
+      console.log(`\nPlease re-run the command with "--debug ${_chalk.default.bold('@automattic/vip:bin:dev-environment')}" appended to it and provide the stack trace on the support ticket.`);
       console.log(_chalk.default.bold('\nExample:\n'));
-      console.log('vip dev-env create --debug @automattic/vip:bin:dev-environment \n');
+      console.log('vip dev-env <command> <arguments> --debug @automattic/vip:bin:dev-environment \n');
     }
 
     debug(exception);

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

@@ -213,8 +213,8 @@ async function printEnvironmentInfo(slug) {
   (0, _devEnvironmentCli.printTable)(appInfo);
 }
 
-async function exec(slug, args) {
-  debug('Will run a wp command on env', slug, 'with args', args);
+async function exec(slug, args, options = {}) {
+  debug('Will run a wp command on env', slug, 'with args', args, ' and options', options);
   const instancePath = getEnvironmentPath(slug);
   debug('Instance path for', slug, 'is:', instancePath);
 
@@ -231,7 +231,7 @@ async function exec(slug, args) {
     commandArgs = [...args.map(argument => argument.replace('--new-site-', '--'))];
   }
 
-  await (0, _devEnvironmentLando.landoExec)(instancePath, command, commandArgs);
+  await (0, _devEnvironmentLando.landoExec)(instancePath, command, commandArgs, options);
 }
 
 function doesEnvironmentExist(slug) {

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

@@ -110,14 +110,42 @@ function addHooks(app, lando) {
   app.events.on('post-start', 1, () => healthcheckHook(app, lando));
 }
 
+const healthChecks = {
+  database: 'mysql -uroot --silent --execute "SHOW DATABASES;"',
+  'vip-search': "curl -s --noproxy '*' -XGET localhost:9200",
+  php: '[[ -f /wp/wp-includes/pomo/mo.php ]]'
+};
+
 async function healthcheckHook(app, lando) {
   try {
     await lando.Promise.retry(async () => {
       const list = await lando.engine.list({
         project: app.project
       });
-      const containersWithHealthCheck = list.filter(container => container.status.includes('health'));
-      const notHealthyContainers = containersWithHealthCheck.filter(container => !container.status.includes('healthy'));
+      const notHealthyContainers = [];
+
+      for (const container of list) {
+        if (healthChecks[container.service]) {
+          try {
+            debug(`Testing ${container.service}: ${healthChecks[container.service]}`);
+            await app.engine.run({
+              id: container.id,
+              cmd: healthChecks[container.service],
+              compose: app.compose,
+              project: app.project,
+              opts: {
+                silent: true,
+                noTTY: true,
+                cstdio: 'pipe',
+                services: [container.service]
+              }
+            });
+          } catch (exception) {
+            debug(`${container.service} Health check failed`);
+            notHealthyContainers.push(container);
+          }
+        }
+      }
 
       if (notHealthyContainers.length) {
         for (const container of notHealthyContainers) {
@@ -185,7 +213,7 @@ async function landoInfo(instancePath) {
   } // Add documentation link
 
 
-  appInfo.Documentation = 'https://docs.wpvip.com/technical-references/vip-local-development-environment/tips/';
+  appInfo.Documentation = 'https://docs.wpvip.com/technical-references/vip-local-development-environment/';
   return appInfo;
 }
 
@@ -244,15 +272,18 @@ async function isEnvUp(app) {
   return (scanResult === null || scanResult === void 0 ? void 0 : scanResult.length) && scanResult.filter(result => result.status).length === scanResult.length;
 }
 
-async function landoExec(instancePath, toolName, args) {
+async function landoExec(instancePath, toolName, args, options) {
   const lando = new _lando.default(getLandoConfig());
   await lando.bootstrap();
   const app = lando.getApp(instancePath);
   await app.init();
-  const isUp = await isEnvUp(app);
 
-  if (!isUp) {
-    throw new Error('environment needs to be started before running wp command');
+  if (!options.force) {
+    const isUp = await isEnvUp(app);
+
+    if (!isUp) {
+      throw new Error('environment needs to be started before running wp command');
+    }
   }
 
   const tool = app.config.tooling[toolName];

package/dist/lib/envvar/read-file.js

@@ -5,15 +5,9 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.readVariableFromFile = readVariableFromFile;
 
-var _fs = require("fs");
-
-var exit = _interopRequireWildcard(require("../cli/exit"));
-
 var _logging = require("./logging");
 
-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; }
+var _readFile = require("../read-file");
 
 /**
  * 
@@ -29,15 +23,5 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
  */
 async function readVariableFromFile(path) {
   (0, _logging.debug)(`Loading variable value from file ${JSON.stringify(path)}`);
-  const data = await _fs.promises.readFile(path, 'binary').catch(({
-    message
-  }) => {
-    // Provide friendly version of common error.
-    if (message.startsWith('ENOENT: no such file or directory')) {
-      exit.withError(`Could not load file ${JSON.stringify(path)}.`);
-    }
-
-    exit.withError(message);
-  });
-  return Buffer.from(data).toString().trim();
+  return await (0, _readFile.readFromFile)(path);
 }

package/{package/dist/lib/envvar → dist/lib}/read-file.js

@@ -3,13 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.readVariableFromFile = readVariableFromFile;
+exports.readFromFile = readFromFile;
 
 var _fs = require("fs");
 
-var exit = _interopRequireWildcard(require("../cli/exit"));
-
-var _logging = require("./logging");
+var exit = _interopRequireWildcard(require("./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); }
 
@@ -27,8 +25,7 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 /**
  * Internal dependencies
  */
-async function readVariableFromFile(path) {
-  (0, _logging.debug)(`Loading variable value from file ${JSON.stringify(path)}`);
+async function readFromFile(path) {
   const data = await _fs.promises.readFile(path, 'binary').catch(({
     message
   }) => {