Merge branch 'fix-cache-provider'

Author: dbu

CHANGELOG.md

@@ -3,6 +3,14 @@ Changelog
 
 See also the [GitHub releases page](https://github.com/FriendsOfSymfony/FOSHttpCache/releases).
 
+2.5.3
+-----
+
+### Symfony HttpCache
+
+* Fixed: Handle HttpCache not available in KernelDispatcher and fix return
+  type annotations - if HttpCache is not set, it can't be returned.
+
 2.5.2
 -----
 

src/SymfonyCache/HttpCacheAware.php

@@ -19,12 +19,12 @@
 trait HttpCacheAware
 {
     /**
-     * @var HttpKernelInterface
+     * @var HttpKernelInterface|null
      */
     private $httpCache;
 
     /**
-     * @return HttpKernelInterface
+     * @return HttpKernelInterface|null
      */
     public function getHttpCache()
     {

src/SymfonyCache/HttpCacheProvider.php

@@ -16,7 +16,7 @@
 interface HttpCacheProvider
 {
     /**
-     * @return HttpKernelInterface
+     * @return HttpKernelInterface|null
      */
     public function getHttpCache();
 }

src/SymfonyCache/KernelDispatcher.php

@@ -12,6 +12,7 @@
 namespace FOS\HttpCache\SymfonyCache;
 
 use FOS\HttpCache\Exception\ExceptionCollection;
+use FOS\HttpCache\Exception\ProxyUnreachableException;
 use FOS\HttpCache\ProxyClient\Dispatcher;
 use Psr\Http\Message\RequestInterface;
 use Symfony\Component\HttpFoundation\Request;
@@ -96,6 +97,10 @@ public function flush()
 
         $httpCache = $this->httpCacheProvider->getHttpCache();
 
+        if (null === $httpCache) {
+            throw new ProxyUnreachableException('Kernel did not return a HttpCache instance. Did you forget $kernel->setHttpCache($cacheKernel) in your front controller?');
+        }
+
         foreach ($queue as $request) {
             try {
                 $httpCache->handle($request, HttpKernelInterface::MASTER_REQUEST, false);

tests/Unit/SymfonyCache/KernelDispatcherTest.php

@@ -11,6 +11,7 @@
 
 namespace FOS\HttpCache\Tests\Unit\SymfonyCache;
 
+use FOS\HttpCache\Exception\ProxyUnreachableException;
 use FOS\HttpCache\SymfonyCache\HttpCacheProvider;
 use FOS\HttpCache\SymfonyCache\KernelDispatcher;
 use GuzzleHttp\Psr7\Request as Psr7Request;
@@ -26,19 +27,6 @@ class KernelDispatcherTest extends TestCase
 {
     public function testFlush()
     {
-        $headers = [
-            'Content-Type' => 'foobar',
-            'Cookie' => 'foo=bar; foscacheis=awesome',
-            'X-Cache-Tags' => 'foo,bar,stuff',
-        ];
-
-        $psr7Request = new Psr7Request(
-            'PURGETAGS',
-            'http://127.0.0.1/foobar?query=string&more=stuff',
-            $headers,
-            'super content'
-        );
-
         $httpCache = $this->createMock(HttpCache::class);
         $httpCache->expects($this->once())
             ->method('handle')
@@ -64,8 +52,43 @@ public function testFlush()
             ->willReturn($httpCache);
 
         $dispatcher = new KernelDispatcher($kernel);
-        $dispatcher->invalidate($psr7Request);
+        $dispatcher->invalidate($this->getRequest());
 
         $dispatcher->flush();
     }
+
+    public function testFlushWithoutHttpCache()
+    {
+        $this->expectException(ProxyUnreachableException::class);
+        $this->expectExceptionMessage('Kernel did not return a HttpCache instance. Did you forget $kernel->setHttpCache($cacheKernel) in your front controller?');
+
+        $kernel = $this->createMock(HttpCacheProvider::class);
+        $kernel->expects($this->once())
+            ->method('getHttpCache')
+            ->willReturn(null);
+
+        $dispatcher = new KernelDispatcher($kernel);
+        $dispatcher->invalidate($this->getRequest());
+
+        $dispatcher->flush();
+    }
+
+    /**
+     * @return Psr7Request
+     */
+    private function getRequest()
+    {
+        $headers = [
+            'Content-Type' => 'foobar',
+            'Cookie' => 'foo=bar; foscacheis=awesome',
+            'X-Cache-Tags' => 'foo,bar,stuff',
+        ];
+
+        return new Psr7Request(
+            'PURGETAGS',
+            'http://127.0.0.1/foobar?query=string&more=stuff',
+            $headers,
+            'super content'
+        );
+    }
 }