Page MenuHomePhabricator
Create Task
Maniphest T371028

Migration Schemas to a non-latest version is broken
Open, 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:
SubjectRepoBranchLines +/-
Fix incomplete CommunityConfiguration SchemaProviderTestCasemediawiki/extensions/Citemaster+3 -0
refactor: make use of version in schema for validationmediawiki/extensions/ReportIncidentmaster+2 -2
fix: finish implementing migrationsmediawiki/extensions/CommunityConfigurationmaster+339 -108
refactor: make use of version in schema for validationmediawiki/extensions/TemplateDatamaster+7 -6
refactor: make IValidator version awaremediawiki/extensions/CommunityConfigurationmaster+8 -2
refactor: make IValidator implementations version-awaremediawiki/extensions/CommunityConfigurationmaster+36 -21
refactor(ISchemaConverter): rename downgrading methodmediawiki/extensions/CommunityConfigurationmaster+5 -5
refactor: Remove unused codemediawiki/extensions/GrowthExperimentsmaster+0 -15
refactor(SchemaConverters): prepare rename of downgradeFromNewer to downgradeToPreviousmediawiki/extensions/GrowthExperimentsmaster+15 -0
fix(migrateSchema): use correct converter when downgradingmediawiki/extensions/CommunityConfigurationmaster+23 -4
Customize query in gerrit

Related Objects
Search...

Event Timeline

Michael created this task.Jul 25 2024, 2:29 PM
Michael renamed this task from Migration Schemas to a non-latest fundamentally broken to Migration Schemas to a non-latest version is fundamentally broken.
Michael renamed this task from Migration Schemas to a non-latest version is fundamentally broken to Migration Schemas to a non-latest version is broken.
gerritbot added a comment.Jul 25 2024, 2:56 PM

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

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

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

gerritbot added a project: Patch-For-Review.Jul 25 2024, 2:56 PM

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

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

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

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 Up Next (estimated tasks) 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 Up Next (estimated tasks) 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 Up Next (estimated tasks) 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 Up Next (estimated tasks) 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.Wed, Oct 8, 9:41 AM
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