Fix Host header for proxy client requests

When using `ban` requests with Varnish proxy client, requests are queued
and sent with `flush()`. Queued requests are registered without host,
making Guzzle create an empty `Host` header.

When flushing, Guzzle request is re-created starting
with the original one (so without host), with all registered headers.
The problem is that the empty `Host` header is also copied, and thus not
re-created by Guzzle with the server URL. In the backend, cURL sees it
and takes it into account, overriding passed URL silently.

This causes requests with empty host being fired by Guzzle, which is
kind of annoying 😃.

Author: lolautruche

src/ProxyClient/AbstractProxyClient.php

@@ -161,11 +161,16 @@ private function sendRequests(array $requests)
         $allRequests = array();
 
         foreach ($requests as $request) {
+            $headers = $request->getHeaders()->toArray();
+            // Force to re-create Host header if empty.
+            if (empty($headers['Host'])) {
+                unset( $headers['Host'] );
+            }
             foreach ($this->servers as $server) {
                 $proxyRequest = $this->client->createRequest(
                     $request->getMethod(),
                     $server . $request->getResource(),
-                    $request->getHeaders()
+                    $headers
                 );
                 $allRequests[] = $proxyRequest;
             }

src/Test/VarnishTestCase.php

@@ -148,15 +148,24 @@ protected function getVarnishVersion()
      *
      * @return Varnish
      */
-    protected function getProxyClient()
+    protected function getProxyClient($baseUrl = null)
     {
         if (null === $this->proxyClient) {
             $this->proxyClient = new Varnish(
                 array('http://127.0.0.1:' . $this->getProxy()->getPort()),
-                $this->getHostName() . ':' . $this->getProxy()->getPort()
+                $baseUrl
             );
         }
 
         return $this->proxyClient;
     }
+
+    /**
+     * @return string
+     * @throws \Exception
+     */
+    protected function getBaseUrl()
+    {
+        return $this->getHostName() . ':' . $this->getProxy()->getPort();
+    }
 }

tests/Functional/Varnish/VarnishProxyClientTest.php

@@ -77,7 +77,7 @@ public function testPurge()
         $this->assertMiss($this->getResponse('/cache.php'));
         $this->assertHit($this->getResponse('/cache.php'));
 
-        $this->getProxyClient()->purge('/cache.php')->flush();
+        $this->getProxyClient($this->getBaseUrl())->purge('/cache.php')->flush();
         $this->assertMiss($this->getResponse('/cache.php'));
     }
 
@@ -97,7 +97,7 @@ public function testPurgeContentType()
         $this->assertHit($this->getResponse('/negotation.php', $html));
 
         $this->getResponse('/negotation.php');
-        $this->getProxyClient()->purge('/negotation.php')->flush();
+        $this->getProxyClient($this->getBaseUrl())->purge('/negotation.php')->flush();
         $this->assertMiss($this->getResponse('/negotation.php', $json));
         $this->assertMiss($this->getResponse('/negotation.php', $html));
     }
@@ -118,7 +118,7 @@ public function testRefresh()
         $response = $this->getResponse('/cache.php');
         $this->assertHit($response);
 
-        $this->getProxyClient()->refresh('/cache.php')->flush();
+        $this->getProxyClient($this->getBaseUrl())->refresh('/cache.php')->flush();
         usleep(1000);
         $refreshed = $this->getResponse('/cache.php');
         $this->assertGreaterThan((float) $response->getBody(true), (float) $refreshed->getBody(true));
@@ -129,7 +129,7 @@ public function testRefreshContentType()
         $json = array('Accept' => 'application/json');
         $html = array('Accept' => 'text/html');
 
-        $this->getProxyClient()->refresh('/negotation.php', $json)->flush();
+        $this->getProxyClient($this->getBaseUrl())->refresh('/negotation.php', $json)->flush();
 
         $this->assertHit($this->getResponse('/negotation.php', $json));
         $this->assertMiss($this->getResponse('/negotation.php', $html));

tests/Unit/ProxyClient/VarnishTest.php

@@ -47,6 +47,23 @@ public function testBanEverything()
         $this->assertEquals('fos.lo', $headers->get('Host'));
     }
 
+    public function testBanEverythingNoBaseUrl()
+    {
+        $varnish = new Varnish(array('http://127.0.0.1:123'), null, $this->client);
+        $varnish->ban(array())->flush();
+
+        $requests = $this->getRequests();
+        $this->assertCount(1, $requests);
+        $this->assertEquals('BAN', $requests[0]->getMethod());
+
+        $headers = $requests[0]->getHeaders();
+        $this->assertEquals('.*', $headers->get('X-Host'));
+        $this->assertEquals('.*', $headers->get('X-Url'));
+        $this->assertEquals('.*', $headers->get('X-Content-Type'));
+        // Ensure host header doesn't exist, as we don't have a base URL.
+        $this->assertNull($headers->get('Host'));
+    }
+
     public function testBanHeaders()
     {
         $varnish = new Varnish(array('http://127.0.0.1:123'), 'fos.lo', $this->client);