Improve database selection. (#33)

* Improve database selection.

* Make sure we add dbConfig.

* Remove laravel references.

* Remove laravel references.

* Update changelog.

* Fix code comments.

.github/workflows/pr-joomla-tests.yml

@@ -20,6 +20,8 @@ jobs:
         leia-test:
           - examples/joomla-custom
           - examples/joomla-defaults
+          - examples/joomla-downstreamer-1
+          - examples/joomla-downstreamer-2
           - examples/joomla-export
           - examples/joomla-import
           - examples/joomla-init

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v1.2.1 - [March 4, 2024](https://github.com/lando/joomla/releases/tag/v1.2.1)
+
+### Fixes
+
+* Improved `database` selection for purposes of `config` loading, fixes some `database` bootup issues when the `database` type is overriden downstream
+
 ## v1.2.0 - [February 26, 2024](https://github.com/lando/joomla/releases/tag/v1.2.0)
 
 ### New Features

builders/joomla.js

@@ -5,6 +5,13 @@ const _ = require('lodash');
 const fs = require('fs');
 const path = require('path');
 
+/*
+ * Helper to get database type
+ */
+const getDatabaseType = options => {
+  return _.get(options, '_app.config.services.database.type', options.database) ?? 'mysql';
+};
+
 // Tooling defaults
 const toolingDefaults = {
   'composer': {
@@ -84,11 +91,12 @@ const getConfigDefaults = options => {
   // Get the viaconf
   if (_.startsWith(options.via, 'nginx')) options.defaultFiles.vhosts = 'default.conf.tpl';
 
-  // Get the default db conf
-  const dbConfig = _.get(options, 'database', 'mysql');
+  // attempt to discover the database that is actually being used
+  // @NOTE: this will look to see if database is overridden
+  const dbConfig = getDatabaseType(options);
   const database = _.first(dbConfig.split(':'));
   const version = _.last(dbConfig.split(':')).substring(0, 2);
-  if (database === 'mysql' || database === 'mariadb') {
+  if (database === 'joomla-mysql' || database === 'mysql' || database === 'mariadb') {
     if (version === '8.') {
       options.defaultFiles.database = 'mysql8.cnf';
     } else {

examples/joomla-downstreamer-1/.lando.yml

@@ -0,0 +1,11 @@
+name: joomla-downstreamer-1
+recipe: joomla
+
+services:
+  database:
+    type: mysql:8.0
+
+# do not remove this
+plugins:
+  "@lando/joomla": ../..
+  "@lando/mysql": ../../node_modules/@lando/mysql

examples/joomla-downstreamer-1/README.md

@@ -0,0 +1,44 @@
+# Joomla Downstreamer Example
+
+This example exists primarily to test the following documentation:
+
+* [Joomla Recipe](https://docs.lando.dev/joomla/config.html)
+
+Start up tests
+--------------
+
+Run the following commands to get up and running with this example.
+
+```bash
+# Should start up successfully
+lando poweroff
+lando start
+```
+
+Verification commands
+---------------------
+
+Run the following commands to validate things are rolling as they should.
+
+```bash
+# Should be using mysql8
+lando mysql -V | grep 8.0
+
+# Should use the default database connection info
+lando mysql -ujoomla -pjoomla joomla -e quit
+
+# Should use the defauly mysql8 config file
+lando ssh -s database -c "cat /opt/bitnami/mysql/conf/my_custom.cnf" | grep "LANDOJOOMLAMYSQL8CNF"
+lando mysql -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 127
+```
+
+Destroy tests
+-------------
+
+Run the following commands to trash this app like nothing ever happened.
+
+```bash
+# Should be destroyed with success
+lando destroy -y
+lando poweroff
+```

examples/joomla-downstreamer-1/index.php

@@ -0,0 +1 @@
+DEFAULTS

examples/joomla-downstreamer-1/info.php

@@ -0,0 +1 @@
+<?php phpinfo(); ?>

examples/joomla-downstreamer-2/.lando.yml

@@ -0,0 +1,11 @@
+name: joomla-downstreamer-2
+recipe: joomla
+
+services:
+  database:
+    type: joomla-mysql:8.0
+
+# do not remove this
+plugins:
+  "@lando/joomla": ../..
+  "@lando/mysql": ../../node_modules/@lando/mysql

examples/joomla-downstreamer-2/README.md

@@ -0,0 +1,44 @@
+# Joomla Downstreamer Example
+
+This example exists primarily to test the following documentation:
+
+* [Joomla Recipe](https://docs.lando.dev/joomla/config.html)
+
+Start up tests
+--------------
+
+Run the following commands to get up and running with this example.
+
+```bash
+# Should start up successfully
+lando poweroff
+lando start
+```
+
+Verification commands
+---------------------
+
+Run the following commands to validate things are rolling as they should.
+
+```bash
+# Should be using mysql8
+lando mysql -V | grep 8.0
+
+# Should use the default database connection info
+lando mysql -ujoomla -pjoomla joomla -e quit
+
+# Should use the defauly mysql8 config file
+lando ssh -s database -c "cat /opt/bitnami/mysql/conf/my_custom.cnf" | grep "LANDOJOOMLAMYSQL8CNF"
+lando mysql -u root -e "show variables;" | grep innodb_lock_wait_timeout | grep 127
+```
+
+Destroy tests
+-------------
+
+Run the following commands to trash this app like nothing ever happened.
+
+```bash
+# Should be destroyed with success
+lando destroy -y
+lando poweroff
+```

examples/joomla-downstreamer-2/index.php

@@ -0,0 +1 @@
+DEFAULTS

examples/joomla-downstreamer-2/info.php

@@ -0,0 +1 @@
+<?php phpinfo(); ?>