@automattic/vip 2.13.1 → 2.14.0

package/README.md

@@ -26,6 +26,13 @@ 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

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/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

@@ -140,7 +140,7 @@ async function healthcheckHook(app, lando) {
                 services: [container.service]
               }
             });
-          } catch (e) {
+          } catch (exception) {
             debug(`${container.service} Health check failed`);
             notHealthyContainers.push(container);
           }
@@ -272,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/validations/sql.js

@@ -41,6 +41,10 @@ function formatError(message) {
   return `${_chalk.default.red('SQL Error:')} ${message}`;
 }
 
+function formatWarning(message) {
+  return `${_chalk.default.yellow('Warning:')} ${message}`;
+}
+
 function formatRecommendation(message) {
   return `${_chalk.default.yellow('Recommendation:')} ${message}`;
 }
@@ -51,13 +55,24 @@ const generalCheckFormatter = check => {
   const validProblems = check.results.filter(result => !result.falsePositive);
 
   if (validProblems.length > 0) {
-    problemsFound += 1;
+    if (validProblems.some(result => !result.warning)) {
+      problemsFound += 1;
+    }
 
     for (const problem of validProblems) {
-      errors.push({
-        error: formatError(`${problem.text || check.message} on line ${problem.lineNumber || ''}.`),
-        recommendation: formatRecommendation(problem.recomendation || check.recommendation)
-      });
+      const text = `${problem.text || check.message} on line ${problem.lineNumber || ''}.`;
+
+      if (problem.warning) {
+        errors.push({
+          warning: formatWarning(text),
+          recommendation: formatRecommendation(problem.recomendation || check.recommendation)
+        });
+      } else {
+        errors.push({
+          error: formatError(text),
+          recommendation: formatRecommendation(problem.recomendation || check.recommendation)
+        });
+      }
     }
   } else {
     infos.push(`✅ ${check.message} was found 0 times.`);
@@ -268,6 +283,7 @@ const checks = {
       }
 
       return {
+        warning: true,
         lineNumber,
         recomendation: `Use '--search-replace="${foundDomain},${expectedDomain}"' switch to replace the domain`
       };
@@ -304,12 +320,21 @@ const postValidation = async options => {
 
   const errorSummary = {};
   const checkEntries = Object.entries(checks).filter(([type]) => !options.skipChecks.includes(type));
+  const formattedWarnings = [];
   let formattedErrors = [];
   let formattedInfos = [];
 
   for (const [type, check] of checkEntries) {
     const formattedOutput = check.outputFormatter(check, type, options.isImport);
-    formattedErrors = formattedErrors.concat(formattedOutput.errors);
+
+    for (const error of formattedOutput.errors) {
+      if (error.warning) {
+        formattedWarnings.push(error);
+      } else {
+        formattedErrors.push(error);
+      }
+    }
+
     formattedInfos = formattedInfos.concat(formattedOutput.infos);
     errorSummary[type] = check.results.length;
   } // eslint-disable-next-line camelcase
@@ -341,6 +366,21 @@ const postValidation = async options => {
     formattedErrors = formattedErrors.concat(errorObject);
   }
 
+  if (formattedWarnings.length) {
+    const warningOutput = [];
+    formattedWarnings.forEach(warning => {
+      warningOutput.push(warning.warning);
+
+      if (warning.recommendation) {
+        warningOutput.push(warning.recommendation);
+      }
+
+      warningOutput.push('');
+    });
+    console.log(warningOutput.join('\n'));
+    console.log('');
+  }
+
   if (problemsFound > 0) {
     await (0, _tracker.trackEvent)('import_validate_sql_command_failure', {
       is_import: options.isImport,

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.13.1",
+  "version": "2.14.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "2.13.1",
+  "version": "2.14.0",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {
@@ -72,7 +72,7 @@
   "license": "MIT",
   "engines": {
     "node": ">=14.14.0",
-    "npm": "^6 "
+    "npm": ">=6"
   },
   "bugs": {
     "url": "https://github.com/Automattic/vip/issues"