From 01938ae7db2a5911c6e88b515acf259377a5b54c Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Fri, 7 Jul 2017 17:19:39 -0700 Subject: [PATCH] statsd: Rename MediawikiStatsdDataFactory to IBufferingStatsdDataFactory Follows-up I2874175647e (7fdc3d09a3b). * Avoid "MediaWiki" in class names. If unavoidable, always camelcase. * Use a more descriptive name, matching the implementing the class ("Buffering"). * Use "I" prefix for consistency with other MediaWiki-provided interfaces. (Avoid "Interface" suffix, which is foreign to MediaWiki and is only used in the StatsdClient namespace, which this interface is not in). Bug: T166354 Change-Id: I06de59122625f9c23e7c1a1bfa69a7ddabbf379e --- autoload.php | 2 +- includes/MediaWikiServices.php | 4 ++-- includes/context/ContextSource.php | 2 +- includes/context/DerivativeContext.php | 2 +- includes/context/IContextSource.php | 2 +- includes/context/RequestContext.php | 2 +- includes/libs/stats/BufferingStatsdDataFactory.php | 2 +- ...tatsdDataFactory.php => IBufferingStatsdDataFactory.php} | 6 ++++-- includes/libs/stats/NullStatsdDataFactory.php | 2 +- tests/phpunit/includes/MediaWikiServicesTest.php | 2 +- 10 files changed, 14 insertions(+), 12 deletions(-) rename includes/libs/stats/{MediawikiStatsdDataFactory.php => IBufferingStatsdDataFactory.php} (71%) diff --git a/autoload.php b/autoload.php index 2560bdbdb9..88b61700e3 100644 --- a/autoload.php +++ b/autoload.php @@ -604,6 +604,7 @@ $wgAutoloadLocalClasses = [ 'HttpError' => __DIR__ . '/includes/exception/HttpError.php', 'HttpStatus' => __DIR__ . '/includes/libs/HttpStatus.php', 'IApiMessage' => __DIR__ . '/includes/api/ApiMessage.php', + 'IBufferingStatsdDataFactory' => __DIR__ . '/includes/libs/stats/IBufferingStatsdDataFactory.php', 'ICacheHelper' => __DIR__ . '/includes/cache/CacheHelper.php', 'IContextSource' => __DIR__ . '/includes/context/IContextSource.php', 'IDBAccessObject' => __DIR__ . '/includes/dao/IDBAccessObject.php', @@ -964,7 +965,6 @@ $wgAutoloadLocalClasses = [ 'MediaWiki\\Widget\\TitleInputWidget' => __DIR__ . '/includes/widget/TitleInputWidget.php', 'MediaWiki\\Widget\\UserInputWidget' => __DIR__ . '/includes/widget/UserInputWidget.php', 'MediaWiki\\Widget\\UsersMultiselectWidget' => __DIR__ . '/includes/widget/UsersMultiselectWidget.php', - 'MediawikiStatsdDataFactory' => __DIR__ . '/includes/libs/stats/MediawikiStatsdDataFactory.php', 'MemCachedClientforWiki' => __DIR__ . '/includes/compat/MemcachedClientCompat.php', 'MemcLockManager' => __DIR__ . '/includes/libs/lockmanager/MemcLockManager.php', 'MemcachedBagOStuff' => __DIR__ . '/includes/libs/objectcache/MemcachedBagOStuff.php', diff --git a/includes/MediaWikiServices.php b/includes/MediaWikiServices.php index ea0ec15c9d..84fc959fa7 100644 --- a/includes/MediaWikiServices.php +++ b/includes/MediaWikiServices.php @@ -9,7 +9,7 @@ use EventRelayerGroup; use GenderCache; use GlobalVarConfig; use Hooks; -use MediawikiStatsdDataFactory; +use IBufferingStatsdDataFactory; use Wikimedia\Rdbms\LBFactory; use LinkCache; use Wikimedia\Rdbms\LoadBalancer; @@ -447,7 +447,7 @@ class MediaWikiServices extends ServiceContainer { /** * @since 1.27 - * @return MediawikiStatsdDataFactory + * @return IBufferingStatsdDataFactory */ public function getStatsdDataFactory() { return $this->getService( 'StatsdDataFactory' ); diff --git a/includes/context/ContextSource.php b/includes/context/ContextSource.php index 36d6df2c57..434201a174 100644 --- a/includes/context/ContextSource.php +++ b/includes/context/ContextSource.php @@ -170,7 +170,7 @@ abstract class ContextSource implements IContextSource { * @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected) * * @since 1.25 - * @return MediawikiStatsdDataFactory + * @return IBufferingStatsdDataFactory */ public function getStats() { return MediaWikiServices::getInstance()->getStatsdDataFactory(); diff --git a/includes/context/DerivativeContext.php b/includes/context/DerivativeContext.php index 9c3c42a92d..0d0c149d80 100644 --- a/includes/context/DerivativeContext.php +++ b/includes/context/DerivativeContext.php @@ -109,7 +109,7 @@ class DerivativeContext extends ContextSource implements MutableContext { * * @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected) * - * @return MediawikiStatsdDataFactory + * @return IBufferingStatsdDataFactory */ public function getStats() { return MediaWikiServices::getInstance()->getStatsdDataFactory(); diff --git a/includes/context/IContextSource.php b/includes/context/IContextSource.php index d13e1a5705..895e9e4b55 100644 --- a/includes/context/IContextSource.php +++ b/includes/context/IContextSource.php @@ -131,7 +131,7 @@ interface IContextSource extends MessageLocalizer { * @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected) * * @since 1.25 - * @return MediawikiStatsdDataFactory + * @return IBufferingStatsdDataFactory */ public function getStats(); diff --git a/includes/context/RequestContext.php b/includes/context/RequestContext.php index 2cabfe1013..2ac41925d8 100644 --- a/includes/context/RequestContext.php +++ b/includes/context/RequestContext.php @@ -138,7 +138,7 @@ class RequestContext implements IContextSource, MutableContext { * * @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected) * - * @return MediawikiStatsdDataFactory + * @return IBufferingStatsdDataFactory */ public function getStats() { return MediaWikiServices::getInstance()->getStatsdDataFactory(); diff --git a/includes/libs/stats/BufferingStatsdDataFactory.php b/includes/libs/stats/BufferingStatsdDataFactory.php index f687254e3c..73c6a8f55c 100644 --- a/includes/libs/stats/BufferingStatsdDataFactory.php +++ b/includes/libs/stats/BufferingStatsdDataFactory.php @@ -32,7 +32,7 @@ use Liuggio\StatsdClient\Factory\StatsdDataFactory; * * @since 1.25 */ -class BufferingStatsdDataFactory extends StatsdDataFactory implements MediawikiStatsdDataFactory { +class BufferingStatsdDataFactory extends StatsdDataFactory implements IBufferingStatsdDataFactory { protected $buffer = []; /** * Collection enabled? diff --git a/includes/libs/stats/MediawikiStatsdDataFactory.php b/includes/libs/stats/IBufferingStatsdDataFactory.php similarity index 71% rename from includes/libs/stats/MediawikiStatsdDataFactory.php rename to includes/libs/stats/IBufferingStatsdDataFactory.php index d560f18694..64ee2676f6 100644 --- a/includes/libs/stats/MediawikiStatsdDataFactory.php +++ b/includes/libs/stats/IBufferingStatsdDataFactory.php @@ -3,9 +3,11 @@ use Liuggio\StatsdClient\Entity\StatsdData; use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface; /** - * Mediawiki adaptation of Statsd data factory. + * MediaWiki adaptation of StatsdDataFactory that provides buffering functionality. + * + * @see BufferingStatsdDataFactory */ -interface MediawikiStatsdDataFactory extends StatsdDataFactoryInterface { +interface IBufferingStatsdDataFactory extends StatsdDataFactoryInterface { /** * Check whether this data factory has any data. * @return boolean diff --git a/includes/libs/stats/NullStatsdDataFactory.php b/includes/libs/stats/NullStatsdDataFactory.php index 4fa0248e60..f2e35b67be 100644 --- a/includes/libs/stats/NullStatsdDataFactory.php +++ b/includes/libs/stats/NullStatsdDataFactory.php @@ -8,7 +8,7 @@ use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface; * @author Addshore * @since 1.27 */ -class NullStatsdDataFactory implements MediawikiStatsdDataFactory { +class NullStatsdDataFactory implements IBufferingStatsdDataFactory { /** * This function creates a 'timing' StatsdData. diff --git a/tests/phpunit/includes/MediaWikiServicesTest.php b/tests/phpunit/includes/MediaWikiServicesTest.php index 4e1625837e..9eae64348b 100644 --- a/tests/phpunit/includes/MediaWikiServicesTest.php +++ b/tests/phpunit/includes/MediaWikiServicesTest.php @@ -303,7 +303,7 @@ class MediaWikiServicesTest extends MediaWikiTestCase { 'MainConfig' => [ 'MainConfig', Config::class ], 'SiteStore' => [ 'SiteStore', SiteStore::class ], 'SiteLookup' => [ 'SiteLookup', SiteLookup::class ], - 'StatsdDataFactory' => [ 'StatsdDataFactory', MediawikiStatsdDataFactory::class ], + 'StatsdDataFactory' => [ 'StatsdDataFactory', IBufferingStatsdDataFactory::class ], 'InterwikiLookup' => [ 'InterwikiLookup', InterwikiLookup::class ], 'EventRelayerGroup' => [ 'EventRelayerGroup', EventRelayerGroup::class ], 'SearchEngineFactory' => [ 'SearchEngineFactory', SearchEngineFactory::class ], -- 2.20.1