Page MenuHomePhabricator
Create Task
Maniphest T353227

[Epic] Cleanups in Cite Extension
Open, Needs TriagePublic
Actions

Description

We're finding a lot of tech debt in Cite which can be tracked in this bug.

Suggested fixes:

  • ReferenceStack shouldn't be responsible for final numbering, that can be moved to the footnote mark renderer.
  • Can the stack rollback concept be deprecated?
  • Render errors in the footnote and not in article text.
  • Always use StatusValue to tranfer errors, rather than immediately rendering errors as HTML.

Patches

Details

SubjectRepoBranchLines +/-
Don't search for [[MediaWiki:cite_link_label_group-]]mediawiki/extensions/Citemaster+29 -8
Switch to a 1-based "count"mediawiki/extensions/Citemaster+113 -94
Use semantic field to test ref typemediawiki/extensions/Citemaster+3 -4
Reduce deeply nested variablesmediawiki/extensions/Citemaster+21 -21
Various cleanups to PHPUnit test mock setupmediawiki/extensions/Citemaster+19 -33
Add basic class-level documentation to more classesmediawiki/extensions/Citemaster+11 -0
More simple and consistent @covers and @license tagsmediawiki/extensions/Citemaster+27 -101
Introduce named constant for "__placeholder__" stringmediawiki/extensions/Citemaster+5 -4
Avoid a few isset() in favor of more recent syntaxmediawiki/extensions/Citemaster+29 -49
Customize query in gerrit

Related Objects
Search...

Event Timeline

awight created this task.Dec 12 2023, 9:58 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 12 2023, 9:58 AM
WMDE-Fisch moved this task from Sprint Backlog to Watching / Epic / Stalled on the WMDE-TechWish-Sprint-2023-12-06 board.Dec 12 2023, 11:13 AM
gerritbot added a comment.Dec 12 2023, 12:12 PM

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

[mediawiki/extensions/Cite@master] Don't search for [[MediaWiki:cite_link_label_group-]]

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

gerritbot added a project: Patch-For-Review.Dec 12 2023, 12:12 PM

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

[mediawiki/extensions/Cite@master] Avoid a few isset() in favor of more recent syntax

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

gerritbot added a comment.Dec 12 2023, 12:27 PM

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

[mediawiki/extensions/Cite@master] Move a bit of code out of Cite::guardedReferences

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

awight added a project: Epic.Dec 12 2023, 2:36 PM
thiemowmde closed subtask T353261: Merge AnchorFormatter jumpLink and jumpLinkTarget functions as Invalid.Dec 12 2023, 6:03 PM
gerritbot added a comment.Dec 12 2023, 11:58 PM

Change 982361 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Avoid a few isset() in favor of more recent syntax

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

ReleaseTaggerBot added a project: MW-1.42-notes (1.42.0-wmf.10; 2023-12-19).Dec 13 2023, 1:00 AM
MareikeHeuerWMDE mentioned this in T202593: Show a warning if the same named ref tag has two conflicting dir values.Dec 13 2023, 3:19 PM
gerritbot added a comment.Dec 14 2023, 8:46 AM

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

[mediawiki/extensions/Cite@master] Introduce named constant for "__placeholder__" string

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

gerritbot added a comment.Dec 14 2023, 2:20 PM

Change 983133 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Introduce named constant for "__placeholder__" string

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

awight added subtasks: T353436: Port Cite web test suite to Cypress, T353439: Write web test for Cite-VisualEditor integration.Dec 14 2023, 4:34 PM
gerritbot added a comment.Dec 15 2023, 11:23 AM

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

[mediawiki/extensions/Cite@master] More simple and consistent @covers and @license tags

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

gerritbot added a comment.Dec 15 2023, 11:45 AM

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

[mediawiki/extensions/Cite@master] Various cleanups to PHPUnit test mock setup

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

gerritbot added a comment.Dec 15 2023, 1:10 PM

Change 983378 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] More simple and consistent @covers and @license tags

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

gerritbot added a comment.Dec 15 2023, 1:29 PM

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

[mediawiki/extensions/Cite@master] Add basic class-level documentation to more classes

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

gerritbot added a comment.Dec 18 2023, 12:35 PM

Change 983402 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Add basic class-level documentation to more classes

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

gerritbot added a comment.Dec 18 2023, 12:36 PM

Change 983383 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Various cleanups to PHPUnit test mock setup

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

thiemowmde closed subtask T353269: Extract ref validation into a separate class as Resolved.Dec 20 2023, 10:03 AM
thiemowmde added a project: WMDE-TechWish-Sprint-2024-01-04.Jan 4 2024, 12:56 PM
thiemowmde closed subtask T353263: Investigate whether Cite rollback / redo mechanism can be avoided as Resolved.
thiemowmde moved this task from Sprint Backlog to Watching / Epic / Stalled on the WMDE-TechWish-Sprint-2024-01-04 board.
gerritbot added a comment.Jan 6 2024, 1:30 AM

Change 988119 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/Cite@master] Reduce deeply nested variables

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

gerritbot added a comment.Jan 6 2024, 1:30 AM

Change 988120 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/Cite@master] Use semantic fields to test ref type

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

gerritbot added a comment.Jan 6 2024, 3:50 PM

Change 988151 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/Cite@master] Switch to a 1-based "count"

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

gerritbot added a comment.Jan 6 2024, 6:48 PM

Change 988119 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Reduce deeply nested variables

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

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.13; 2024-01-09 ); removed MW-1.42-notes (1.42.0-wmf.10; 2023-12-19).Jan 6 2024, 7:00 PM
gerritbot added a comment.Jan 8 2024, 8:16 AM

Change 988120 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Use semantic field to test ref type

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

gerritbot added a comment.Jan 8 2024, 11:33 AM

Change 988151 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Switch to a 1-based "count"

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

gerritbot added a comment.Jan 9 2024, 4:21 PM

Change 982377 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Don't search for [[MediaWiki:cite_link_label_group-]]

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

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.14; 2024-01-16); removed MW-1.42-notes (1.42.0-wmf.13; 2024-01-09 ).Jan 9 2024, 5:00 PM
awight closed subtask T353451: Encapsulate ReferenceStackItem as Resolved.Jan 17 2024, 9:35 AM
awight closed subtask T353266: Use StatusValue to transfer results and errors as Resolved.
Tobi_WMDE_SW closed subtask T353439: Write web test for Cite-VisualEditor integration as Resolved.Jan 31 2024, 9:44 AM
Tobi_WMDE_SW closed subtask T353436: Port Cite web test suite to Cypress as Resolved.
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