Fixes #428 Config Distro Import Ignore Bug

[tadean]

This PR attempts to provide a workaround for a current bug in the config_sync/config_distro ecosystem. The symptom of this problem is that when distribution updates are imported, any modules that are deselected (eg. you choose not to import their updates) still import anyway.

Description

This PR provides a patch that hooks the storage comparer used in the Config Import process up between the site's sync storage and active storage.

Normally config_distro's import form integrates with the sync storage indirectly, through the new transformation API. The config_sync/config_distro ecosystem has been trying to move towards using the transformation API but it appears that perhaps something in the config_filter layer is being cached or not regenerated during a plugin derivation process.

This needs a little more investigation for a real fix as this is a bandaid fix for something that seems going amiss with config_filter using the transformation API.

Related Issue

#428

How Has This Been Tested?

• Test locally, not practical in Probo.ci
• Build site and install Drupal as normal
• Make edits to two configuration files for Quickstart content, eg. Change the display names of two content types in their .yml files
• Make these edits in two separate modules, eg. there should be two modules with changes
• visit /admin/config/development/distro
• Verify that both changes are listed
• Uncheck one of the modules
• Import the distribution update
• Verify that only the CHECKED update was applied, eg. if you changed two content type names, only the checked one should be changed in your active site.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I've added this Pull Request to the AZ Quickstart Github project and set it to "Review in progress".
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[camikazegreen]

Here's the diff of the actual patch for convenience in review:

diff --git a/src/Form/ConfigDistroImportForm.php b/src/Form/ConfigDistroImportForm.php
index aff2f08..9410401 100644
--- a/src/Form/ConfigDistroImportForm.php
+++ b/src/Form/ConfigDistroImportForm.php
@@ -41,11 +41,11 @@ class ConfigDistroImportForm extends ConfigSync {
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form = parent::buildForm($form, $form_state);

• // @todo: why is this empty?
• $storage_comparer = $form_state->get('storage_comparer');
• if (!isset($storage_comparer)) {

•  $storage_comparer = new StorageComparer($this->syncStorage, $this->activeStorage, $this->configManager);
  

• }

• $storage_comparer = new StorageComparer($this->syncStorage, $this->activeStorage);
• // Store the comparer for use in the submit.
• $form_state->set('storage_comparer', $storage_comparer);
• foreach ($storage_comparer->getAllCollectionNames() as $collection) {
  if (isset($form[$collection])) {
  foreach (array_keys($form[$collection]) as $config_change_type) {

Do we have any precedent for including patches via personal gist?

[mmunro-ltrr]

Followed along with a local Lando installation, checked for errors in the Probo build logs.