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.
Spin-off from #1609760: hook_image_style_*() is not invoked for image styles upon Image module installation and #1670370: Enforce writing of config changes during import, even if the module callback handled it already
Problem
- Module A (say, Book) can ship with default config that actually pertains to Module B (Node).
- The current system assumes always-compatible config objects, which is known to be invalid.
Goal
- Correctly handle API compatibility for configuration in module interdependencies.
- Allow modules to reject incompatible configuration during installation/import.
Details
- There happens to be an "export API version" as the base integration part of CTools' Export API, Views API, Panels API, etc.
- The new configuration system does not have any version identifiers or compatibility checks, albeit almost fully mimicking the basic export/import concepts of Features/CTools in D7 contrib.
- E.g., admin_views.module can provide default config (views) for views.module, but which are only compatible with views 3.x, and on top of that, they also require VBO 2.x. The views definition is only compatible with Views 3.x and incompatible with Views 2.x. The VBO plugin definition is only compatible with VBO 2.x and incompatible with VBO 1.x.
- Thus, either all modules are forced to work with any kind of version-agnostic config at any time — which is the current situation and effectively means "backwards-compatibility for eternity."
- Or we not only need to trust the module API, but we actually need to introduce an additional mechanism/way to allow modules to "reject" config if it is not compatible during any kind of installation/import.
Comments
Comment #1
sunbleh
Comment #2
sunRelated: #1848998-76: Problems with update_module_enable()
Not sure whether this should be handled by the Entity system or by the Configuration system?
Comment #3
xjmWell, I think even plain configuration is likely to depend on the module version, no?
Related: #1842956: [Meta] Implement event listeners to validate imports
Comment #4
mtiftTwo very similar issues:
#1398040: Detect if default configuration of a module has been changed, and allow to restore to the original
Comment #4.0
mtiftUpdated issue summary.
Comment #5
alexpottIt does not like we are going to do anything about this for 8.0.0 so postponing to 8.1.x where we probably have a much better idea about what is possible.
Comment #6
effulgentsia CreditAttribution: effulgentsia at Acquia commentedShould this issue be closed? Regarding the 2 goals in the IS:
Are module dependencies not sufficient? The IS details gives the example of admin_views wanting to ship default config for Views 3.x and not Views 2.x. Is that not accomplishable with admin_views.info.yml specifying that it depends on Views 3.x?
Doesn't the configuration dependency system now do this? It didn't when this issue was opened, but it now does, I think.
We have #1977498: Add version tracking for configuration schema and data for other problems related to config schema versioning, so I'm wondering if there's anything about this issue that remains relevant.
Comment #9
andypostLooks this could be closed, config version using module updates version