Merge "Fix wikidata entity usage tracking and access count"

client/WikibaseClient.ServiceWiring.php

@@ -75,7 +75,7 @@
 use Wikibase\DataModel\Services\Lookup\EntityLookup;
 use Wikibase\DataModel\Services\Lookup\EntityRetrievingDataTypeLookup;
 use Wikibase\DataModel\Services\Lookup\PropertyDataTypeLookup;
-use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookup;
+use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookupFactory;
 use Wikibase\DataModel\Services\Lookup\TermLookup;
 use Wikibase\DataModel\Services\Term\PropertyLabelResolver;
 use Wikibase\DataModel\Services\Term\TermBuffer;
@@ -781,7 +781,7 @@ function ( EntityNamespaceLookup $nsLookup, DatabaseEntitySource $source ): Enti
 			WikibaseClient::getStatementGroupRendererFactory( $services ),
 			WikibaseClient::getStore( $services )->getSiteLinkLookup(),
 			WikibaseClient::getEntityIdParser( $services ),
-			WikibaseClient::getRestrictedEntityLookup( $services ),
+			WikibaseClient::getRestrictedEntityLookupFactory( $services ),
 			$settings->getSetting( 'siteGlobalID' ),
 			$settings->getSetting( 'allowArbitraryDataAccess' )
 		);
@@ -868,13 +868,13 @@ function ( EntityNamespaceLookup $nsLookup, DatabaseEntitySource $source ): Enti
 		);
 	},
 
-	'WikibaseClient.RestrictedEntityLookup' => function ( MediaWikiServices $services ): RestrictedEntityLookup {
+	'WikibaseClient.RestrictedEntityLookupFactory' => function ( MediaWikiServices $services ): RestrictedEntityLookupFactory {
 		$settings = WikibaseClient::getSettings( $services );
 		$disabledEntityTypesEntityLookup = new DisabledEntityTypesEntityLookup(
 			WikibaseClient::getEntityLookup( $services ),
 			$settings->getSetting( 'disabledAccessEntityTypes' )
 		);
-		return new RestrictedEntityLookup(
+		return new RestrictedEntityLookupFactory(
 			$disabledEntityTypesEntityLookup,
 			$settings->getSetting( 'entityAccessLimit' )
 		);
@@ -969,7 +969,7 @@ function ( EntityNamespaceLookup $nsLookup, DatabaseEntitySource $source ): Enti
 		return new StatementGroupRendererFactory(
 			WikibaseClient::getPropertyLabelResolver( $services ),
 			new SnaksFinder(),
-			WikibaseClient::getRestrictedEntityLookup( $services ),
+			WikibaseClient::getRestrictedEntityLookupFactory( $services ),
 			WikibaseClient::getDataAccessSnakFormatterFactory( $services ),
 			WikibaseClient::getUsageAccumulatorFactory( $services ),
 			$services->getLanguageConverterFactory(),

client/includes/DataAccess/ParserFunctions/Runner.php

@@ -10,7 +10,7 @@
 use Wikibase\DataModel\Entity\EntityId;
 use Wikibase\DataModel\Entity\EntityIdParser;
 use Wikibase\DataModel\Entity\EntityIdParsingException;
-use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookup;
+use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookupFactory;
 use Wikibase\Lib\Store\SiteLinkLookup;
 
 /**
@@ -36,9 +36,9 @@ class Runner {
 	private $entityIdParser;
 
 	/**
-	 * @var RestrictedEntityLookup
+	 * @var RestrictedEntityLookupFactory
 	 */
-	private $restrictedEntityLookup;
+	private $restrictedEntityLookupFactory;
 
 	/**
 	 * @var string
@@ -54,22 +54,22 @@ class Runner {
 	 * @param StatementGroupRendererFactory $rendererFactory
 	 * @param SiteLinkLookup $siteLinkLookup
 	 * @param EntityIdParser $entityIdParser
-	 * @param RestrictedEntityLookup $restrictedEntityLookup
+	 * @param RestrictedEntityLookupFactory $restrictedEntityLookupFactory
 	 * @param string $siteId
 	 * @param bool $allowArbitraryDataAccess
 	 */
 	public function __construct(
 		StatementGroupRendererFactory $rendererFactory,
 		SiteLinkLookup $siteLinkLookup,
 		EntityIdParser $entityIdParser,
-		RestrictedEntityLookup $restrictedEntityLookup,
+		RestrictedEntityLookupFactory $restrictedEntityLookupFactory,
 		$siteId,
 		$allowArbitraryDataAccess
 	) {
 		$this->rendererFactory = $rendererFactory;
 		$this->siteLinkLookup = $siteLinkLookup;
 		$this->entityIdParser = $entityIdParser;
-		$this->restrictedEntityLookup = $restrictedEntityLookup;
+		$this->restrictedEntityLookupFactory = $restrictedEntityLookupFactory;
 		$this->siteId = $siteId;
 		$this->allowArbitraryDataAccess = $allowArbitraryDataAccess;
 	}
@@ -141,7 +141,7 @@ private function getEntityIdFromString( Parser $parser, $entityIdString ) {
 
 		// Getting a foreign item is expensive (unless we already loaded it and it's cached)
 		if (
-			!$this->restrictedEntityLookup->entityHasBeenAccessed( $entityId ) &&
+			!$this->restrictedEntityLookupFactory->getRestrictedEntityLookup( $parser )->entityHasBeenAccessed( $entityId ) &&
 			!$parser->incrementExpensiveFunctionCount()
 		) {
 			// Just do nothing, that's what parser functions do when the limit has been

client/includes/DataAccess/ParserFunctions/StatementGroupRendererFactory.php

@@ -16,7 +16,7 @@
 use Wikibase\Client\DataAccess\StatementTransclusionInteractor;
 use Wikibase\Client\Usage\UsageAccumulator;
 use Wikibase\Client\Usage\UsageAccumulatorFactory;
-use Wikibase\DataModel\Services\Lookup\EntityLookup;
+use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookupFactory;
 use Wikibase\DataModel\Services\Term\PropertyLabelResolver;
 
 /**
@@ -42,9 +42,9 @@ class StatementGroupRendererFactory {
 	private $languageAwareRenderers = [];
 
 	/**
-	 * @var EntityLookup
+	 * @var RestrictedEntityLookupFactory
 	 */
-	private $entityLookup;
+	private $restrictedEntityLookupFactory;
 
 	/**
 	 * @var DataAccessSnakFormatterFactory
@@ -74,7 +74,7 @@ class StatementGroupRendererFactory {
 	public function __construct(
 		PropertyLabelResolver $propertyLabelResolver,
 		SnaksFinder $snaksFinder,
-		EntityLookup $entityLookup,
+		RestrictedEntityLookupFactory $restrictedEntityLookupFactory,
 		DataAccessSnakFormatterFactory $dataAccessSnakFormatterFactory,
 		UsageAccumulatorFactory $usageAccumulatorFactory,
 		LanguageConverterFactory $langConvFactory,
@@ -83,7 +83,7 @@ public function __construct(
 	) {
 		$this->propertyLabelResolver = $propertyLabelResolver;
 		$this->snaksFinder = $snaksFinder;
-		$this->entityLookup = $entityLookup;
+		$this->restrictedEntityLookupFactory = $restrictedEntityLookupFactory;
 		$this->dataAccessSnakFormatterFactory = $dataAccessSnakFormatterFactory;
 		$this->usageAccumulatorFactory = $usageAccumulatorFactory;
 		$this->langConvFactory = $langConvFactory;
@@ -109,6 +109,7 @@ public function newRendererFromParser(
 				$type,
 				$targetLanguage,
 				$usageAccumulator,
+				$parser,
 				$parser->getOutput(),
 				$parser->getTitle()
 			);
@@ -118,6 +119,7 @@ public function newRendererFromParser(
 				$type,
 				$variants,
 				$usageAccumulator,
+				$parser,
 				$parser->getOutput(),
 				$parser->getTitle()
 			);
@@ -127,6 +129,7 @@ public function newRendererFromParser(
 				$type,
 				$targetLanguage,
 				$usageAccumulator,
+				$parser,
 				$parser->getOutput(),
 				$parser->getTitle()
 			);
@@ -137,13 +140,16 @@ public function newRendererFromParser(
 	 * @param string $type One of DataAccessSnakFormatterFactory::TYPE_*
 	 * @param Language $language
 	 * @param UsageAccumulator $usageAccumulator
+	 * @param Parser $parser
 	 * @param ParserOutput $parserOutput
 	 * @param Title $title
+	 * @return LanguageAwareRenderer
 	 */
 	private function newLanguageAwareRenderer(
 		string $type,
 		Language $language,
 		UsageAccumulator $usageAccumulator,
+		Parser $parser,
 		ParserOutput $parserOutput,
 		Title $title
 	): LanguageAwareRenderer {
@@ -154,7 +160,7 @@ private function newLanguageAwareRenderer(
 		);
 
 		$propertyIdResolver = new PropertyIdResolver(
-			$this->entityLookup,
+			$this->restrictedEntityLookupFactory->getRestrictedEntityLookup( $parser ),
 			$this->propertyLabelResolver,
 			$usageAccumulator
 		);
@@ -164,7 +170,7 @@ private function newLanguageAwareRenderer(
 			$propertyIdResolver,
 			$this->snaksFinder,
 			$snakFormatter,
-			$this->entityLookup,
+			$this->restrictedEntityLookupFactory->getRestrictedEntityLookup( $parser ),
 			$usageAccumulator
 		);
 
@@ -180,13 +186,16 @@ private function newLanguageAwareRenderer(
 	 * @param string $type One of DataAccessSnakFormatterFactory::TYPE_*
 	 * @param string $languageCode
 	 * @param UsageAccumulator $usageAccumulator
+	 * @param Parser $parser
 	 * @param ParserOutput $parserOutput
 	 * @param Title $title
+	 * @return LanguageAwareRenderer
 	 */
 	private function getLanguageAwareRendererFromCode(
 		string $type,
 		string $languageCode,
 		UsageAccumulator $usageAccumulator,
+		Parser $parser,
 		ParserOutput $parserOutput,
 		Title $title
 	): LanguageAwareRenderer {
@@ -195,6 +204,7 @@ private function getLanguageAwareRendererFromCode(
 				$type,
 				$this->langFactory->getLanguage( $languageCode ),
 				$usageAccumulator,
+				$parser,
 				$parserOutput,
 				$title
 			);
@@ -207,6 +217,7 @@ private function getLanguageAwareRendererFromCode(
 	 * @param string $type One of DataAccessSnakFormatterFactory::TYPE_*
 	 * @param string[] $variants
 	 * @param UsageAccumulator $usageAccumulator
+	 * @param Parser $parser
 	 * @param ParserOutput $parserOutput
 	 * @param Title $title
 	 *
@@ -216,6 +227,7 @@ private function newVariantsAwareRenderer(
 		string $type,
 		array $variants,
 		UsageAccumulator $usageAccumulator,
+		Parser $parser,
 		ParserOutput $parserOutput,
 		Title $title
 	): VariantsAwareRenderer {
@@ -226,6 +238,7 @@ private function newVariantsAwareRenderer(
 				$type,
 				$variant,
 				$usageAccumulator,
+				$parser,
 				$parserOutput,
 				$title
 			);

client/includes/DataAccess/Scribunto/WikibaseEntityLibrary.php

@@ -58,7 +58,8 @@ private function newImplementation(): WikibaseLuaEntityBindings {
 			$lang
 		);
 
-		$entityLookup = WikibaseClient::getRestrictedEntityLookup();
+		$parser = $this->getParser();
+		$entityLookup = WikibaseClient::getRestrictedEntityLookupFactory()->getRestrictedEntityLookup( $parser );
 
 		$propertyIdResolver = new PropertyIdResolver(
 			$entityLookup,

client/includes/DataAccess/Scribunto/WikibaseLibrary.php

@@ -209,9 +209,11 @@ private function allowDataAccessInUserLanguage(): bool {
 	}
 
 	private function newEntityAccessor(): EntityAccessor {
+		$parser = $this->getParser();
+
 		return new EntityAccessor(
 			$this->getEntityIdParser(),
-			WikibaseClient::getRestrictedEntityLookup(),
+			WikibaseClient::getRestrictedEntityLookupFactory()->getRestrictedEntityLookup( $parser ),
 			$this->getUsageAccumulator(),
 			WikibaseClient::getCompactEntitySerializer(),
 			WikibaseClient::getCompactBaseDataModelSerializerFactory()

client/includes/Hooks/ParserHookHandler.php

@@ -8,7 +8,7 @@
 use MediaWiki\Hook\ParserLimitReportPrepareHook;
 use MediaWiki\Parser\Parser;
 use MediaWiki\Parser\ParserOutput;
-use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookup;
+use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookupFactory;
 use Wikibase\Lib\SettingsArray;
 
 /**
@@ -21,27 +21,24 @@ class ParserHookHandler implements
 	ParserClearStateHook,
 	ParserLimitReportPrepareHook
 {
+	private RestrictedEntityLookupFactory $restrictedEntityLookupFactory;
 
-	/** @var RestrictedEntityLookup */
-	private $restrictedEntityLookup;
-
-	/** @var int */
-	private $entityAccessLimit;
+	private int $entityAccessLimit;
 
 	public function __construct(
-		RestrictedEntityLookup $restrictedEntityLookup,
+		RestrictedEntityLookupFactory $restrictedEntityLookupFactory,
 		int $entityAccessLimit
 	) {
-		$this->restrictedEntityLookup = $restrictedEntityLookup;
+		$this->restrictedEntityLookupFactory = $restrictedEntityLookupFactory;
 		$this->entityAccessLimit = $entityAccessLimit;
 	}
 
 	public static function factory(
-		RestrictedEntityLookup $restrictedEntityLookup,
+		RestrictedEntityLookupFactory $restrictedEntityLookupFactory,
 		SettingsArray $clientSettings
 	): self {
 		return new self(
-			$restrictedEntityLookup,
+			$restrictedEntityLookupFactory,
 			$clientSettings->getSetting( 'entityAccessLimit' )
 		);
 	}
@@ -53,7 +50,7 @@ public static function factory(
 	 */
 	public function onParserClearState( $parser ) {
 		// Reset the entity access limits, per T127462
-		$this->restrictedEntityLookup->reset();
+		$this->restrictedEntityLookupFactory->getRestrictedEntityLookup( $parser )->reset();
 	}
 
 	/**
@@ -64,7 +61,7 @@ public function onParserLimitReportPrepare( $parser, $parserOutput ) {
 		$parserOutput->setLimitReportData(
 			'limitreport-entityaccesscount',
 			[
-				$this->restrictedEntityLookup->getEntityAccessCount(),
+				$this->restrictedEntityLookupFactory->getRestrictedEntityLookup( $parser )->getEntityAccessCount(),
 				$this->entityAccessLimit,
 			]
 		);

client/includes/WikibaseClient.php

@@ -39,7 +39,7 @@
 use Wikibase\DataModel\Services\EntityId\EntityIdComposer;
 use Wikibase\DataModel\Services\Lookup\EntityLookup;
 use Wikibase\DataModel\Services\Lookup\PropertyDataTypeLookup;
-use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookup;
+use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookupFactory;
 use Wikibase\DataModel\Services\Lookup\TermLookup;
 use Wikibase\DataModel\Services\Term\PropertyLabelResolver;
 use Wikibase\DataModel\Services\Term\TermBuffer;
@@ -446,9 +446,9 @@ public static function getTermsLanguages( ContainerInterface $services = null ):
 			->get( 'WikibaseClient.TermsLanguages' );
 	}
 
-	public static function getRestrictedEntityLookup( ContainerInterface $services = null ): RestrictedEntityLookup {
+	public static function getRestrictedEntityLookupFactory( ContainerInterface $services = null ): RestrictedEntityLookupFactory {
 		return ( $services ?: MediaWikiServices::getInstance() )
-			->get( 'WikibaseClient.RestrictedEntityLookup' );
+			->get( 'WikibaseClient.RestrictedEntityLookupFactory' );
 	}
 
 	public static function getPropertyOrderProvider( ContainerInterface $services = null ): PropertyOrderProvider {

client/tests/phpunit/integration/includes/Hooks/ParserHookHandlerTest.php

@@ -34,13 +34,15 @@ protected function setUp(): void {
 
 	public function testStateCleared() {
 		$title = Title::newMainPage();
-		$restrictedEntityLookup = WikibaseClient::getRestrictedEntityLookup();
+		$restrictedEntityLookupFactory = WikibaseClient::getRestrictedEntityLookupFactory();
 
 		$popt = new ParserOptions( User::newFromId( 0 ), $this->getServiceContainer()->getLanguageFactory()->getLanguage( 'en' ) );
 
 		$parser = $this->getServiceContainer()->getParserFactory()->create();
 		$parser->parse( '{{#property:P1234|from=Q1}}', $title, $popt );
 
+		$restrictedEntityLookup = $restrictedEntityLookupFactory->getRestrictedEntityLookup( $parser );
+
 		$this->assertSame( 1, $restrictedEntityLookup->getEntityAccessCount() );
 
 		$parser->parse( '{{#property:P1234|from=Q2}}', $title, $popt );