Fix cache management

Author: Thomas Rabaix

Adapter/EsiCache.php

@@ -111,6 +111,14 @@ public function has(array $keys)
      */
     public function get(array $keys)
     {
+        if (!isset($keys['controller'])) {
+            throw new \RuntimeException('Please define a controller key');
+        }
+
+        if (!isset($keys['parameters'])) {
+            throw new \RuntimeException('Please define a parameters key');
+        }
+
         $content = sprintf('<esi:include src="%s"/>', $this->getUrl($keys));
 
         return new CacheElement($keys, new Response($content));
@@ -135,7 +143,7 @@ protected function getUrl(array $keys)
             'parameters' => $keys
         );
 
-        return $this->router->generate('sonata_page_esi_cache', $parameters, true);
+        return $this->router->generate('sonata_cache_esi', $parameters, true);
     }
 
     /**
@@ -165,11 +173,9 @@ public function cacheAction(Request $request)
         $parameters = $request->get('parameters', array());
 
         if ($request->get('token') != $this->computeHash($parameters)) {
-            throw new AccessDeniedHttpException('Invalid token'.$this->computeHash($parameters));
+            throw new AccessDeniedHttpException('Invalid token');
         }
 
-        $parameters['_controller'] = $request->get('controller');
-
         $subRequest = Request::create('', 'get', $parameters, $request->cookies->all(), array(), $request->server->all());
 
         $controller = $this->resolver->getController($subRequest);

Cache/CacheManager.php

@@ -27,10 +27,12 @@ class CacheManager implements CacheManagerInterface
 
     /**
      * @param \Sonata\CacheBundle\Invalidation\InvalidationInterface $cacheInvalidation
+     * @param array $cacheServices
      */
-    public function __construct(InvalidationInterface $cacheInvalidation)
+    public function __construct(InvalidationInterface $cacheInvalidation, array $cacheServices)
     {
         $this->cacheInvalidation  = $cacheInvalidation;
+        $this->cacheServices      = $cacheServices;
     }
 
     /**

DependencyInjection/Compiler/TweakCompilerPass.php renamed to DependencyInjection/Compiler/CacheCompilerPass.php

@@ -21,22 +21,31 @@
  *
  * @author Thomas Rabaix <[email protected]>
  */
-class TweakCompilerPass implements CompilerPassInterface
+class CacheCompilerPass implements CompilerPassInterface
 {
     /**
      * {@inheritDoc}
      */
     public function process(ContainerBuilder $container)
     {
-        if ($container->hasDefinition('sonata.cache.orm.event_subscriber.default')) {
-            $ormListener = $container->getDefinition('sonata.cache.orm.event_subscriber.default');
-            foreach ($container->findTaggedServiceIds('sonata.cache') as $id => $attributes) {
-                if (!$container->hasDefinition($id)) {
-                    continue;
-                }
+        $caches = array();
 
-                $ormListener->addMethodCall('addCache', array(new Reference($id)));
+        foreach ($container->findTaggedServiceIds('sonata.cache') as $id => $attributes) {
+            if (!$container->hasDefinition($id)) {
+                continue;
             }
+
+            $caches[$id] = new Reference($id);
+        }
+
+        if ($container->hasDefinition('sonata.cache.orm.event_subscriber.default')) {
+            $container->getDefinition('sonata.cache.orm.event_subscriber.default')
+                ->replaceArgument(1, $caches);
+        }
+
+        if ($container->hasDefinition('sonata.cache.manager')) {
+            $container->getDefinition('sonata.cache.manager')
+                ->replaceArgument(1, $caches);
         }
     }
 }

DependencyInjection/SonataCacheExtension.php

@@ -114,7 +114,7 @@ public function configureCache(ContainerBuilder $container, $config)
             $container->removeDefinition('sonata.cache.mongo');
         }
 
-        if (isset($configs['caches']['memcached'])) {
+        if (isset($config['caches']['memcached'])) {
 
             if (!class_exists('\Memcached', true)) {
                 throw new \RuntimeException(<<<HELP
@@ -135,7 +135,7 @@ public function configureCache(ContainerBuilder $container, $config)
             $container->removeDefinition('sonata.cache.memcached');
         }
 
-        if (isset($configs['caches']['apc'])) {
+        if (isset($config['caches']['apc'])) {
 
             if (!function_exists('apc_fetch')) {
                 throw new \RuntimeException(<<<HELP

Invalidation/DoctrineORMListener.php

@@ -23,9 +23,13 @@ class DoctrineORMListener implements EventSubscriber
 
     protected $collectionIdentifiers;
 
-    public function __construct(ModelCollectionIdentifiers $collectionIdentifiers)
+    public function __construct(ModelCollectionIdentifiers $collectionIdentifiers, $caches)
     {
         $this->collectionIdentifiers = $collectionIdentifiers;
+
+        foreach ($caches as $cache) {
+            $this->addCache($cache);
+        }
     }
 
     public function getSubscribedEvents()

Resources/config/cache.xml

@@ -7,6 +7,7 @@
 
         <service id="sonata.cache.manager" class="Sonata\CacheBundle\Cache\CacheManager" >
             <argument />
+            <argument />
         </service>
 
 
@@ -18,7 +19,9 @@
             <argument type="collection" />
         </service>
 
-        <service id="sonata.cache.noop" class="Sonata\CacheBundle\Adapter\NoopCache" />
+        <service id="sonata.cache.noop" class="Sonata\CacheBundle\Adapter\NoopCache">
+            <tag name="sonata.cache" />
+        </service>
 
         <service id="sonata.cache.mongo" class="Sonata\CacheBundle\Adapter\MongoCache" >
             <tag name="sonata.cache" />
@@ -41,7 +44,7 @@
             <argument type="collection" />
         </service>
 
-        <service id="sonata.cache.esi" class="Sonata\CacheBundle\Cache\EsiCache">
+        <service id="sonata.cache.esi" class="Sonata\CacheBundle\Adapter\EsiCache">
             <tag name="sonata.cache" />
             <argument />
             <argument type="collection" />

Resources/config/orm.xml

@@ -8,6 +8,7 @@
 
         <service id="sonata.cache.orm.event_subscriber.default" class="Sonata\CacheBundle\Invalidation\DoctrineORMListener" >
             <argument type="service" id="sonata.cache.model_identifier" />
+            <argument />
         </service>
 
         <service id="sonata.cache.orm.event_subscriber" class="Sonata\CacheBundle\Invalidation\DoctrineORMListenerContainerAware">

SonataCacheBundle.php

@@ -12,15 +12,15 @@
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Sonata\CacheBundle\DependencyInjection\Compiler\TweakCompilerPass;
+use Sonata\CacheBundle\DependencyInjection\Compiler\CacheCompilerPass;
 
 class SonataCacheBundle extends Bundle
 {
     public function build(ContainerBuilder $container)
     {
         parent::build($container);
 
-        $container->addCompilerPass(new TweakCompilerPass());
+        $container->addCompilerPass(new CacheCompilerPass());
     }
 
     public function boot()

Tests/Adapter/EsiCacheTest.php

@@ -39,7 +39,7 @@ public function testInitCache()
 
         $this->assertTrue($cache->has(array('id' => 7)));
 
-        $cacheElement = $cache->get(array('id' => 7));
+        $cacheElement = $cache->get(array('id' => 7, 'controller' => 'foo.service::runAction', 'parameters' => array()));
 
         $this->assertInstanceOf('Sonata\CacheBundle\Cache\CacheElement', $cacheElement);
 

Tests/Invalidation/DoctrineORMListenerTest.php

@@ -33,7 +33,7 @@ public function test()
     {
         $collection = new ModelCollectionIdentifiers;
 
-        $listener = new DoctrineORMListener($collection);
+        $listener = new DoctrineORMListener($collection, array());
 
         $event = $this->getMock('Doctrine\ORM\Event\LifecycleEventArgs', array(), array(), '', false);
         $event->expects($this->exactly(4))