Replace $wgMFUseParsoid configuration flag with Parsoid API
Closed, ResolvedPublic2 Estimated Story Points
Actions

Description

Background

The web team is working on migrating MobileFrontend to Parsoid. While working on this we were unable to find a reliable way to detect whether Parsoid was enable. This logic seems to exist in ParserMigration extension but doesn't seem to be formalized in an API. We tried using ParserOptions::getUseParsoid() but we get different results relating to race conditions relating to order dependencies so need something more reliable.

Currently, we are using a placeholder config flag (MFUseParsoid) to condition whether to turn on section collapsing for mobile when using parsoid. Now that we have the ParserMigration.Oracle service, this is no longer necessary as we can query whether parsoid will be used or not

User story

As a developer in the ArticleParserOptions hook I need to be able to call a function that returns a boolean to tell me whether Parsoid read views is enabled or not.

public function onArticleParserOptions( Article $article, ParserOptions $parserOptions )

Requirements

It should be possible to do this check in the hook in cases where the hook runs before the equivalent hook in ParserMigration.
If the parameters under which the parser is loaded change, callers (e.g. MobileFrontend) should not need to change anything.

Acceptance criteria (Mobilefrontend)

Remove $wgMFUseParsoid in favor of the new Oracle service

This task was created by Version 1.0.0 of the [[ mediawiki.org/w/index.php?title=Reading/Web/Request_process | Web team task template ]]

Details

Other Assignee: Jdlrobson

	Subject	Repo	Branch	Lines +/-
	Remove MFUseParsoid, use ParserMigration Oracle service	mediawiki/extensions/MobileFrontend	master	+40 -19
	Factor out ParserMigration.Oracle service	mediawiki/extensions/ParserMigration	master	+179 -79

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Open		ovasileva	T269499 [Epic] Make MobileFrontend compatible with Parsoid HTML
		Resolved		Edtadros	T363935 Replace $wgMFUseParsoid configuration flag with Parsoid API

Event Timeline

Jdlrobson created this task.May 1 2024, 7:00 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 1 2024, 7:00 PM

Jdlrobson mentioned this in T359001: Mobile section collapsing doesn't work with Parsoid HTML.May 1 2024, 7:01 PM

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

[mediawiki/extensions/ParserMigration@master] Factor out ParserMigration.Oracle service

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

gerritbot added a project: Patch-For-Review.Fri, May 3, 8:24 PM

Change #1027017 merged by jenkins-bot:

[mediawiki/extensions/ParserMigration@master] Factor out ParserMigration.Oracle service

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

ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.5; 2024-05-14).Tue, May 7, 6:00 PM

Maintenance_bot removed a project: Patch-For-Review.Tue, May 7, 6:30 PM

Jdlrobson triaged this task as High priority.Tue, May 14, 9:28 PM

Jdlrobson added projects: Web Team Essential Work 2024, Web-Team-Backlog (FY2023-24 Q4 Sprint 4).

Jdlrobson updated the task description. (Show Details)

Thanks for the new API! Steph will take a look at this and check it meets our requirements in time for estimation Thursday.

Added a bit of context - this ticket is ready to estimate on Thursday!

Jdlrobson added a parent task: T269499: [Epic] Make MobileFrontend compatible with Parsoid HTML.Wed, May 15, 12:13 AM

Jdlrobson moved this task from Backlog to Q4 (April-July) on the Web Team Essential Work 2024 board.Wed, May 15, 3:57 PM

Edtadros mentioned this in T363372: Verify 1.43.0-wmf.5 deployment.Wed, May 15, 10:52 PM

Please let us know if there are anything actionable on Content-Transform-Team to support you.

Thanks we will take this task from here and let you know if we run into any issues on MobileFrontend side.
A quick glance suggests this is working as expected.

		// set the collapsible sections parser flag so that section content is wrapped in a div for easier targeting
		// only if we're in mobile view and the config flag is set
		$useParsoid = MediaWikiServices::getInstance()->get( 'ParserMigration.Oracle' )
			->shouldUseParsoid( $context->getUser(), $context->getRequest(), $article->getTitle() );

		if ( $context->shouldDisplayMobileView() && $useParsoid ) {
			$parserOptions->setCollapsibleSections();
		}

Jdlrobson edited projects, added MobileFrontend; removed Content-Transform-Team.Thu, May 16, 4:33 PM

ovasileva set the point value for this task to 2.Thu, May 16, 5:50 PM

Jdlrobson moved this task from Needs analysis to Ready for Development on the Web-Team-Backlog (FY2023-24 Q4 Sprint 4) board.Thu, May 16, 5:50 PM

SToyofuku-WMF moved this task from Ready for Development to Doing on the Web-Team-Backlog (FY2023-24 Q4 Sprint 4) board.Fri, May 17, 9:55 PM

Change #1034152 had a related patch set uploaded (by Stoyofuku-wmf; author: Stoyofuku-wmf):

[mediawiki/extensions/MobileFrontend@master] Remove MFUseParsoid, use ParserMigration Oracle service

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

gerritbot added a project: Patch-For-Review.Mon, May 20, 8:40 PM

SToyofuku-WMF moved this task from Doing to Blocked on Others on the Web-Team-Backlog (FY2023-24 Q4 Sprint 4) board.Mon, May 20, 11:31 PM

Patch affected by T365403, will pick up again when I can

T365403 fixed, thanks for rebasing for me @Jdlrobson!

Jdlrobson updated Other Assignee, added: Jdlrobson.Tue, May 21, 4:25 PM

Change #1034152 merged by jenkins-bot:

[mediawiki/extensions/MobileFrontend@master] Remove MFUseParsoid, use ParserMigration Oracle service

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

@Jdlrobson do you want to do QA for this as well, or should I write steps in the ticket?

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.7; 2024-05-28); removed MW-1.43-notes (1.43.0-wmf.5; 2024-05-14).Wed, May 22, 12:00 AM

Maintenance_bot removed a project: Patch-For-Review.Wed, May 22, 12:30 AM

Jdlrobson assigned this task to Edtadros.Thu, May 23, 4:56 PM

@SToyofuku-WMF looks like this needs test steps.

@Jdlrobson wanted to double check if Edward should be the one to QA this or if you wanted to - I realize you might want to do sign off, in which case I'm happy to add QA steps

No need for QA on this one. I can verify this is working as expected on office.wikimedia.org

Jdlrobson moved this task from QA to Ready for Signoff on the Web-Team-Backlog (FY2023-24 Q4 Sprint 4) board.Wed, May 29, 7:00 PM