@automattic/vip 2.22.0 → 2.24.0

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

@@ -3,35 +3,25 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.landoStart = landoStart;
-exports.landoRebuild = landoRebuild;
-exports.landoStop = landoStop;
+exports.bootstrapLando = bootstrapLando;
 exports.landoDestroy = landoDestroy;
-exports.landoInfo = landoInfo;
 exports.landoExec = landoExec;
-exports.validateDockerInstalled = validateDockerInstalled;
+exports.landoInfo = landoInfo;
+exports.landoRebuild = landoRebuild;
+exports.landoStart = landoStart;
+exports.landoStop = landoStop;
 exports.validateDockerAccess = validateDockerAccess;
-
+exports.validateDockerInstalled = validateDockerInstalled;
 var _debug = _interopRequireDefault(require("debug"));
-
 var _os = _interopRequireDefault(require("os"));
-
 var _path = _interopRequireDefault(require("path"));
-
 var _lando = _interopRequireDefault(require("lando/lib/lando"));
-
 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"));
-
 var _app = _interopRequireDefault(require("lando/lib/app"));
-
 var _userError = _interopRequireDefault(require("../user-error"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * 
  * @format
@@ -51,25 +41,22 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 const DEBUG_KEY = '@automattic/vip:bin:dev-environment';
 const debug = (0, _debug.default)(DEBUG_KEY);
 let landoConfRoot;
+
 /**
  * @returns {string} User configuration root directory (aka userConfRoot in Lando)
  */
-
 function getLandoUserConfigurationRoot() {
   if (!landoConfRoot) {
     landoConfRoot = _path.default.join(_os.default.tmpdir(), 'lando');
   }
-
   return landoConfRoot;
 }
+
 /**
  * @returns {object} Lando configuration
  */
-
-
 function getLandoConfig() {
   const landoPath = _path.default.join(__dirname, '..', '..', '..', 'node_modules', 'lando');
-
   debug(`Getting lando config, using path '${landoPath}' for plugins`);
   const isLandoDebugSelected = (process.env.DEBUG || '').includes(DEBUG_KEY);
   const isAllDebugSelected = process.env.DEBUG === '*';
@@ -84,41 +71,38 @@ function getLandoConfig() {
       subdir: '.'
     }],
     proxyName: 'vip-dev-env-proxy',
-    userConfRoot: getLandoUserConfigurationRoot()
+    userConfRoot: getLandoUserConfigurationRoot(),
+    home: ''
   };
 }
-
-async function landoStart(instancePath) {
-  debug('Will start lando app on path:', instancePath);
+async function bootstrapLando() {
   const lando = new _lando.default(getLandoConfig());
   await lando.bootstrap();
+  return lando;
+}
+async function landoStart(lando, instancePath) {
+  debug('Will start lando app on path:', instancePath);
   const app = lando.getApp(instancePath);
   await app.init();
   addHooks(app, lando);
   await app.start();
 }
-
-async function landoRebuild(instancePath) {
+async function landoRebuild(lando, instancePath) {
   debug('Will rebuild lando app on path:', instancePath);
-  const lando = new _lando.default(getLandoConfig());
-  await lando.bootstrap();
   const app = lando.getApp(instancePath);
   await app.init();
   await ensureNoOrphantProxyContainer(lando);
   addHooks(app, lando);
   await app.rebuild();
 }
-
 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 () => {
@@ -126,7 +110,6 @@ async function healthcheckHook(app, lando) {
         project: app.project
       });
       const notHealthyContainers = [];
-
       for (const container of list) {
         if (healthChecks[container.service]) {
           try {
@@ -149,12 +132,10 @@ async function healthcheckHook(app, lando) {
           }
         }
       }
-
       if (notHealthyContainers.length) {
         for (const container of notHealthyContainers) {
           console.log(`Waiting for service ${container.service} ...`);
         }
-
         return Promise.reject(notHealthyContainers);
       }
     }, {
@@ -167,35 +148,23 @@ async function healthcheckHook(app, lando) {
     }
   }
 }
-
-async function landoStop(instancePath) {
+async function landoStop(lando, instancePath) {
   debug('Will stop lando app on path:', instancePath);
-  const lando = new _lando.default(getLandoConfig());
-  await lando.bootstrap();
   const app = lando.getApp(instancePath);
   await app.init();
   await app.stop();
 }
-
-async function landoDestroy(instancePath) {
+async function landoDestroy(lando, instancePath) {
   debug('Will destroy lando app on path:', instancePath);
-  const lando = new _lando.default(getLandoConfig());
-  await lando.bootstrap();
   const app = lando.getApp(instancePath);
   await app.init();
   await app.destroy();
 }
-
-async function landoInfo(instancePath) {
+async function landoInfo(lando, instancePath) {
   var _app$info$find;
-
-  const lando = new _lando.default(getLandoConfig());
-  await lando.bootstrap();
   const app = lando.getApp(instancePath);
   await app.init();
-
   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(app);
@@ -207,20 +176,20 @@ async function landoInfo(instancePath) {
     ...extraService
   };
   delete appInfo.name;
-  appInfo.status = isUp ? _chalk.default.green('UP') : _chalk.default.yellow('DOWN'); // Add login information
+  appInfo.status = isUp ? _chalk.default.green('UP') : _chalk.default.yellow('DOWN');
 
+  // Add login information
   if (frontEndUrl) {
     const loginUrl = `${frontEndUrl}wp-admin/`;
     appInfo['Login URL'] = loginUrl;
     appInfo['Default username'] = 'vipgo';
     appInfo['Default password'] = 'password';
-  } // Add documentation link
-
+  }
 
+  // Add documentation link
   appInfo.Documentation = 'https://docs.wpvip.com/technical-references/vip-local-development-environment/';
   return appInfo;
 }
-
 const extraServiceDisplayConfiguration = [{
   name: 'vip-search',
   label: 'enterprise search',
@@ -230,27 +199,20 @@ const extraServiceDisplayConfiguration = [{
   // Skipping, as the phpmyadmin was already printed by the regular services
   skip: true
 }];
-
 async function getExtraServicesConnections(lando, app) {
   const extraServices = {};
   const allServices = await lando.engine.list({
     project: app.project
   });
-
   for (const service of allServices) {
     var _containerScan$Networ;
-
     const displayConfiguration = extraServiceDisplayConfiguration.find(conf => conf.name === service.service) || {};
-
     if (displayConfiguration.skip) {
       continue;
     }
-
     const containerScan = service !== null && service !== void 0 && service.id ? await lando.engine.docker.scan(service === null || service === void 0 ? void 0 : service.id) : null;
-
     if (containerScan !== null && containerScan !== void 0 && (_containerScan$Networ = containerScan.NetworkSettings) !== null && _containerScan$Networ !== void 0 && _containerScan$Networ.Ports) {
       const mappings = Object.keys(containerScan.NetworkSettings.Ports).map(internalPort => containerScan.NetworkSettings.Ports[internalPort]).filter(externalMapping => externalMapping === null || externalMapping === void 0 ? void 0 : externalMapping.length);
-
       if (mappings !== null && mappings !== void 0 && mappings.length) {
         const {
           HostIp: host,
@@ -262,56 +224,47 @@ async function getExtraServicesConnections(lando, app) {
       }
     }
   }
-
   return extraServices;
 }
-
 async function isEnvUp(app) {
   const reachableServices = app.info.filter(service => service.urls.length);
   const urls = reachableServices.map(service => service.urls).flat();
   const scanResult = await app.scanUrls(urls, {
     max: 1
-  }); // If all the URLs are reachable than the app is considered 'up'
-
+  });
+  // 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;
 }
-
-async function landoExec(instancePath, toolName, args, options) {
-  const lando = new _lando.default(getLandoConfig());
-  await lando.bootstrap();
+async function landoExec(lando, instancePath, toolName, args, options) {
   const app = lando.getApp(instancePath);
   await app.init();
-
   if (!options.force) {
     const isUp = await isEnvUp(app);
-
     if (!isUp) {
       throw new _userError.default('Environment needs to be started before running wp command');
     }
   }
-
   const tool = app.config.tooling[toolName];
-
   if (!tool) {
-    throw new Error('wp is not a known lando task');
+    throw new Error(`${toolName} is not a known lando task`);
   }
+
   /*
    lando is looking in both passed args and process.argv so we need to do a bit of hack to fake process.argv
    so that lando doesn't try to interpret args not meant for wp.
   	 Lando drops first 3 args (<node> <lando> <command>) from process.argv and process rest, so we will fake 3 args + the real args
   */
-
-
   process.argv = ['0', '1', '3'].concat(args);
   tool.app = app;
   tool.name = toolName;
   const task = (0, _build.default)(tool, lando);
   const argv = {
     _: args // eslint-disable-line
-
   };
+
   await task.run(argv);
 }
+
 /**
  * Sometimes the proxy network seems to disapper leaving only orphant stopped proxy container.
  * It seems to happen while restarting/powering off computer. This container would then failed
@@ -322,54 +275,37 @@ async function landoExec(instancePath, toolName, args, options) {
  *
  * @param {object} lando Bootstrapped Lando object
  */
-
-
 async function ensureNoOrphantProxyContainer(lando) {
   var _status$State;
-
   const proxyContainerName = lando.config.proxyContainer;
   const docker = lando.engine.docker;
   const containers = await docker.listContainers({
     all: true
   });
   const proxyContainerExists = containers.some(container => container.Names.includes(`/${proxyContainerName}`));
-
   if (!proxyContainerExists) {
     return;
   }
-
   const proxyContainer = await docker.getContainer(proxyContainerName);
   const status = await proxyContainer.inspect();
-
   if (status !== null && status !== void 0 && (_status$State = status.State) !== null && _status$State !== void 0 && _status$State.Running) {
     return;
   }
-
   await proxyContainer.remove();
 }
-
-async function validateDockerInstalled() {
-  const lando = new _lando.default(getLandoConfig());
-  await lando.bootstrap();
+async function validateDockerInstalled(lando) {
   lando.log.verbose('docker-engine exists: %s', lando.engine.dockerInstalled);
-
   if (lando.engine.dockerInstalled === false) {
     throw Error('docker could not be located! Please follow the following instructions to install it - https://docs.docker.com/engine/install/');
   }
-
   lando.log.verbose('docker-compose exists: %s', lando.engine.composeInstalled);
-
   if (lando.engine.composeInstalled === false) {
     throw Error('docker-compose could not be located! Please follow the following instructions to install it - https://docs.docker.com/compose/install/');
   }
 }
-
-async function validateDockerAccess() {
-  const lando = new _lando.default(getLandoConfig());
-  await lando.bootstrap();
+async function validateDockerAccess(lando) {
   const docker = lando.engine.docker;
   lando.log.verbose('Fetching docker info to verify user is in docker group');
-
   try {
     await docker.info();
   } catch (error) {

package/dist/lib/env.js

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _os = _interopRequireDefault(require("os"));
-
 var _package = _interopRequireDefault(require("../../package.json"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * External dependencies
  */
@@ -18,6 +14,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 const env = {
   app: {
     name: _package.default.name,

package/dist/lib/envvar/api-delete.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = deleteEnvVar;
-
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-
 var _api = _interopRequireDefault(require("../api"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -18,6 +15,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 const mutation = (0, _graphqlTag.default)`
 	mutation DeleteEnvironmentVariable(
 		$appId: Int!
@@ -41,7 +39,6 @@ const mutation = (0, _graphqlTag.default)`
 		}
 	}
 `;
-
 async function deleteEnvVar(appId, envId, name) {
   const api = await (0, _api.default)();
   const variables = {

package/dist/lib/envvar/api-get-all.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = getEnvVars;
-
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-
 var _api = _interopRequireDefault(require("../api"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -18,6 +15,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 const query = (0, _graphqlTag.default)`
 	query GetEnvironmentVariablesWithValues(
 		$appId: Int!
@@ -42,7 +40,6 @@ const query = (0, _graphqlTag.default)`
 		}
 	}
 `;
-
 async function getEnvVars(appId, envId) {
   const api = await (0, _api.default)();
   const variables = {

package/dist/lib/envvar/api-get.js

@@ -4,9 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = getEnvVar;
-
 var _apiGetAll = _interopRequireDefault(require("./api-get-all"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -16,6 +14,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 async function getEnvVar(appId, envId, name) {
   const envvars = await (0, _apiGetAll.default)(appId, envId);
   return envvars.find(({

package/dist/lib/envvar/api-list.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = listEnvVars;
-
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-
 var _api = _interopRequireDefault(require("../api"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -18,6 +15,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 const query = (0, _graphqlTag.default)`
 	query GetEnvironmentVariables(
 		$appId: Int!
@@ -40,8 +38,9 @@ const query = (0, _graphqlTag.default)`
 			}
 		}
 	}
-`; // List the names (but not values) of environment variables.
+`;
 
+// List the names (but not values) of environment variables.
 async function listEnvVars(appId, envId) {
   const api = await (0, _api.default)();
   const variables = {

package/dist/lib/envvar/api-set.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = setEnvVar;
-
 var _graphqlTag = _interopRequireDefault(require("graphql-tag"));
-
 var _api = _interopRequireDefault(require("../api"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
@@ -18,6 +15,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 const mutation = (0, _graphqlTag.default)`
 	mutation AddEnvironmentVariable(
 		$appId: Int!
@@ -42,7 +40,6 @@ const mutation = (0, _graphqlTag.default)`
 		}
 	}
 `;
-
 async function setEnvVar(appId, envId, name, value) {
   const api = await (0, _api.default)();
   const variables = {

package/dist/lib/envvar/api.js

@@ -3,8 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.validateName = validateName;
-exports.validateNameWithMessage = validateNameWithMessage;
+exports.appQuery = void 0;
 Object.defineProperty(exports, "deleteEnvVar", {
   enumerable: true,
   get: function () {
@@ -35,24 +34,16 @@ Object.defineProperty(exports, "setEnvVar", {
     return _apiSet.default;
   }
 });
-exports.appQuery = void 0;
-
+exports.validateName = validateName;
+exports.validateNameWithMessage = validateNameWithMessage;
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _logging = require("./logging");
-
 var _apiDelete = _interopRequireDefault(require("./api-delete"));
-
 var _apiGet = _interopRequireDefault(require("./api-get"));
-
 var _apiGetAll = _interopRequireDefault(require("./api-get-all"));
-
 var _apiList = _interopRequireDefault(require("./api-list"));
-
 var _apiSet = _interopRequireDefault(require("./api-set"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * 
  * @format
@@ -65,7 +56,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 // Reexport for convenience
+
 // The subquery for environments lets users choose any environment, including production.
 const appQuery = `
 	id
@@ -85,20 +78,16 @@ const appQuery = `
 	}
 `;
 exports.appQuery = appQuery;
-
 function validateName(name) {
   const sanitizedName = name.trim().toUpperCase().replace(/[^A-Z0-9_]/g, '');
   return name === sanitizedName && /^[A-Z]/.test(sanitizedName);
 }
-
 function validateNameWithMessage(name) {
   (0, _logging.debug)(`Validating environment variable name ${JSON.stringify(name)}`);
-
   if (!validateName(name)) {
     const message = ['Environment variable name must consist of A-Z, 0-9, or _,', 'and must start with an uppercase letter.'].join('\n');
     console.log(_chalk.default.bold.red(message));
     return false;
   }
-
   return true;
 }

package/dist/lib/envvar/input.js

@@ -6,13 +6,9 @@ Object.defineProperty(exports, "__esModule", {
 exports.cancel = cancel;
 exports.confirm = confirm;
 exports.promptForValue = promptForValue;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _enquirer = require("enquirer");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * 
  * @format
@@ -25,20 +21,18 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 function cancel() {
   console.log(_chalk.default.yellow('Command cancelled by user.'));
   process.exit();
 }
-
 function confirm(message) {
   return new _enquirer.BooleanPrompt({
     message
   }).run().catch(() => false);
 }
-
 async function promptForValue(message, mustMatch) {
   var _response$str;
-
   const response = await (0, _enquirer.prompt)({
     message,
     name: 'str',
@@ -47,7 +41,6 @@ async function promptForValue(message, mustMatch) {
       if (mustMatch && input !== mustMatch) {
         return `Please type ${mustMatch} to proceed or ESC to cancel`;
       }
-
       return true;
     }
   });

package/dist/lib/envvar/logging.js

@@ -3,15 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getEnvContext = getEnvContext;
 exports.debug = void 0;
-
+exports.getEnvContext = getEnvContext;
 var _debug = _interopRequireDefault(require("debug"));
-
 var _command = require("../cli/command");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * 
  * @format
@@ -24,10 +20,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 // Shared debugger.
 const debug = (0, _debug.default)('@automattic/vip:bin:config:envvar');
 exports.debug = debug;
-
 function getEnvContext(app, env) {
   return `@${app.id}.${(0, _command.getEnvIdentifier)(env)}`;
 }

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

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.readVariableFromFile = readVariableFromFile;
-
 var _logging = require("./logging");
-
 var _readFile = require("../read-file");
-
 /**
  * 
  * @format
@@ -21,6 +18,7 @@ var _readFile = require("../read-file");
 /**
  * Internal dependencies
  */
+
 async function readVariableFromFile(path) {
   (0, _logging.debug)(`Loading variable value from file ${JSON.stringify(path)}`);
   return await (0, _readFile.readFromFile)(path);