Page MenuHomePhabricator

Community configuration: Allow administrators to resolve issues with invalid configuration within the Editor form
Open, MediumPublic


Background & Problem

From time to time, the JSON wikipage with the configuration might end up containing invalid configuration. This can happen during configuration schema changes, thanks to a bug or for other reasons. Currently, whenever that happens, the configuration form displays this error message:

image.png (560×2 px, 56 KB)

This is unhelpful, as it (a) does not provide any information about where the issue is (b) it is impossible to fix the problem from the form.


When the editor encounters an invalid configuration, it should:

  • explain where the issue is (where is the invalid data coming from, what the validation error is)
  • give the user a choice between fixing the issue themselves (for example, by manually fixing the config within the JSON wikipage) and getting an empty form (=form filled in with default configuration) and re-configuring everything from scratch

While working on this problem, we need to keep the Configuration Store concept in (right now, the config is stored in JSON wikipages, but in the future, it might be somewhere else). This needs to be implemented in a sufficiently generic way to support different stores that might be implemented in the future.

Considering the first bullet point is easier to satisfy, we will work on this iteratively, and fulfilling the first bullet point is in scope for a subtask.

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

Hi @Sgs! As I promised during our last 1:1, I filled this task (and the subtask) to capture the changes we agreed on making regarding invalid configuration. I'd appreciate it if you could review the description, to ensure they match with what we agreed on.

Hi @KStoller-WMF! Can you please review the description as well, and let me know if there is anything unclear that needs to be clarified? FTR, the work is meant to be completed in two phases (one of them "soon", second of them at some later point, possibly even post-MVP).

Change 1012737 had a related patch set uploaded (by Catrope; author: Catrope):

[mediawiki/core@master] Update Codex from 1.3.4 to 1.3.5