@lando/mysql/builders/mysql.js

A Lando plugin that provides a tight integration with MySQL.

'use strict';

// Modules
const _ = require('lodash');
const path = require('path');

// Builder
module.exports = {
  name: 'mysql',
  config: {
    version: '5.7',
    supported: ['8.4', '8.0', '5.7'],
    pinPairs: {
      '8.4': 'bitnami/mysql:8.4.3-debian-12-r4',
      '8.0': 'bitnami/mysql:8.0.40-debian-12-r4',
      '5.7': 'bitnami/mysql:5.7.43-debian-11-r73',
    },
    patchesSupported: true,
    confSrc: path.resolve(__dirname, '..', 'config'),
    creds: {
      database: 'database',
      password: 'mysql',
      user: 'mysql',
    },
    port: '3306',
    defaultFiles: {
      database: 'my_custom.cnf',
    },
    remoteFiles: {
      database: '/opt/bitnami/mysql/conf/my_custom.cnf',
    },
  },
  parent: '_service',
  builder: (parent, config) => class LandoMySql extends parent {
    constructor(id, options = {}) {
      options = _.merge({}, config, options);
      // Force the auth plugin to be mysql_native_password on 5.7
      if (_.startsWith(options.version, '5.7')) options.authentication = 'mysql_native_password';

      // set a default health check if we dont already have one
      if (!options.healthcheck) options.healthcheck = require('../utils/get-default-healthcheck')(options);

      // Ensure the non-root backup perm sweep runs
      // NOTE: we guard against cases where the UID is the same as the bitnami non-root user
      // because this messes things up on circle ci and presumably elsewhere and _should_ be unncessary
      if (_.get(options, '_app._config.uid', '1000') !== '1001') options._app.nonRoot.push(options.name);

      // Build the default stuff here
      const mysql = {
        image: `bitnami/mysql:${options.version}`,
        command: '/launch.sh',
        environment: {
          ALLOW_EMPTY_PASSWORD: 'yes',
          MYSQL_AUTHENTICATION_PLUGIN: options.authentication,
          MYSQL_DATABASE: options.creds.database,
          MYSQL_PASSWORD: options.creds.password,
          MYSQL_USER: options.creds.user,
          LANDO_NEEDS_EXEC: 'DOEEET',
        },
        volumes: [
          `${options.confDest}/launch.sh:/launch.sh`,
          `${options.confDest}/${options.defaultFiles.database}:${options.remoteFiles.database}`,
          `${options.data}:/bitnami/mysql/data`,
        ],
      };

        // Send it downstream
      super(id, options, {services: _.set({}, options.name, mysql)});
    }
  },
};