Module configuration issues

Open on Drupal.org →

Created on 21 September 2022, about 2 years ago

Updated 5 August 2024, 3 months ago

Problem/Motivation

1. AddressProvider plugin config is unnecessarily being serialized and un-serialized

It is difficult to override config for an AddressProvider plugin when the configuration is serialized.

Instead of:

$config['address_autocomplete.settings']['google_maps']['api_key'] = 'foo';

One must specify a serialized array:

$config['address_autocomplete.settings']['google_maps'] = 'a:2:{s:9:"plugin_id";s:11:"google_maps";s:7:"api_key";s:3:"foo";}';

Additionally, it does not appear that the serialization and un-serialization of the plugin config is actually necessary.

2. Immutable (potentially overridden) config values are displayed in config admin screens for edit

This can lead to confusion and is not standard practice in module config forms.

3. We appear to be lacking a configuration schema file for our module settings

Proposed resolution

- Add a configuration schema file
- Write an update hook to un-serialize and re-save the AddressProvider plugin configuration and remove the serialization and un-serialization steps when saving and loading config.
- Display mutable/editable config values in module configuration forms

Remaining tasks

User interface changes

DX: Easier / standard configuration overrides, easier to read config in config files.
UX: Less confusion in settings forms when configuration overrides are present.

API changes

Data model changes

🐛 Bug report

Status

Fixed

Version

1.0

Component

Code

Created by

🇺🇸United States chrisolof

Live updates comments and jobs are added and updated live.

Incomplete comments

Sign in to follow issues

Merge Requests

!12Module configuration issues
Merged
🇷🇸Serbia vaish
updated 4 months ago

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 12 months ago →
🇷🇸Serbia vaish
Here is a new version of the patch from #2. Tested both on Drupal 9.5 and Drupal 10.1. Main difference is a fix for an error

TypeError: Drupal\Component\Plugin\PluginManagerBase::createInstance(): Argument #2 ($configuration) must be of type array, null given

which occurs when attempting to edit provider settings for the very first time while they are still undefined. In addition to that, I converted variable into a constant and injected Guzzle Http client instead of instantiating it in the constructor.

Note: If you want to use this patch on Drupal 10, you also need to apply #3349849-12: Drupal 10 compatibility → .
Merge request !12Improve module's configuration → (Merged) created by vaish
Pipeline finished with Skipped
4 months ago
#231102
Comment 4 months ago →
System Message

vaish → committed 17738397 on 1.0.x
Issue #3311019 by vaish, chrisolof: Module configuration issues
Status changed to Fixed 4 months ago11:20am 22 July 2024
Comment 4 months ago →
🇷🇸Serbia vaish
Comment 3 months ago →
System Message
Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024