Add Ability to Override Configuration With Keys [#2771013]

The way the config overrides work is a module can provide an optional config file that defines keys the submodule should override. For example, this is one for the smtp module:

# smtp/config/optional/key_config.key_override.smtp.yml
id: smtp
module: smtp

config_objects:
  - name: smtp.settings
    paths:
      - key: smtp_password
        label: SMTP Password

The idea for having this functionality as a submodule of key as opposed to a separate project is to lower the friction for adoption by not requiring invasive patching on the part of module maintainers.

Comment	File	Size	Author
#17	2771013-17.patch	15.94 KB	tynor
#17
#13	interdiff.patch	1.9 KB	tynor
#13
#13	2771013-13.patch	15.97 KB	tynor
#13
#11	2771013-11.patch	16 KB	tynor
#11
#9	2771013-9.patch	15.94 KB	tynor
#9	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 6 pass
#8	2771013-8.patch	16.01 KB	tynor
#8	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 6 pass
#5	interdiff.patch	1.25 KB	tynor
#5
#5	2771013-5.patch	15.9 KB	tynor
#5	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 Patch failed to apply
#4	2771013-4.patch	15.96 KB	tynor
#4	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 6 pass
#4	interdiff.patch	9.55 KB	tynor
#4
#2	key-add_a_submodule_that-2771013-2.patch	15.9 KB	tynor
#2	8.x-1.x: PHP 5.5 & MySQL 5.5, D8.2 6 pass

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

22 July 2016 at 05:33

tynor created an issue. See original summary.

Comment #2

tynor CreditAttribution: tynor commented 22 July 2016 at 05:37

File	Size
key-add_a_submodule_that-2771013-2.patch	15.9 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.2 6 pass

Comment #3

tynor CreditAttribution: tynor commented 22 July 2016 at 05:38

Status:

Active

» Needs review

Comment #4

tynor CreditAttribution: tynor commented 12 August 2016 at 21:49

File	Size
interdiff.patch	9.55 KB

2771013-4.patch	15.96 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 6 pass

After discussion with Rick, here are is an updated patch with an interdiff using the \NestedArray::getValue() function rather than manual array element extraction, as well as styling updates.

Comment #5

tynor CreditAttribution: tynor commented 19 August 2016 at 00:52

File	Size
2771013-5.patch	15.9 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 Patch failed to apply
interdiff.patch	1.25 KB

Fixed an issue with the previous patch that tried to inject a config.installer into KeyConfigForms when none is taken.

Comment #6

19 August 2016 at 00:54

The last submitted patch, 5: 2771013-5.patch, failed testing.

Comment #7

rlhawk

English

Seattle, Washington, United States

CreditAttribution: rlhawk commented 19 August 2016 at 16:32

Tynor, the last patch appears to be corrupt. Can you fix it and repost?

Comment #8

tynor CreditAttribution: tynor commented 19 August 2016 at 17:10

File	Size
2771013-8.patch	16.01 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 6 pass

Here's the fresh patch.

Comment #9

tynor CreditAttribution: tynor commented 19 August 2016 at 17:13

File	Size
2771013-9.patch	15.94 KB
8.x-1.x: PHP 5.5 & MySQL 5.5, D8.3 6 pass

Actually, ignore that last one, I accidentally didn't include some changes (targeted the wrong revision for the diff.)

Comment #10

tynor CreditAttribution: tynor commented 19 August 2016 at 22:01

Status:

Needs review

» Active

Working on refactor into centralized override management, removing need for a global form_alter.

Comment #11

tynor CreditAttribution: tynor commented 23 August 2016 at 18:11

File	Size
2771013-11.patch	16 KB

Here is a patch implementing the centralized override management.

I'm not sure what text should appear on the Overrides form, but the functionality is working quite nicely.

Comment #12

tynor CreditAttribution: tynor commented 23 August 2016 at 18:14

Issue summary:

View changes

Comment #13

tynor CreditAttribution: tynor commented 23 August 2016 at 20:31

File	Size
2771013-13.patch	15.97 KB

interdiff.patch	1.9 KB

Couple small updates from Chris on the layout of the Overrides page. There is also now a container stub for putting text.

Comment #14

tynor CreditAttribution: tynor commented 23 August 2016 at 20:32

Issue summary:

View changes

Updated example config file to remove the now unnecessary label.

Comment #15

rlhawk

English

Seattle, Washington, United States

CreditAttribution: rlhawk commented 24 August 2016 at 06:32

README.md still has the config object label in the example code, so we should remove it there also.

Comment #16

rlhawk

English

Seattle, Washington, United States

CreditAttribution: rlhawk commented 24 August 2016 at 16:46

This generally looks good. In my tests, though, the actual key value is not getting copied over to the key configuration when importing.

Comment #17

tynor CreditAttribution: tynor commented 3 May 2017 at 20:33

File	Size
2771013-17.patch	15.94 KB

Fixed the README.md (new diff attached.)

I tried to reproduce the error with importing, but it looks like it's working correctly for me. Can you try again and just make sure it's the most recent patch?

Here are the steps I took:

Install standard Drupal 8 site
Install key with composer require --update-no-dev drupal/key
Install smtp with composer require --update-no-dev drupal/smtp
Create the smtp override config file in smtp/config/optional/key_config.key_override.smtp.yml
Apply the patch
Set the smtp password
Go to admin/config/system/keys/overrides
Click on "Import"
Verify that the smtp_password setting was set to the key id with drush ev "echo Drupal::configFactory()->getEditable('smtp.settings')->get('smtp_password'), PHP_EOL"
Verify that the smtp_password is overridden correctly with drush ev "echo Drupal::configFactory()->get('smtp.settings')->get('smtp_password'), PHP_EOL"