Problem/Motivation

Code that must be able to store the configuration of plugins of different types in CMI, have no way to reference the schemas of those plugins' configuration in their own configuration schemas. To work around this, I created the plugin.plugin_configuration.$plugin_type_id.$plugin_id format convention as documented in the Plugin module.

However, as Drupal core, and likely many contributed modules as well, do not adhere to this format, the configuration schemas of plugins from these projects cannot be referenced generically.

At DrupalCamp Vienna, @alexpott and @Xano discussed the idea of aliasing schemas, which will essentially allow schemas to exist under multiple names. Example:

plugin.plugin_configuration.block.*
  type: block_settings.*

These aliases work well in Drupal 8.0.x, but wildcard values are not passed. This means that with this schema, lookups for plugin.plugin_configuration.block.foobar will result in the schema for block_settings.* being loaded instead of the schema for block_settings.foobar.

Proposed resolution

Resolve schema types by passing on wildcard values from 'parent' types to 'child' types.

Remaining tasks

To be determined.

User interface changes

None.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#3 drupal_2629640_3.patch8.54 KBxano
#3 interdiff.txt6.21 KBxano
#2 drupal_2629640_2.patch3.25 KBxano

Comments

Xano created an issue. See original summary.

xano’s picture

xano
he/they
Primary language English
Location Southampton
commented
Status: Active » Needs review
Issue tags: +Needs tests
StatusFileSize
new drupal_2629640_2.patch3.25 KB

This is a quick proof of concept.

xano’s picture

xano
he/they
Primary language English
Location Southampton
commented
Issue tags: -Needs tests
StatusFileSize
new interdiff.txt6.21 KB
new drupal_2629640_3.patch8.54 KB

Now with tests. I fixed a small bug that the tests exposed.

xano’s picture

xano
he/they
Primary language English
Location Southampton
commented

For the Plugin module I realized that CMI currently already facilitates dynamic schema types, as long as the dynamic values are contained by the same config object that defines the dynamic schema name. I used this to store the entire config schema name in a config property, and use that as the type of another property contained by the same config object. See #2543420: Add schemas for core plugins' configuration.

xano’s picture

xano
he/they
Primary language English
Location Southampton
commented
Related issues: +#2633232: Missing fallback plugin configuration schemas

Adding a related issue for those who came here via the Plugin module.

berdir’s picture

berdir
Primary language German
Location Switzerland
commented

I think this was resolved by #2392057: Config schema fails to expand dynamic top-level types?

xano’s picture

xano
he/they
Primary language English
Location Southampton
commented

I looked at it briefly and it doesn't look like it handles replacements for wildcards.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.0-beta1 was released on March 2, 2016, which means new developments and disruptive changes should now be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

smustgrave’s picture

smustgrave commented
Status: Needs review » Postponed (maintainer needs more info)

With the changes in D9 + D10 wonder if this is still relevant?

Before anyone works on rerolling or updating.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

smustgrave’s picture

smustgrave commented
Status: Postponed (maintainer needs more info) » Closed (outdated)
Issue tags: +Triaged feature request

Since there has been no follow up going to close for now.

If still a valid request please reopen though, maybe updating issue summary for what needs to be done for D10+

Thanks all!