Merge pull request #92 from Automattic/integrate-compose

refactor: integrate `compose` plugin into lando and fix paths in `env_file`

Author: sjinks

.github/workflows/pr-plugins-installed.yml

@@ -101,7 +101,6 @@
     }
   },
   "dependencies": {
-    "@lando/compose": "1.0.0",
     "axios": "^1.7.2",
     "bluebird": "^3.4.1",
     "cli-table3": "^0.6.5",

package.json

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = lando => {};

plugins/lando-compose/index.js

@@ -0,0 +1,77 @@
+'use strict';
+
+// Modules
+const _ = require('lodash');
+const path = require('path');
+
+/*
+ * Helper method to get the host part of a volume
+ */
+exports.getHostPath = mount => _.dropRight(mount.split(':')).join(':');
+
+/*
+ * Helper method to normalize a path so that Lando overrides can be used as though
+ * the docker-compose files were in the app root.
+ */
+exports.normalizePath = (local, base = '.', excludes = []) => {
+  // Return local if it starts with $ or ~
+  if (_.startsWith(local, '$') || _.startsWith(local, '~')) return local;
+  // Return local if it is one of the excludes
+  if (_.includes(excludes, local)) return local;
+  // Return local if local is an absolute path
+  if (path.isAbsolute(local)) return local;
+  // Otherwise this is a relaive path so return local resolved by base
+  return path.resolve(path.join(base, local));
+};
+
+/*
+ * Helper to normalize overrides
+ */
+exports.normalizeOverrides = (overrides, base = '.', volumes = {}) => {
+  // Normalize any build paths
+  if (_.has(overrides, 'build')) {
+    if (_.isObject(overrides.build) && _.has(overrides, 'build.context')) {
+      overrides.build.context = exports.normalizePath(overrides.build.context, base);
+    } else {
+      overrides.build = exports.normalizePath(overrides.build, base);
+    }
+  }
+  // Normalize any volumes
+  if (_.has(overrides, 'volumes')) {
+    overrides.volumes = _.map(overrides.volumes, volume => {
+      if (!_.includes(volume, ':')) {
+        return volume;
+      } else {
+        const local = exports.getHostPath(volume);
+        const remote = _.last(volume.split(':'));
+        // @TODO: I don't think below does anything?
+        const excludes = _.keys(volumes).concat(_.keys(volumes));
+        const host = exports.normalizePath(local, base, excludes);
+        return [host, remote].join(':');
+      }
+    });
+  }
+
+  if (overrides.env_file) {
+    if (Array.isArray(overrides.env_file)) {
+      overrides.env_file = overrides.env_file.map(entry => {
+        if (typeof entry === 'string') {
+          return exports.normalizePath(entry, base);
+        }
+
+        if (typeof entry === 'object' && typeof entry.path === 'string') {
+          return {
+            ...entry,
+            path: exports.normalizePath(entry.path, base),
+          };
+        }
+
+        return entry;
+      });
+    } else {
+      overrides.env_file = exports.normalizePath(overrides.env_file, base);
+    }
+  }
+
+  return overrides;
+};

plugins/lando-compose/lib/utils.js

@@ -0,0 +1 @@
+name: "@lando/compose"

plugins/lando-compose/plugin.yml

@@ -0,0 +1,31 @@
+'use strict';
+
+// Modules
+const _ = require('lodash');
+const utils = require('./../../lib/utils');
+
+// Builder
+module.exports = {
+  name: 'compose',
+  config: {
+    version: 'custom',
+    services: {},
+    networks: {},
+    volumes: {},
+  },
+  parent: '_lando',
+  builder: (parent, config) => class LandoCompose extends parent {
+    constructor(id, options = {}) {
+      options = _.merge({}, config, options);
+      super(id, options, {
+        services: _.set(
+            {},
+            options.name,
+            utils.normalizeOverrides(options.services, options._app.root, options.volumes),
+        ),
+        networks: options.networks,
+        volumes: options.volumes,
+      });
+    };
+  },
+};

plugins/lando-compose/services/compose/builder.js

@@ -285,13 +285,6 @@
     "@jridgewell/resolve-uri" "^3.1.0"
     "@jridgewell/sourcemap-codec" "^1.4.14"
 
-"@lando/compose@1.0.0":
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/@lando/compose/-/compose-1.0.0.tgz#1e24bdfe39fb536f43e86aa179c4671d62ffb771"
-  integrity sha512-n7EelwK+1T22ueYiOWpniBo5508QJtGsXHENIdnew9e30T33GRUbXCeK7at+dv8CvpqgKsw76lD2Antna9b/Zg==
-  dependencies:
-    lodash "^4.17.21"
-
 "@nicolo-ribaudo/eslint-scope-5-internals@5.1.1-v1":
   version "5.1.1-v1"
   resolved "https://registry.yarnpkg.com/@nicolo-ribaudo/eslint-scope-5-internals/-/eslint-scope-5-internals-5.1.1-v1.tgz#dbf733a965ca47b1973177dc0bb6c889edcfb129"