mediawiki-extensions-Echo/ServiceWiring.php
Daimona Eaytoy ef50bfeda5 Make Title and Revision caches proper services
Singletons are bad, amongst other reasons, because they're never reset
in tests. They can therefore occasionally cause test failures if the
cached data stored in one of these singletons becomes stale.

As noted on the task, ideally these two classes shouldn't exist at all,
and core should be responsible for caching the information it deems
expensive to compute.

As a temporary (TM) workaround, make both classes actual services, so
that the setUp/tearDown logic in MediaWikiIntegrationTestCase can
properly reset them between tests.

Dependencies are intentionally not being injected, precisely because
these classes should just be deleted, not improved.

Bug: T344124
Change-Id: I58b8d9610f9447468235b94d25732528ab6acce6
2023-08-14 17:41:23 +02:00

103 lines
3.3 KiB
PHP

<?php
use MediaWiki\Extension\Notifications\Cache\RevisionLocalCache;
use MediaWiki\Extension\Notifications\Cache\TitleLocalCache;
use MediaWiki\Extension\Notifications\Push\NotificationServiceClient;
use MediaWiki\Extension\Notifications\Push\SubscriptionManager;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use MediaWiki\Storage\NameTableStore;
// PHP unit does not understand code coverage for this file
// as the @covers annotation cannot cover a specific file.
// Whether the services return without error is checked in ServiceWiringTest.php
// @codeCoverageIgnoreStart
return [
'EchoAttributeManager' => static function ( MediaWikiServices $services ): EchoAttributeManager {
$userGroupManager = $services->getUserGroupManager();
$echoConfig = $services->getConfigFactory()->makeConfig( 'Echo' );
$notifications = $echoConfig->get( 'EchoNotifications' );
$categories = $echoConfig->get( 'EchoNotificationCategories' );
$typeAvailability = $echoConfig->get( 'DefaultNotifyTypeAvailability' );
$typeAvailabilityByCategory = $echoConfig->get( 'NotifyTypeAvailabilityByCategory' );
return new EchoAttributeManager(
$notifications,
$categories,
$typeAvailability,
$typeAvailabilityByCategory,
$userGroupManager,
$services->getUserOptionsLookup()
);
},
'EchoPushNotificationServiceClient' => static function (
MediaWikiServices $services
): NotificationServiceClient {
$echoConfig = $services->getConfigFactory()->makeConfig( 'Echo' );
$httpRequestFactory = $services->getHttpRequestFactory();
$url = $echoConfig->get( 'EchoPushServiceBaseUrl' );
$client = new NotificationServiceClient( $httpRequestFactory, $url );
$client->setLogger( LoggerFactory::getInstance( 'Echo' ) );
return $client;
},
'EchoPushSubscriptionManager' => static function ( MediaWikiServices $services ): SubscriptionManager {
$echoConfig = $services->getConfigFactory()->makeConfig( 'Echo' );
// Use shared DB/cluster for push subscriptions
$cluster = $echoConfig->get( 'EchoSharedTrackingCluster' );
$database = $echoConfig->get( 'EchoSharedTrackingDB' );
$loadBalancerFactory = $services->getDBLoadBalancerFactory();
$loadBalancer = $cluster
? $loadBalancerFactory->getExternalLB( $cluster )
: $loadBalancerFactory->getMainLB( $database );
$dbw = $loadBalancer->getConnection( DB_PRIMARY, [], $database );
$dbr = $loadBalancer->getConnection( DB_REPLICA, [], $database );
$pushProviderStore = new NameTableStore(
$loadBalancer,
$services->getMainWANObjectCache(),
LoggerFactory::getInstance( 'Echo' ),
'echo_push_provider',
'epp_id',
'epp_name',
null,
$database
);
$pushTopicStore = new NameTableStore(
$loadBalancer,
$services->getMainWANObjectCache(),
LoggerFactory::getInstance( 'Echo' ),
'echo_push_topic',
'ept_id',
'ept_text',
null,
$database
);
$maxSubscriptionsPerUser = $echoConfig->get( 'EchoPushMaxSubscriptionsPerUser' );
return new SubscriptionManager(
$dbw,
$dbr,
$pushProviderStore,
$pushTopicStore,
$maxSubscriptionsPerUser
);
},
'EchoTitleLocalCache' => static function ( MediaWikiServices $services ): TitleLocalCache {
return new TitleLocalCache();
},
'EchoRevisionLocalCache' => static function ( MediaWikiServices $services ): RevisionLocalCache {
return new RevisionLocalCache();
}
];
// @codeCoverageIgnoreEnd