Replace getting route collection with route generation

The Symfony Router's getRouteCollection is not cached, so calling it causes the routes to be loaded. The UrlGenerator is cached, but it means we have to manually strip the query string that Symfony fills with parameters missing from the invalidated route.

Author: ddeboer

EventListener/InvalidationListener.php

@@ -58,10 +58,14 @@ public function __construct(
      * Apply invalidators and flush cache manager
      *
      * On kernel.terminate:
-     * - see if any invalidators apply to the current request and, if so, add their routes to the cache manager
-     * - flush the cache manager in order to send invalidation requests to the HTTP cache.
+     * - see if any invalidators apply to the current request and, if so, add
+     *   their routes to the cache manager
+     * - flush the cache manager in order to send invalidation requests to the
+     *   HTTP cache.
      *
      * @param PostResponseEvent $event
+     *
+     * @return array Paths that were flushed from the invalidation queue
      */
     public function onKernelTerminate(PostResponseEvent $event)
     {
@@ -78,34 +82,26 @@ public function onKernelTerminate(PostResponseEvent $event)
             return $this->cacheManager->flush();
         }
 
-        $invalidateRoutes = $this->invalidators->getInvalidatedRoutes($requestRoute);
-        foreach ($invalidateRoutes as $route => $config) {
-            $params = $this->getInvalidateRouteParameters($route, $request->attributes->get('_route_params'));
-            $this->cacheManager->invalidateRoute($route, $params);
-        }
+        $requestParams = $request->attributes->get('_route_params');
+        $invalidators = $this->invalidators->getInvalidators($requestRoute);
+        foreach ($invalidators as $invalidator) {
+            foreach ($invalidator->getInvalidatedRoutes() as $route => $config) {
+                $path = $this->router->generate($route, $requestParams);
 
-        $this->cacheManager->flush();
-    }
-
-    /**
-     * Get route parameters for the route to invalidated based on current request parameters
-     *
-     * @param string $route      Route name
-     * @param array  $parameters Request parameters
-     *
-     * @return array Parameters in the invalidate route that match current request parameters
-     */
-    protected function getInvalidateRouteParameters($route, array $parameters)
-    {
-        // Which of the request parameters are also supported by the URL to be
-        // generated?
-        $invalidateRoute = $this->router->getRouteCollection()
-            ->get($route)
-            ->compile();
+                // If extra route parameters should be ignored, strip the query
+                // string generated by the Symfony router from the path
+                if (isset($config['ignore_extra_params'])
+                    && $config['ignore_extra_params']
+                    && $pos = strpos($path, '?')
+                ) {
+                    $path = substr($path, 0, $pos);
+                }
 
-        $supportedParams = \array_flip($invalidateRoute->getVariables());
+                $this->cacheManager->invalidatePath($path);
+            }
+        }
 
-        return \array_intersect_key($parameters, $supportedParams);
+        return $this->cacheManager->flush();
     }
 
     /**

Invalidator/Invalidator.php

@@ -50,8 +50,12 @@ public function getInvalidatedRoutes()
     /**
      * {@inheritdoc}
      */
-    public function addInvalidatedRoute($route, $config = null)
+    public function addInvalidatedRoute($route, array $config = array())
     {
+        $defaultConfig = array(
+            'ignore_extra_params' => true
+        );
+        $config = \array_merge($defaultConfig, $config);
         $this->invalidatedRoutes[$route] = $config;
 
         return $this;

Invalidator/InvalidatorInterface.php

@@ -37,7 +37,7 @@ public function getInvalidatorRoutes();
      *
      * @return InvalidatorInterface
      */
-    public function addInvalidatedRoute($route, $config);
+    public function addInvalidatedRoute($route, array $config);
 
     /**
      * Get routes that will be invalidated

Tests/EventListener/InvalidationListenerTest.php

@@ -5,18 +5,16 @@
 use Driebit\HttpCacheBundle\EventListener\InvalidationListener;
 use Driebit\HttpCacheBundle\Invalidator\Invalidator;
 use Driebit\HttpCacheBundle\Invalidator\InvalidatorCollection;
-use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\PostResponseEvent;
 use \Mockery;
-use Driebit\HttpCacheBundle\HttpCache\Varnish;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
 
 class InvalidationListenerTest extends \PHPUnit_Framework_TestCase
 {
-    public function testNoRoutesInvalidedWhenResponseIsUnsuccessful()
+    public function testNoRoutesInvalidatedWhenResponseIsUnsuccessful()
     {
         $cacheManager = \Mockery::mock('\Driebit\HttpCacheBundle\CacheManager')
             ->shouldDeferMissing()
@@ -46,25 +44,27 @@ public function testNoRoutesInvalidedWhenResponseIsUnsuccessful()
 
     public function testOnKernelTerminate()
     {
-        $cacheManager = \Mockery::mock('\Driebit\HttpCacheBundle\CacheManager')
-            ->shouldReceive('invalidateRoute')
-            ->with('route_invalidated', array('id' => '123'))
-            ->shouldReceive('invalidateRoute')->with('route_invalidated_special', array('id' => '123', 'special' => 'bla'))
+        $cacheManager = \Mockery::mock('\Driebit\HttpCacheBundle\CacheManager');
+        $cacheManager->shouldReceive('invalidatePath')->with('/retrieve/something/123')
+            ->shouldReceive('invalidatePath')->with('/retrieve/something/123/bla')
             ->shouldReceive('flush')->once()
             ->getMock();
 
         $routes = new RouteCollection();
-        $route = new Route('/edit/something/{id}/{special}');
-        $route2 = new Route('/retrieve/something/{id}');
-        $route3 = new Route('/retrieve/something/{id}/{special}');
-        $routes->add('route_invalidator', $route);
-        $routes->add('route_invalidated', $route2);
-        $routes->add('route_invalidated_special', $route3);
+        $routes->add('route_invalidator', new Route('/edit/something/{id}/{special}'));
+        $routes->add('route_invalidated', new Route('/retrieve/something/{id}'));
+        $routes->add('route_invalidated_special', new Route('/retrieve/something/{id}/{special}'));
 
+        $requestParams = array('id' => 123, 'special' => 'bla');
         $router = \Mockery::mock('\Symfony\Component\Routing\Router')
             ->shouldDeferMissing()
-            ->shouldReceive('getRouteCollection')
-            ->andReturn($routes)
+            ->shouldReceive('generate')
+            ->with('route_invalidated', $requestParams)
+            ->andReturn('/retrieve/something/123?special=bla')
+
+            ->shouldReceive('generate')
+            ->with('route_invalidated_special', $requestParams)
+            ->andReturn('/retrieve/something/123/bla')
             ->getMock();
 
         $invalidator = new Invalidator();
@@ -79,7 +79,7 @@ public function testOnKernelTerminate()
 
         $request = new Request();
         $request->attributes->set('_route', 'route_invalidator');
-        $request->attributes->set('_route_params', array('id' => '123', 'special' => 'bla'));
+        $request->attributes->set('_route_params', $requestParams);
 
         $event = $this->getEvent($request);
         $listener->onKernelTerminate($event);