cleanup cache setup

Author: dbu

doc/symfony-cache-configuration.rst

@@ -32,9 +32,9 @@ Instead of extending ``Symfony\Component\HttpKernel\HttpCache\HttpCache``, your
 
     If your class already needs to extend a different class, simply copy the
     event handling code from the EventDispatchingHttpCache into your
-    ``AppCache`` class. The drawback is that you need to manually check whether
-    you need to adjust your ``AppCache`` each time you update the FOSHttpCache
-    library.
+    ``AppCache`` class and make it implement ``CacheInvalidationInterface``.
+    The drawback is that you need to manually check whether you need to adjust
+    your ``AppCache`` each time you update the FOSHttpCache library.
 
 Now that you have an event dispatching kernel, you can make it register the
 subscribers you need. While you could do that from your bootstrap code, this is
@@ -168,7 +168,7 @@ options through the constructor:
 
     With Apache, you can do this for example in a ``.htaccess`` file::
 
-        RewriteEngine On 
+        RewriteEngine On
         RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
 
 Cleaning the Cookie Header

src/SymfonyCache/CacheEvent.php

@@ -24,7 +24,7 @@
 class CacheEvent extends Event
 {
     /**
-     * @var HttpCache
+     * @var CacheInvalidationInterface
      */
     private $kernel;
 
@@ -39,19 +39,25 @@ class CacheEvent extends Event
     private $response;
 
     /**
-     * @param HttpCache $kernel  The kernel raising with this event.
-     * @param Request   $request The request being processed.
+     * Make sure your $kernel implements CacheInvalidationInterface. Creating the event with other
+     * HttpCache classes is deprecated and will no longer be supported in version 2 of this library.
+     *
+     * @param CacheInvalidationInterface|HttpCache $kernel  The kernel raising with this event.
+     * @param Request                              $request The request being processed.
      */
-    public function __construct(HttpCache $kernel, Request $request)
+    public function __construct($kernel, Request $request)
     {
+        if (!($kernel instanceof CacheInvalidationInterface || $kernel instanceof HttpCache)) {
+            throw new \InvalidArgumentException('Expected a CacheInvalidationInterface or HttpCache');
+        }
         $this->kernel = $kernel;
         $this->request = $request;
     }
 
     /**
      * Get the cache kernel that raised this event.
      *
-     * @return HttpCache
+     * @return CacheInvalidationInterface
      */
     public function getKernel()
     {

src/SymfonyCache/CacheInvalidationInterface.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the FOSHttpCache package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\HttpCache\SymfonyCache;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\HttpCache\StoreInterface;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+
+/**
+ * Interface for a HttpCache that supports active cache invalidation.
+ */
+interface CacheInvalidationInterface extends HttpKernelInterface
+{
+    /**
+     * Forwards the Request to the backend and determines whether the response should be stored.
+     *
+     * This methods is triggered when the cache missed or a reload is required.
+     *
+     * This method is present on HttpCache but must be public to allow event subscribers to do
+     * refresh operations.
+     *
+     * @param Request $request A Request instance
+     * @param bool    $catch   Whether to process exceptions
+     *
+     * @return Response A Response instance
+     */
+    public function fetch(Request $request, $catch = false);
+
+    /**
+     * Gets the store for cached responses.
+     *
+     * @return StoreInterface $store The store used by the HttpCache
+     */
+    public function getStore();
+}

src/SymfonyCache/EventDispatchingHttpCache.php

@@ -30,7 +30,7 @@
  *
  * {@inheritdoc}
  */
-abstract class EventDispatchingHttpCache extends HttpCache
+abstract class EventDispatchingHttpCache extends HttpCache implements CacheInvalidationInterface
 {
     /**
      * @var EventDispatcherInterface

tests/Functional/CacheInvalidatorTest.php

@@ -12,6 +12,7 @@
 namespace FOS\HttpCache\Tests\Functional;
 
 use FOS\HttpCache\CacheInvalidator;
+use FOS\HttpCache\Handler\TagHandler;
 use FOS\HttpCache\Test\VarnishTestCase;
 
 /**
@@ -20,6 +21,23 @@
 class CacheInvalidatorTest extends VarnishTestCase
 {
     public function testInvalidateTags()
+    {
+        $cacheInvalidator = new CacheInvalidator($this->getProxyClient());
+        $tagHandler = new TagHandler($cacheInvalidator);
+
+        $this->assertMiss($this->getResponse('/tags.php'));
+        $this->assertHit($this->getResponse('/tags.php'));
+
+        $tagHandler->invalidateTags(array('tag1'));
+        $cacheInvalidator->flush();
+
+        $this->assertMiss($this->getResponse('/tags.php'));
+    }
+
+    /**
+     * Test the deprecated CacheInvalidator::invalidateTags method.
+     */
+    public function testInvalidateTagsBC()
     {
         $cacheInvalidator = new CacheInvalidator($this->getProxyClient());
 

tests/Functional/NginxTest.php renamed to tests/Functional/NginxProxyClientTest.php

@@ -27,7 +27,7 @@ class PurgeSubscriberTest extends \PHPUnit_Framework_TestCase
     public function setUp()
     {
         $this->kernel = $this
-            ->getMockBuilder('Symfony\Component\HttpKernel\HttpCache\HttpCache')
+            ->getMockBuilder('FOS\HttpCache\SymfonyCache\CacheInvalidationInterface')
             ->disableOriginalConstructor()
             ->getMock()
         ;

tests/Unit/SymfonyCache/PurgeSubscriberTest.php

@@ -27,7 +27,7 @@ class RefreshSubscriberTest extends \PHPUnit_Framework_TestCase
 
     public function setUp()
     {
-        $this->kernel = $this->getMock('FOS\HttpCache\Tests\Unit\SymfonyCache\TestHttpCache');
+        $this->kernel = $this->getMock('FOS\HttpCache\SymfonyCache\CacheInvalidationInterface');
     }
 
     public function testRefreshAllowed()
@@ -127,19 +127,3 @@ public function testInvalidConfiguration()
         new RefreshSubscriber(array('purge_client_ip' => '1.2.3.4'));
     }
 }
-
-class TestHttpCache extends HttpCache
-{
-    public function __construct()
-    {}
-
-    /**
-     * Made public to allow event subscribers to do refresh operations.
-     *
-     * {@inheritDoc}
-     */
-    public function fetch(Request $request, $catch = false)
-    {
-        return parent::fetch($request, $catch);
-    }
-}

tests/Unit/SymfonyCache/RefreshSubscriberTest.php

@@ -27,7 +27,7 @@ class UserContextSubscriberTest extends \PHPUnit_Framework_TestCase
     public function setUp()
     {
         $this->kernel = $this
-            ->getMockBuilder('Symfony\Component\HttpKernel\HttpCache\HttpCache')
+            ->getMockBuilder('FOS\HttpCache\SymfonyCache\CacheInvalidationInterface')
             ->disableOriginalConstructor()
             ->getMock()
         ;