Merge branch 'remove-xkey-tag-escaping'

Author: dbu

CHANGELOG.md

@@ -3,6 +3,15 @@ Changelog
 
 See also the [GitHub releases page](https://github.com/FriendsOfSymfony/FOSHttpCache/releases).
 
+2.3.1
+-----
+
+### Varnish
+
+* Fixed: Do not `preg_quote` tags when using xkey. Quoting is only used for BAN
+  requests that expect a regular expression. This bug only affected you if you
+  use xkey *and* used characters in your tags that are changed by `preg_quote`.
+
 2.3.0
 -----
 

src/ProxyClient/Varnish.php

@@ -73,11 +73,15 @@ class Varnish extends HttpProxyClient implements BanCapable, PurgeCapable, Refre
     public function invalidateTags(array $tags)
     {
         $banMode = self::TAG_BAN === $this->options['tag_mode'];
-        $escapedTags = array_map('preg_quote', $this->escapeTags($tags));
 
-        $chunkSize = $this->determineTagsPerHeader($escapedTags, $banMode ? '|' : ' ');
+        // If using BAN's, escape each tag
+        if ($banMode) {
+            $tags = array_map('preg_quote', $this->escapeTags($tags));
+        }
+
+        $chunkSize = $this->determineTagsPerHeader($tags, $banMode ? '|' : ' ');
 
-        foreach (array_chunk($escapedTags, $chunkSize) as $tagchunk) {
+        foreach (array_chunk($tags, $chunkSize) as $tagchunk) {
             if ($banMode) {
                 $this->invalidateByBan($tagchunk);
             } else {

tests/Unit/ProxyClient/VarnishTest.php

@@ -84,6 +84,49 @@ function (RequestInterface $request) {
         $varnish->banPath('/articles/.*', 'text/html', $hosts);
     }
 
+    public function testPurgekeys()
+    {
+        $options = [
+            'tag_mode' => 'purgekeys',
+        ];
+
+        $varnish = new Varnish($this->httpDispatcher, $options);
+        $this->httpDispatcher->shouldReceive('invalidate')->once()->with(
+            \Mockery::on(
+                function (RequestInterface $request) {
+                    $this->assertEquals('PURGEKEYS', $request->getMethod());
+                    $this->assertEquals('post-1 post,type-3', $request->getHeaderLine('xkey-softpurge'));
+
+                    return true;
+                }
+            ), false
+        );
+
+        $varnish->invalidateTags(['post-1', 'post,type-3']);
+    }
+
+    public function testHardPurgekeys()
+    {
+        $options = [
+            'tag_mode' => 'purgekeys',
+            'tags_header' => 'xkey-purge',
+        ];
+
+        $varnish = new Varnish($this->httpDispatcher, $options);
+        $this->httpDispatcher->shouldReceive('invalidate')->once()->with(
+            \Mockery::on(
+                function (RequestInterface $request) {
+                    $this->assertEquals('PURGEKEYS', $request->getMethod());
+                    $this->assertEquals('post-1 post,type-3', $request->getHeaderLine('xkey-purge'));
+
+                    return true;
+                }
+            ), false
+        );
+
+        $varnish->invalidateTags(['post-1', 'post,type-3']);
+    }
+
     /**
      * @expectedException \FOS\HttpCache\Exception\InvalidArgumentException
      */