Enable the wbui2025 interface for beta feature users

Determine “is this a wbui2025 mobile view?” once, when the
Wbui2025FeatureFlag is called in the lazy-loaded parser options.
In EntityHandler, we read that option (which will then be evaluated
based on $lazyLoad), and pass it through to all the other places that
don’t have access to the parser options directly. In ItemView and
PropertyView, we add a new “placeholder” to the ViewContent, which will
later be copied to the parser output’s extension data; in data
updaters, we can then add the ResourceLoader modules based on that
extension data, without needing another copy of the flag passed in.

Because the "placeholder" variables need to be available in time for
the content view creation, we create a new `getParserOuputOptions`
function in the EntityView interface that the
EntityParserOutputGenerator can call to transfer the options to the
extension data before the content is rendered.

`$wbMobile` is currently a bool|string mix. In a follow-up we can
consider changing this to be an enum.

Co-Authored-By: Lucas Werkmeister <[email protected]>
Depends-On: Ifab976f2656b1e76fa2ea2d4c8621ce24c654617
Bug: T407737
Change-Id: I5ebf9743642fafe14b08e2dddbc1d29c90e5576c

Author: 2 people

repo/WikibaseRepo.ServiceWiring.php

@@ -252,6 +252,7 @@
 use Wikibase\View\LanguageDirectionalityLookup;
 use Wikibase\View\Template\TemplateFactory;
 use Wikibase\View\ViewFactory;
+use Wikibase\View\Wbui2025FeatureFlag;
 use Wikimedia\ObjectCache\HashBagOStuff;
 use Wikimedia\ObjectFactory\ObjectFactory;
 
@@ -901,7 +902,9 @@ function ( EntityNamespaceLookup $nsLookup, DatabaseEntitySource $source ): Enti
 			WikibaseRepo::getEntityViewFactory( $services ),
 			WikibaseRepo::getEntityMetaTagsCreatorFactory( $services ),
 			WikibaseRepo::getEntityTitleLookup( $services ),
+			$services->getLanguageFactory(),
 			WikibaseRepo::getLanguageFallbackChainFactory( $services ),
+			$services->getLanguageNameUtils(),
 			WikibaseRepo::getEntityDataFormatProvider( $services ),
 			// FIXME: Should this be done for all usages of this lookup, or is the impact of
 			// CachingPropertyInfoLookup enough?
@@ -2164,9 +2167,6 @@ function ( $types, $localTypeName ) use ( $subEntityTypes ) {
 			$services->getObjectCacheFactory()->getLocalClusterInstance()
 		);
 
-		$vueStatementView = $settings->getSetting( 'tmpMobileEditingUI' ) &&
-			WikibaseRepo::getMobileSite( $services );
-
 		return new ViewFactory(
 			WikibaseRepo::getEntityIdHtmlLinkFormatterFactory( $services ),
 			WikibaseRepo::getEntityIdLabelFormatterFactory( $services ),
@@ -2190,7 +2190,14 @@ function ( $types, $localTypeName ) use ( $subEntityTypes ) {
 			new RepoSpecialPageLinker(),
 			$services->getLanguageFactory(),
 			WikibaseRepo::getEntityIdParser( $services ),
-			$vueStatementView
+			WikibaseRepo::getWbui2025FeatureFlag( $services ),
+		);
+	},
+
+	'WikibaseRepo.Wbui2025FeatureFlag' => function ( MediaWikiServices $services ): Wbui2025FeatureFlag {
+		return new Wbui2025FeatureFlag(
+			$services->getUserOptionsLookup(),
+			WikibaseRepo::getSettings( $services ),
 		);
 	},
 

repo/WikibaseRepo.entitytypes.php

@@ -92,7 +92,8 @@
 		Def::VIEW_FACTORY_CALLBACK => function(
 			Language $language,
 			TermLanguageFallbackChain $fallbackChain,
-			EntityDocument $entity
+			EntityDocument $entity,
+			array $viewOptions,
 		) {
 			$viewFactory = WikibaseRepo::getViewFactory();
 			return $viewFactory->newItemView(
@@ -104,7 +105,8 @@
 						$language,
 						$fallbackChain,
 						TermboxFlag::getInstance()->shouldRenderTermbox()
-					)
+					),
+				$viewOptions,
 			);
 		},
 		Def::META_TAGS_CREATOR_CALLBACK => function ( $userLanguage ) {
@@ -306,7 +308,8 @@
 		Def::VIEW_FACTORY_CALLBACK => function(
 			Language $language,
 			TermLanguageFallbackChain $fallbackChain,
-			EntityDocument $entity
+			EntityDocument $entity,
+			array $viewOptions,
 		) {
 			$viewFactory = WikibaseRepo::getViewFactory();
 			return $viewFactory->newPropertyView(
@@ -318,7 +321,8 @@
 						$language,
 						$fallbackChain,
 						TermboxFlag::getInstance()->shouldRenderTermbox()
-					)
+					),
+				$viewOptions
 			);
 		},
 		Def::META_TAGS_CREATOR_CALLBACK => function ( Language $userLanguage ) {

repo/includes/Content/EntityHandler.php

@@ -853,9 +853,7 @@ protected function getParserOutputFromEntityView(
 		$generateHtml = true
 	) {
 		$outputGenerator = WikibaseRepo::getEntityParserOutputGeneratorFactory()
-			->getEntityParserOutputGenerator(
-				$this->getValidUserLanguage( $options->getUserLangObj() )
-			);
+			->getEntityParserOutputGeneratorForParserOptions( $options );
 
 		$entityRevision = $this->getEntityRevision( $content, $revisionId );
 
@@ -872,15 +870,6 @@ protected function getParserOutputFromEntityView(
 		return $parserOutput;
 	}
 
-	private function getValidUserLanguage( Language $language ): Language {
-		$services = MediaWikiServices::getInstance();
-		if ( !$services->getLanguageNameUtils()->isValidBuiltInCode( $language->getCode() ) ) {
-			return $services->getLanguageFactory()->getLanguage( 'und' ); // T204791
-		}
-
-		return $language;
-	}
-
 	/**
 	 * @param EntityContent $content
 	 * @param int|null $revisionId

repo/includes/Hooks/GetBetaFeaturePreferencesHookHandler.php

@@ -6,6 +6,7 @@
 
 use MediaWiki\User\User;
 use Wikibase\Lib\SettingsArray;
+use Wikibase\View\Wbui2025FeatureFlag;
 
 /**
  * Hook handler that registers beta features with the BetaFeatures extension.
@@ -31,7 +32,7 @@ public function onGetBetaFeaturePreferences( User $user, array &$betaFeatures ):
 		if ( !$this->enableMobileEditingUIBetaFeature ) {
 			return;
 		}
-		$betaFeatures['wikibase-mobile-editing-ui'] = [
+		$betaFeatures[Wbui2025FeatureFlag::OPTION_NAME] = [
 			'label-message' => 'wikibase-mobile-editing-ui-beta-feature-message',
 			'desc-message' => 'wikibase-mobile-editing-ui-beta-feature-description',
 			// These links are required, but given we don't have community pages set up yet, link to Phab.

repo/includes/ParserOutput/DispatchingEntityViewFactory.php

@@ -37,14 +37,16 @@ public function __construct( array $entityViewFactoryCallbacks ) {
 	 * @param Language $language
 	 * @param TermLanguageFallbackChain $termFallbackChain
 	 * @param EntityDocument $entity
+	 * @param array $factoryOptions
 	 *
 	 * @throws OutOfBoundsException
 	 * @return EntityDocumentView
 	 */
 	public function newEntityView(
 		Language $language,
 		TermLanguageFallbackChain $termFallbackChain,
-		EntityDocument $entity
+		EntityDocument $entity,
+		array $factoryOptions = [],
 	) {
 		$entityType = $entity->getType();
 		if ( !isset( $this->entityViewFactoryCallbacks[$entityType] ) ) {
@@ -54,7 +56,8 @@ public function newEntityView(
 		$entityView = $this->entityViewFactoryCallbacks[$entityType](
 			$language,
 			$termFallbackChain,
-			$entity
+			$entity,
+			$factoryOptions,
 		);
 
 		Assert::postcondition(

repo/includes/ParserOutput/EntityParserOutputGeneratorFactory.php

@@ -8,6 +8,9 @@
 use MediaWiki\Extension\Math\MathDataUpdater;
 use MediaWiki\FileRepo\RepoGroup;
 use MediaWiki\Language\Language;
+use MediaWiki\Language\LanguageFactory;
+use MediaWiki\Language\LanguageNameUtils;
+use MediaWiki\Parser\ParserOptions;
 use MediaWiki\Registration\ExtensionRegistry;
 use PageImages\PageImages;
 use Wikibase\DataModel\Services\Entity\PropertyDataTypeMatcher;
@@ -34,7 +37,9 @@ class EntityParserOutputGeneratorFactory {
 	private DispatchingEntityViewFactory $entityViewFactory;
 	private DispatchingEntityMetaTagsCreatorFactory $entityMetaTagsCreatorFactory;
 	private EntityTitleLookup $entityTitleLookup;
+	private LanguageFactory $languageFactory;
 	private LanguageFallbackChainFactory $languageFallbackChainFactory;
+	private LanguageNameUtils $languageNameUtils;
 	private EntityDataFormatProvider $entityDataFormatProvider;
 	private PropertyDataTypeLookup $propertyDataTypeLookup;
 
@@ -66,7 +71,9 @@ class EntityParserOutputGeneratorFactory {
 	 * @param DispatchingEntityViewFactory $entityViewFactory
 	 * @param DispatchingEntityMetaTagsCreatorFactory $entityMetaTagsCreatorFactory
 	 * @param EntityTitleLookup $entityTitleLookup
+	 * @param LanguageFactory $languageFactory
 	 * @param LanguageFallbackChainFactory $languageFallbackChainFactory
+	 * @param LanguageNameUtils $languageNameUtils
 	 * @param EntityDataFormatProvider $entityDataFormatProvider
 	 * @param PropertyDataTypeLookup $propertyDataTypeLookup
 	 * @param EntityReferenceExtractorDelegator $entityReferenceExtractorDelegator
@@ -85,7 +92,9 @@ public function __construct(
 		DispatchingEntityViewFactory $entityViewFactory,
 		DispatchingEntityMetaTagsCreatorFactory $entityMetaTagsCreatorFactory,
 		EntityTitleLookup $entityTitleLookup,
+		LanguageFactory $languageFactory,
 		LanguageFallbackChainFactory $languageFallbackChainFactory,
+		LanguageNameUtils $languageNameUtils,
 		EntityDataFormatProvider $entityDataFormatProvider,
 		PropertyDataTypeLookup $propertyDataTypeLookup,
 		EntityReferenceExtractorDelegator $entityReferenceExtractorDelegator,
@@ -102,7 +111,9 @@ public function __construct(
 		$this->entityViewFactory = $entityViewFactory;
 		$this->entityMetaTagsCreatorFactory = $entityMetaTagsCreatorFactory;
 		$this->entityTitleLookup = $entityTitleLookup;
+		$this->languageFactory = $languageFactory;
 		$this->languageFallbackChainFactory = $languageFallbackChainFactory;
+		$this->languageNameUtils = $languageNameUtils;
 		$this->entityDataFormatProvider = $entityDataFormatProvider;
 		$this->propertyDataTypeLookup = $propertyDataTypeLookup;
 		$this->entityReferenceExtractorDelegator = $entityReferenceExtractorDelegator;
@@ -117,7 +128,41 @@ public function __construct(
 		$this->isMobileView = $isMobileView;
 	}
 
-	public function getEntityParserOutputGenerator( Language $userLanguage ): EntityParserOutputGenerator {
+	private function getValidUserLanguage( Language $language ): Language {
+		if ( !$this->languageNameUtils->isValidBuiltInCode( $language->getCode() ) ) {
+			return $this->languageFactory->getLanguage( 'und' ); // T204791
+		}
+		return $language;
+	}
+
+	/**
+	 * Introduce this function to make it possible to transition the interface
+	 * for `getEntityParserOutputGenerator` from taking a Language to taking a ParserOptions
+	 * object.
+	 *
+	 * We introduce this new function, update callers to call the new function with the
+	 * new interface, then in future commits we will remove the old function.
+	 *
+	 * @param ParserOptions $options
+	 * @return EntityParserOutputGenerator
+	 */
+	public function getEntityParserOutputGeneratorForParserOptions( ParserOptions $options ): EntityParserOutputGenerator {
+		$userLanguage = $this->getValidUserLanguage( $options->getUserLangObj() );
+		$wbMobile = $options->getOption( 'wbMobile' );
+
+		return $this->getEntityParserOutputGenerator( $userLanguage, $wbMobile );
+	}
+
+	/**
+	 * @deprecated Remove this function in favour of the function version that takes
+	 * a ParserOptions object. When all callers of this function have migrated, the function
+	 * can be removed.
+	 *
+	 * @param Language $userLanguage
+	 * @param bool|string $wbMobile
+	 * @return EntityParserOutputGenerator
+	 */
+	public function getEntityParserOutputGenerator( Language $userLanguage, $wbMobile = false ): EntityParserOutputGenerator {
 		$pog = new FullEntityParserOutputGenerator(
 			$this->entityViewFactory,
 			$this->entityMetaTagsCreatorFactory,
@@ -126,6 +171,7 @@ public function getEntityParserOutputGenerator( Language $userLanguage ): Entity
 			$this->entityDataFormatProvider,
 			$this->getDataUpdaters(),
 			$userLanguage,
+			$wbMobile,
 			$this->isMobileView
 		);
 
@@ -186,17 +232,12 @@ private function getDataUpdaters(): array {
 				$this->newKartographerDataUpdater( $this->kartographerEmbeddingHandler ) );
 		}
 
-		$tmpMobileEditingUI = WikibaseRepo::getSettings()->getSetting( 'tmpMobileEditingUI' );
 		$entityUpdaters = [
 			new ItemParserOutputUpdater(
 				$statementUpdater,
-				$this->isMobileView,
-				$tmpMobileEditingUI
 			),
 			new PropertyParserOutputUpdater(
 				$statementUpdater,
-				$this->isMobileView,
-				$tmpMobileEditingUI
 			),
 			new ReferencedEntitiesDataUpdater(
 				$this->entityReferenceExtractorDelegator,

repo/includes/ParserOutput/FullEntityParserOutputGenerator.php

@@ -12,7 +12,9 @@
 use Wikibase\Lib\Store\EntityRevision;
 use Wikibase\Lib\TermLanguageFallbackChain;
 use Wikibase\Repo\LinkedData\EntityDataFormatProvider;
+use Wikibase\View\EntityDocumentView;
 use Wikibase\View\ViewPlaceHolderEmitter;
+use Wikibase\View\Wbui2025FeatureFlag;
 
 /**
  * Creates the parser output for an entity.
@@ -41,6 +43,8 @@ class FullEntityParserOutputGenerator implements EntityParserOutputGenerator {
 
 	private Language $language;
 
+	private bool|string $wbMobile;
+
 	private bool $isMobileView;
 
 	/**
@@ -51,6 +55,8 @@ class FullEntityParserOutputGenerator implements EntityParserOutputGenerator {
 	 * @param EntityDataFormatProvider $entityDataFormatProvider
 	 * @param EntityParserOutputUpdater[] $dataUpdaters
 	 * @param Language $language
+	 * @param bool|string $wbMobile
+	 * @param bool $isMobileView
 	 */
 	public function __construct(
 		DispatchingEntityViewFactory $entityViewFactory,
@@ -60,6 +66,7 @@ public function __construct(
 		EntityDataFormatProvider $entityDataFormatProvider,
 		array $dataUpdaters,
 		Language $language,
+		bool|string $wbMobile,
 		bool $isMobileView
 	) {
 		$this->entityViewFactory = $entityViewFactory;
@@ -69,6 +76,7 @@ public function __construct(
 		$this->entityDataFormatProvider = $entityDataFormatProvider;
 		$this->dataUpdaters = $dataUpdaters;
 		$this->language = $language;
+		$this->wbMobile = $wbMobile;
 		$this->isMobileView = $isMobileView;
 	}
 
@@ -86,6 +94,12 @@ public function getParserOutput(
 		$parserOutput = new ParserOutput();
 		$parserOutput->resetParseStartTime();
 
+		$entityView = $this->createEntityView( $entityRevision );
+		$parserOutputOptions = $entityView->getParserOutputOptions();
+		foreach ( $parserOutputOptions as $key => $value ) {
+			$parserOutput->setExtensionData( $key, $value );
+		}
+
 		$updaterCollection = new EntityParserOutputDataUpdaterCollection( $parserOutput, $this->dataUpdaters );
 		$updaterCollection->updateParserOutput( $entity );
 
@@ -99,7 +113,8 @@ public function getParserOutput(
 		if ( $generateHtml ) {
 			$this->addHtmlToParserOutput(
 				$parserOutput,
-				$entityRevision
+				$entityRevision,
+				$entityView,
 			);
 		} else {
 			// If we don't have HTML, the ParserOutput in question
@@ -128,17 +143,23 @@ public function getParserOutput(
 		return $parserOutput;
 	}
 
-	private function addHtmlToParserOutput(
-		ParserOutput $parserOutput,
-		EntityRevision $entityRevision
-	): void {
+	private function createEntityView( EntityRevision $entityRevision ): EntityDocumentView {
 		$entity = $entityRevision->getEntity();
 
-		$entityView = $this->entityViewFactory->newEntityView(
+		return $this->entityViewFactory->newEntityView(
 			$this->language,
 			$this->termLanguageFallbackChain,
-			$entity
+			$entity,
+			[ Wbui2025FeatureFlag::EXTENSION_DATA_KEY => $this->wbMobile ],
 		);
+	}
+
+	private function addHtmlToParserOutput(
+		ParserOutput $parserOutput,
+		EntityRevision $entityRevision,
+		EntityDocumentView $entityView,
+	): void {
+		$entity = $entityRevision->getEntity();
 
 		// Set the display title to display the label together with the item's id
 		$titleHtml = $entityView->getTitleHtml( $entity );