Page MenuHomePhabricator
Create Task
Maniphest T293513

Deprecate and remove ParserOutput::setTOCHTML()
Open, LowPublic
Actions

Description

With the refactoring of TOC generation into ParserOutput::getText() as a post-processing step (see T287767 and https://gerrit.wikimedia.org/r/c/mediawiki/core/+/721115) we should go one step further and remove the HTML from ParserOutput and instead regenerate it from ParserOutput::getSections() only if/when needed by the skin (by calling methods in Linker). This would also ensure that Parsoid *only* needs to generate the appropriate ParesrOutput::setSections() call and doesn't also need to implement HTML for the ToC.

Details

SubjectRepoBranchLines +/-
Deprecate mutation of ToC in OutputPageParserOutput hookmediawiki/coremaster+21 -1
Deprecate TOC mutation in OutputPageParserOutput hookmediawiki/coremaster+5 -1
Deprecate ParserOutput::{get,set}TOCHTML()mediawiki/coremaster+32 -4
Generate TOC HTML on demand in ParserOutput::getText()mediawiki/coremaster+147 -113
Customize query in gerrit

Related Objects
Search...

StatusSubtypeAssignedTask
 OpenReleaseNoneT84936 Release VisualEditor-MediaWiki as "1.0"
 OpenNoneT50429 [Epic] Support editing parts of a page in VisualEditor-MediaWiki
 OpenNoneT54365 Explore performance gains from progressive (JIT?) de-alienation in VisualEditor
 OpenNoneT174303 Copy-pasting linked ISBN numbers from view mode HTML into VisualEditor inserts wikitext links to Special:BookSources (it should turn them into magic links?)
 OpenFeatureNoneT54091 The read HTML should have hinting to allow full DOM copying (as opposed to just rich copying) from read mode into VE surfaces
 OpenNoneT55784 [EPIC] Use Parsoid HTML for all page views
 OpenNoneT272987 [EPIC] Parsoid read views for DiscussionTools
 OpenNoneT297840 Populate ParserCache with Parsoid output as a post-edit hook
 Resolved• ssastryT310510 Discussion tools visual diff testing between parsoid read views and legacy read views
 OpenNoneT310511 Metadata comparison testing between Parsoid and the legacy parser
 OpenNoneT310512 Parsoid and the legacy parser should emit exactly the same ParserOutput metadata
 OpenNoneT305159 Improve coverage of the ContentMetadataCollector interface
 ResolvedovasilevaT283505 [EPIC] Fixed "sticky" site header
 Resolved• ssastryT270199 Table of contents in Parsoid output
 OpenNoneT325567 Document how to safely make changes to ParserOutput serialization
 ResolvedcscottT355952 "PHP Deprecated: Use of MediaWiki\Parser\ParserOutput::setTOCHTML was deprecated in MediaWiki 1.40" in PHPUnit tests
 OpenNoneT353570 Clean up old ParserCache serialization test cases
 OpenNoneT293513 Deprecate and remove ParserOutput::setTOCHTML()
 ResolvedcscottT295169 Parser TOC placeholder should be a meta tag
 OpenNoneT295168 Ensure <meta typeof="..."> in Parser/Parsoid HTML can't be spoofed from wikitext
 ResolvedmatmarexT218330 Table of contents HTML may be unbalanced

Event Timeline

cscott created this task.Oct 15 2021, 6:49 PM
cscott added a comment.Oct 15 2021, 7:03 PM

Worth considering if we should update setSections() to take an array<SectionMetadata> instead of a plain associative array as well.

Arlolra moved this task from Needs Triage to Tech Debt / Big changes on the Parsoid board.Oct 22 2021, 3:09 PM
cscott mentioned this in T270199: Table of contents in Parsoid output.Oct 22 2021, 8:22 PM
cscott added a subtask: T295169: Parser TOC placeholder should be a meta tag.Nov 5 2021, 4:05 PM
cscott mentioned this in T19587: alias __TOC__ to {{#TOC}} and add TOC style options to such parser function.Nov 5 2021, 4:43 PM
cscott added a parent task: T270199: Table of contents in Parsoid output.Mar 30 2022, 9:53 PM
cscott edited parent tasks, added: T305159: Improve coverage of the ContentMetadataCollector interface; removed: T287216: ParserOutput should implement ContentMetadataCollector.Mar 31 2022, 3:23 PM
cscott added a subtask: T218330: Table of contents HTML may be unbalanced.May 31 2022, 3:20 PM
cscott mentioned this in T307251: [ToC] Show new/modified sections after publishing an edit (new floating ToC).
Jdlrobson awarded a token.May 31 2022, 3:34 PM
Jdlrobson rescinded a token.
Jdlrobson awarded a token.
Jdlrobson subscribed.

Sorry, very much intended a like token there :-)

ovasileva subscribed.May 31 2022, 3:46 PM
cscott mentioned this in T310083: ToC issues.Jun 7 2022, 3:53 PM
daniel moved this task from Unsorted pile to VE Backend pile on the Platform Team Workboards (MW Expedition) board.Jun 28 2022, 8:39 AM
daniel triaged this task as Low priority.Jun 29 2022, 10:20 AM
gerritbot added a comment.Jul 27 2022, 11:14 PM

Change 804310 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/core@master] [EXPERIMENTAL] deprecate mutation of ToC in OutputPageParserOutput hook

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

gerritbot added a project: Patch-For-Review.Jul 27 2022, 11:14 PM
NBaca-WMF subscribed.Aug 1 2022, 3:48 PM
cscott mentioned this in T316007: TOC is shown unstyled and inline on Special:EditWatchlist.Sep 8 2022, 6:44 PM
cscott mentioned this in T317014: Incorrect width in Vector 2022 due to mismatched weight on a text heading.Sep 8 2022, 7:04 PM
daniel added a project: RESTBase Sunsetting.Dec 6 2022, 3:28 PM
daniel moved this task from Unsorted to Parsoid pile on the RESTBase Sunsetting board.Dec 6 2022, 3:30 PM
daniel removed a project: Platform Team Workboards (MW Expedition).Dec 6 2022, 3:55 PM
• ssastry added a comment.Dec 6 2022, 5:17 PM

https://gerrit.wikimedia.org/r/c/mediawiki/core/+/862391 fixes this and I should probably add this phab task to that patch.

• ssastry added a comment.Dec 6 2022, 5:22 PM

Since there are no external users of setTOCHTML, we could potentially remove setTOCHTML completely right away if we got rid of synthetic data from parsercache serialization test data.

gerritbot added a comment.Dec 6 2022, 5:31 PM

Change 862391 had a related patch set uploaded (by Subramanya Sastry; author: Subramanya Sastry):

[mediawiki/core@master] Generate TOC HTML on demand in ParserOutput

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

daniel moved this task from Parsoid pile to Radar on the RESTBase Sunsetting board.Jan 9 2023, 9:52 AM
cscott closed subtask T295169: Parser TOC placeholder should be a meta tag as Resolved.Jan 23 2023, 10:40 PM
gerritbot added a comment.Jan 26 2023, 5:51 PM

Change 862391 merged by jenkins-bot:

[mediawiki/core@master] Generate TOC HTML on demand in ParserOutput::getText()

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

ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.21; 2023-01-30).Jan 26 2023, 6:00 PM
gerritbot added a comment.Jan 26 2023, 10:14 PM

Change 884103 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/core@master] WIP: Deprecate ParserOutput::{get,set}TOCHTML()

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

cscott mentioned this in T328087: Upcoming TOC changes break WikidataPageBanner, used on WIkivoyage.Jan 26 2023, 10:44 PM
matmarex mentioned this in T328122: Move DiscussionTools TOC metadata generation to a post-processing step.Jan 27 2023, 12:02 PM
gerritbot added a comment.Mar 12 2023, 9:41 PM

Change 884103 merged by jenkins-bot:

[mediawiki/core@master] Deprecate ParserOutput::{get,set}TOCHTML()

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

ReleaseTaggerBot edited projects, added MW-1.40-notes (1.40.0-wmf.27; 2023-03-13); removed MW-1.40-notes (1.40.0-wmf.21; 2023-01-30).Mar 12 2023, 10:00 PM
MSantos subscribed.May 4 2023, 3:03 PM

@cscott what are the next steps here after /r/884103 got merged?

gerritbot added a comment.Aug 8 2023, 6:18 PM

Change 946987 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/core@master] Deprecate TOC mutation in OutputPageParserOutput hook

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

gerritbot added a comment.Sep 30 2023, 4:12 AM

Change 946987 merged by jenkins-bot:

[mediawiki/core@master] Deprecate TOC mutation in OutputPageParserOutput hook

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

ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.29; 2023-10-03).Sep 30 2023, 5:00 AM
Umherirrender mentioned this in T348134: PHP Deprecated: Use of OutputPageParserOutput hook to mutate TOC was deprecated in MediaWiki 1.41.Oct 4 2023, 3:36 PM
cscott added a comment.Nov 6 2023, 8:59 PM

The only reason ::setTOCHTML is still sticking around is because we haven't regenerated the ParserCache migration test suite to remove it yet.

matmarex closed subtask T218330: Table of contents HTML may be unbalanced as Resolved.Nov 17 2023, 6:35 PM
cscott added a parent task: T353570: Clean up old ParserCache serialization test cases.Dec 16 2023, 3:34 AM
Reedy subscribed.Dec 27 2023, 12:00 AM

See in CI...

23:57:59 PHP Deprecated:  Use of MediaWiki\Parser\ParserOutput::setTOCHTML was deprecated in MediaWiki 1.40. [Called from MediaWiki\Tests\Parser\ParserCacheSerializationTestCases::getParserOutputTestCases in /workspace/src/tests/phpunit/includes/parser/ParserCacheSerializationTestCases.php at line 236] in /workspace/src/includes/debug/MWDebug.php on line 378
gerritbot added a comment.Apr 15 2024, 5:27 PM

Change #804310 abandoned by C. Scott Ananian:

[mediawiki/core@master] Deprecate mutation of ToC in OutputPageParserOutput hook

Reason:

We ended up removing setTOCHTML(), making this patch moot.

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

Maintenance_bot removed a project: Patch-For-Review.Apr 15 2024, 5:30 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