Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Problem/Motivation
LocaleConfigManager provides methods to remove configuration translation overrides when modules are uninstalled. Namely deleteComponentTranslations() which uses a local deleteTranslationData() method. However, when modules are uninstalled, their configuration is removed already and LanguageConfigFactoryOverride::onConfigDelete covers that case, so needing to look up which original files belonged to the given module and attempting to remove their language overrides is double work. When the config files are removed, their overrides vanish as well.
Proposed resolution
Remove the extra unneeded code.
Remaining tasks
Review. Commit.
User interface changes
None.
API changes
Public methods LocaleConfigManager::deleteComponentTranslations() and deleteTranslationData() removed. However, deleteTranslationData() was a very thin wrapper on deleting the language override itself, which is possible by loading the language override from the language manager and deleting: \Drupal::languageManager()->getLanguageConfigOverride($langcode, $name)->delete().
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | interdiff.txt | 2.98 KB | Gábor Hojtsy |
| #5 | 2429385-dont-feed-back-to-locale-5.patch | 1.76 KB | Gábor Hojtsy |
| #1 | 2429385-extra-code.patch | 4.44 KB | Gábor Hojtsy |
Comments
Comment #1
Gábor HojtsyComment #2
Gábor HojtsyWe should figure out that test coverage exists for uninstalling modules removing config overrides. It may not exist yet.
Comment #3
Gábor HojtsyNote that LanguageConfigOverrideInstallTest exists to test that overrides are installed. I did not find a test covering that uninstalling would remove config overrides. (Also note that the config file tested in LanguageConfigOverrideInstallTest only has an override, so actually uninstalling that module would not remove the override because it does not actually ship with a config. That is a test-only case. We can add a scenario with a real core module or a different test module that has a config file, add an override and remove the module).
Comment #4
Gábor HojtsyAdd parent of parent as parent.
Comment #5
Gábor HojtsyI learned a lot while building #2212069-47: Non-English Drupal sites get default configuration in English, edited in English, originals not actually used if translated. So I realize the feeding back to the locale DB may be needed when deleting a config translation manually (so it does not come back). However that may need a bit more thinking. On the other hand, when removing a module, locale should certainly NOT be updated. We don't / cannot remove t() strings either at that point and we don't really know if those strings were used at other places too. So we should not remove them from locale. The LocaleConfigManager connection is what would update the locale DB. The config overrides themselves would be removed by LocaleConfigSubscriber anyway.
Comment #6
Gábor HojtsyComment #7
Gábor HojtsyMost of this same code needs to be rewritten due to #2429651: When adding English, translated default config should get English translations extracted so we better remove it there.