Use plain IRIs as tags. Allow several Varnish.

Author: dunglas

features/http_cache/tags.feature

@@ -22,7 +22,7 @@ Feature: Cache invalidation trough HTTP Cache tags
   Scenario: Tags must be set for items
     When I send a "GET" request to "/relation_embedders/1"
     Then the response status code should be 200
-    And the header "Cache-Tags" should be equal to "aa9e2bee5be20590f7dcc520ce2dffca,12a0c94f947a680d68bd6f65e025457d,91774d67418192a057e25dae00345572"
+    And the header "Cache-Tags" should be equal to "/relation_embedders/1,/related_dummies/1,/third_levels/1"
 
   Scenario: Create some more resources
     When I add "Content-Type" header equal to "application/ld+json"
@@ -41,7 +41,7 @@ Feature: Cache invalidation trough HTTP Cache tags
   Scenario: Tags must be set for collections
     When I send a "GET" request to "/relation_embedders"
     Then the response status code should be 200
-    And the header "Cache-Tags" should be equal to "aa9e2bee5be20590f7dcc520ce2dffca,12a0c94f947a680d68bd6f65e025457d,91774d67418192a057e25dae00345572,0b51526d04eac211b0d5e93ce6b133e3,e3d156c7d2d2b9d2228071aca2aa71ca,4f4c0d1c39015017ca3e97b15c36fc16,245ca118219102ad043d75121434c707"
+    And the header "Cache-Tags" should be equal to "/relation_embedders/1,/related_dummies/1,/third_levels/1,/relation_embedders/2,/related_dummies/2,/third_levels/2,/relation_embedders"
 
   Scenario: Purge item on update
     When I add "Content-Type" header equal to "application/ld+json"
@@ -53,12 +53,12 @@ Feature: Cache invalidation trough HTTP Cache tags
     """
     Then the response status code should be 200
     And the header "Cache-Tags" should not exist
-    And "/relation_embedders/1,/related_dummies/1,/third_levels/1" IRIs should be purged
+    And "/relation_embedders,/relation_embedders/1,/related_dummies/1,/third_levels/1" IRIs should be purged
 
   @dropSchema
   Scenario: Purge item and the related collection on update
     When I add "Content-Type" header equal to "application/ld+json"
     And I send a "DELETE" request to "/relation_embedders/1"
     Then the response status code should be 204
     And the header "Cache-Tags" should not exist
-    And "/relation_embedders/1,/relation_embedders" IRIs should be purged
+    And "/relation_embedders,/relation_embedders/1" IRIs should be purged

src/Bridge/Doctrine/EventListener/PurgeHttpCacheListener.php

@@ -11,7 +11,9 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\EventListener;
 
+use ApiPlatform\Core\Api\IriConverterInterface;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
+use ApiPlatform\Core\HttpCache\ResourceManagerInterface;
 use Doctrine\ORM\Event\OnFlushEventArgs;
 use Psr\Container\ContainerInterface;
 
@@ -27,7 +29,7 @@ final class PurgeHttpCacheListener
     private $container;
 
     /**
-     * @param ContainerInterface|\Symfony\Component\DependencyInjection\ContainerInterface $container
+     * @param ContainerInterface|\Symfony\Component\DependencyInjection\ContainerInterface $container The container is injected because of a circular reference.
      */
     public function __construct($container)
     {
@@ -38,38 +40,32 @@ public function onFlush(OnFlushEventArgs $eventArgs)
     {
         $iriConverter = $this->container->get('api_platform.iri_converter');
         $resourceManager = $this->container->get('api_platform.http_cache.resource_manager');
-
-        $em = $eventArgs->getEntityManager();
-        $uow = $em->getUnitOfWork();
+        $uow = $eventArgs->getEntityManager()->getUnitOfWork();
 
         foreach ($uow->getScheduledEntityInsertions() as $entity) {
-            if (null !== $resourceClass = $this->getResource($entity)) {
-                $resourceManager->addResource($iriConverter->getIriFromResourceClass($resourceClass));
-            }
+            $this->purge($iriConverter, $resourceManager, $entity, false);
         }
 
         foreach ($uow->getScheduledEntityUpdates() as $entity) {
-            if (null !== $this->getResource($entity)) {
-                $resourceManager->addResource($iriConverter->getIriFromItem($entity));
-            }
+            $this->purge($iriConverter, $resourceManager, $entity, true);
         }
 
         foreach ($uow->getScheduledEntityDeletions() as $entity) {
-            if (null === $resourceClass = $this->getResource($entity)) {
-                continue;
-            }
-
-            $resourceManager->addResource($iriConverter->getIriFromResourceClass($resourceClass));
-            $resourceManager->addResource($iriConverter->getIriFromItem($entity));
+            $this->purge($iriConverter, $resourceManager, $entity, true);
         }
     }
 
-    private function getResource($entity)
+    private function purge(IriConverterInterface $iriConverter, ResourceManagerInterface $resourceManager, $entity, bool $purgeItem)
     {
         try {
-            return $this->container->get('api_platform.resource_class_resolver')->getResourceClass($entity);
+            $resourceClass = $this->container->get('api_platform.resource_class_resolver')->getResourceClass($entity);
         } catch (InvalidArgumentException $e) {
-            // Return null
+            return;
+        }
+
+        $resourceManager->addResource($iriConverter->getIriFromResourceClass($resourceClass));
+        if ($purgeItem) {
+            $resourceManager->addResource($iriConverter->getIriFromItem($entity));
         }
     }
 }

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -16,9 +16,12 @@
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Resource\DirectoryResource;
+use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\DefinitionDecorator;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
@@ -306,15 +309,25 @@ private function registerHttpCache(ContainerBuilder $container, array $config, X
         }
 
         $loader->load('http_cache_tags.xml');
-        if (null === $config['http_cache']['varnish_url']) {
-            $container->removeDefinition('api_platform.http_cache.purger.varnish_client');
-
+        if (!$config['http_cache']['varnish_urls']) {
             return;
         }
 
-        $container->getDefinition('api_platform.http_cache.purger.varnish_client')->addArgument(
-            ['base_uri' => $config['http_cache']['varnish_url']]
-        );
+        $references = [];
+        foreach ($config['http_cache']['varnish_urls'] as $url) {
+            $id = sprintf('api_platform.http_cache.purger.varnish_client.%s', $url);
+            $references[] = new Reference($id);
+
+            if (class_exists(ChildDefinition::class)) {
+                $definition = new ChildDefinition('api_platform.http_cache.purger.varnish_client');
+            } else {
+                $definition = new DefinitionDecorator('api_platform.http_cache.purger.varnish_client');
+            }
+            $definition->addArgument(['base_uri' => $url]);
+            $container->setDefinition($id, $definition);
+        }
+
+        $container->getDefinition('api_platform.http_cache.purger.varnish')->addArgument($references);
         $container->setAlias('api_platform.http_cache.purger', 'api_platform.http_cache.purger.varnish');
     }
 

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -105,7 +105,11 @@ public function getConfigTreeBuilder()
                         ->end()
                         ->booleanNode('public')->defaultNull()->info('To make all responses public by default.')->end()
                         ->booleanNode('enable_tags')->defaultFalse()->info('Add cache tags to the response.')->end()
-                        ->scalarNode('varnish_url')->defaultNull()->info('URL of the Varnish server to purge using cache tags when a resource is updated.')->end()
+                        ->arrayNode('varnish_urls')
+                            ->defaultValue([])
+                            ->prototype('scalar')->end()
+                            ->info('URL of the Varnish server to purge using cache tags when a resource is updated.')
+                        ->end()
                     ->end()
                 ->end()
 

src/Bridge/Symfony/Bundle/Resources/config/http_cache_tags.xml

@@ -6,11 +6,8 @@
 
     <services>
         <service id="api_platform.http_cache.resource_manager" class="ApiPlatform\Core\HttpCache\ResourceManager" public="false" />
-        <service id="api_platform.http_cache.purger.varnish_client" class="GuzzleHttp\Client" public="false" />
-
-        <service id="api_platform.http_cache.purger.varnish" class="ApiPlatform\Core\HttpCache\VarnishPurger" public="false">
-            <argument type="service" id="api_platform.http_cache.purger.varnish_client" />
-        </service>
+        <service id="api_platform.http_cache.purger.varnish_client" class="GuzzleHttp\Client" abstract="true" public="false" />
+        <service id="api_platform.http_cache.purger.varnish" class="ApiPlatform\Core\HttpCache\VarnishPurger" public="false" />
 
         <service id="api_platform.http_cache.listener.response.add_tags" class="ApiPlatform\Core\HttpCache\EventListener\AddTagsListener">
             <argument type="service" id="api_platform.http_cache.resource_manager" />
@@ -23,9 +20,7 @@
         <service id="api_platform.http_cache.listener.response.purge" class="ApiPlatform\Core\HttpCache\EventListener\PurgeListener">
             <argument type="service" id="api_platform.http_cache.resource_manager" />
             <argument type="service" id="api_platform.http_cache.purger" />
-            <argument type="service" id="api_platform.iri_converter" />
 
-            <tag name="kernel.event_listener" event="kernel.view" method="onKernelView" priority="48" />
             <tag name="kernel.event_listener" event="kernel.terminate" method="onKernelTerminate" />
         </service>
     </services>

src/HttpCache/EventListener/AddTagsListener.php

@@ -61,7 +61,7 @@ public function onKernelResponse(FilterResponseEvent $event)
             return;
         }
 
-        $event->getResponse()->headers->set('Cache-Tags', implode(',', array_map('md5', $resources)));
+        $event->getResponse()->headers->set('Cache-Tags', implode(',', $resources));
         $this->resourceManager->clear();
     }
 }

src/HttpCache/EventListener/PurgeListener.php

@@ -11,12 +11,8 @@
 
 namespace ApiPlatform\Core\HttpCache\EventListener;
 
-use ApiPlatform\Core\Api\IriConverterInterface;
 use ApiPlatform\Core\HttpCache\PurgerInterface;
 use ApiPlatform\Core\HttpCache\ResourceManagerInterface;
-use ApiPlatform\Core\Util\RequestAttributesExtractor;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
 use Symfony\Component\HttpKernel\Event\PostResponseEvent;
 
 /**
@@ -28,55 +24,20 @@ final class PurgeListener
 {
     private $resourceManager;
     private $purger;
-    private $iriConverter;
 
-    public function __construct(ResourceManagerInterface $resourceManager, PurgerInterface $purger, IriConverterInterface $iriConverter)
+    public function __construct(ResourceManagerInterface $resourceManager, PurgerInterface $purger)
     {
         $this->resourceManager = $resourceManager;
         $this->purger = $purger;
-        $this->iriConverter = $iriConverter;
     }
 
-    /**
-     * Stores the original IRI of the object to be deleted because it may not be available anymore at purge time (e.g. when using Doctrine).
-     *
-     * @param GetResponseForControllerResultEvent $event
-     */
-    public function onKernelView(GetResponseForControllerResultEvent $event)
+    public function onKernelTerminate()
     {
-        $request = $event->getRequest();
-        if ($request->isMethod('DELETE') && RequestAttributesExtractor::extractAttributes($request)) {
-            $this->resourceManager->addResource($this->iriConverter->getIriFromItem($request->attributes->get('data')));
-        }
-    }
-
-    public function onKernelTerminate(PostResponseEvent $event)
-    {
-        $this->addResources($event->getRequest());
-
         if ($iris = $this->resourceManager->getResources()) {
-            $this->purger->purge($iris);
-            $this->resourceManager->clear();
-        }
-    }
-
-    private function addResources(Request $request)
-    {
-        if (
-            $request->isMethodSafe()
-            || !($attributes = RequestAttributesExtractor::extractAttributes($request))
-            || !$data = $request->attributes->get('data')
-        ) {
-            return;
-        }
-
-        $method = $request->getMethod();
-        if ('POST' === $method || 'DELETE' === $method) {
-            $this->resourceManager->addResource($this->iriConverter->getIriFromResourceClass($attributes['resource_class']));
-
             return;
         }
 
-        $this->resourceManager->addResource($this->iriConverter->getIriFromItem($data));
+        $this->purger->purge($iris);
+        $this->resourceManager->clear();
     }
 }

src/HttpCache/VarnishPurger.php

@@ -15,11 +15,14 @@
 
 final class VarnishPurger implements PurgerInterface
 {
-    private $guzzle;
+    private $clients;
 
-    public function __construct(ClientInterface $guzzle)
+    /**
+     * @param ClientInterface[] $clients
+     */
+    public function __construct(array $clients)
     {
-        $this->guzzle = $guzzle;
+        $this->clients = $clients;
     }
 
     /**
@@ -31,9 +34,13 @@ public function purge(array $iris)
             return;
         }
 
-        $hashes = array_map('md5', $iris);
-        $regex = isset($hashes[1]) ? sprintf('(%s)', implode('|', $hashes)) : $hashes[0];
+        $parts = array_map(function ($iri) {
+            return sprintf('(^|\,)%s($|\,)', preg_quote($iri));
+        }, $iris);
+        $regex = isset($parts[1]) ? sprintf('(%s)', implode(')|(', $parts)) : $parts[0];
 
-        $this->guzzle->sendAsync($this->guzzle->request('BAN', '', ['headers' => ['X-Ban-Regex' => $regex]]));
+        foreach ($this->clients as $client) {
+            $client->sendAsync($client->request('BAN', implode('-', $iris), ['headers' => ['X-Ban-Regex' => $regex]]));
+        }
     }
 }

tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -101,7 +101,7 @@ public function testDefaultConfig()
                 'shared_max_age' => null,
                 'vary' => ['Content-Type'],
                 'public' => null,
-                'varnish_url' => null,
+                'varnish_urls' => [],
             ],
         ], $config);
     }