@automattic/vip 2.26.0 → 2.26.2

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

@@ -93,7 +93,7 @@ async function stopEnvironment(lando, slug) {
 }
 async function createEnvironment(instanceData) {
   const slug = instanceData.siteSlug;
-  debug('Will create an environment', slug, 'with instanceData: ', instanceData);
+  debug('Will process an environment', slug, 'with instanceData for creation: ', instanceData);
   const instancePath = getEnvironmentPath(slug);
   debug('Instance path for', slug, 'is:', instancePath);
   const alreadyExists = _fs.default.existsSync(instancePath);
@@ -101,11 +101,12 @@ async function createEnvironment(instanceData) {
     throw new Error('Environment already exists.');
   }
   const preProcessedInstanceData = preProcessInstanceData(instanceData);
+  debug('Will create an environment', slug, 'with instanceData: ', preProcessedInstanceData);
   await prepareLandoEnv(preProcessedInstanceData, instancePath);
 }
 async function updateEnvironment(instanceData) {
   const slug = instanceData.siteSlug;
-  debug('Will update an environment', slug, 'with instanceData: ', instanceData);
+  debug('Will process an environment', slug, 'with instanceData for updating: ', instanceData);
   const instancePath = getEnvironmentPath(slug);
   debug('Instance path for', slug, 'is:', instancePath);
   const alreadyExists = _fs.default.existsSync(instancePath);
@@ -113,6 +114,7 @@ async function updateEnvironment(instanceData) {
     throw new Error('Environment doesn\'t exist.');
   }
   const preProcessedInstanceData = preProcessInstanceData(instanceData);
+  debug('Will create an environment', slug, 'with instanceData: ', preProcessedInstanceData);
   await prepareLandoEnv(preProcessedInstanceData, instancePath);
 }
 function preProcessInstanceData(instanceData) {
@@ -128,6 +130,9 @@ function preProcessInstanceData(instanceData) {
   if (newInstanceData.php.startsWith('image:')) {
     newInstanceData.php = newInstanceData.php.slice('image:'.length);
   }
+  if (isNaN(instanceData.wordpress.tag)) {
+    newInstanceData.wordpress.tag = 'trunk';
+  }
   if (!newInstanceData.xdebugConfig) {
     newInstanceData.xdebugConfig = '';
   }
@@ -142,6 +147,11 @@ function preProcessInstanceData(instanceData) {
   if (!newInstanceData.mailhog) {
     newInstanceData.mailhog = false;
   }
+
+  // MariaDB migration
+  if (!newInstanceData.mariadb) {
+    newInstanceData.mariadb = undefined;
+  }
   return newInstanceData;
 }
 async function destroyEnvironment(lando, slug, removeFiles) {
@@ -198,7 +208,7 @@ async function printEnvironmentInfo(lando, slug, options) {
   if (!environmentExists) {
     throw new _userError.default(_devEnvironment.DEV_ENVIRONMENT_NOT_FOUND);
   }
-  const appInfo = await (0, _devEnvironmentLando.landoInfo)(lando, instancePath);
+  const appInfo = await (0, _devEnvironmentLando.landoInfo)(lando, instancePath, !!options.suppressWarnings);
   if (options.extended) {
     const environmentData = readEnvironmentData(slug);
     appInfo.title = environmentData.wpTitle;

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

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.bootstrapLando = bootstrapLando;
+exports.checkEnvHealth = checkEnvHealth;
 exports.isEnvUp = isEnvUp;
 exports.landoDestroy = landoDestroy;
 exports.landoExec = landoExec;
@@ -18,6 +19,7 @@ var _os = _interopRequireDefault(require("os"));
 var _fs = _interopRequireDefault(require("fs"));
 var _path = _interopRequireDefault(require("path"));
 var _lando = _interopRequireDefault(require("lando/lib/lando"));
+var _bootstrap = require("lando/lib/bootstrap");
 var _utils = _interopRequireDefault(require("lando/plugins/lando-core/lib/utils"));
 var _build = _interopRequireDefault(require("lando/plugins/lando-tooling/lib/build"));
 var _chalk = _interopRequireDefault(require("chalk"));
@@ -48,7 +50,7 @@ async function getLandoConfig() {
   const nodeModulesPath = _path.default.join(__dirname, '..', '..', '..', 'node_modules');
   const landoPath = _path.default.join(nodeModulesPath, 'lando');
   const atLandoPath = _path.default.join(nodeModulesPath, '@lando');
-  debug(`Getting lando config, using paths '${landoPath}' and '${atLandoPath}' for plugins`);
+  debug(`Getting Lando config, using paths '${landoPath}' and '${atLandoPath}' for plugins`);
   const isLandoDebugSelected = _debug.default.enabled(DEBUG_KEY);
   const isAllDebugSelected = _debug.default.enabled('"*"');
   let logLevelConsole;
@@ -69,8 +71,9 @@ async function getLandoConfig() {
   } catch (err) {
     // Ignore
   }
-  return {
+  const config = {
     logLevelConsole,
+    configSources: [_path.default.join(landoDir, 'config.yml')],
     landoFile: '.lando.yml',
     preLandoFiles: ['.lando.base.yml', '.lando.dist.yml', '.lando.upstream.yml'],
     postLandoFiles: ['.lando.local.yml'],
@@ -92,6 +95,7 @@ async function getLandoConfig() {
     domain: 'lndo.site',
     version: 'unknown'
   };
+  return (0, _bootstrap.buildConfig)(config);
 }
 const appMap = new Map();
 async function regenerateLandofile(instancePath) {
@@ -102,7 +106,7 @@ async function regenerateLandofile(instancePath) {
     await _fs.default.promises.rename(landoFile, backup);
     console.warn(_chalk.default.yellow('Backed up %s to %s'), landoFile, backup);
   } catch (err) {
-    // Rename failed - possible the file does not exist. Silently ignoring.
+    // Rename failed - possibly the file does not exist. Silently ignoring.
   }
   const slug = _path.default.basename(instancePath);
   const currentInstanceData = (0, _devEnvironmentCore.readEnvironmentData)(slug);
@@ -138,7 +142,7 @@ async function getLandoApplication(lando, instancePath) {
   let app;
   try {
     app = lando.getApp(instancePath);
-    addHooks(app, lando);
+    await addHooks(app, lando);
     await app.init();
   } catch (error) {
     app = await landoRecovery(lando, instancePath, error);
@@ -162,7 +166,7 @@ async function landoRebuild(lando, instancePath) {
   await ensureNoOrphantProxyContainer(lando);
   await app.rebuild();
 }
-function addHooks(app, lando) {
+async function addHooks(app, lando) {
   app.events.on('post-start', 1, () => healthcheckHook(app, lando));
   lando.events.once('pre-engine-build', async data => {
     const instanceData = (0, _devEnvironmentCore.readEnvironmentData)(app._name);
@@ -249,13 +253,13 @@ async function landoDestroy(lando, instancePath) {
   const app = await getLandoApplication(lando, instancePath);
   await app.destroy();
 }
-async function landoInfo(lando, instancePath) {
+async function landoInfo(lando, instancePath, suppressWarnings) {
   var _app$info$find;
   const app = await getLandoApplication(lando, instancePath);
   let appInfo = _utils.default.startTable(app);
   const reachableServices = app.info.filter(service => service.urls.length);
   reachableServices.forEach(service => appInfo[`${service.service} urls`] = service.urls);
-  const isUp = await isEnvUp(lando, instancePath);
+  const health = await checkEnvHealth(lando, instancePath);
   const frontEndUrl = (_app$info$find = app.info.find(service => 'nginx' === service.service)) === null || _app$info$find === void 0 ? void 0 : _app$info$find.urls[0];
   const extraService = await getExtraServicesConnections(lando, app);
   appInfo = {
@@ -264,7 +268,15 @@ async function landoInfo(lando, instancePath) {
     ...extraService
   };
   delete appInfo.name;
-  appInfo.status = isUp ? _chalk.default.green('UP') : _chalk.default.yellow('DOWN');
+  const hasResults = Object.values(health).length > 0;
+  const hasWarnings = Object.values(health).some(status => !status);
+  if (hasResults && !hasWarnings) {
+    appInfo.status = _chalk.default.green('UP');
+  } else if (health.nginx) {
+    appInfo.status = _chalk.default.yellow('PARTIALLY UP');
+  } else {
+    appInfo.status = _chalk.default.red('DOWN');
+  }
 
   // Add login information
   if (frontEndUrl) {
@@ -273,6 +285,15 @@ async function landoInfo(lando, instancePath) {
     appInfo['Default username'] = 'vipgo';
     appInfo['Default password'] = 'password';
   }
+  if (!suppressWarnings && hasWarnings) {
+    let message = _chalk.default.bold.yellow('The following services have failed health checks:\n');
+    Object.keys(health).forEach(service => {
+      if (!health[service]) {
+        message += `${_chalk.default.red(service)}\n`;
+      }
+    });
+    appInfo['Health warnings'] = message;
+  }
 
   // Add documentation link
   appInfo.Documentation = 'https://docs.wpvip.com/technical-references/vip-local-development-environment/';
@@ -286,6 +307,9 @@ const extraServiceDisplayConfiguration = [{
   name: 'phpmyadmin',
   // Skipping, as the phpmyadmin was already printed by the regular services
   skip: true
+}, {
+  name: 'mailhog',
+  skip: true
 }];
 async function getExtraServicesConnections(lando, app) {
   const extraServices = {};
@@ -316,19 +340,39 @@ async function getExtraServicesConnections(lando, app) {
   }
   return extraServices;
 }
+async function checkEnvHealth(lando, instancePath) {
+  const urls = {};
+  const now = new Date();
+  const app = await getLandoApplication(lando, instancePath);
+  app.info.filter(service => service.urls.length).forEach(service => {
+    service.urls.forEach(url => {
+      urls[url] = service.service;
+    });
+  });
+  const scanResults = await app.scanUrls(Object.keys(urls), {
+    max: 1
+  });
+  const result = {};
+  scanResults.forEach(scanResult => {
+    result[urls[scanResult.url]] = scanResult.status;
+  });
+  const duration = new Date().getTime() - now.getTime();
+  debug('checkEnvHealth took %d ms', duration);
+  return result;
+}
 async function isEnvUp(lando, instancePath) {
   const now = new Date();
   const app = await getLandoApplication(lando, instancePath);
   const reachableServices = app.info.filter(service => service.urls.length);
-  const urls = reachableServices.map(service => service.urls).flat();
-  const scanResult = await app.scanUrls(urls, {
+  const webUrls = reachableServices.map(service => service.urls).flat().filter(url => !url.match(/^https?:\/\/(localhost|127\.0\.0\.1):/));
+  const scanResult = await app.scanUrls(webUrls, {
     max: 1
   });
   const duration = new Date().getTime() - now.getTime();
   debug('isEnvUp took %d ms', duration);
 
   // If all the URLs are reachable then the app is considered 'up'
-  return (scanResult === null || scanResult === void 0 ? void 0 : scanResult.length) && scanResult.filter(result => result.status).length === scanResult.length;
+  return scanResult.length && scanResult.filter(result => result.status).length === scanResult.length;
 }
 async function landoExec(lando, instancePath, toolName, args, options) {
   const app = await getLandoApplication(lando, instancePath);

package/dist/lib/search-and-replace.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.getReadAndWriteStreams = getReadAndWriteStreams;
 exports.searchAndReplace = void 0;
 var _fs = _interopRequireDefault(require("fs"));
-var _os = _interopRequireDefault(require("os"));
 var _path = _interopRequireDefault(require("path"));
 var _chalk = _interopRequireDefault(require("chalk"));
 var _debug = _interopRequireDefault(require("debug"));
@@ -15,6 +14,7 @@ var _tracker = require("../lib/tracker");
 var _prompt = require("../lib/cli/prompt");
 var _clientFileUploader = require("../lib/client-file-uploader");
 var exit = _interopRequireWildcard(require("../lib/cli/exit"));
+var _utils = require("./utils");
 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 }; }
@@ -37,11 +37,6 @@ const flatten = arr => {
     return flat.concat(Array.isArray(toFlatten) ? flatten(toFlatten) : toFlatten);
   }, []);
 };
-function makeTempDir() {
-  const tmpDir = _fs.default.mkdtempSync(_path.default.join(_os.default.tmpdir(), 'vip-search-replace-'));
-  debug(`Created a directory to hold temporary files: ${tmpDir}`);
-  return tmpDir;
-}
 function getReadAndWriteStreams({
   fileName,
   inPlace,
@@ -51,7 +46,7 @@ function getReadAndWriteStreams({
   let usingStdOut = false;
   let outputFileName;
   if (inPlace) {
-    const midputFileName = _path.default.join(makeTempDir(), _path.default.basename(fileName));
+    const midputFileName = _path.default.join((0, _utils.makeTempDir)('vip-search-replace'), _path.default.basename(fileName));
     _fs.default.copyFileSync(fileName, midputFileName);
     debug(`Copied input file to ${midputFileName}`);
     debug(`Set output to the original file path ${fileName}`);
@@ -81,7 +76,7 @@ function getReadAndWriteStreams({
       break;
     default:
       {
-        const tmpOutFile = _path.default.join(makeTempDir(), _path.default.basename(fileName));
+        const tmpOutFile = _path.default.join((0, _utils.makeTempDir)('vip-search-replace'), _path.default.basename(fileName));
         writeStream = _fs.default.createWriteStream(tmpOutFile);
         outputFileName = tmpOutFile;
         debug(`Outputting to file: ${outputFileName}`);

package/dist/lib/utils.js

@@ -3,7 +3,28 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.makeTempDir = makeTempDir;
 exports.pollUntil = pollUntil;
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _os = _interopRequireDefault(require("os"));
+var _debug = _interopRequireDefault(require("debug"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * 
+ * @format
+ */
+
+/**
+ * External dependencies
+ */
+
+/**
+ * Internal dependencies
+ */
+
+const debug = (0, _debug.default)('@automattic/vip:lib:utils');
+
 /**
  * Polls a function until its return value satisfies a condition
  *
@@ -25,4 +46,24 @@ async function pollUntil(fn, interval, isDone) {
     // eslint-disable-next-line no-await-in-loop
     await new Promise(res => setTimeout(res, interval));
   }
+}
+
+/**
+ * Create a temporary directory in the system's temp directory
+ *
+ * @param {string} prefix Prefix for the directory name
+ * @return {string}				Path to the temporary directory
+ * @throws {Error} 				If the directory cannot be created
+ */
+function makeTempDir(prefix = 'vip-cli') {
+  const tempDir = _fs.default.mkdtempSync(_path.default.join(_os.default.tmpdir(), `${prefix}-`));
+  debug(`Created a directory to hold temporary files: ${tempDir}`);
+  process.on('exit', () => {
+    _fs.default.rmSync(tempDir, {
+      recursive: true,
+      force: true
+    });
+    debug(`Removed temporary directory: ${tempDir}`);
+  });
+  return tempDir;
 }