Page MenuHomePhabricator
Create Task
Maniphest T301337

Split separate concepts off from large TemplateDataBlob class
Closed, ResolvedPublic8 Estimated Story Points
Actions

Description

As of January 2022 the TemplateDataBlob class is 1001 lines long. Buried in there are at least 4 different concept:

  • The actual data
  • Validation
  • Normalization
  • HTML formatting
  • As well as some utility code

Some of the benefits of splitting these into separate smaller services:

  • Code is much easier to read
  • Things can be tested separately in smaller and faster unit tests
  • Validation can be skipped when the input is known to be valid. This is currently not possible. Validation is done over and over again every time the API is used.

Patch-For-Review:

Details

SubjectRepoBranchLines +/-
Split validation and normalization into separate servicesmediawiki/extensions/TemplateDatamaster+143 -110
Split parameter validation off as separate methodsmediawiki/extensions/TemplateDatamaster+183 -157
Simplify language handling in API codemediawiki/extensions/TemplateDatamaster+3 -11
Extract named isValidCustomFormatString() methodmediawiki/extensions/TemplateDatamaster+20 -9
Remove unreachable validation stepmediawiki/extensions/TemplateDatamaster+1 -6
Replace duplicate getData…() signature with a single onemediawiki/extensions/TemplateDatamaster+14 -22
Move getRawParams helper method to ApiTemplateData classmediawiki/extensions/TemplateDatamaster+38 -33
Split and streamline HTML formatter codemediawiki/extensions/TemplateDatamaster+48 -42
Customize query in gerrit

Event Timeline

thiemowmde created this task.Feb 9 2022, 12:35 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 9 2022, 12:35 PM
thiemowmde moved this task from Sprint Backlog to Doing on the WMDE-TechWish-Sprint-2022-02-02 board.Feb 9 2022, 12:36 PM
thiemowmde set the point value for this task to 8.
gerritbot added a comment.Feb 9 2022, 12:37 PM

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

[mediawiki/extensions/TemplateData@master] Simplify language handling in API code

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

gerritbot added a project: Patch-For-Review.Feb 9 2022, 12:37 PM

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

[mediawiki/extensions/TemplateData@master] Replace duplicate getData\u2026() signature with a single one

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

gerritbot added a comment.Feb 9 2022, 12:37 PM

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

[mediawiki/extensions/TemplateData@master] Split and streamline HTML formatter code

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

gerritbot added a comment.Feb 9 2022, 12:37 PM

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

[mediawiki/extensions/TemplateData@master] Move getRawParams helper method to ApiTemplateData class

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

gerritbot added a comment.Feb 9 2022, 12:37 PM

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

[mediawiki/extensions/TemplateData@master] Split validation and normalization into separate services

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

Maintenance_bot added a project: VisualEditor.Feb 9 2022, 12:45 PM
thiemowmde moved this task from Doing to Tech Review on the WMDE-TechWish-Sprint-2022-02-02 board.Feb 9 2022, 1:34 PM
thiemowmde edited projects, added WMDE-Templates-FocusArea; removed WMDE-GeoInfo-FocusArea.Feb 9 2022, 1:38 PM
gerritbot added a comment.Feb 9 2022, 2:23 PM

Change 759462 merged by jenkins-bot:

[mediawiki/extensions/TemplateData@master] Split and streamline HTML formatter code

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

thiemowmde updated the task description. (Show Details)Feb 9 2022, 2:46 PM
ReleaseTaggerBot added a project: MW-1.38-notes (1.38.0-wmf.22; 2022-02-14).Feb 9 2022, 3:00 PM
WMDE-Fisch moved this task from Backlog to In sprint on the WMDE-Templates-FocusArea board.Feb 9 2022, 3:17 PM
gerritbot added a comment.Feb 10 2022, 5:44 AM

Change 749695 merged by jenkins-bot:

[mediawiki/extensions/TemplateData@master] Move getRawParams helper method to ApiTemplateData class

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

gerritbot added a comment.Feb 10 2022, 9:37 AM

Change 759455 abandoned by Thiemo Kreuz (WMDE):

[mediawiki/extensions/TemplateData@master] Replace duplicate getData\u2026() signature with a single one

Reason:

Originally my goal was to get rid of the deep clone altogether. But this got lost very early. I might try again later.

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

ppelberg moved this task from To Triage to Triaged on the VisualEditor board.Feb 10 2022, 4:39 PM
thiemowmde moved this task from Tech Review to Watching / Epic / Stalled on the WMDE-TechWish-Sprint-2022-02-02 board.Feb 11 2022, 9:58 AM
thiemowmde moved this task from Incoming to In progress on the WMDE-TechWish-Maintenance board.Feb 14 2022, 4:41 PM
gerritbot added a comment.Feb 22 2022, 9:51 AM

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

[mediawiki/extensions/TemplateData@master] Remove unreachable validation step

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

gerritbot added a comment.Mar 3 2022, 4:33 PM

Change 764729 merged by jenkins-bot:

[mediawiki/extensions/TemplateData@master] Remove unreachable validation step

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

ReleaseTaggerBot edited projects, added MW-1.38-notes (1.38.0-wmf.25; 2022-03-07); removed MW-1.38-notes (1.38.0-wmf.22; 2022-02-14).Mar 3 2022, 5:00 PM
thiemowmde updated the task description. (Show Details)Mar 4 2022, 10:33 AM
thiemowmde moved this task from In progress to Backlog on the WMDE-TechWish-Maintenance board.
awight moved this task from In sprint to Backlog on the WMDE-Templates-FocusArea board.Jun 17 2022, 9:15 AM
gerritbot added a comment.Jul 15 2022, 9:11 AM

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

[mediawiki/extensions/TemplateData@master] Split parameter validation off as separate methods

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

gerritbot added a comment.Jul 15 2022, 9:58 AM

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

[mediawiki/extensions/TemplateData@master] Extract named isValidCustomFormatString() method

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

gerritbot added a comment.Dec 13 2022, 9:09 PM

Change 814109 merged by jenkins-bot:

[mediawiki/extensions/TemplateData@master] Split parameter validation off as separate methods

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

ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.17; 2023-01-02).Dec 13 2022, 10:01 PM
gerritbot added a comment.Dec 29 2022, 1:06 AM

Change 814112 merged by jenkins-bot:

[mediawiki/extensions/TemplateData@master] Extract named isValidCustomFormatString() method

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

thiemowmde moved this task from Backlog to In progress on the WMDE-TechWish-Maintenance board.Mar 13 2023, 2:10 PM
gerritbot added a comment.Apr 11 2023, 4:51 AM

Change 749747 merged by jenkins-bot:

[mediawiki/extensions/TemplateData@master] Split validation and normalization into separate services

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

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.5; 2023-04-17).Apr 11 2023, 5:00 AM
gerritbot added a comment.Apr 11 2023, 5:51 PM

Change 759454 abandoned by Thiemo Kreuz (WMDE):

[mediawiki/extensions/TemplateData@master] Simplify language handling in API code

Reason:

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

thiemowmde closed this task as Resolved.Apr 11 2023, 5:52 PM
Maintenance_bot removed a project: Patch-For-Review.Apr 11 2023, 6:10 PM
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