Add CacheKeyGenerator::Version

Author: mwjames

src/CacheKeyGenerator.php

@@ -11,10 +11,10 @@
 class CacheKeyGenerator {
 
 	/**
-	 * External (hence auxiliary) cache key modifier that can be used to alter
-	 * existing keys
+	 * Update the version to force a recache for all items due to
+	 * required changes
 	 */
-	private $auxiliaryKeyModifier = '';
+	const VERSION = '1.1';
 
 	/**
 	 * @var string|null
@@ -33,18 +33,6 @@ public function setCachePrefix( $cachePrefix ) {
 		return $this;
 	}
 
-	/**
-	 * @since 1.0
-	 *
-	 * @param string $auxiliaryKeyModifier
-	 *
-	 * @return CacheKeyGenerator
-	 */
-	public function setAuxiliaryKeyModifier( $auxiliaryKeyModifier ) {
-		$this->auxiliaryKeyModifier = $auxiliaryKeyModifier;
-		return $this;
-	}
-
 	/**
 	 * @since 1.0
 	 *
@@ -53,7 +41,7 @@ public function setAuxiliaryKeyModifier( $auxiliaryKeyModifier ) {
 	 * @return  string
 	 */
 	public function getSiteCacheKey( $key ) {
-		return $this->getCachePrefix() . 's:' . md5( $key . $this->auxiliaryKeyModifier );
+		return $this->getCachePrefix() . 's:' . md5( $key . self::VERSION );
 	}
 
 	/**
@@ -64,7 +52,7 @@ public function getSiteCacheKey( $key ) {
 	 * @return  string
 	 */
 	public function getPageLanguageCacheBlobKey( $key = '' ) {
-		return $this->getCachePrefix() . 'b:' . md5( $key . $this->auxiliaryKeyModifier );
+		return $this->getCachePrefix() . 'b:' . md5( $key . self::VERSION );
 	}
 
 	/**
@@ -76,7 +64,7 @@ public function getPageLanguageCacheBlobKey( $key = '' ) {
 	 * @return  string
 	 */
 	public function getPageCacheKey( $key, $stable = true ) {
-		return $this->getCachePrefix() . 'p:' . md5( $key . ( $stable ? '' : $this->auxiliaryKeyModifier ) );
+		return $this->getCachePrefix() . 'p:' . md5( $key . ( $stable ? '' : self::VERSION ) );
 	}
 
 	/**

src/HookRegistry.php

@@ -69,7 +69,6 @@ public function register() {
 	private function addCallbackHandlers( $store, $cache, $cachePrefix ) {
 
 		$cacheKeyGenerator = new CacheKeyGenerator();
-		$cacheKeyGenerator->setAuxiliaryKeyModifier( '20150122' );
 		$cacheKeyGenerator->setCachePrefix( $cachePrefix );
 
 		$languageTargetLinksCache = new LanguageTargetLinksCache(

tests/phpunit/Unit/CacheKeyGeneratorTest.php

@@ -28,21 +28,10 @@ public function testGetSiteCacheKey() {
 
 		$instance = new CacheKeyGenerator();
 
-		$this->assertNotSame(
-			$instance
-				->setAuxiliaryKeyModifier( 'foo' )
-				->getSiteCacheKey( 'foo' ),
-			$instance
-				->setAuxiliaryKeyModifier( 'bar' )
-				->getSiteCacheKey( 'foo' )
-		);
-
 		$this->assertSame(
 			$instance
-				->setAuxiliaryKeyModifier( 'bar' )
 				->getSiteCacheKey( 'foo' ),
 			$instance
-				->setAuxiliaryKeyModifier( 'bar' )
 				->getSiteCacheKey( 'foo' )
 		);
 	}
@@ -51,12 +40,10 @@ public function testGetPageLanguageCacheBlobKey() {
 
 		$instance = new CacheKeyGenerator();
 
-		$this->assertNotSame(
+		$this->assertSame(
 			$instance
-				->setAuxiliaryKeyModifier( 'foo' )
 				->getPageLanguageCacheBlobKey( 'foo' ),
 			$instance
-				->setAuxiliaryKeyModifier( 'bar' )
 				->getPageLanguageCacheBlobKey( 'foo' )
 		);
 	}
@@ -65,21 +52,10 @@ public function testGetPageCacheKey() {
 
 		$instance = new CacheKeyGenerator();
 
-		$this->assertNotSame(
-			$instance
-				->setAuxiliaryKeyModifier( 'foo' )
-				->getPageCacheKey( 'foo', false ),
-			$instance
-				->setAuxiliaryKeyModifier( 'bar' )
-				->getPageCacheKey( 'foo', false )
-		);
-
 		$this->assertSame(
 			$instance
-				->setAuxiliaryKeyModifier( 'foo' )
 				->getPageCacheKey( 'foo', true ),
 			$instance
-				->setAuxiliaryKeyModifier( 'bar' )
 				->getPageCacheKey( 'foo', true )
 		);
 	}

tests/phpunit/Unit/LanguageTargetLinksCacheTest.php

@@ -318,7 +318,6 @@ public function testUpdatePageLanguageToCache( $pageLanguageCacheStrategy ) {
 				$this->equalTo( $data ) );
 
 		$cacheKeyGenerator = new CacheKeyGenerator();
-		$cacheKeyGenerator->setAuxiliaryKeyModifier( '20150122' );
 		$cacheKeyGenerator->setCachePrefix( 'foo' );
 
 		$instance = new LanguageTargetLinksCache( $cache, $cacheKeyGenerator );