Added functional tests for tag invalidation with single and multiple headers

Author: Toflar

.travis.yml

@@ -7,7 +7,7 @@ cache:
 env:
   global:
     - VARNISH_VERSION=5.1
-    - DEPENDENCIES="toflar/psr6-symfony-http-cache-store:^1.0"
+    - DEPENDENCIES="toflar/psr6-symfony-http-cache-store:^1.1.2"
 
 matrix:
   fast_finish: true
@@ -30,7 +30,7 @@ matrix:
     - php: 7.2
       env: DEPENDENCIES="symfony/lts:^2"
     - php: 7.2
-      env: DEPENDENCIES="symfony/lts:^3 toflar/psr6-symfony-http-cache-store:^1.0"
+      env: DEPENDENCIES="symfony/lts:^3 toflar/psr6-symfony-http-cache-store:^1.1.2"
 
       # Latest commit to master
     - php: 7.2

src/ProxyClient/Symfony.php

@@ -58,11 +58,13 @@ protected function configureOptions()
             'purge_method' => PurgeListener::DEFAULT_PURGE_METHOD,
             'tags_method' => PurgeTagsListener::DEFAULT_TAGS_METHOD,
             'tags_header' => PurgeTagsListener::DEFAULT_TAGS_HEADER,
+            'tags_path' => '/',
             'header_length' => 7500,
         ]);
         $resolver->setAllowedTypes('purge_method', 'string');
         $resolver->setAllowedTypes('tags_method', 'string');
         $resolver->setAllowedTypes('tags_header', 'string');
+        $resolver->setAllowedTypes('tags_path', 'string');
         $resolver->setAllowedTypes('header_length', 'int');
 
         return $resolver;
@@ -84,7 +86,7 @@ public function invalidateTags(array $tags)
         foreach (array_chunk($escapedTags, $chunkSize) as $tagchunk) {
             $this->queueRequest(
                 $this->options['tags_method'],
-                '/',
+                $this->options['tags_path'],
                 [$this->options['tags_header'] => implode(',', $tagchunk)],
                 false
             );

src/SymfonyCache/PurgeTagsListener.php

@@ -117,7 +117,13 @@ public function handlePurgeTags(CacheEvent $event)
             return;
         }
 
-        $tags = explode(',', $request->headers->get($this->tagsHeader));
+        $tags = [];
+
+        foreach ($request->headers->get($this->tagsHeader, '', false) as $v) {
+            foreach (explode(',', $v) as $tag) {
+                $tags[] = $tag;
+            }
+        }
 
         if ($store->invalidateTags($tags)) {
             $response->setStatusCode(200, 'Purged');

src/Test/SymfonyTest.php

@@ -123,6 +123,8 @@ protected function getProxyClient()
 
             $this->proxyClient = new Symfony($httpDispatcher, [
                     'purge_method' => 'NOTIFY',
+                    'tags_method' => 'UNSUBSCRIBE',
+                    'tags_path' => '/symfony.php/',
                 ]
             );
         }

tests/Functional/Fixtures/Symfony/AppCache.php

@@ -16,6 +16,7 @@
 use FOS\HttpCache\SymfonyCache\DebugListener;
 use FOS\HttpCache\SymfonyCache\EventDispatchingHttpCache;
 use FOS\HttpCache\SymfonyCache\PurgeListener;
+use FOS\HttpCache\SymfonyCache\PurgeTagsListener;
 use FOS\HttpCache\SymfonyCache\RefreshListener;
 use FOS\HttpCache\SymfonyCache\UserContextListener;
 use Symfony\Component\HttpFoundation\Request;
@@ -34,6 +35,7 @@ public function __construct(HttpKernelInterface $kernel, StoreInterface $store,
 
         $this->addSubscriber(new CustomTtlListener());
         $this->addSubscriber(new PurgeListener(['purge_method' => 'NOTIFY']));
+        $this->addSubscriber(new PurgeTagsListener(['tags_method' => 'UNSUBSCRIBE']));
         $this->addSubscriber(new RefreshListener());
         $this->addSubscriber(new UserContextListener());
         if (isset($options['debug']) && $options['debug']) {

tests/Functional/Fixtures/Symfony/AppKernel.php

@@ -32,6 +32,18 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
                 $response = new Response(microtime(true));
                 $response->setCache(['max_age' => 3600, 'public' => true]);
 
+                return $response;
+            case '/tags':
+                $response = new Response(microtime(true));
+                $response->setCache(['max_age' => 3600, 'public' => true]);
+                $response->headers->set('X-Cache-Tags', 'tag1,tag2');
+
+                return $response;
+            case '/tags_multi_header':
+                $response = new Response(microtime(true));
+                $response->setCache(['max_age' => 3600, 'public' => true]);
+                $response->headers->set('X-Cache-Tags', ['tag1', 'tag2']);
+
                 return $response;
             case '/negotiation':
                 $response = new Response(microtime(true));

tests/Functional/Fixtures/web/symfony.php

@@ -14,13 +14,14 @@
 use FOS\HttpCache\Tests\Functional\Fixtures\Symfony\AppKernel;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\HttpCache\Store;
+use Toflar\Psr6HttpCacheStore\Psr6Store;
 
 $loader = require_once __DIR__.'/../../../../vendor/autoload.php';
 
 $symfonyProxy = new SymfonyProxy();
 
 $kernel = new AppKernel();
-$kernel = new AppCache($kernel, new Store($symfonyProxy->getCacheDir()), null, ['debug' => true]);
+$kernel = new AppCache($kernel, new Psr6Store(['cache_directory' => $symfonyProxy->getCacheDir(), 'cache_tags_header' => 'X-Cache-Tags']), null, ['debug' => true]);
 $request = Request::createFromGlobals();
 $response = $kernel->handle($request);
 $response->send();

tests/Functional/Fixtures/web/tags_multi_header.php

@@ -0,0 +1,16 @@
+<?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.
+ */
+
+header('Cache-Control: max-age=3600');
+header('Content-Type: text/html');
+header('X-Cache-Tags: tag1');
+header('X-Cache-Tags: tag2');
+header('X-Cache-Debug: 1');

tests/Functional/ProxyClient/InvalidateTagsAssertions.php

@@ -0,0 +1,37 @@
+<?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\Tests\Functional\ProxyClient;
+
+use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
+use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;
+
+/**
+ * Assertions that do the cache tag invalidation operations.
+ */
+trait InvalidateTagsAssertions
+{
+    /**
+     * Asserting that purging cache tags leads to invalidated content.
+     *
+     * @param PurgeCapable $proxyClient The client to send purge instructions to the cache
+     * @param array $tags The cache tags to invalidate
+     * @param string $path The path to get and purge, defaults to /tags.php
+     */
+    protected function assertInvalidateTags(TagCapable $proxyClient, array $cacheTags, $path = '/tags.php')
+    {
+        $this->assertMiss($this->getResponse($path));
+        $this->assertHit($this->getResponse($path));
+
+        $proxyClient->invalidateTags($cacheTags)->flush();
+        $this->assertMiss($this->getResponse($path));
+    }
+}

tests/Functional/ProxyClient/SymfonyProxyClientTest.php

@@ -21,6 +21,7 @@ class SymfonyProxyClientTest extends SymfonyTestCase
 {
     use RefreshAssertions;
     use PurgeAssertions;
+    use InvalidateTagsAssertions;
 
     public function testPurge()
     {
@@ -46,4 +47,14 @@ public function testRefreshContentType()
     {
         $this->assertRefresh($this->getProxyClient(), '/symfony.php/negotiation');
     }
+
+    public function testInvalidateTags()
+    {
+        $this->assertInvalidateTags($this->getProxyClient(), ['tag1'], '/symfony.php/tags');
+    }
+
+    public function testInvalidateTagsMultiHeader()
+    {
+        $this->assertInvalidateTags($this->getProxyClient(), ['tag2'], '/symfony.php/tags_multi_header');
+    }
 }