feature #18716 [Cache] Add nonce based cache invalidation to ApcuAdapter (nicolas-grekas)

fabpot · fabpot · commit 209fb450da02 · 2016-05-12T13:36:56.000-05:00
This PR was merged into the 3.1-dev branch. Discussion ---------- [Cache] Add nonce based cache invalidation to ApcuAdapter | Q | A | ------------- | --- | Branch? | 3.1 | Bug fix? | yes | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - APCu cache invalidation is tedious because it can't be done from the cli. This PR adds and wires a nonce based cache invalidation strategy to work around this limitation. Commits ------- a7899fe [Cache] Add nonce based cache invalidation to ApcuAdapter
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1037,6 +1037,8 @@ private function registerPropertyInfoConfiguration(array $config, ContainerBuild
 
     private function registerCacheConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)
     {
+        $nonce = substr(str_replace('/', '-', base64_encode(md5(uniqid(mt_rand(), true), true))), 0, -2);
+        $container->getDefinition('cache.adapter.apcu')->replaceArgument(2, $nonce);
         $container->getDefinition('cache.adapter.filesystem')->replaceArgument(2, $config['directory']);
 
         foreach (array('doctrine', 'psr6', 'redis') as $name) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/cache.xml
@@ -27,6 +27,7 @@
             <tag name="monolog.logger" channel="cache" />
             <argument /> <!-- namespace -->
             <argument /> <!-- default lifetime -->
+            <argument /> <!-- nonce -->
             <call method="setLogger">
                 <argument type="service" id="logger" on-invalid="ignore" />
             </call>
diff --git a/src/Symfony/Component/Cache/Adapter/ApcuAdapter.php b/src/Symfony/Component/Cache/Adapter/ApcuAdapter.php
@@ -11,14 +11,15 @@
 
 namespace Symfony\Component\Cache\Adapter;
 
+use Symfony\Component\Cache\CacheItem;
 use Symfony\Component\Cache\Exception\CacheException;
 
 /**
  * @author Nicolas Grekas <p@tchwork.com>
  */
 class ApcuAdapter extends AbstractAdapter
 {
-    public function __construct($namespace = '', $defaultLifetime = 0)
+    public function __construct($namespace = '', $defaultLifetime = 0, $nonce = null)
     {
         if (!function_exists('apcu_fetch') || !ini_get('apc.enabled') || ('cli' === PHP_SAPI && !ini_get('apc.enable_cli'))) {
             throw new CacheException('APCu is not enabled');
@@ -27,6 +28,15 @@ public function __construct($namespace = '', $defaultLifetime = 0)
             ini_set('apc.use_request_time', 0);
         }
         parent::__construct($namespace, $defaultLifetime);
+
+        if (null !== $nonce) {
+            CacheItem::validateKey($nonce);
+
+            if (!apcu_exists($nonce.':nonce'.$namespace)) {
+                $this->clear($namespace);
+                apcu_add($nonce.':nonce'.$namespace, null);
+            }
+        }
     }
 
     /**
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/ApcuAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/ApcuAdapterTest.php
@@ -43,4 +43,29 @@ public function testUnserializable()
         $item = $pool->getItem('foo');
         $this->assertFalse($item->isHit());
     }
+
+    public function testNonce()
+    {
+        $namespace = str_replace('\\', '.', __CLASS__);
+
+        $pool1 = new ApcuAdapter($namespace, 0, 'p1');
+
+        $item = $pool1->getItem('foo');
+        $this->assertFalse($item->isHit());
+        $this->assertTrue($pool1->save($item->set('bar')));
+
+        $item = $pool1->getItem('foo');
+        $this->assertTrue($item->isHit());
+        $this->assertSame('bar', $item->get());
+
+        $pool2 = new ApcuAdapter($namespace, 0, 'p2');
+
+        $item = $pool2->getItem('foo');
+        $this->assertFalse($item->isHit());
+        $this->assertNull($item->get());
+
+        $item = $pool1->getItem('foo');
+        $this->assertFalse($item->isHit());
+        $this->assertNull($item->get());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1037,6 +1037,8 @@ private function registerPropertyInfoConfiguration(array $config, ContainerBuild`
`1037`	`1037`
`1038`	`1038`	`private function registerCacheConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)`
`1039`	`1039`	`{`
	`1040`	`+ $nonce = substr(str_replace('/', '-', base64_encode(md5(uniqid(mt_rand(), true), true))), 0, -2);`
	`1041`	`+ $container->getDefinition('cache.adapter.apcu')->replaceArgument(2, $nonce);`
`1040`	`1042`	`$container->getDefinition('cache.adapter.filesystem')->replaceArgument(2, $config['directory']);`
`1041`	`1043`
`1042`	`1044`	`foreach (array('doctrine', 'psr6', 'redis') as $name) {`