Page MenuHomePhabricator
Create Task
Maniphest T292868

Migrate boolean flags in ParserOutput to ::setFlag() or ::setOutputFlag() or ::setExtensionData()
Closed, ResolvedPublic
Actions

Description

There are a large number of ad-hoc booleans in ParserOutput:

  • ::setNoGallery()
  • ::setEnableOOUI()
  • ::setIndexPolicy() (maybe?)
  • ::setNewSection()
  • ::setHideNewSection()
  • ::setPreventClickjacking()

These generally have nothing to do with the parser, they are just pass-throughs from certain extensions or parser functions. We should try to unify them to a standard interface so that the API of ParserOutput doesn't grow w/o limit. Perhaps

function setOutputFlag(string $flag, bool $val = true);

can be used, with a class

class ParserOutputFlags {
   public const PREVENT_CLICKJACKING = 'mw-preventClickjacking';
   public const ENABLE_OOUI = 'mw-enableOOUI';
   // etc
}

In fact, we already have ParserOutput::setExtensionData() *and* ::setFlag(); perhaps this should be used for the backend storage instead of inventing a new method.

Details

Related Changes in Gerrit:
Show related patches 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
 OpenNoneT396539 Introduce a way to edit a span of text from within read mode
 OpenNoneT385558 Improve copy and paste from read mode to VE
 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
 ResolvedssastryT270199 Table of contents in Parsoid output
 ResolvedssastryT92999 Better handle `__TOC__` in parser tests
 ResolvedcscottT295209 Followup to fix corner cases in ToC language-conversion
 ResolvedcscottT269630 Parsoid should support section editing links
 ResolvedcscottT357826 DiscussionTools Headings are wrapped twice when using Parsoid
 ResolvedNoneT357831 Headings are too large when Parsoid section edit links are added
 ResolvedssastryT107332 Parsoid-native implementation for <indicator> (page status indicators)
 ResolvedcscottT254181 Run parserTests with Parsoid in extension repos
 ResolvedcscottT234932 Parsoid srcset is inconsistent with core
 ResolvedcscottT287216 ParserOutput should implement ContentMetadataCollector
 ResolvedcscottT293515 Migrate ParserOutput::addWarning() to ::addWarningMsg()
 ResolvedPRODUCTION ERRORLucas_Werkmeister_WMDET293860 PHP Deprecated: Use of ParserOutput::setProperty was deprecated in MediaWiki 1.38. [Called from Wikibase\Client\Hooks\ShortDescHandler::doHandle]
 ResolvedPRODUCTION ERRORabi_T293895 PHP Deprecated: Use of ParserOutput::getProperty was deprecated in MediaWiki 1.38. [Called from LqtDiscussionPager::getPageLimit]
 ResolvedPRODUCTION ERRORcscottT293894 PHP Deprecated: Use of ParserOutput::getProperty was deprecated in MediaWiki 1.38. [Called from GeoCrumbsHooks::makeTrail]
 ResolvedPRODUCTION ERRORroman-stolarT293923 PHP Deprecated: Use of ParserOutput::addTrackingCategory was deprecated in MediaWiki 1.38. [Called from TemplateStylesContent::getParserOutput]
 ResolvedNoneT296123 Simplify string|array argument type for ParserOutput::addModules()/::addModuleStyles()/::addJsConfigVars()
 ResolvedNoneT301619 Replace use of deprecated ParserOutput::{get,set,unset}Property
 ResolvedmatmarexT317489 <!--__DTEMPTYTALKPAGE__--> turning indicator HTML from <link> to <span>
 ResolvedmatmarexT328980 DiscussionTools marker comments still appear in the output sometimes in weird places
 ResolvedcscottT297840 Populate ParserCache with Parsoid output as a post-edit hook
 ResolvedcscottT300189 DiscussionTools should sometimes set the 'useParsoid' option in ParserOptions
 ResolvedcscottT300190 Ensure that if 'useParsoid' flag is present in ParserOptions that we use Parsoid to parse the page.
 ResolvedihurbainT310520 Parsoid content not compatible with `index.php?title=` URLs
 ResolvedNoneT300191 Bikeshed name of 'useParsoid' flag in ParserOptions
 ResolvedcscottT310526 Parsoid read views doesn't support -{T|...}- page title markup
 ResolvedNoneT310544 Ensure MobileFrontend works with Parsoid read views for discussion tools
 ResolvedssastryT341010 DiscussionTools doesn't recognize talk threads with Parsoid HTML
 DeclinedssastryT342352 Create ParsoidExperimentalDeprecatedPostProcessingHookDoNotUse hook for DiscussionTools testing
 ResolvedPRODUCTION ERRORssastryT351461 InvalidArgumentException: Multiple conflicting values given for wgDiscussionToolsPageThreads
 ResolvedcscottT355374 Use Parsoid for DiscussionTools on wikitech
 ResolvedssastryT353079 On wikitech, DiscussionTools doesn't render reply links with "?useparsoid=1" when logged out
 ResolvedMSantosT348998 Spike: Parsoid Usage Confidence Framework
 ResolvedihurbainT69486 Links: Add support for self-links to Parsoid
 OpenNoneT336256 Inconsistent use of href parameter and selflink mw-selflink classes between plain links and links in images
 ResolvedcscottT355564 Add config option to switch DT to use parsoid by default on wikitech
 DeclinedNoneT360903 Parsoid DiscussionTools for arwiki/cswiki/huwiki (phase 2)
 DeclinedNoneT364316 Run visualdiff testing on arwiki/cswiki/huwiki Talk namespace
 DeclinedNoneT360905 Parsoid DiscussionTools, phase 3
 DeclinedNoneT360906 Parsoid DiscussionTools for dewiki (phase 4)
 ResolvedppelbergT381655 FOUC when loading talk pages on mobile using Parsoid read views
 ResolvedBUG REPORTNoneT358981 Talk page discussion parsing is broken on mobile views with Parsoid read views enabled
 ResolvedPRODUCTION ERRORJdlrobson-WMFT376048 MFE still have issues with Parsoid Read Views on talk pages (Discussion Tools) - Type Error: startMarker is null
 ResolvedEsandersT401852 Talk page sections do not always collapse with Parsoid
 OpenNoneT419048 Use Parsoid as default wikitext parser in MW 1.47
 StalledNoneT403531 add remaining SLIs to Pyrra dashboard
 OpenNoneT409815 SLI: MediaWiki system load
 OpenNoneT393717 Put lints in ParserOutput/RefreshLinksJob
 OpenBUG REPORTNoneT393682 Wikifunctions fragments that trigger errors and try to put the page in a tracking category show it at the bottom of the view page, but the pages using the fragment do not appear on the category page
 OpenNoneT393716 [EPIC] RefreshLinksJob should use Parsoid-generated metadata
 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
 ResolvedcscottT292868 Migrate boolean flags in ParserOutput to ::setFlag() or ::setOutputFlag() or ::setExtensionData()
 ResolvedcscottT293513 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
 OpenNoneT331483 Resolve differences between Parsoid & legacy parser TOC metadata output for template, extension, and parser-function generated content
 ResolvedcscottT213468 Parsoid section IDs don't correspond to PHP section IDs when headings are transcluded
 ResolvedABreault-WMFT215628 Make Parsoid and PHP edit-section numbering consistent when <noinclude> and <includeonly> are in use
 ResolvedcscottT214538 MediaWiki shouldn't assign section numbers during tokenization, but instead only when headings are generated
 OpencscottT359221 Parsoid's TOC handling needs to deal with HTML-returning components (exts, SPTs, parser funcs returning HTML) consistently
 ResolvedssastryT359450 Parsoid is not adding headings to TOC entries in some templated content scenarios
 ResolvedJgiannelosT402456 More Parsoid TOC edge cases?
 OpenJgiannelosT415554 From TOC difftesting (legacy/parsoid): Differences in template handling from sections
 OpenJgiannelosT415558 From TOC difftesting (legacy/parsoid): Mismatch when sections come from the same article
 OpenJgiannelosT415563 From TOC difftesting (legacy/parsoid): Inconsistent index level between legacy and parsoid
 OpenJgiannelosT415565 From TOC difftesting (legacy/parsoid): Section titles wrapped in html elements on parsoid
 ResolvedJgiannelosT403188 Implement TOC comparison in Linter extension
 OpenNoneT428786 Expose JSON-serialized ParserOutput via API

Event Timeline

cscott created this task.Oct 8 2021, 6:36 PM
Restricted Application removed a project: Patch-For-Review. · View Herald TranscriptOct 8 2021, 6:36 PM
gerritbot added a comment.Oct 8 2021, 8:07 PM

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

[mediawiki/core@master] Add new ParserOutput::{get,set}OutputFlag() interface

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

gerritbot added a project: Patch-For-Review.Oct 8 2021, 8:07 PM
cscott renamed this task from Migrate boolean flags in ParserOutput to ::setOutputFlag() or ::setExtensionData() to Migrate boolean flags in ParserOutput to ::setFlag() or ::setOutputFlag() or ::setExtensionData().Oct 8 2021, 8:15 PM
cscott updated the task description. (Show Details)
gerritbot added a comment.Oct 13 2021, 8:35 PM

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

[mediawiki/core@master] Mark ParserOutput::getAllFlags() @internal

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

gerritbot added a comment.Oct 15 2021, 11:02 PM

Change 730636 merged by jenkins-bot:

[mediawiki/core@master] Mark ParserOutput::getAllFlags() @internal

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

gerritbot added a comment.Oct 15 2021, 11:28 PM

Change 728644 merged by jenkins-bot:

[mediawiki/core@master] Add new ParserOutput::{get,set}OutputFlag() interface

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

ReleaseTaggerBot edited projects, added: MW-1.38-notes (1.38.0-wmf.5; 2021-10-19); removed: MW-1.38-notes (1.38.0-wmf.4; 2021-10-12).Oct 16 2021, 12:00 AM
Arlolra moved this task from Needs Triage to Tech Debt / Big changes on the Parsoid board.Oct 22 2021, 3:10 PM
cscott mentioned this in T296345: Add ParserOutput::addOutputData() to unify various accumulators in ParserOutput.Nov 23 2021, 9:16 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
ssastry moved this task from Backlog to In Progress on the Parsoid-Read-Views (Phase 2 - testwiki Main namespace support) board.May 11 2022, 1:44 PM
daniel moved this task from Unsorted pile to VE Backend pile on the Platform Team Workboards (MW Expedition) board.May 19 2022, 12:42 PM
daniel subscribed.May 24 2022, 8:22 AM

Patches are merged, can we close this ticket?

daniel triaged this task as Medium priority.May 24 2022, 8:22 AM
daniel lowered the priority of this task from Medium to Low.May 30 2022, 3:09 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
daniel moved this task from Parsoid pile to Radar on the RESTBase Sunsetting board.Jan 9 2023, 9:52 AM
gerritbot added a comment.Jul 28 2023, 3:37 AM

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

[mediawiki/core@master] Hard-deprecate ParserOutput::{get,set}Flag()

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

gerritbot added a comment.Jul 28 2023, 3:43 AM

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

[mediawiki/extensions/CIForms@master] Use ParserOutput::{get,set}ExtensionData instead of deprecated methods

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

gerritbot added a comment.Jul 28 2023, 3:47 AM

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

[mediawiki/extensions/PageProperties@master] Use ParserOutput::{get,set}ExtensionData instead of deprecated methods

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

gerritbot added a comment.Aug 2 2023, 5:40 PM

Change 942535 merged by jenkins-bot:

[mediawiki/extensions/PageProperties@master] Use ParserOutput::{get,set}ExtensionData instead of deprecated methods

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

cscott mentioned this in rEPPRa171347a2c78: Use ParserOutput::{get,set}ExtensionData instead of deprecated methods.Aug 2 2023, 5:41 PM
gerritbot added a comment.Aug 2 2023, 5:48 PM

Change 942525 merged by jenkins-bot:

[mediawiki/core@master] Hard-deprecate ParserOutput::{get,set}Flag()

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

MSantos removed a project: RESTBase Sunsetting.Nov 21 2024, 11:13 AM
MSantos subscribed.

I am removing RESTBase Sunsetting as this is not needed for its completion. Please, re-add in case I'm missing something.

gerritbot added a comment.Oct 6 2025, 2:15 AM

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

[mediawiki/core@master] ParserOutput: move flags into $mFlags array

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

gerritbot added a comment.Oct 6 2025, 2:15 AM

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

[mediawiki/core@master] Forward-compatibility: allow output flags to be serialized in `OutputFlags`

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

gerritbot added a comment.Oct 6 2025, 2:15 AM

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

[mediawiki/core@master] ParserOutput: Serialize output flags in `OutputFlags`

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

Tacsipacsi subscribed.Oct 6 2025, 9:40 AM
gerritbot added a comment.Oct 28 2025, 2:03 AM

Change #1193579 merged by jenkins-bot:

[mediawiki/core@master] Forward-compatibility: allow output flags to be serialized in `OutputFlags`

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

gerritbot added a comment.Oct 28 2025, 2:24 AM

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

[mediawiki/core@REL1_44] Forward-compatibility: allow output flags to be serialized in `OutputFlags`

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

gerritbot added a comment.Oct 28 2025, 2:59 AM

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

[mediawiki/core@REL1_43] Forward-compatibility: allow output flags to be serialized in `OutputFlags`

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

gerritbot added a comment.Oct 28 2025, 3:37 AM

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

[mediawiki/core@wmf/1.45.0-wmf.25] Forward-compatibility: allow output flags to be serialized in `OutputFlags`

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

gerritbot added a comment.Oct 28 2025, 3:53 AM

Change #1199114 merged by jenkins-bot:

[mediawiki/core@wmf/1.45.0-wmf.25] Forward-compatibility: allow output flags to be serialized in `OutputFlags`

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

gerritbot added a comment.Oct 28 2025, 6:07 PM

Change #1199108 merged by jenkins-bot:

[mediawiki/core@REL1_43] Forward-compatibility: allow output flags to be serialized in `OutputFlags`

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

gerritbot added a comment.Oct 28 2025, 6:09 PM

Change #1199106 merged by jenkins-bot:

[mediawiki/core@REL1_44] Forward-compatibility: allow output flags to be serialized in `OutputFlags`

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

gerritbot added a comment.Jan 15 2026, 12:30 AM

Change #1193580 merged by jenkins-bot:

[mediawiki/core@master] ParserOutput: Serialize output flags in `OutputFlags`

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

gerritbot added a comment.Feb 17 2026, 1:56 AM

Change #1193553 merged by jenkins-bot:

[mediawiki/core@master] ParserOutput: move flags into $mFlags array

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

ReleaseTaggerBot added a project: MW-1.46-notes (1.46.0-wmf.17; 2026-02-24).Feb 17 2026, 2:00 AM
Izno mentioned this in T417819: PHP Deprecated: Use of MediaWiki\Parser\ParserOutput::setOutputFlag with non-standard flag was deprecated in MediaWiki 1.45. [Called from MediaWiki\Parser\ParserOutput::initFromJson].Feb 19 2026, 7:09 AM
gerritbot added a comment.Mar 8 2026, 12:10 PM

Change #942534 abandoned by Thomas-topway-it:

[mediawiki/extensions/CIForms@master] Use ParserOutput::{get,set}ExtensionData instead of deprecated methods

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

cscott closed this task as Resolved.Mar 18 2026, 4:51 PM
cscott claimed this task.
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