When looking at the configuration synchronisation pages you will still see certain configuration overrides, even though you have selected those to be ignored with this module. Same happens when using Drush or Console and you get a list of configuration overrides that will change with the import command.
I believe for the sake of better UX this module should either override those outputs or just hide them as it might be confusing for some users since they will expect for those modules to be overridden even though they actually won't be.
I'm happy to work on this, I would just like also someone else's input on this, on how to approach this?
Comment | File | Size | Author |
---|---|---|---|
#10 | config_ignore_drush_cim.png | 96.17 KB | tlyngej |
#10 | should_the_module-2845286-10.patch | 12.95 KB | tlyngej |
| |||
#9 | interdiff-2845286-8-9.txt | 9.01 KB | tlyngej |
#9 | should_the_module-2845286-9.patch | 10.34 KB | tlyngej |
| |||
#8 | interdiff-2845286-3-8.txt | 1.43 KB | jzavrl |
Comments
Comment #2
tlyngej CreditAttribution: tlyngej at Annertech commentedBut you are so absolutely right @jzavrl!
The UX (and DX for that matter) for this module is terrible for the time being.
I don't really have any strong opinions on how to get the user notified about, which config entities that are being ignored, as long as it's done through Drupal Core API's only.
If you put something together that would be lovely. It doesn't have to be the complete work, but a proposal, or a patch with pseudo code would do just fine. Then we can work from there.
Comment #3
tlyngej CreditAttribution: tlyngej at Annertech commentedRight, as far as I can see, there is no good way to suppress the information displayed, prior to an import. For example, if you visit
admin/config/development/configuration
or run adrush cim
.But this patch will at least inform the user, running the import, that the configuration has been ignored.
Let me know if you think that this would be a good first step at least.
Comment #4
tlyngej CreditAttribution: tlyngej at Annertech commentedComment #5
tlyngej CreditAttribution: tlyngej at Annertech commentedComment #6
tlyngej CreditAttribution: tlyngej at Annertech commentedMarking #2850620: How to not list the ignored list during import? as a related issue.
Comment #7
tlyngej CreditAttribution: tlyngej at Annertech commentedThat didn't go so well. Lets try again...
Comment #8
jzavrl CreditAttribution: jzavrl at NDP commentedThat looks great. The message appears in the UI as well as when using Drush.
I've also wanted to display some of this information right from the start as the messages are only visible upon import. So I've been playing around a little and have altered the configuration overview table so it now displays one more column 'Ignored' and indicators for each row. Let me know what you think.
On a note to the related issue - would it perhaps make more sense to completely hide the rows with config entities that are ignored? For the table that shouldn't be a problem, but not quite sure on the Drush part. I'm afraid we might have to override some classes for that.
Comment #9
tlyngej CreditAttribution: tlyngej at Annertech commentedBrilliant approach, @jzavrl!
Definitely better than nothing.
I've made a few changes. Mainly adding missing
use
statements, and added a few punctuations in the comments here and there.Further more, I have made a generic function, that we can ask whether a config name should be considered as ignored or not.
Ohh, yes, and added a test to verify that the column is set to the right value.
Hiding the column sounds like something that could cause confusion. For now I think that it's better to be upfront about the fact that there are changes, but the site won't apply them.
Regarding Drush, I might have a friend I can ask about how to alter the output there. If no one else beats me to it :-)
Comment #10
tlyngej CreditAttribution: tlyngej at Annertech commentedI've figured out how to hook into Drush, but unfortunately, it doesn't seem like I can alter the existing table of changes that it prints.
I can, how ever, print something before (see screenshot).
I'm not sure if a message after and before the import is a good idea.
What do you thing?
Comment #11
jzavrl CreditAttribution: jzavrl at NDP commentedNice! I think having both messages is not a bad idea, I'd leave it at that, to be honest. For now I think it's safe to say that this can be commited.
Comment #13
tlyngej CreditAttribution: tlyngej at Annertech commentedCool.
Let's get this bad boy out in the open then!