Page MenuHomePhabricator
Create Task
Maniphest T371028

Migration Schemas to a non-latest version is broken
Open, In Progress, MediumPublic5 Estimated Story PointsBUG REPORT
Actions

Description

The migrateSchema.php maintenance script developer for T357532: Create a system to support developers while upgrading configuration schemas supports in principle both upgrading and downgrading. However, there is a fundamental problem with migrating to anything besides the most recent version of a Schema: The store and the validator used to save that schema are not version-aware.
That means when migrating to anything but the most-recent version, then the schema saved will still be validated with the most recent Schema and it will be saved with the version of the most-recent Schema.

Acceptance Criteria:

  • It is possible to migrate Configuration to any version of a Schema. That version will be validated with the Schema at that version, and have that version as the value for $version in the stored json.
  • in particular, it is possible to migrate to the first version of a Schema
  • there exist e2e tests asserting that functionality in the CommunityConfiguration extension

Details

Related Changes in Gerrit:
SubjectAuthorRepoBranchLines +/-
fix: finish implementing migrationsEMcFarlandmediawiki/extensions/GrowthExperimentsmaster+2 -1
MentorListConfigProvider: Use current version of DataProvider::storeValidConfigurationEMcFarlandmediawiki/extensions/GrowthExperimentsmaster+3 -2
fix: finish implementing migrationsMichael Großemediawiki/extensions/CommunityConfigurationmaster+626 -197
fix: finish implementing migrationsEMcFarlandmediawiki/extensions/GrowthExperimentsmaster+3 -2
refactor: make use of version in schema for validationMichael Großemediawiki/extensions/ReportIncidentmaster+2 -2
Fix incomplete CommunityConfiguration SchemaProviderTestCaseThiemo Kreuz (WMDE)mediawiki/extensions/Citemaster+3 -0
refactor: make use of version in schema for validationMichael Großemediawiki/extensions/TemplateDatamaster+7 -6
refactor: make IValidator version awareMichael Großemediawiki/extensions/CommunityConfigurationmaster+8 -2
refactor: make IValidator implementations version-awareMichael Großemediawiki/extensions/CommunityConfigurationmaster+36 -21
refactor(ISchemaConverter): rename downgrading methodMichael Großemediawiki/extensions/CommunityConfigurationmaster+5 -5
refactor: Remove unused codeMichael Großemediawiki/extensions/GrowthExperimentsmaster+0 -15
refactor(SchemaConverters): prepare rename of downgradeFromNewer to downgradeToPreviousMichael Großemediawiki/extensions/GrowthExperimentsmaster+15 -0
fix(migrateSchema): use correct converter when downgradingMichael Großemediawiki/extensions/CommunityConfigurationmaster+23 -4
Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
gerritbot added a comment.Jul 25 2024, 2:56 PM

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

[mediawiki/extensions/CommunityConfiguration@master] fix(migrateSchema): use correct converter when downgrading

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

gerritbot added a comment.Jul 25 2024, 2:56 PM

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

[mediawiki/extensions/CommunityConfiguration@master] refactor(ISchemaConverter): rename downgrading method

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

Michael added a comment.Jul 25 2024, 2:58 PM

Note that while the added changes improve the code, they do not yet address the fundamental issue brought up in this task and mentioned in the AC. So this task should not move to QA until the main points have actually been addressed.

gerritbot added a comment.Jul 29 2024, 12:10 PM

Change #1056961 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@master] fix(migrateSchema): use correct converter when downgrading

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

Michael mentioned this in rECOM4be40920839b: fix(migrateSchema): use correct converter when downgrading.Jul 29 2024, 12:10 PM
ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.16; 2024-07-30).Jul 29 2024, 1:00 PM
gerritbot added a comment.Jul 29 2024, 4:58 PM

Change #1056959 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] refactor(SchemaConverters): prepare rename of downgradeFromNewer to downgradeToPrevious

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

gerritbot added a comment.Jul 29 2024, 4:58 PM

Change #1056962 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@master] refactor(ISchemaConverter): rename downgrading method

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

gerritbot added a comment.Jul 29 2024, 4:58 PM

Change #1056960 merged by jenkins-bot:

[mediawiki/extensions/GrowthExperiments@master] refactor: Remove unused code

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

Michael mentioned this in rECOM966e26739a10: refactor(ISchemaConverter): rename downgrading method.Jul 29 2024, 5:00 PM
Maintenance_bot removed a project: Patch-For-Review.Jul 29 2024, 5:30 PM
Michael mentioned this in T372055: Add a Migration to the CommunityConfiguration example (and tests).Aug 8 2024, 1:04 PM
Michael added a parent task: T372055: Add a Migration to the CommunityConfiguration example (and tests).
KStoller-WMF moved this task from FY2024-25 Q1 Sprint 2 to Estimated tasks backlog on the Growth-Team board.Aug 12 2024, 12:52 AM
KStoller-WMF edited projects, added: Growth-Team; removed: Growth-Team (FY2024-25 Q1 Sprint 2).
KStoller-WMF triaged this task as Medium priority.Aug 14 2024, 4:25 PM
Michael added a parent task: T371228: Page title component makes it easy to unintentionally blank page title.Sep 2 2024, 2:56 PM
KStoller-WMF moved this task from Estimated tasks backlog to Backlog on the Growth-Team board.Sep 3 2024, 4:24 PM
KStoller-WMF subscribed.

Estimation planning decision: this task should be broken into subtasks

Urbanecm_WMF removed a parent task: T371228: Page title component makes it easy to unintentionally blank page title.Sep 6 2024, 1:23 PM
Urbanecm_WMF added a subtask: T374236: Help panel schema: Require title and text keys to be present and non-empty.
Urbanecm_WMF changed the status of subtask T374236: Help panel schema: Require title and text keys to be present and non-empty from Open to Stalled.
Urbanecm_WMF mentioned this in T374236: Help panel schema: Require title and text keys to be present and non-empty.
Michael mentioned this in T357532: Create a system to support developers while upgrading configuration schemas.Sep 10 2024, 8:21 AM
Michael removed a subtask: T374236: Help panel schema: Require title and text keys to be present and non-empty.Oct 7 2024, 5:42 PM
Michael added a parent task: T374236: Help panel schema: Require title and text keys to be present and non-empty.
Sgs mentioned this in T383719: Declare the Community Configuration extension stable.Feb 6 2025, 10:44 AM
KStoller-WMF moved this task from Backlog to Estimated tasks backlog on the Growth-Team board.Feb 27 2025, 4:37 PM
KStoller-WMF set the point value for this task to 5.Mar 3 2025, 5:18 PM
KStoller-WMF moved this task from Estimated tasks backlog to Current Sprint on the Growth-Team board.Mar 18 2025, 4:54 PM
KStoller-WMF edited projects, added: Growth-Team (Current Sprint); removed: Growth-Team.
Michael claimed this task.Mar 26 2025, 4:11 PM
Restricted Application added a project: User-Michael. · View Herald TranscriptMar 26 2025, 4:11 PM
Michael added a comment.Mar 27 2025, 2:27 PM

General approach to finish implementing the migration feature:

  • write example migration and test for CommunityConfigurationExample (test will be failing for now)
  • when writing configuration, it should be validated with the Schema of its own version
  • when reading configuration for functional usage from code, the converters must be applied to bring it to the latest version
  • when reading configuration for rendering value in the Special:CommunityConfiguration form, then too the converters must be applied to bring it to the latest version

⇒ running the migration script will be a "convenience" so that the change of functionality is visible in the history of the config wiki-page, but it should not change anything functionality-wise

Michael moved this task from Incoming to Doing on the Growth-Team (Current Sprint) board.Mar 28 2025, 5:35 PM
gerritbot added a comment.Mar 28 2025, 5:45 PM

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

[mediawiki/extensions/CommunityConfiguration@master] fix: finish implementing migrations

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

gerritbot added a project: Patch-For-Review.Mar 28 2025, 5:45 PM
gerritbot added a comment.Apr 25 2025, 4:47 PM

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

[mediawiki/extensions/CommunityConfiguration@master] refactor: make IValidator implementations version-aware

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

gerritbot added a comment.Apr 25 2025, 4:47 PM

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

[mediawiki/extensions/CommunityConfiguration@master] refactor: make IValidator version aware

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

gerritbot added a comment.Apr 25 2025, 4:47 PM

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

[mediawiki/extensions/ReportIncident@master] refactor: make use of version in schema for validation

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

Michael moved this task from Doing to Code Review on the Growth-Team (Current Sprint) board.Apr 28 2025, 10:58 AM

This is finally ready for review now.

gerritbot added a comment.Jun 20 2025, 2:50 PM

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

[mediawiki/extensions/TemplateData@master] refactor: make use of version in schema for validation

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

gerritbot added a comment.Jun 23 2025, 10:25 AM

Change #1139103 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@master] refactor: make IValidator implementations version-aware

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

ReleaseTaggerBot added a project: MW-1.45-notes (1.45.0-wmf.8; 2025-07-01).Jun 24 2025, 3:02 PM
gerritbot added a comment.Jul 2 2025, 11:30 AM

Change #1139104 merged by jenkins-bot:

[mediawiki/extensions/CommunityConfiguration@master] refactor: make IValidator version aware

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

ReleaseTaggerBot edited projects, added: MW-1.45-notes (1.45.0-wmf.9; 2025-07-08); removed: MW-1.45-notes (1.45.0-wmf.8; 2025-07-01).Jul 2 2025, 12:01 PM
gerritbot added a comment.Jul 2 2025, 3:33 PM

Change #1161998 merged by jenkins-bot:

[mediawiki/extensions/TemplateData@master] refactor: make use of version in schema for validation

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

Michael mentioned this in T372049: Enable CommunityConfiguration Example in one beta wiki.Jul 3 2025, 4:38 PM
Michael moved this task from Code Review to Blocked / Needs Work on the Growth-Team (Current Sprint) board.Jul 11 2025, 8:46 PM

This is now blocked on work in T372049: Enable CommunityConfiguration Example in one beta wiki.

gerritbot added a comment.Jul 14 2025, 10:16 AM

Change #1169068 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Fix incomplete CommunityConfiguration SchemaProviderTestCase

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

gerritbot added a comment.Jul 14 2025, 11:28 AM

Change #1169068 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Fix incomplete CommunityConfiguration SchemaProviderTestCase

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

ReleaseTaggerBot edited projects, added: MW-1.45-notes (1.45.0-wmf.10; 2025-07-15); removed: MW-1.45-notes (1.45.0-wmf.9; 2025-07-08).Jul 14 2025, 12:00 PM
Michael removed a project: Growth-Team (Current Sprint).Aug 26 2025, 4:32 PM
Restricted Application added a project: Growth-Team. · View Herald TranscriptAug 26 2025, 4:32 PM
Urbanecm_WMF moved this task from Inbox to Triaged on the Growth-Team board.Oct 8 2025, 9:41 AM
gerritbot added a comment.Nov 14 2025, 3:59 PM

Change #1139106 merged by jenkins-bot:

[mediawiki/extensions/ReportIncident@master] refactor: make use of version in schema for validation

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

ReleaseTaggerBot added a project: MW-1.46-notes (1.46.0-wmf.3; 2025-11-19).Nov 14 2025, 4:00 PM
jenkins-bot mentioned this in rEREIa2a970e051f1: refactor: make use of version in schema for validation.Nov 14 2025, 4:00 PM
Michael added a project: Growth Team Maintenance.Dec 23 2025, 9:56 AM
Michael moved this task from Backlog to Finish CommunityConfiguration on the Growth Team Maintenance board.
Michael mentioned this in T293710: Remove opis/json-schema from MW vendor now that it's no longer used, everyone's on justinrainbow/json-schema.Jan 22 2026, 5:06 PM
Michael mentioned this in T388380: Migrate Community Configuration PHP library from justinrainbow/json-schema to opis/json-schema.Jan 22 2026, 5:25 PM
Michael raised the priority of this task from Medium to High.Jan 22 2026, 5:29 PM
Michael moved this task from Triaged to Current Maintenance Backlog on the Growth-Team board.Apr 21 2026, 4:34 PM
Michael moved this task from Current Maintenance Backlog to Estimated tasks backlog on the Growth-Team board.Apr 27 2026, 4:54 PM
Michael lowered the priority of this task from High to Medium.Apr 28 2026, 3:45 PM
KStoller-WMF moved this task from Estimated tasks backlog to Up next Sprint on the Growth-Team board.Apr 28 2026, 3:46 PM
Michael removed Michael as the assignee of this task.May 19 2026, 3:47 PM
KStoller-WMF assigned this task to EMcFarland-WMF.May 19 2026, 3:49 PM
KStoller-WMF moved this task from Up next Sprint to FY2025-26 Q4 Sprint 3 on the Growth-Team board.
KStoller-WMF edited projects, added: Growth-Team (FY2025-26 Q4 Sprint 3); removed: Growth-Team.
EMcFarland-WMF changed the task status from Open to In Progress.May 20 2026, 4:16 PM
EMcFarland-WMF moved this task from Incoming to Doing on the Growth-Team (FY2025-26 Q4 Sprint 3) board.May 21 2026, 10:39 AM
gerritbot added a comment.Jun 2 2026, 10:02 AM

Change #1296526 had a related patch set uploaded (by EMcFarland; author: EMcFarland):

[mediawiki/extensions/GrowthExperiments@master] fix: finish implementing migrations

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

DMburugu edited projects, added: Growth-Team (FY2025-26 Q4 Sprint 4); removed: Growth-Team (FY2025-26 Q4 Sprint 3).Jun 2 2026, 4:48 PM
DMburugu moved this task from Incoming to Doing on the Growth-Team (FY2025-26 Q4 Sprint 4) board.
DMburugu edited projects, added: Growth-Team; removed: Growth-Team (FY2025-26 Q4 Sprint 4).Jun 2 2026, 4:52 PM
DMburugu moved this task from Inbox to Up next Sprint on the Growth-Team board.
KStoller-WMF moved this task from Up next Sprint to Estimated tasks backlog on the Growth-Team board.Jun 27 2026, 8:35 PM
Michael moved this task from Estimated tasks backlog to Up next Sprint on the Growth-Team board.Mon, Jul 27, 2:01 PM
DMburugu moved this task from Up next Sprint to FY2026-27 Q1 Sprint 3 on the Growth-Team board.Tue, Jul 28, 4:36 PM
DMburugu edited projects, added: Growth-Team (FY2026-27 Q1 Sprint 3); removed: Growth-Team.
KStoller-WMF moved this task from Incoming to Doing on the Growth-Team (FY2026-27 Q1 Sprint 3) board.Wed, Jul 29, 4:05 PM
gerritbot added a comment.Fri, Aug 7, 1:23 PM

Change #1322764 had a related patch set uploaded (by EMcFarland; author: EMcFarland):

[mediawiki/extensions/GrowthExperiments@master] fix: finish implementing migrations

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

gerritbot added a comment.Fri, Aug 7, 1:25 PM

Change #1131996 abandoned by EMcFarland:

[mediawiki/extensions/CommunityConfiguration@master] fix: finish implementing migrations

Reason:

abandoned in favor of https://gerrit.wikimedia.org/r/c/mediawiki/extensions/GrowthExperiments/+/1322764

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

gerritbot added a comment.Fri, Aug 7, 1:26 PM

Change #1131996 restored by EMcFarland:

[mediawiki/extensions/CommunityConfiguration@master] fix: finish implementing migrations

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

gerritbot added a comment.Fri, Aug 7, 1:36 PM

Change #1296526 abandoned by EMcFarland:

[mediawiki/extensions/GrowthExperiments@master] fix: finish implementing migrations

Reason:

abandoned in favor of https://gerrit.wikimedia.org/r/c/mediawiki/extensions/GrowthExperiments/+/1322764

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

DMburugu added a project: Essential-Work.Mon, Aug 10, 10:55 AM
EMcFarland-WMF moved this task from Doing to Code Review on the Growth-Team (FY2026-27 Q1 Sprint 3) board.Tue, Aug 11, 11:17 AM
DMburugu moved this task from FY2026-27 Q1 Sprint 3 to FY2026-27 Q1 Sprint 4 on the Growth-Team board.Tue, Aug 11, 4:44 PM
DMburugu edited projects, added: Growth-Team (FY2026-27 Q1 Sprint 4); removed: Growth-Team (FY2026-27 Q1 Sprint 3).
DMburugu moved this task from Incoming to Code Review on the Growth-Team (FY2026-27 Q1 Sprint 4) board.
gerritbot added a comment.Thu, Aug 13, 8:41 AM

Change #1325418 had a related patch set uploaded (by EMcFarland; author: EMcFarland):

[mediawiki/extensions/GrowthExperiments@master] MentorListConfigProvider: Use current version of DataProvider::storeValidConfiguration

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

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits