Community configuration: Create a maintenance script for configuration changes
Closed, ResolvedPublic8 Estimated Story Points
Actions

Description

Community configuration 2.0 moves MediaWiki configuration to be on-wiki. From time to time, the Foundation (generically: the site operator) needs to perform a configuration change on one or more wikis. Rather than using a personal wiki account to do such a change, there should be a maintenance script that supports this sort of change. As an example, see maintenance/changeWikiConfig.php in GrowthExperiments.

This script is also useful in case of site-reliability issues caused by CommunityConfiguration (so that there is a way to edit the config, independent of the web UI).

Acceptance Criteria

A maintenance script exists that allows sysadmins to change community configuration-handled values. This script allows to replace a certain store in bulk, or to manipulate with individual variables only.
The maintenance script is usable even when the currently-stored configuration is not valid, or when attempts to retrieve the configuration result in a fatal crash.

Open Questions

Should the script avoid using the CommunityConfiguration services as they could be unusable in a breakage situation? (from T365243)

Details

Subject	Repo	Branch	Lines +/-
Add maint script to change existing configuration	mediawiki/extensions/CommunityConfiguration	master	+453 -0
tests: ensure maintenance base class has always been requierd	mediawiki/extensions/CommunityConfiguration	wmf/1.43.0-wmf.27	+6 -0
tests: ensure maintenance base class has always been requierd	mediawiki/extensions/CommunityConfiguration	master	+6 -0
Add example array containing links to pages	mediawiki/extensions/CommunityConfigurationExample	master	+42 -1

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Open	None	T265163 Create a system to encode best practices into editing experiences
Open	None	T327563 Enable volunteers to configure Edit Check in ways that align with project policies and norms
Open	None	T327655 Epic: Migration of some GrowthExperiments features into MediaWiki core
Open	None	T323811 [EPIC] Community configuration 2.0: Factor Community configuration out of GrowthExperiments
Open	None	T350731 Community Configuration: Monitoring & Contingency plan
Resolved	Michael	T357535 Community configuration: Create a maintenance script for configuration changes
Resolved	Michael	T371678 Allow sysadmins to make an empty edit to a configuration provider

Event Timeline

Urbanecm_WMF created this task.Feb 14 2024, 1:59 PM

Restricted Application added a project: Growth-Team. · View Herald TranscriptFeb 14 2024, 1:59 PM

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

KStoller-WMF moved this task from Backlog to Needed before pilot release on the MediaWiki-extensions-CommunityConfiguration board.Feb 14 2024, 2:54 PM

KStoller-WMF triaged this task as Medium priority.Feb 15 2024, 5:14 PM

KStoller-WMF moved this task from Inbox to Backlog on the Growth-Team board.

Urbanecm_WMF moved this task from Needed before pilot release to Support non-Growth use cases on the MediaWiki-extensions-CommunityConfiguration board.Apr 3 2024, 4:38 PM

Urbanecm_WMF removed a project: GrowthExperiments-EditGrowthConfig (2.0).May 16 2024, 1:53 PM

Urbanecm_WMF updated the task description. (Show Details)May 17 2024, 1:25 PM

Urbanecm_WMF merged a task: T365243: Create a maintenance script for patching a community configuration.

Urbanecm_WMF added a subscriber: Sgs.

Sgs moved this task from Backlog to Up Next on the Growth-Team board.May 24 2024, 7:45 AM

Michael added a parent task: T350731: Community Configuration: Monitoring & Contingency plan.May 28 2024, 4:34 PM

Sgs set the point value for this task to 8.May 28 2024, 4:36 PM

Michael subscribed.Jun 25 2024, 4:32 PM

Michael mentioned this in T370611: CommunityConfiguration: `Add a link (Structured task)` fix handling when "backend" is enabled & "frontend" is disabled.Jul 24 2024, 11:54 AM

KStoller-WMF raised the priority of this task from Medium to High.Jul 24 2024, 9:13 PM

KStoller-WMF edited projects, added Growth-Team (FY2024-25 Q1 Sprint 2); removed Growth-Team.

Urbanecm_WMF mentioned this in T371678: Allow sysadmins to make an empty edit to a configuration provider.Aug 2 2024, 10:24 AM

Urbanecm_WMF added a subtask: T371678: Allow sysadmins to make an empty edit to a configuration provider.

Michael moved this task from FY2024-25 Q1 Sprint 2 to FY2024-25 Q1 Sprint 3 on the Growth-Team board.Aug 7 2024, 3:04 PM

Michael edited projects, added Growth-Team (FY2024-25 Q1 Sprint 3); removed Growth-Team (FY2024-25 Q1 Sprint 2).

KStoller-WMF mentioned this in Growth-Team (FY2024-25 Q1 Sprint 4).Aug 19 2024, 10:25 PM

KStoller-WMF edited projects, added Growth-Team; removed Growth-Team (FY2024-25 Q1 Sprint 3).Aug 19 2024, 11:15 PM

Michael moved this task from Up Next to FY2024-25 Q1 Sprint 4 on the Growth-Team board.Aug 20 2024, 4:40 PM

Michael edited projects, added Growth-Team (FY2024-25 Q1 Sprint 4); removed Growth-Team.

Michael claimed this task.Aug 21 2024, 9:49 AM

Michael moved this task from Incoming to Doing on the Growth-Team (FY2024-25 Q1 Sprint 4) board.

Restricted Application added a project: User-Michael. · View Herald TranscriptAug 21 2024, 9:49 AM

Michael moved this task from Doing to Code Review on the Growth-Team (FY2024-25 Q1 Sprint 4) board.Aug 30 2024, 7:20 AM

Note to self: Add capability to delete specific key from all elements of an array which contains objects. Specific use-case: removing the id key from help panel links.

Change #1064361 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/CommunityConfiguration@master] Add maint script to change existing configuration

https://gerrit.wikimedia.org/r/1064361

gerritbot added a project: Patch-For-Review.Sep 5 2024, 9:47 AM

Per @Michael's request, I did a high-level review of the patch above. I left comments on Gerrit; please do feel free to move back to CR once another review is needed (or if you need any clarification from my end).

KStoller-WMF edited projects, added Growth-Team (FY2024-25 Q1 Sprint 6); removed Growth-Team (FY2024-25 Q1 Sprint 5).Sep 16 2024, 10:43 PM

KStoller-WMF moved this task from Incoming to Doing on the Growth-Team (FY2024-25 Q1 Sprint 6) board.Sep 16 2024, 10:47 PM

KStoller-WMF edited projects, added Growth-Team (Current Sprint); removed Growth-Team (FY2024-25 Q1 Sprint 6).Sep 30 2024, 11:55 PM

KStoller-WMF moved this task from Incoming to Doing on the Growth-Team (Current Sprint) board.Oct 1 2024, 4:43 PM

Change #1075950 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/CommunityConfigurationExample@master] Add example array containing links to pages

https://gerrit.wikimedia.org/r/1075950

I think this is now ready for code-review, I just added the dry-run option as a last change, which I think this script should have.

In code review, I'd be especially curious about further test-cases that we should cover.

Change #1075950 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfigurationExample@master] Add example array containing links to pages

https://gerrit.wikimedia.org/r/1075950

Michael mentioned this in rECCE82f97dd83721: Add example array containing links to pages.Oct 10 2024, 12:13 PM

Change #1064361 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@master] Add maint script to change existing configuration

https://gerrit.wikimedia.org/r/1064361

Michael mentioned this in rECOM39a59b4b1d97: Add maint script to change existing configuration.Oct 14 2024, 2:33 PM

ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.27; 2024-10-15).Oct 14 2024, 3:00 PM

Maintenance_bot removed a project: Patch-For-Review.Oct 14 2024, 3:31 PM

I think this is done. And since this is a maintenance script that is being run on-demand, I don't see how it can be tested by QA. There is a follow-up task T371678: Allow sysadmins to make an empty edit to a configuration provider, the output of which we may can get QA opinion on.

Please reopen this task if you think there is still something that needs doing.

This patch is breaking CI: https://integration.wikimedia.org/ci/job/wmf-quibble-core-vendor-mysql-php74/14652/console (search for RUN_MAINTENANCE_IF_MAIN)

cscott mentioned this in T377391: CommunityConfiguration extension breaking CI for all patches to mediawiki-vendor train branch.Oct 16 2024, 8:41 PM

Change #1080825 had a related patch set uploaded (by Michael Große; author: Michael Große):

[mediawiki/extensions/CommunityConfiguration@master] tests: ensure maintenance base class has always been requierd

https://gerrit.wikimedia.org/r/1080825

gerritbot added a project: Patch-For-Review.Oct 16 2024, 10:42 PM

Change #1080828 had a related patch set uploaded (by C. Scott Ananian; author: Michael Große):

[mediawiki/extensions/CommunityConfiguration@wmf/1.43.0-wmf.27] tests: ensure maintenance base class has always been requierd

https://gerrit.wikimedia.org/r/1080828

Change #1080825 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@master] tests: ensure maintenance base class has always been requierd

https://gerrit.wikimedia.org/r/1080825

Michael mentioned this in rECOM1c4acc415771: tests: ensure maintenance base class has always been requierd.Oct 16 2024, 11:58 PM

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.28; 2024-10-22); removed MW-1.43-notes (1.43.0-wmf.27; 2024-10-15).Oct 17 2024, 12:00 AM

Change #1080828 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@wmf/1.43.0-wmf.27] tests: ensure maintenance base class has always been requierd

https://gerrit.wikimedia.org/r/1080828

cscott mentioned this in rECOM21149bf3f4b0: tests: ensure maintenance base class has always been requierd.Oct 17 2024, 1:23 PM

Mentioned in SAL (#wikimedia-operations) [2024-10-17T13:27:14Z] <urbanecm@deploy2002> Started scap sync-world: Backport for [[gerrit:1080805|Set $wgAllowRawHtmlCopyrightMessages = false (T375789)]], [[gerrit:1080828|tests: ensure maintenance base class has always been requierd (T377391 T357535)]]

Stashbot mentioned this in T375789: Replace on-wiki raw HTML overrides for "MediaWiki:Copyright" etc. and set $wgAllowRawHtmlCopyrightMessages = false.Oct 17 2024, 1:27 PM

Mentioned in SAL (#wikimedia-operations) [2024-10-17T13:29:28Z] <urbanecm@deploy2002> cscott, urbanecm, matmarex: Backport for [[gerrit:1080805|Set $wgAllowRawHtmlCopyrightMessages = false (T375789)]], [[gerrit:1080828|tests: ensure maintenance base class has always been requierd (T377391 T357535)]] synced to the testservers (https://wikitech.wikimedia.org/wiki/Mwdebug)

Maintenance_bot removed a project: Patch-For-Review.Oct 17 2024, 1:31 PM

Mentioned in SAL (#wikimedia-operations) [2024-10-17T13:35:22Z] <urbanecm@deploy2002> Finished scap sync-world: Backport for [[gerrit:1080805|Set $wgAllowRawHtmlCopyrightMessages = false (T375789)]], [[gerrit:1080828|tests: ensure maintenance base class has always been requierd (T377391 T357535)]] (duration: 08m 07s)

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.27; 2024-10-15); removed MW-1.43-notes (1.43.0-wmf.28; 2024-10-22).Oct 17 2024, 2:00 PM

Etonkovidova closed subtask T371678: Allow sysadmins to make an empty edit to a configuration provider as Resolved.Fri, Nov 1, 9:27 PM

Community configuration: Create a maintenance script for configuration changesClosed, ResolvedPublic8 Estimated Story PointsActions