do not force a host in the uri for ban requests

FriendsOfSymfony · Jun 23, 2017 · 4beeec7 · 4beeec7
1 parent c9e50d3
commit 4beeec7
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,13 @@ Changelog
 
 See also the [GitHub releases page](https://github.com/FriendsOfSymfony/FOSHttpCache/releases).
 
+2.0.1
+-----
+
+### Fixed
+
+* Ban requests now work even when no base URI is configured.
+
 2.0.0
 -----
 

diff --git a/src/ProxyClient/HttpDispatcher.php b/src/ProxyClient/HttpDispatcher.php
@@ -111,10 +111,13 @@ public function __construct(
      * Queue invalidation request.
      *
      * @param RequestInterface $invalidationRequest
+     * @param bool             $validateHost        If false, do not validate that we either have a
+     *                                              base uri or the invalidation request specifies
+     *                                              the host
      */
-    public function invalidate(RequestInterface $invalidationRequest)
+    public function invalidate(RequestInterface $invalidationRequest, $validateHost = true)
     {
-        if (!$this->baseUri && !$invalidationRequest->getUri()->getHost()) {
+        if ($validateHost && !$this->baseUri && !$invalidationRequest->getUri()->getHost()) {
             throw MissingHostException::missingHost((string) $invalidationRequest->getUri());
         }
 

diff --git a/src/ProxyClient/HttpProxyClient.php b/src/ProxyClient/HttpProxyClient.php
@@ -86,11 +86,13 @@ protected function configureOptions()
      * @param string              $method
      * @param string|UriInterface $url
      * @param array               $headers
+     * @param bool                $validateHost see HttpDispatcher::invalidate
      */
-    protected function queueRequest($method, $url, array $headers)
+    protected function queueRequest($method, $url, array $headers, $validateHost = true)
     {
         $this->httpDispatcher->invalidate(
-            $this->requestFactory->createRequest($method, $url, $headers)
+            $this->requestFactory->createRequest($method, $url, $headers),
+            $validateHost
         );
     }
 

diff --git a/src/ProxyClient/Varnish.php b/src/ProxyClient/Varnish.php
@@ -87,7 +87,7 @@ public function ban(array $headers)
             $headers
         );
 
-        $this->queueRequest(self::HTTP_METHOD_BAN, '/', $headers);
+        $this->queueRequest(self::HTTP_METHOD_BAN, '/', $headers, false);
 
         return $this;
     }

diff --git a/tests/Unit/ProxyClient/HttpDispatcherTest.php b/tests/Unit/ProxyClient/HttpDispatcherTest.php
@@ -157,6 +157,18 @@ public function testMissingHostExceptionIsThrown()
         $httpDispatcher->invalidate($request);
     }
 
+    public function testBanWithoutBaseUri()
+    {
+        $httpDispatcher = new HttpDispatcher(
+            ['127.0.0.1:123'],
+            '',
+            $this->httpClient
+        );
+
+        $request = $this->messageFactory->createRequest('BAN', '/', ['X-Url' => '/foo/.*']);
+        $httpDispatcher->invalidate($request, false);
+    }
+
     public function testSetBasePathWithHost()
     {
         $httpDispatcher = new HttpDispatcher(

diff --git a/tests/Unit/ProxyClient/SymfonyTest.php b/tests/Unit/ProxyClient/SymfonyTest.php
@@ -42,7 +42,7 @@ function (RequestInterface $request) {
 
                     return true;
                 }
-            )
+            ), true
         );
 
         $symfony->purge('/url', ['X-Foo' => 'bar']);
@@ -62,7 +62,8 @@ function (RequestInterface $request) {
 
                     return true;
                 }
-            )
+            ),
+            true
         );
 
         $symfony->refresh('/fresh');

diff --git a/tests/Unit/ProxyClient/VarnishTest.php b/tests/Unit/ProxyClient/VarnishTest.php
@@ -52,7 +52,7 @@ function (RequestInterface $request) {
 
                     return true;
                 }
-            )
+            ), false
         );
 
         $varnish->ban([
@@ -74,7 +74,7 @@ function (RequestInterface $request) {
 
                     return true;
                 }
-            )
+            ), false
         );
         $hosts = ['fos.lo', 'fos2.lo'];
         $varnish->banPath('/articles/.*', 'text/html', $hosts);
@@ -113,7 +113,7 @@ function (RequestInterface $request) {
 
                     return true;
                 }
-            )
+            ), false
         );
 
         $varnish->invalidateTags(['mytag', 'othertag']);
@@ -134,7 +134,7 @@ function (RequestInterface $request) {
 
                     return true;
                 }
-            )
+            ), false
         );
 
         $varnish->invalidateTags(['post-1', 'post,type-3']);
@@ -162,7 +162,7 @@ function (RequestInterface $request) {
 
                     return true;
                 }
-            )
+            ), true
         );
 
         $varnish->purge('/url', ['X-Foo' => 'bar']);
@@ -180,7 +180,7 @@ function (RequestInterface $request) {
 
                     return true;
                 }
-            )
+            ), true
         );
 
         $varnish->refresh('/fresh');