@automattic/vip 4.1.5 → 4.1.8

package/node_modules/lando/bin/lando.js

@@ -1,18 +1,15 @@
 #!/usr/bin/env node
 
 /**
- * Main CLI entrypoint to use the lando libraries
+ * Main CLI entrypoint to use the lando libraries.
  * This file is meant to be linked as a "lando" executable.
- *
- * @NOTE: We are duplicating a lot of code here because its less expensive than requiring our lando libs and
- * the users have a need for speed
- *
+ * We duplicate a small amount of setup code here because it is cheaper than
+ * requiring the full Lando runtime before command dispatch.
  * @name lando
  */
 
 'use strict';
 // Minimal modules we need to get the cli rolling
-const argv = require('@lando/argv');
 const fs = require('fs');
 const bootstrap = require('./../lib/bootstrap');
 const path = require('path');
@@ -29,80 +26,6 @@ const cli = new Cli(ENVPREFIX, LOGLEVELCONSOLE, USERCONFROOT);
 // Assemble the lando config here so we have correct knowledge of things
 // like the landofile names
 const landoConfig = bootstrap.buildConfig(cli.defaultConfig());
-// Start by grabbing the hyperdrive config if we can
-const hconf = fs.existsSync(landoConfig.hconf) ? require(landoConfig.hconf) : {};
-const binPath = landoConfig.env['_'];
-
-// if we have a version mismatch then regenerate it
-if (!hconf[binPath] || (landoConfig.version !== hconf[binPath].version)) {
-  const yaml = require('js-yaml');
-  // get config things we need
-  const {landoFile, preLandoFiles, postLandoFiles, version, envPrefix, product} = landoConfig;
-  // get lando config
-  // @NOTE: right now we just hardcode these in there, in L4 we will actually use the users config
-  const globalDir = path.join(landoConfig.userConfRoot, 'plugins');
-  const pluginDirs = [
-    {type: 'core', dir: 'plugins', depth: 1},
-    {type: 'core', dir: path.join('node_modules', '@lando'), depth: 1},
-    {type: 'global', dir: globalDir, depth: 2},
-  ];
-
-  const plugins = pluginDirs
-      .filter(dir => dir.type === 'core')
-      .map(dir => ([dir.dir, fs.readdirSync(path.resolve(__dirname, '..', dir.dir))]))
-      .map(dir => dir[1].map(plugin => path.join(dir[0], plugin)))
-      .flat(Number.POSITIVE_INFINITY)
-      .map(dir => ({
-        location: `lando://${dir}`,
-        manifest: path.join(__dirname, '..', dir, 'plugin.yml'),
-        pjson: path.join(__dirname, '..', dir, 'package.json'),
-      }))
-      .filter(plugin => fs.existsSync(plugin.manifest))
-    .map(plugin => Object.assign(plugin, { // eslint-disable-line
-        manifest: yaml.load(fs.readFileSync(plugin.manifest)),
-        pjson: fs.existsSync(plugin.pjson) ? require(plugin.pjson) : {},
-      }))
-      .map(plugin => ({
-        name: plugin.manifest.name || plugin.pjson.name,
-        package: plugin.manifest.name || plugin.pjson.name,
-        deprecated: plugin.deprecated === true,
-        hidden: plugin.hidden === true,
-        location: plugin.location,
-        type: 'core',
-        version: plugin.manifest.version || plugin.pjson.version || version,
-        isValid: true,
-        isInstalled: true,
-      }));
-
-  // get app config
-  const extension = `.${landoFile.split('.')[landoFile.split('.').length -1]}`;
-  const namespace = path.basename(landoFile, extension);
-  const landofiles = preLandoFiles.concat([namespace]).concat(postLandoFiles)
-      .map(file => file.replace(namespace, ''))
-      .map(file => file.replace(extension, ''))
-      .map(file => file.replace('.', ''));
-
-  // assemble
-  hconf[binPath] = {
-    lando: {globalDir, plugins, pluginDirs, version, envPrefix, product},
-    app: {landofile: namespace, landofiles,
-    }};
-  // dump
-  fs.mkdirSync(path.dirname(landoConfig.hconf), {recursive: true});
-  fs.writeFileSync(landoConfig.hconf, JSON.stringify(hconf, null, 2));
-}
-
-// If --hyperdrive is passed in then print out the hyperdrive config and exit
-// @NOTE: we do this to minimize the time taken to fully bootstrap lando
-if (argv.hasOption(`--${landoConfig.hyperdrive}`)) {
-  // we need to make process.stdout and process.stderr blocking so that process.stdout drains completely before
-  // process.exit is called
-  // see: https://github.com/nodejs/node/issues/6379
-  process.stdout._handle.setBlocking(true);
-  process.stderr._handle.setBlocking(true);
-  process.stdout.write(JSON.stringify(hconf));
-  process.exit(0);
-}
 
 const _ = require('lodash');
 const landoFile = landoConfig.landoFile;
@@ -118,9 +41,6 @@ process.landoTaskCacheName = '_.tasks.cache';
 process.landoTaskCacheFile = path.join(cli.defaultConfig().userConfRoot, 'cache', process.landoTaskCacheName);
 process.landoAppTaskCacheFile = !_.isEmpty(config) ? config.toolingCache : undefined;
 
-// Check for sudo usage
-cli.checkPerms();
-
 // Check to see if we have a recipe and if it doesn't have a tooling cache lets enforce a manual cache clear
 if (bsLevel === 'APP' && !fs.existsSync(config.toolingCache)) {
   if (fs.existsSync(process.landoTaskCacheFile)) fs.unlinkSync(process.landoTaskCacheFile);

package/node_modules/lando/config.yml

@@ -1,5 +1,4 @@
 product: lando
-hyperdrive: hyperdrive
 channel: stable
 domain: lndo.site
 mode: cli

package/node_modules/lando/eslint.config.mjs

@@ -35,4 +35,8 @@ export default [
       'require-jsdoc': 'off',
     }
   },
+  {
+    files: ['lib/esm/**/*.js'],
+    languageOptions: {sourceType: 'module'},
+  },
 ];

package/node_modules/lando/examples/django/.lando.yml

@@ -1,7 +1,7 @@
 name: lando-django
 services:
   appserver:
-    type: python
+    type: python:3.11
     build:
       - pip install -r requirements.txt
 tooling:

package/node_modules/lando/examples/django/README.md

@@ -25,7 +25,7 @@ Run the following commands to validate things are rolling as they should.
 
 ```bash
 # Should be able to run django-admin without errors
-lando django-admin --version | grep "^2."
+lando django-admin --version | grep "^4."
 ```
 
 Destroy tests

package/node_modules/lando/examples/django/requirements.txt

@@ -1,4 +1,4 @@
 # requirements.txt
 
-Django>=2.0,<3.0
+Django>=4.2.26,<5.0
 psycopg2>=2.7,<3.0

package/node_modules/lando/examples/sql-export/README.md

@@ -35,8 +35,13 @@ lando db-import -h database2 test2.sql
 lando psqlverify | grep users
 
 # Should be able to export the contents of the dbs
+rm -f database.*.sql database.*.sql.gz
 lando db-export
+gzip -t database.*.sql.gz
+rm database.*.sql.gz
 lando db-export -h database2
+gzip -t database.*.sql.gz
+rm database.*.sql.gz
 
 # Should export to filename if specified
 lando db-export database.dump.sql

package/node_modules/lando/lib/app.js

@@ -8,8 +8,35 @@ const path = require('path');
 const Promise = require('./promise');
 const utils = require('./utils');
 
-/*
- * Helper to init and then report
+/**
+ * App config loaded from a Landofile plus bootstrap metadata.
+ * @typedef {object} AppConfig
+ * @property {object} [config] Recipe or service config overrides.
+ * @property {string[]} [compose] Compose file paths.
+ * @property {string[]} [env_file] Environment file paths.
+ * @property {string[]} files Source config files.
+ */
+
+/**
+ * Compose data group tracked on an app instance.
+ * @typedef {object} ComposeGroup
+ * @property {object[]} data Compose documents in this group.
+ * @property {string} id Group identifier.
+ * @property {object} [info] Extra metadata about the group.
+ */
+
+/**
+ * @typedef {object} AppWarning
+ * @property {string} title Warning title.
+ * @property {string} [message] Warning details.
+ * @property {string} [severity] Warning severity.
+ */
+
+/**
+ * Initializes an app before a lifecycle operation continues.
+ * @param {App} app App instance.
+ * @param {string} [method] Lifecycle method name.
+ * @returns {Promise<boolean>} Promise resolving after initialization.
  */
 const initAndReport = (app, method = 'start') => {
   return app.init().then(() => {
@@ -17,8 +44,11 @@ const initAndReport = (app, method = 'start') => {
   });
 };
 
-/*
- * Helper to load in all app plugins
+/**
+ * Loads app plugins and merges their data onto the app.
+ * @param {App} app App instance.
+ * @param {import('./lando')} lando Lando instance.
+ * @returns {Promise} Promise resolving after plugin data is merged.
  */
 const loadPlugins = (app, lando) => {
   app.appPlugins = [];
@@ -38,15 +68,15 @@ const loadPlugins = (app, lando) => {
 
 /**
  * The class to instantiate a new App
- *
  * @since 3.0.0
  * @name app
- * @param {String} name Name of the app
- * @param {Object} config Config for the app
- * @param {Object} [lando={}] A Lando instance
- * @return {App} An App instance
  */
 module.exports = class App {
+  /**
+   * @param {string} name Name of the app.
+  * @param {AppConfig} config Config for the app.
+  * @param {import('./lando')} [lando] A Lando instance.
+   */
   constructor(name, config, lando = {}) {
     const AsyncEvents = require('./events');
     const bootstrap = require('./bootstrap');
@@ -56,7 +86,6 @@ module.exports = class App {
 
     /**
      * The apps name
-     *
      * @since 3.0.0
      * @alias app.name
      */
@@ -68,31 +97,26 @@ module.exports = class App {
     this._name = name;
     /**
      * The apps logger
-     *
      * @since 3.0.0
      * @alias app.log
      */
     /**
      * The apps engine
-     *
      * @since 3.0.0
      * @alias app.engine
      */
     /**
      * The apps event emitter
-     *
      * @since 3.0.0
      * @alias app.events
      */
     /**
      * The apps url scanner
-     *
      * @since 3.0.0
      * @alias app.scanUrl
      */
     /**
      * The apps shell
-     *
      * @since 3.0.0
      * @alias app.shell
      */
@@ -101,7 +125,9 @@ module.exports = class App {
     } else {
       this.log = new Log(_.merge({}, lando.config, {logName: this.name}));
     }
+    /** @type {Shell} */
     this.shell = new Shell(this.log);
+    /** @type {import('./engine')} */
     this.engine = bootstrap.setupEngine(
         lando.config,
         lando.cache,
@@ -111,12 +137,12 @@ module.exports = class App {
         lando.config.instance,
     );
     this.Promise = lando.Promise;
+    /** @type {AsyncEvents} */
     this.events = new AsyncEvents(this.log);
     this.scanUrls = scan(this.log);
 
     /**
      * The apps configuration
-     *
      * @since 3.0.0
      * @alias app.config
      */
@@ -128,7 +154,6 @@ module.exports = class App {
 
     /**
      * Information about this app
-     *
      * @since 3.0.0
      * @alias app.info
      */
@@ -142,14 +167,12 @@ module.exports = class App {
 
     /**
      * The apps root directory
-     *
      * @since 3.0.0
      * @alias app.root
      */
     this.root = path.dirname(this.configFiles[0]);
     /**
      * Tasks and commands the app can run
-     *
      * @since 3.0.0
      * @alias app.tasks
      */
@@ -160,16 +183,22 @@ module.exports = class App {
     this.id = hasher(`${this.name}-${this.root}`);
   }
 
-  /*
-   * @TODO, add compose data to the add
+  /**
+   * Adds compose data to the app, optionally at the front of the list.
+    * @param {ComposeGroup} data Compose fragment to add.
+   * @param {boolean} [front] Whether to prepend instead of append.
+   * @returns {void} No return value.
    */
   add(data, front = false) {
     if (front) this.composeData.unshift(data);
     else this.composeData.push(data);
   }
 
-  /*
-   * @TODO, add and log a warning
+  /**
+   * Records a warning or error on the app and updates the exit code when needed.
+   * @param {AppWarning} message Warning payload.
+   * @param {Error|string|null} [error] Optional backing error.
+   * @returns {void} No return value.
    */
   addWarning(message, error = null) {
     // Do special handling if this is an error
@@ -188,12 +217,9 @@ module.exports = class App {
 
   /**
    * Hard removes all app services, volumes, networks, etc.
-   *
    * This differs from `uninstall` in that uninstall will only soft remove all app
    * services, while maintaining things like volumes, networks, etc.
-   *
    * That said this DOES call both `stop` and `uninstall` under the hood.
-   *
    * @since 3.0.0
    * @alias app.destroy
    * @fires pre_destroy
@@ -202,7 +228,7 @@ module.exports = class App {
    * @fires pre_uninstall
    * @fires post_uninstall
    * @fires post_destroy
-   * @return {Promise} A Promise
+   * @returns {Promise} A promise.
    */
   destroy() {
     // Start it off
@@ -211,9 +237,7 @@ module.exports = class App {
 
     /**
      * Event that runs before an app is destroyed.
-     *
      * @since 3.0.0
-     * @alias app.events:pre-destroy
      * @event pre_destroy
      */
         .then(() => this.events.emit('pre-destroy'))
@@ -225,9 +249,7 @@ module.exports = class App {
 
     /**
      * Event that runs after an app is destroyed.
-     *
      * @since 3.0.0
-     * @alias app.events:post-destroy
      * @event post_destroy
      */
         .then(() => this.events.emit('post-destroy'))
@@ -236,16 +258,14 @@ module.exports = class App {
 
   /**
    * Initializes the app
-   *
    * You will want to run this to get the app ready for lando.engine. This will
    * load in relevant app plugins, build the docker compose files and get them ready to go
-   *
    * @since 3.0.0
    * @alias app.init
    * @fires pre_init
    * @fires post_init
    * @fires ready
-   * @return {Promise} A Promise.
+   * @returns {Promise} A promise.
    */
   init() {
     // We should only need to initialize once, if we have just go right to app ready
@@ -265,11 +285,9 @@ module.exports = class App {
      *
      * Note that this is a global event so it is invoked with `lando.events.on`
      * not `app.events.on` See example below:
-     *
      * @since 3.0.0
-     * @alias app.events:pre-init
      * @event pre_init
-     * @property {App} app The app instance.
+    * @property {App} app The app instance.
      */
     return loadPlugins(this, this._lando).then(() => this.events.emit('pre-init', this))
 
@@ -283,11 +301,9 @@ module.exports = class App {
     /**
      * Event that allows altering of the app object right after it has been
      * full initialized and all its plugins have been loaded.
-     *
      * @since 3.0.0
-     * @alias app.events:post-init
      * @event post_init
-     * @property {App} app The app instance.
+    * @property {App} app The app instance.
      */
         .then(() => this.events.emit('post-init', this))
     // Finish up
@@ -306,22 +322,18 @@ module.exports = class App {
         })
     /**
      * Event that runs when the app is ready for action
-     *
      * @since 3.0.0
-     * @alias app.events:ready
      * @event ready
-     * @property {App} app The app instance.
+    * @property {App} app The app instance.
      */
         .then(() => this.events.emit('ready', this));
   }
 
   /**
    * Rebuilds an app.
-   *
    * This will stop an app, soft remove its services, rebuild those services and
    * then, finally, start the app back up again. This is useful for developers who
    * might want to tweak Dockerfiles or compose yamls.
-   *
    * @since 3.0.0
    * @alias app.rebuild
    * @fires pre_stop
@@ -332,7 +344,7 @@ module.exports = class App {
    * @fires post_rebuild
    * @fires pre_start
    * @fires post_start
-   * @return {Promise} A Promise.
+   * @returns {Promise} A promise.
    */
   rebuild() {
     // Start it off
@@ -341,8 +353,7 @@ module.exports = class App {
 
     /**
      * Event that runs before an app is rebuilt.
-     *
-     * @alias app.events:pre-rebuild
+     * @since 3.0.0
      * @event pre_rebuild
      */
         .then(() => this.events.emit('pre-rebuild'))
@@ -356,35 +367,31 @@ module.exports = class App {
         .then(() => this.start())
     /**
      * Event that runs after an app is rebuilt.
-     *
      * @since 3.0.0
-     * @alias app.events:post-rebuild
      * @event post_rebuild
      */
         .then(() => this.events.emit('post-rebuild'))
         .then(() => this.log.info('rebuilt app.'));
   }
 
-  /*
-  * @TODO
-  */
+  /**
+   * Resets cached initialization state.
+   * @returns {void} No return value.
+   */
   reset() {
     this.initialized = false;
   }
 
   /**
    * Stops and then starts an app.
-   *
    * This just runs `app.stop` and `app.start` in succession.
-   *
    * @since 3.0.0
    * @alias app.restart
    * @fires pre_stop
    * @fires post_stop
    * @fires pre_start
    * @fires post_start
-   * @param {Object} app - A fully instantiated app object
-   * @return {Promise} A Promise.
+   * @returns {Promise} A promise.
    */
   restart() {
     // Start it off
@@ -397,15 +404,12 @@ module.exports = class App {
 
   /**
    * Starts an app.
-   *
    * This will start up all services/containers that have been defined for this app.
-   *
    * @since 3.0.0
    * @alias app.start
    * @fires pre_start
    * @fires post_start
-   * @return {Promise} A Promise.
-   *
+   * @returns {Promise} A promise.
    */
   start() {
     // Log
@@ -414,12 +418,9 @@ module.exports = class App {
 
     /**
      * Event that runs before an app starts up.
-     *
      * This is useful if you want to start up any support services before an app
      * stars.
-     *
      * @since 3.0.0
-     * @alias app.events:pre-start
      * @event pre_start
      */
         .then(() => this.events.emit('pre-start'))
@@ -429,12 +430,9 @@ module.exports = class App {
 
     /**
      * Event that runs after an app is started.
-     *
      * This is useful if you want to perform additional operations after an app
      * starts such as running additional build commands.
-     *
      * @since 3.0.0
-     * @alias app.events:post-start
      * @event post_start
      */
         .then(() => this.events.emit('post-start'))
@@ -443,14 +441,12 @@ module.exports = class App {
 
   /**
    * Stops an app.
-   *
    * This will stop all services/containers that have been defined for this app.
-   *
    * @since 3.0.0
    * @alias app.stop
    * @fires pre_stop
    * @fires post_stop
-   * @return {Promise} A Promise.
+   * @returns {Promise} A promise.
    */
   stop() {
     // Stop it!
@@ -459,9 +455,7 @@ module.exports = class App {
 
     /**
      * Event that runs before an app stops.
-     *
      * @since 3.0.0
-     * @alias app.events:pre-stop
      * @event pre_stop
      */
         .then(() => this.events.emit('pre-stop'))
@@ -471,9 +465,7 @@ module.exports = class App {
 
     /**
      * Event that runs after an app stop.
-     *
      * @since 3.0.0
-     * @alias app.events:post-stop
      * @event post_stop
      */
         .then(() => this.events.emit('post-stop'))
@@ -482,16 +474,14 @@ module.exports = class App {
 
   /**
    * Soft removes the apps services but maintains persistent data like app volumes.
-   *
    * This differs from `destroy` in that destroy will hard remove all app services,
    * volumes, networks, etc as well as remove the app from the appRegistry.
-   *
    * @since 3.0.0
    * @alias app.uninstall
    * @fires pre_uninstall
    * @fires post_uninstall
-   * @param {Boolean} purge - A fully instantiated app object
-   * @return {Promise} A Promise.
+   * @param {boolean} purge Whether to remove persistent resources as well.
+   * @returns {Promise} A promise.
    */
   uninstall(purge = false) {
     // Cleaning up
@@ -500,13 +490,10 @@ module.exports = class App {
 
     /**
      * Event that runs before an app is uninstalled.
-     *
      * This is useful if you want to add or remove parts of the uninstall process.
      * For example, it might be nice to persist a container whose data you do not
      * want to replace in a rebuild and that cannot persist easily with a volume.
-     *
      * @since 3.0.0
-     * @alias app.events:pre-uninstall
      * @event pre_uninstall
      */
         .then(() => this.events.emit('pre-uninstall'))
@@ -516,22 +503,29 @@ module.exports = class App {
 
     /**
      * Event that runs after an app is uninstalled.
-     *
      * This is useful if you want to do some additional cleanup steps after an
      * app is uninstalled such as invalidating any cached data.
-     *
      * @since 3.0.0
-     * @alias app.events:post-uninstall
      * @event post_uninstall
      */
         .then(() => this.events.emit('post-uninstall'))
         .then(() => this.log.info('uninstalled app.'));
   }
 
+  /**
+   * Gets the default container id for a service.
+   * @param {string} service Service name.
+   * @returns {string} Docker Compose container id.
+   */
   getServiceContainerId(service) {
     return `${this.project}-${service}-1`;
   }
 
+  /**
+   * Resolves a service name from a Compose container id.
+   * @param {string} id Container id.
+   * @returns {string} Service name.
+   */
   getServiceFromContainerId(id) {
     const regex = new RegExp(`${this.project}-(.*)-1`);
     return id.replace(regex, '$1');