wikimedia / mediawiki-extensions-WikibaseQualityConstraints

src/ConstraintCheck/Helper/LoggingHelper.php

Spacing +38 added lines, -38 removed lines

@@ -53,12 +53,12 @@ 
 		$this->statsFactory = $statsFactory;
 		$this->logger = $logger;
 		$this->constraintCheckDurationLimits = [
-			'info' => $config->get( 'WBQualityConstraintsCheckDurationInfoSeconds' ),
-			'warning' => $config->get( 'WBQualityConstraintsCheckDurationWarningSeconds' ),
+			'info' => $config->get('WBQualityConstraintsCheckDurationInfoSeconds'),
+			'warning' => $config->get('WBQualityConstraintsCheckDurationWarningSeconds'),
 		];
 		$this->constraintCheckOnEntityDurationLimits = [
-			'info' => $config->get( 'WBQualityConstraintsCheckOnEntityDurationInfoSeconds' ),
-			'warning' => $config->get( 'WBQualityConstraintsCheckOnEntityDurationWarningSeconds' ),
+			'info' => $config->get('WBQualityConstraintsCheckOnEntityDurationInfoSeconds'),
+			'warning' => $config->get('WBQualityConstraintsCheckOnEntityDurationWarningSeconds'),
 		];
 	}
 
@@ -70,23 +70,23 @@ 
 	 * @param float $durationSeconds
 	 * @return array [ $limitSeconds, $logLevel ]
 	 */
-	private function findLimit( $limits, $durationSeconds ) {
+	private function findLimit($limits, $durationSeconds) {
 		$limitSeconds = null;
 		$logLevel = null;
 
-		foreach ( $limits as $level => $limit ) {
+		foreach ($limits as $level => $limit) {
 			if (
 				// duration exceeds this limit
 				$limit !== null && $durationSeconds > $limit &&
 				// this limit is longer than previous longest limit
-				( $limitSeconds === null || $limit > $limitSeconds )
+				($limitSeconds === null || $limit > $limitSeconds)
 			) {
 				$limitSeconds = $limit;
 				$logLevel = $level;
 			}
 		}
 
-		return [ $limitSeconds, $logLevel ];
+		return [$limitSeconds, $logLevel];
 	}
 
 	/**
@@ -111,30 +111,30 @@ 
 		$durationSeconds,
 		$method
 	) {
-		$constraintCheckerClassShortName = substr( strrchr( $constraintCheckerClass, '\\' ), 1 );
+		$constraintCheckerClassShortName = substr(strrchr($constraintCheckerClass, '\\'), 1);
 		$constraintTypeItemId = $constraint->getConstraintTypeItemId();
 
 		$baseCheckTimingKey = 'wikibase.quality.constraints.check.timing';
 		$this->statsFactory
-			->getTiming( 'check_constraint_duration_seconds' )
-			->copyToStatsdAt( "$baseCheckTimingKey.$constraintTypeItemId-$constraintCheckerClassShortName" )
-			->observe( $durationSeconds * 1000 );
+			->getTiming('check_constraint_duration_seconds')
+			->copyToStatsdAt("$baseCheckTimingKey.$constraintTypeItemId-$constraintCheckerClassShortName")
+			->observe($durationSeconds * 1000);
 
 		// find the longest limit (and associated log level) that the duration exceeds
-		[ $limitSeconds, $logLevel ] = $this->findLimit(
+		[$limitSeconds, $logLevel] = $this->findLimit(
 			$this->constraintCheckDurationLimits,
 			$durationSeconds
 		);
-		if ( $limitSeconds === null ) {
+		if ($limitSeconds === null) {
 			return;
 		}
-		if ( $context->getType() !== Context::TYPE_STATEMENT ) {
+		if ($context->getType() !== Context::TYPE_STATEMENT) {
 			// TODO log less details but still log something
 			return;
 		}
 
 		$resultMessage = $result->getMessage();
-		if ( $resultMessage !== null ) {
+		if ($resultMessage !== null) {
 			$resultMessageKey = $resultMessage->getMessageKey();
 		} else {
 			$resultMessageKey = null;
@@ -142,8 +142,8 @@ 
 
 		$this->logger->log(
 			$logLevel,
-			'Constraint check with {constraintCheckerClassShortName} ' .
-			'took longer than {limitSeconds} second(s) ' .
+			'Constraint check with {constraintCheckerClassShortName} '.
+			'took longer than {limitSeconds} second(s) '.
 			'(duration: {durationSeconds} seconds).',
 			[
 				'method' => $method,
@@ -153,7 +153,7 @@ 
 				'constraintId' => $constraint->getConstraintId(),
 				'constraintPropertyId' => $constraint->getPropertyId()->getSerialization(),
 				'constraintTypeItemId' => $constraintTypeItemId,
-				'constraintParameters' => json_encode( $constraint->getConstraintParameters() ),
+				'constraintParameters' => json_encode($constraint->getConstraintParameters()),
 				'constraintCheckerClass' => $constraintCheckerClass,
 				'constraintCheckerClassShortName' => $constraintCheckerClassShortName,
 				'entityId' => $context->getEntity()->getId()->getSerialization(),
@@ -185,23 +185,23 @@ 
 	) {
 		$checkEntityTimingKey = 'wikibase.quality.constraints.check.entity.timing';
 		$this->statsFactory
-			->getTiming( 'check_entity_constraint_duration_seconds' )
-			->copyToStatsdAt( $checkEntityTimingKey )
-			->observe( $durationSeconds * 1000 );
+			->getTiming('check_entity_constraint_duration_seconds')
+			->copyToStatsdAt($checkEntityTimingKey)
+			->observe($durationSeconds * 1000);
 
 		// find the longest limit (and associated log level) that the duration exceeds
-		[ $limitSeconds, $logLevel ] = $this->findLimit(
+		[$limitSeconds, $logLevel] = $this->findLimit(
 			$this->constraintCheckOnEntityDurationLimits,
 			$durationSeconds
 		);
-		if ( $limitSeconds === null ) {
+		if ($limitSeconds === null) {
 			return;
 		}
 
 		$this->logger->log(
 			$logLevel,
-			'Full constraint check on {entityId} ' .
-			'took longer than {limitSeconds} second(s) ' .
+			'Full constraint check on {entityId} '.
+			'took longer than {limitSeconds} second(s) '.
 			'(duration: {durationSeconds} seconds).',
 			[
 				'method' => $method,
@@ -217,9 +217,9 @@ 
 	/**
 	 * Log a cache hit for a complete constraint check result for the given entity ID.
 	 */
-	public function logCheckConstraintsCacheHit( EntityId $entityId ) {
+	public function logCheckConstraintsCacheHit(EntityId $entityId) {
 		$cacheEntityHitKey = 'wikibase.quality.constraints.cache.entity.hit';
-		$metric = $this->statsFactory->getCounter( 'cache_entity_hit_total' );
+		$metric = $this->statsFactory->getCounter('cache_entity_hit_total');
 		$metric->copyToStatsdAt(
 				$cacheEntityHitKey,
 			)->increment();
@@ -230,12 +230,12 @@ 
 	 *
 	 * @param EntityId[] $entityIds
 	 */
-	public function logCheckConstraintsCacheMisses( array $entityIds ) {
+	public function logCheckConstraintsCacheMisses(array $entityIds) {
 		$cacheEntityMissKey = 'wikibase.quality.constraints.cache.entity.miss';
-		$metric = $this->statsFactory->getCounter( 'cache_entity_miss_total' );
+		$metric = $this->statsFactory->getCounter('cache_entity_miss_total');
 		$metric->copyToStatsdAt(
 				$cacheEntityMissKey,
-			)->incrementBy( count( $entityIds ) );
+			)->incrementBy(count($entityIds));
 	}
 
 	/**
@@ -261,17 +261,17 @@ 
 	 * @param EntityId[] $entityIds
 	 * @param int $maxRevisionIds
 	 */
-	public function logHugeDependencyMetadata( array $entityIds, $maxRevisionIds ) {
+	public function logHugeDependencyMetadata(array $entityIds, $maxRevisionIds) {
 		$this->logger->log(
 			'warning',
-			'Dependency metadata for constraint check result has huge set of entity IDs ' .
-			'(count ' . count( $entityIds ) . ', limit ' . $maxRevisionIds . '); ' .
+			'Dependency metadata for constraint check result has huge set of entity IDs '.
+			'(count '.count($entityIds).', limit '.$maxRevisionIds.'); '.
 			'caching disabled for this check result.',
 			[
 				'loggingMethod' => __METHOD__,
 				'entityIds' => json_encode(
 					array_map(
-						static function ( EntityId $entityId ) {
+						static function(EntityId $entityId) {
 							return $entityId->getSerialization();
 						},
 						$entityIds
@@ -290,17 +290,17 @@ 
 			'Sparql API replied with status 429 and a retry-after header. Requesting to retry after {retryAfterTime}',
 			[
 				'retryAfterTime' => $retryAfterTime,
-				'responseHeaders' => json_encode( $request->getResponseHeaders() ),
+				'responseHeaders' => json_encode($request->getResponseHeaders()),
 				'responseContent' => $request->getContent(),
 			]
 		);
 	}
 
-	public function logSparqlHelperTooManyRequestsRetryAfterInvalid( MWHttpRequest $request ) {
+	public function logSparqlHelperTooManyRequestsRetryAfterInvalid(MWHttpRequest $request) {
 		$this->logger->warning(
 			'Sparql API replied with status 429 and no valid retry-after header.',
 			[
-				'responseHeaders' => json_encode( $request->getResponseHeaders() ),
+				'responseHeaders' => json_encode($request->getResponseHeaders()),
 				'responseContent' => $request->getContent(),
 			]
 		);

src/Api/CachingResultsSource.php

Spacing +77 added lines, -78 removed lines

@@ -144,14 +144,14 @@ 
 	) {
 		$results = [];
 		$metadatas = [];
-		if ( $this->canUseStoredResults( $entityIds, $claimIds, $constraintIds, $statuses ) ) {
+		if ($this->canUseStoredResults($entityIds, $claimIds, $constraintIds, $statuses)) {
 			$storedEntityIds = [];
-			foreach ( $entityIds as $entityId ) {
-				$storedResults = $this->getStoredResults( $entityId );
-				if ( $storedResults !== null ) {
-					$this->loggingHelper->logCheckConstraintsCacheHit( $entityId );
-					foreach ( $storedResults->getArray() as $checkResult ) {
-						if ( $this->statusSelected( $statuses, $checkResult ) ) {
+			foreach ($entityIds as $entityId) {
+				$storedResults = $this->getStoredResults($entityId);
+				if ($storedResults !== null) {
+					$this->loggingHelper->logCheckConstraintsCacheHit($entityId);
+					foreach ($storedResults->getArray() as $checkResult) {
+						if ($this->statusSelected($statuses, $checkResult)) {
 							$results[] = $checkResult;
 						}
 					}
@@ -159,19 +159,19 @@ 
 					$storedEntityIds[] = $entityId;
 				}
 			}
-			$entityIds = array_values( array_diff( $entityIds, $storedEntityIds ) );
+			$entityIds = array_values(array_diff($entityIds, $storedEntityIds));
 		}
-		if ( $entityIds !== [] || $claimIds !== [] ) {
-			if ( $entityIds !== [] ) {
-				$this->loggingHelper->logCheckConstraintsCacheMisses( $entityIds );
+		if ($entityIds !== [] || $claimIds !== []) {
+			if ($entityIds !== []) {
+				$this->loggingHelper->logCheckConstraintsCacheMisses($entityIds);
 			}
-			$response = $this->getAndStoreResults( $entityIds, $claimIds, $constraintIds, $statuses );
-			$results = array_merge( $results, $response->getArray() );
+			$response = $this->getAndStoreResults($entityIds, $claimIds, $constraintIds, $statuses);
+			$results = array_merge($results, $response->getArray());
 			$metadatas[] = $response->getMetadata();
 		}
 		return new CachedCheckResults(
 			$results,
-			Metadata::merge( $metadatas )
+			Metadata::merge($metadatas)
 		);
 	}
 
@@ -194,13 +194,13 @@ 
 		?array $constraintIds,
 		array $statuses
 	) {
-		if ( $claimIds !== [] ) {
+		if ($claimIds !== []) {
 			return false;
 		}
-		if ( $constraintIds !== null ) {
+		if ($constraintIds !== null) {
 			return false;
 		}
-		if ( array_diff( $statuses, self::CACHED_STATUSES ) !== [] ) {
+		if (array_diff($statuses, self::CACHED_STATUSES) !== []) {
 			return false;
 		}
 		return true;
@@ -215,8 +215,8 @@ 
 	 * @param CheckResult $result
 	 * @return bool
 	 */
-	private function statusSelected( array $statuses, CheckResult $result ) {
-		return in_array( $result->getStatus(), $statuses, true ) ||
+	private function statusSelected(array $statuses, CheckResult $result) {
+		return in_array($result->getStatus(), $statuses, true) ||
 			$result instanceof NullResult;
 	}
 
@@ -233,11 +233,11 @@ 
 		?array $constraintIds,
 		array $statuses
 	) {
-		$results = $this->resultsSource->getResults( $entityIds, $claimIds, $constraintIds, $statuses );
+		$results = $this->resultsSource->getResults($entityIds, $claimIds, $constraintIds, $statuses);
 
-		if ( $this->canStoreResults( $entityIds, $claimIds, $constraintIds, $statuses ) ) {
-			foreach ( $entityIds as $entityId ) {
-				$this->storeResults( $entityId, $results );
+		if ($this->canStoreResults($entityIds, $claimIds, $constraintIds, $statuses)) {
+			foreach ($entityIds as $entityId) {
+				$this->storeResults($entityId, $results);
 			}
 		}
 
@@ -268,10 +268,10 @@ 
 		?array $constraintIds,
 		array $statuses
 	) {
-		if ( $constraintIds !== null ) {
+		if ($constraintIds !== null) {
 			return false;
 		}
-		if ( array_diff( self::CACHED_STATUSES, $statuses ) !== [] ) {
+		if (array_diff(self::CACHED_STATUSES, $statuses) !== []) {
 			return false;
 		}
 		return true;
@@ -285,21 +285,21 @@ 
 	 * May include check results for other entity IDs as well,
 	 * or check results with statuses that we’re not interested in caching.
 	 */
-	private function storeResults( EntityId $entityId, CachedCheckResults $results ) {
+	private function storeResults(EntityId $entityId, CachedCheckResults $results) {
 		$latestRevisionIds = $this->getLatestRevisionIds(
 			$results->getMetadata()->getDependencyMetadata()->getEntityIds()
 		);
-		if ( $latestRevisionIds === null ) {
+		if ($latestRevisionIds === null) {
 			return;
 		}
 
 		$resultSerializations = [];
-		foreach ( $results->getArray() as $checkResult ) {
-			if ( $checkResult->getContextCursor()->getEntityId() !== $entityId->getSerialization() ) {
+		foreach ($results->getArray() as $checkResult) {
+			if ($checkResult->getContextCursor()->getEntityId() !== $entityId->getSerialization()) {
 				continue;
 			}
-			if ( $this->statusSelected( self::CACHED_STATUSES, $checkResult ) ) {
-				$resultSerializations[] = $this->checkResultSerializer->serialize( $checkResult );
+			if ($this->statusSelected(self::CACHED_STATUSES, $checkResult)) {
+				$resultSerializations[] = $this->checkResultSerializer->serialize($checkResult);
 			}
 		}
 
@@ -308,11 +308,11 @@ 
 			'latestRevisionIds' => $latestRevisionIds,
 		];
 		$futureTime = $results->getMetadata()->getDependencyMetadata()->getFutureTime();
-		if ( $futureTime !== null ) {
+		if ($futureTime !== null) {
 			$value['futureTime'] = $futureTime->getArrayValue();
 		}
 
-		$this->cache->set( $entityId, $value, $this->ttlInSeconds );
+		$this->cache->set($entityId, $value, $this->ttlInSeconds);
 	}
 
 	/**
@@ -327,33 +327,32 @@ 
 		$forRevision = 0
 	) {
 		$cacheInfo = WANObjectCache::PASS_BY_REF;
-		$value = $this->cache->get( $entityId, $curTTL, [], $cacheInfo );
-		$now = ( $this->microtime )( true );
+		$value = $this->cache->get($entityId, $curTTL, [], $cacheInfo);
+		$now = ($this->microtime)(true);
 
-		$dependencyMetadata = $this->checkDependencyMetadata( $value,
-			[ $entityId->getSerialization() => $forRevision ] );
-		if ( $dependencyMetadata === null ) {
+		$dependencyMetadata = $this->checkDependencyMetadata($value,
+			[$entityId->getSerialization() => $forRevision]);
+		if ($dependencyMetadata === null) {
 			return null;
 		}
 
 		// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset False positive
 		$asOf = $cacheInfo[WANObjectCache::KEY_AS_OF];
-		$ageInSeconds = (int)ceil( $now - $asOf );
+		$ageInSeconds = (int) ceil($now - $asOf);
 		$cachingMetadata = $ageInSeconds > 0 ?
-			CachingMetadata::ofMaximumAgeInSeconds( $ageInSeconds ) :
-			CachingMetadata::fresh();
+			CachingMetadata::ofMaximumAgeInSeconds($ageInSeconds) : CachingMetadata::fresh();
 
 		$results = [];
-		foreach ( $value['results'] as $resultSerialization ) {
-			$results[] = $this->deserializeCheckResult( $resultSerialization, $cachingMetadata );
+		foreach ($value['results'] as $resultSerialization) {
+			$results[] = $this->deserializeCheckResult($resultSerialization, $cachingMetadata);
 		}
 
 		return new CachedCheckResults(
 			$results,
-			Metadata::merge( [
-				Metadata::ofCachingMetadata( $cachingMetadata ),
-				Metadata::ofDependencyMetadata( $dependencyMetadata ),
-			] )
+			Metadata::merge([
+				Metadata::ofCachingMetadata($cachingMetadata),
+				Metadata::ofDependencyMetadata($dependencyMetadata),
+			])
 		);
 	}
 
@@ -369,43 +368,43 @@ 
 	 * @return DependencyMetadata|null the dependency metadata,
 	 * or null if $value should no longer be used
 	 */
-	private function checkDependencyMetadata( $value, $paramRevs ) {
-		if ( $value === false ) {
+	private function checkDependencyMetadata($value, $paramRevs) {
+		if ($value === false) {
 			return null;
 		}
 
-		if ( array_key_exists( 'futureTime', $value ) ) {
-			$futureTime = TimeValue::newFromArray( $value['futureTime'] );
-			if ( !$this->timeValueComparer->isFutureTime( $futureTime ) ) {
+		if (array_key_exists('futureTime', $value)) {
+			$futureTime = TimeValue::newFromArray($value['futureTime']);
+			if (!$this->timeValueComparer->isFutureTime($futureTime)) {
 				return null;
 			}
-			$futureTimeDependencyMetadata = DependencyMetadata::ofFutureTime( $futureTime );
+			$futureTimeDependencyMetadata = DependencyMetadata::ofFutureTime($futureTime);
 		} else {
 			$futureTimeDependencyMetadata = DependencyMetadata::blank();
 		}
 
-		foreach ( $paramRevs as $id => $revision ) {
-			if ( $revision > 0 ) {
-				$value['latestRevisionIds'][$id] = min( $revision, $value['latestRevisionIds'][$id] ?? PHP_INT_MAX );
+		foreach ($paramRevs as $id => $revision) {
+			if ($revision > 0) {
+				$value['latestRevisionIds'][$id] = min($revision, $value['latestRevisionIds'][$id] ?? PHP_INT_MAX);
 			}
 		}
 
 		$dependedEntityIds = array_map(
-			[ $this->entityIdParser, "parse" ],
-			array_keys( $value['latestRevisionIds'] )
+			[$this->entityIdParser, "parse"],
+			array_keys($value['latestRevisionIds'])
 		);
 
-		if ( $value['latestRevisionIds'] !== $this->getLatestRevisionIds( $dependedEntityIds ) ) {
+		if ($value['latestRevisionIds'] !== $this->getLatestRevisionIds($dependedEntityIds)) {
 			return null;
 		}
 
 		return array_reduce(
 			$dependedEntityIds,
-			static function ( DependencyMetadata $metadata, EntityId $entityId ) {
-				return DependencyMetadata::merge( [
+			static function(DependencyMetadata $metadata, EntityId $entityId) {
+				return DependencyMetadata::merge([
 					$metadata,
-					DependencyMetadata::ofEntityId( $entityId ),
-				] );
+					DependencyMetadata::ofEntityId($entityId),
+				]);
 			},
 			$futureTimeDependencyMetadata
 		);
@@ -425,13 +424,13 @@ 
 		array $resultSerialization,
 		CachingMetadata $cachingMetadata
 	) {
-		$result = $this->checkResultDeserializer->deserialize( $resultSerialization );
-		if ( $this->isPossiblyStaleResult( $result ) ) {
+		$result = $this->checkResultDeserializer->deserialize($resultSerialization);
+		if ($this->isPossiblyStaleResult($result)) {
 			$result->withMetadata(
-				Metadata::merge( [
+				Metadata::merge([
 					$result->getMetadata(),
-					Metadata::ofCachingMetadata( $cachingMetadata ),
-				] )
+					Metadata::ofCachingMetadata($cachingMetadata),
+				])
 			);
 		}
 		return $result;
@@ -441,8 +440,8 @@ 
 	 * @param CheckResult $result
 	 * @return bool
 	 */
-	private function isPossiblyStaleResult( CheckResult $result ) {
-		if ( $result instanceof NullResult ) {
+	private function isPossiblyStaleResult(CheckResult $result) {
+		if ($result instanceof NullResult) {
 			return false;
 		}
 
@@ -457,14 +456,14 @@ 
 	 * @return int[]|null array from entity ID serializations to revision ID,
 	 * or null to indicate that not all revision IDs could be loaded
 	 */
-	private function getLatestRevisionIds( array $entityIds ) {
-		if ( $entityIds === [] ) {
+	private function getLatestRevisionIds(array $entityIds) {
+		if ($entityIds === []) {
 			$this->loggingHelper->logEmptyDependencyMetadata();
 			return [];
 		}
-		if ( count( $entityIds ) > $this->maxRevisionIds ) {
+		if (count($entityIds) > $this->maxRevisionIds) {
 			// one of those entities will probably be edited soon, so might as well skip caching
-			$this->loggingHelper->logHugeDependencyMetadata( $entityIds, $this->maxRevisionIds );
+			$this->loggingHelper->logHugeDependencyMetadata($entityIds, $this->maxRevisionIds);
 			return null;
 		}
 
@@ -472,7 +471,7 @@ 
 			$entityIds,
 			LookupConstants::LATEST_FROM_REPLICA
 		);
-		if ( $this->hasFalseElements( $latestRevisionIds ) ) {
+		if ($this->hasFalseElements($latestRevisionIds)) {
 			return null;
 		}
 		return $latestRevisionIds;
@@ -482,14 +481,14 @@ 
 	 * @param array $array
 	 * @return bool
 	 */
-	private function hasFalseElements( array $array ) {
-		return in_array( false, $array, true );
+	private function hasFalseElements(array $array) {
+		return in_array(false, $array, true);
 	}
 
 	/**
 	 * Set a custom function to get the current time, instead of microtime().
 	 */
-	public function setMicrotimeFunction( callable $microtime ) {
+	public function setMicrotimeFunction(callable $microtime) {
 		$this->microtime = $microtime;
 	}