Can't disable mysql57 module

[danflanagan8]

Describe the bug
The mysql57 module can't be disabled on a site using DRS

To Reproduce
Try to disable mysql57.

Expected behavior
I can disable it as long as I'm no longer referencing mysql57 in my settings.php

Unfortunately mysql57 is still referenced in DRS.

Screenshots
If applicable, add screenshots to help explain your problem.

Environment
Operating system, browser, version numbers, etc.

Additional context
There's a support request against mysql57 on d.o: https://www.drupal.org/project/mysql57/issues/3550572

The complication related to DRS is correctly noted in a comment.

[danflanagan8]

Now that Acquia has mySQL 8 support, when are the mysql57 settings going to be removed from DRS?

[vishalkhode1]

@danflanagan8 Are you seeing any error ? Because after you remove the drupal/mysql57 module from your codebase, the MySQL57 settings.inc file won't be included by the DRS. See this, there's condition check.

[danflanagan8]

Once the module is installed, that condition is true until you uninstall the module. But that condition being true prevents the module from being uninstalled. It's stuck installed. It can't be uninstalled while DRS is managing the mysql settings.

[vauxia]

@vishalkhode1 this is happening when this plugin is installed and activated by way of including this line in settings.php:

require DRUPAL_ROOT . "/../vendor/acquia/drupal-recommended-settings/settings/acquia-recommended.settings.php";

… which, in turn, always loads modules/contrib/mysql57.inc, when present.

As @danflanagan8 says, and the code you point to indicates, the module need only be present, not enabled. Once that file is loaded, the mysql57 module becomes uninstallable: _The module 'MySQL 5.7' is providing the database driver 'mysql'.

It did not work to simply remove the module from composer and deploy to Acquia, because config import catastrophically failed ( was hoping it would just complain about the missing module) -- It needs to be uninstalled first, but it cannot be uninstalled unless is it is present, which puts us in a catch-22

The workaround is to stop using this plugin:

1. comment out the above line in settings.php, which includes acquia-recommended.settings.php
2. add a line to settings.php to directly include Acquia's database configuration:

if (file_exists('/var/www/site-php')) {
  require('/var/www/site-php/sitename/sitename-settings.inc');
}

And then deploy twice:

1. deploy the change which uninstalls the mysql57 module
2. deploy a second time to remove it from composer and revert the changes to settings.php

[vauxia]

This caught us off guard because it doesn't fail in the same way on our local environments.

This code, which is accompanied by a @todo Remove this line once acquia platform start supporting mysql 8.0 comment, only runs on Acquia environments.

If Acquia has completed the MySQL 8 conversion, all references to the mysql57 module should be removed from this plugin.

If Acquia has not completed this work, an additional check of some kind should be included in acquia-recommended.settings.php to prevent this include.

[vishalkhode1]

@vauxia Thanks for the detailed explanation. I'm now able to reproduce the issue in local. If you are blocked or need to resolve this urgently. I would request you to follow the steps as mentioned here. Ex:

Approach 1:

1. Remove the module from your codebase.
2. Deploy code.
3. Run drush cr command to clear cache.
4. Write an update hook which removes module entry from core.extension. Ex:

/**
 * Remove mysql57 module from core.extension.
 */
function example_update_N() {
  $config = \Drupal::configFactory()->getEditable('core.extension');
  $modules = $config->get('module') ?? [];
  unset($modules['mysql57']);
  $config->set('module', $modules)->save();
}

Replace example with your module machine name and N with your hook update number.

Approach 2:

1. Remove drupal/mysql57 module entry using drush. Ex:

$ drush php-eval "\$config = \Drupal::configFactory()->getEditable('core.extension'); \$modules = \$config->get('module'); unset(\$modules['mysql57']); \$config->set('module', \$modules)->save();"

2. Remove the module from your codebase.
3. Deploy code.

Note: This is NOT the recommended method for uninstalling modules. However, it can be used in this case because drupal/mysql57 does not provide any runtime code that could cause a WSOD, nor does it include any configurations.

Yes, will see if we can remove all references for mysql57 or if there's any alternate way to handle this.

If Acquia has completed the MySQL 8 conversion, all references to the mysql57 module should be removed from this plugin.
If Acquia has not completed this work, an additional check of some kind should be included in acquia-recommended.settings.php to prevent this include