@automattic/vip 3.9.4 → 3.9.6

package/assets/dev-env.lando.template.yml.ejs

@@ -19,18 +19,14 @@ services:
     type: compose
     services:
       image: ghcr.io/automattic/vip-container-images/dev-tools:0.9
-      command: /bin/true
       volumes:
         - devtools:/dev-tools
         - scripts:/scripts
-      environment:
-        LANDO_NO_USER_PERMS: 1
-        LANDO_NO_SCRIPTS: 1
-        LANDO_NEEDS_EXEC: 1
     volumes:
       devtools: {}
       scripts:
     initOnly: true
+    entrypoint: sh -c 'test -d /dev-tools-orig && /usr/bin/rsync -a --delete /dev-tools-orig/ /dev-tools/ || true'
 
   nginx:
     type: compose
@@ -38,14 +34,13 @@ services:
     sslExpose: false
     services:
       image: ghcr.io/automattic/vip-container-images/nginx:latest
-      command: nginx -g "daemon off;"
-      environment:
-        LANDO_NEEDS_EXEC: 1
-        LANDO_WEBROOT_USER: nginx
-        LANDO_WEBROOT_GROUP: nginx
       volumes:
         - ./nginx/extra.conf:/etc/nginx/conf.extra/extra.conf
 <% wpVolumes() %>
+      depends_on:
+        php:
+          condition: service_started
+    entrypoint: /usr/sbin/nginx -g "daemon off;"
 
   php:
     type: compose
@@ -66,6 +61,27 @@ services:
 <% } %>
         LANDO_NO_USER_PERMS: 'enable'
         LANDO_NEEDS_EXEC: 1
+      depends_on:
+        database:
+          condition: service_started
+        memcached:
+          condition: service_started
+<% if ( elasticsearch ) { %>
+        elasticsearch:
+          condition: service_started
+<% } %>
+        devtools:
+          condition: service_completed_successfully
+        wordpress:
+          condition: service_completed_successfully
+<% if ( muPlugins.mode == 'image' ) { %>
+        vip-mu-plugins:
+          condition: service_started
+<% } %>
+<% if ( appCode.mode == 'image' ) { %>
+        demo-app-code:
+          condition: service_completed_successfully
+<% } %>
       volumes:
         - type: volume
           source: devtools
@@ -175,8 +191,6 @@ services:
     type: compose
     services:
       image: ghcr.io/automattic/vip-container-images/wordpress:<%= wordpress.tag %>
-#      command: /usr/local/bin/entrypoint.sh
-      command: sh -c "rsync -a --chown=www-data:www-data /wp/ /shared/; sleep infinity"
       volumes:
         - ./wordpress:/shared
         - type: volume
@@ -184,10 +198,8 @@ services:
           target: /scripts
           volume:
             nocopy: true
-#      environment:
-#        LANDO_NO_SCRIPTS: 1
-#        LANDO_NEEDS_EXEC: 1
-#    initOnly: true
+    initOnly: true
+    entrypoint: /usr/bin/rsync -a --chown=${LANDO_HOST_USER_ID}:${LANDO_HOST_GROUP_ID} /wp/ /shared/
 
 <% if ( muPlugins.mode == 'image' ) { %>
   vip-mu-plugins:

package/dist/bin/vip-app.js

@@ -5,6 +5,7 @@ var _chalk = _interopRequireDefault(require("chalk"));
 var _app = _interopRequireDefault(require("../lib/api/app"));
 var _command = _interopRequireWildcard(require("../lib/cli/command"));
 var _tracker = require("../lib/tracker");
+var _utils = require("../lib/utils");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
@@ -20,14 +21,24 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
     await (0, _tracker.trackEvent)('app_command_fetch_error', {
       error: `App ${arg[0]} does not exist`
     });
-    console.log(`App ${_chalk.default.blueBright(arg[0])} does not exist`);
+
+    // Get error message, if available.
+    const apiErrorMsg = (0, _utils.parseApiError)(err);
+    let errorMsg = `Unable to locate app ${_chalk.default.blueBright(arg[0])}: `;
+    if (apiErrorMsg) {
+      errorMsg += apiErrorMsg;
+    } else {
+      // No error message, so let's include stack trace for debugging.
+      errorMsg += 'Unknown error. Please contact VIP support if this persists.\n' + err.stack;
+    }
+    console.log(errorMsg);
     return;
   }
   if (!res || !res.environments) {
     await (0, _tracker.trackEvent)('app_command_fetch_error', {
       error: `App ${arg[0]} does not exist`
     });
-    console.log(`App ${_chalk.default.blueBright(arg[0])} does not exist`);
+    console.log(`App ${_chalk.default.blueBright(arg[0])} was not found`);
     return;
   }
   await (0, _tracker.trackEvent)('app_command_success');

package/dist/lib/cli/command.js

@@ -17,6 +17,7 @@ var _package = _interopRequireDefault(require("../../../package.json"));
 var _api = _interopRequireDefault(require("../../lib/api"));
 var _app = _interopRequireDefault(require("../../lib/api/app"));
 var _tracker = require("../../lib/tracker");
+var _utils = require("../../lib/utils");
 var _userError = _interopRequireDefault(require("../user-error"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
@@ -214,7 +215,7 @@ _args.default.argv = async function (argv, cb) {
         await (0, _tracker.trackEvent)('command_appcontext_list_select_error', {
           error: 'Invalid app selected'
         });
-        exit.withError(`App ${_chalk.default.blueBright(appSelection.app.name)} does not exist`);
+        exit.withError(`App ${_chalk.default.blueBright(appSelection.app.name)} could not be located`);
       }
       await (0, _tracker.trackEvent)('command_appcontext_list_select_success');
       options.app = {
@@ -228,7 +229,17 @@ _args.default.argv = async function (argv, cb) {
         await (0, _tracker.trackEvent)('command_appcontext_param_error', {
           error: 'App lookup failed'
         });
-        exit.withError(`App ${_chalk.default.blueBright(options.app)} does not exist`);
+
+        // Get error message, if available.
+        const apiErrorMsg = (0, _utils.parseApiError)(err);
+        let errorMsg = `Unable to find app ${_chalk.default.blueBright(options.app)}: `;
+        if (apiErrorMsg) {
+          errorMsg += apiErrorMsg;
+        } else {
+          // Should happen rarely, if ever. Let's include stack trace for debugging.
+          errorMsg += 'Unknown error. If this persists, please contact VIP support.\n' + err.stack;
+        }
+        exit.withError(errorMsg);
       }
       if (!appLookup?.id) {
         await (0, _tracker.trackEvent)('command_appcontext_param_error', {

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

@@ -36,4 +36,4 @@ const DEV_ENVIRONMENT_DEFAULTS = exports.DEV_ENVIRONMENT_DEFAULTS = {
   multisite: false,
   phpVersion: Object.keys(DEV_ENVIRONMENT_PHP_VERSIONS)[0]
 };
-const DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_VERSION = '2.1.2';
+const DEV_ENVIRONMENT_VERSION = exports.DEV_ENVIRONMENT_VERSION = '2.1.3';

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

@@ -85,7 +85,11 @@ async function getLandoConfig() {
     userConfRoot: landoDir,
     home: fakeHomeDir,
     domain: 'vipdev.lndo.site',
-    version: 'unknown'
+    version: 'unknown',
+    env: {
+      LANDO_HOST_USER_ID: process.platform === 'win32' ? '1000' : `${(0, _nodeOs.userInfo)().uid}`,
+      LANDO_HOST_GROUP_ID: process.platform === 'win32' ? '1000' : `${(0, _nodeOs.userInfo)().gid}`
+    }
   };
   return (0, _bootstrap.buildConfig)(config);
 }
@@ -231,7 +235,6 @@ async function landoRebuild(lando, instancePath) {
   try {
     debug('Will rebuild lando app on path:', instancePath);
     const app = await getLandoApplication(lando, instancePath);
-    app.events.on('post-uninstall', async () => removeDevToolsVolumes(lando, app));
     await ensureNoOrphantProxyContainer(lando);
     await app.rebuild();
   } finally {
@@ -526,39 +529,6 @@ async function landoShell(lando, instancePath, service, user, command) {
   });
 }
 
-/**
- * Dev-tools volumes can get stale and is not updated when the new version of dev-tools
- * image is installed. Removing it during rebuild ensures the content is freshly populated
- * on startup.
- *
- * @param {Lando} lando
- * @param {App}   app
- */
-async function removeDevToolsVolumes(lando, app) {
-  debug('Attempting to removing dev-tools volumes');
-  const scanResult = await lando.engine.docker.listVolumes();
-  const devToolsVolumeNames = scanResult.Volumes.map(volume => volume.Name)
-  // eslint-disable-next-line security/detect-non-literal-regexp
-  .filter(volumeName => new RegExp(`${app.project}.*devtools`).test(volumeName));
-  debug('Will remove', devToolsVolumeNames);
-  const removalPromises = devToolsVolumeNames.map(volumeName => removeVolume(lando, volumeName));
-  await Promise.all(removalPromises);
-}
-
-/**
- * Remove volume
- */
-async function removeVolume(lando, volumeName) {
-  debug(`Removing devtools volume ${volumeName}`);
-  const devToolsVolume = lando.engine.docker.getVolume(volumeName);
-  try {
-    await devToolsVolume.remove();
-    debug(`${volumeName} volume removed`);
-  } catch (err) {
-    debug(`Failed to remove volume ${volumeName}`, err);
-  }
-}
-
 /**
  * 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

package/dist/lib/utils.js

@@ -3,6 +3,7 @@
 exports.__esModule = true;
 exports.getAbsolutePath = getAbsolutePath;
 exports.makeTempDir = makeTempDir;
+exports.parseApiError = parseApiError;
 exports.pollUntil = pollUntil;
 var _debug = _interopRequireDefault(require("debug"));
 var _fs = _interopRequireDefault(require("fs"));
@@ -74,4 +75,24 @@ function getAbsolutePath(filePath) {
     return _path.default.resolve(process.cwd(), filePath);
   }
   return filePath;
+}
+
+/**
+ * Parse error object and return probable error.
+ *
+ * @param {Error} Error object
+ *
+ * @return {string|null} Error string when error was found, otherwise null.
+ */
+function parseApiError(err) {
+  if (err?.networkError?.message) {
+    return err?.networkError?.message;
+  }
+  if (err?.graphQLErrors?.[0]?.message) {
+    return err.graphQLErrors[0].message;
+  }
+  if (err?.message) {
+    return err?.message;
+  }
+  return null;
 }

package/dist/lib/validations/sql.js

@@ -312,6 +312,17 @@ const checks = {
     message: 'ENGINE != InnoDB',
     excerpt: "'ENGINE=InnoDB' should be present (case-insensitive) for all tables",
     recommendation: "Ensure your application works with InnoDB and update your SQL dump to include only 'ENGINE=InnoDB' engine definitions in 'CREATE TABLE' statements. " + "We suggest you search for all 'ENGINE=X' entries and replace them with 'ENGINE=InnoDB'!"
+  },
+  autoIncrement: {
+    matcher: /\s(NOT NULL AUTO_INCREMENT,)/i,
+    matchHandler: (_lineNumber, results) => ({
+      text: results[1]
+    }),
+    outputFormatter: requiredCheckFormatter,
+    results: [],
+    message: 'AUTO_INCREMENT attribute',
+    excerpt: "'AUTO_INCREMENT attribute' should be present (case-insensitive) for all CREATE TABLE statements",
+    recommendation: 'Check import settings to include AUTO_INCREMENT attribute in all the CREATE TABLE statements'
   }
 };
 const DEV_ENV_SPECIFIC_CHECKS = ['useStatement', 'siteHomeUrlLando'];

package/docs/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Changelog
 
+### 3.9.5
+
+* fix: improve error handling and output
+* refactor(dev-env): make wordpress init-only container
+* refactor(dev-env): let dev-tools handle their volumes
+
+**Full Changelog**: https://github.com/Automattic/vip-cli/compare/3.9.4...3.9.5
+
 ### 3.9.4
 
 * fix(phpmyadmin): populate application name in App Query

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@automattic/vip",
-  "version": "3.9.4",
+  "version": "3.9.6",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@automattic/vip",
-      "version": "3.9.4",
+      "version": "3.9.6",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automattic/vip",
-  "version": "3.9.4",
+  "version": "3.9.6",
   "description": "The VIP Javascript library & CLI",
   "main": "index.js",
   "bin": {