Spike: Parsoid Usage Confidence Framework
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	MSantos
	Oct 16 2023, 2:56 PM

Description

Background Information

See the current draft proposal in this wiki page.

The goal is to turn on parsoid on self-contained and safe places to develop the framework for ‘Parsoid Usage Readiness’.

What

The idea is to use the framework to actively learn with our roll-outs and identify the opportunities and gaps we need to cover without being framed by a latter of phases and specific milestones but instead, evolving the product strategy for the Parsoid Product Domain (draft proposal) for a long-term strategy that also takes into account immediate goals and committed work.

How

Research how the current metrics can fit into this framework

Acceptance Criteria

We have a set of metrics to look before rolling-out Parsoid Read Views in the Officewiki or Wikitech DiscussionTools

Related Objects
Search...

Status	Subtype	Assigned	Task
Open	Release	None	T84936 Release VisualEditor-MediaWiki as "1.0"
Open		None	T50429 [Epic] Support editing parts of a page in VisualEditor-MediaWiki
Open		None	T54365 Explore performance gains from progressive (JIT?) de-alienation in VisualEditor
Open		None	T174303 Copy-pasting linked ISBN numbers from view mode HTML into VisualEditor inserts wikitext links to Special:BookSources (it should turn them into magic links?)
Open	Feature	None	T54091 The read HTML should have hinting to allow full DOM copying (as opposed to just rich copying) from read mode into VE surfaces
Open		None	T55784 [EPIC] Use Parsoid HTML for all page views
Open		None	T272987 [EPIC] Parsoid read views for DiscussionTools
Resolved		ssastry	T270199 Table of contents in Parsoid output
Resolved		ssastry	T92999 Better handle `__TOC__` in parser tests
Resolved		cscott	T295209 Followup to fix corner cases in ToC language-conversion
Resolved		cscott	T269630 Parsoid should support section editing links
Open		None	T331483 Resolve diferences between Parsoid & legacy parser TOC metadata output for template, extension, and parser-function generated content
Resolved		cscott	T213468 Parsoid section IDs don't correspond to PHP section IDs when headings are transcluded
Open		None	T215628 Make Parsoid and PHP edit-section numbering consistent when <noinclude> and <includeonly> are in use
Open		None	T214538 MediaWiki shouldn't assign section ids during tokenization, but instead only when headings are generated
Open		None	T359221 Parsoid's TOC handling needs to deal with HTML-returning components (exts, SPTs, parser funcs returning HTML) consistently
Resolved		ssastry	T359450 Parsoid is not adding headings to TOC entries in some templated content scenarios
Resolved		cscott	T357826 DiscussionTools Headings are wrapped twice when using Parsoid
Resolved		None	T357831 Headings are too large when Parsoid section edit links are added
Resolved		ssastry	T107332 Parsoid-native implementation for <indicator> (page status indicators)
Resolved		cscott	T254181 Run parserTests with Parsoid in extension repos
Resolved		cscott	T234932 Parsoid srcset is inconsistent with core
Resolved		cscott	T287216 ParserOutput should implement ContentMetadataCollector
Resolved		cscott	T293515 Migrate ParserOutput::addWarning() to ::addWarningMsg()
Resolved	PRODUCTION ERROR	Lucas_Werkmeister_WMDE	T293860 PHP Deprecated: Use of ParserOutput::setProperty was deprecated in MediaWiki 1.38. [Called from Wikibase\Client\Hooks\ShortDescHandler::doHandle]
Resolved	PRODUCTION ERROR	abi_	T293895 PHP Deprecated: Use of ParserOutput::getProperty was deprecated in MediaWiki 1.38. [Called from LqtDiscussionPager::getPageLimit]
Resolved	PRODUCTION ERROR	cscott	T293894 PHP Deprecated: Use of ParserOutput::getProperty was deprecated in MediaWiki 1.38. [Called from GeoCrumbsHooks::makeTrail]
Resolved	PRODUCTION ERROR	roman-stolar	T293923 PHP Deprecated: Use of ParserOutput::addTrackingCategory was deprecated in MediaWiki 1.38. [Called from TemplateStylesContent::getParserOutput]
Resolved		None	T296123 Simplify string\|array argument type for ParserOutput::addModules()/::addModuleStyles()/::addJsConfigVars()
Resolved		None	T301619 Replace use of deprecated ParserOutput::{get,set,unset}Property
Resolved		matmarex	T317489 <!--__DTEMPTYTALKPAGE__--> turning indicator HTML from <link> to <span>
Resolved		matmarex	T328980 DiscussionTools marker comments still appear in the output sometimes in weird places
Open		None	T297840 Populate ParserCache with Parsoid output as a post-edit hook
Resolved		ssastry	T310510 Discussion tools visual diff testing between parsoid read views and legacy read views
Open		None	T310511 Metadata comparison testing between Parsoid and the legacy parser
Open		None	T310512 Parsoid and the legacy parser should emit exactly the same ParserOutput metadata
Open		None	T305159 Improve coverage of the ContentMetadataCollector interface
Open		None	T292865 Plumb revision information from ParserOptions through to ParserOutput (bypassing Parsoid)
Open		None	T292868 Migrate boolean flags in ParserOutput to ::setFlag() or ::setOutputFlag() or ::setExtensionData()
Open		None	T293513 Deprecate and remove ParserOutput::setTOCHTML()
Resolved		cscott	T295169 Parser TOC placeholder should be a meta tag
Open		cscott	T295168 Ensure <meta typeof="..."> in Parser/Parsoid HTML can't be spoofed from wikitext
Resolved		matmarex	T218330 Table of contents HTML may be unbalanced
Open		None	T293514 Unify ParserOutput::{get,set}{TitleText,DisplayTitle}
Open		cscott	T296019 Improve ParserOutput::setLanguageLinks() / ::addLanguageLink()
Open		cscott	T296037 ParserOutput::addImage() should take a LinkTarget
Resolved		cscott	T296023 Parsoid needs a core-compatible LinkTarget interface
Open		None	T296038 ParserOutput::addTemplate() interaction with ParserOptions::getTemplateCallback()
Resolved		None	T296025 ParserOutput::setSections() should be more structured
Open		None	T324035 Add "title" as a property of TOCData
Open		None	T296036 Deprecate and remove ParserOutput::isLinkInternal() (or at least mark it as @internal)
Open		cscott	T300979 Ensure ParserOutput can always be combined asynchronously/out-of-order
Open		None	T300307 Ensure JsConfigVars can always be combined asynchronously/out-of-order
Open		cscott	T300980 Store page indicators as a set; select one at output time
Open		cscott	T300981 Ensure extensionData can always be combined asynchronously/out-of-order
Open		cscott	T301004 Use OutputPage::appendExtensionData for wikibase-otherprojects-sidebar
Open		cscott	T300986 Ensure Page Properties can always be combined asynchronously/out-of-order
Open		cscott	T353530 Category defaultsort should be applied in CategoryLinkTable.php
Open		cscott	T296345 Add ParserOutput::addOutputData() to unify various accumulators in ParserOutput
Open		None	T296352 ParserOutput::addWarningMsg() should take a MessageValue instead of a string
Open		None	T296353 Create composer library for includes/libs/Message
Resolved	BUG REPORT	Jgiannelos	T351931 With parsoid categories are not shown
Open		None	T357048 Parsoid needs to call ParserOutput::addLink with a link batch
Open	BUG REPORT	ihurbain	T358950 Local interlanguage links don’t work with Parsoid read views
Open		None	T300189 DiscussionTools should sometimes set the 'useParsoid' option in ParserOptions
Resolved		cscott	T300190 Ensure that if 'useParsoid' flag is present in ParserOptions that we use Parsoid to parse the page.
Open		None	T310520 Parsoid content not compatible with `index.php?title=` URLs
Resolved		None	T300191 Bikeshed name of 'useParsoid' flag in ParserOptions
Open		None	T310526 Parsoid read views doesn't support -{T\|...}- page title markup
Open		None	T310544 Ensure MobileFrontend works with Parsoid read views for discussion tools
Resolved		ssastry	T341010 DiscussionTools doesn't recognize talk threads with Parsoid HTML
Declined		ssastry	T342352 Create ParsoidExperimentalDeprecatedPostProcessingHookDoNotUse hook for DiscussionTools testing
Resolved	PRODUCTION ERROR	ssastry	T351461 InvalidArgumentException: Multiple conflicting values given for wgDiscussionToolsPageThreads
Resolved		cscott	T355374 Use Parsoid for DiscussionTools on wikitech
Open		None	T360903 Parsoid DiscussionTools for arwiki/cswiki/huwiki (phase 2)
Open		None	T360905 Parsoid DiscussionTools, phase 3
Open		None	T360906 Parsoid DiscussionTools for dewiki (phase 4)
Resolved		cscott	T355566 Use Parsoid for read views on OfficeWiki by default
Resolved		MSantos	T348998 Spike: Parsoid Usage Confidence Framework

Event Timeline

MSantos created this task.Oct 16 2023, 2:56 PM

Restricted Application added a project: Parsoid. · View Herald TranscriptOct 16 2023, 2:56 PM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

MSantos triaged this task as High priority.Oct 16 2023, 2:56 PM

Some initial thoughts:

We don't have any active linter categories that impact parsoid read views -- but if we introduced any going forward, then yes, this would be a factor.
We can do wiki-specific visual diff testing for a subset of pages sampled from the wiki, but we cannot do this for private wikis right now. So visual diff testing for officewiki is currently difficult.
For initial rollouts (wikitech DT, officewiki), or even low-scale opt-in, performance may not be a consideration, but default enabling of read views on anything but the small wikis might need to factor in performance metrics.
For opt-in rollout, extension coverage gaps might be acceptable (but # of pages affected may be a metric?), but default enabling of read views will probably need 100% coverage OR a mechanism to opt-out affected pages (once again, # of pages that need to be opted out may be a metric).