Merge pull request #38 from ddeboer/console-terminate

Flush cache manager at command termination (fix #32)

Author: ddeboer

EventListener/InvalidationListener.php

@@ -6,6 +6,8 @@
 use FOS\HttpCacheBundle\Configuration\InvalidatePath;
 use FOS\HttpCacheBundle\Configuration\InvalidateRoute;
 use FOS\HttpCacheBundle\Invalidator\InvalidatorCollection;
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\Console\Event\ConsoleEvent;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\ExpressionLanguage\SyntaxError;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
@@ -124,12 +126,37 @@ public function onKernelTerminate(PostResponseEvent $event)
         return $this->cacheManager->flush();
     }
 
+    /**
+     * Flush cache manager when kernel exception occurs
+     */
+    public function onKernelException()
+    {
+        $this->cacheManager->flush();
+    }
+
+    /**
+     * Flush cache manager when console terminates or errors
+     */
+    public function onConsoleTerminate(ConsoleEvent $event)
+    {
+        $num = $this->cacheManager->flush();
+
+        if ($num > 0 && $event->getInput()->getOption('verbose')) {
+            $event->getOutput()->writeln(sprintf('Sent %d invalidation requests', $num));
+        }
+    }
+
     /**
      * {@inheritdoc}
      */
     public static function getSubscribedEvents()
     {
-        return array(KernelEvents::TERMINATE => 'onKernelTerminate');
+        return array(
+            KernelEvents::TERMINATE  => 'onKernelTerminate',
+            KernelEvents::EXCEPTION  => 'onKernelException',
+            ConsoleEvents::TERMINATE => 'onConsoleTerminate',
+            ConsoleEvents::EXCEPTION => 'onConsoleTerminate'
+        );
     }
 
     /**

Resources/doc/cache-manager.md

@@ -130,20 +130,12 @@ Flushing
 --------
 
 Internally, the invalidation requests are queued and only sent out to your HTTP
-proxy when the manager is flushed. During HTTP requests, the manager is flushed
-automatically. If you want to invalidate objects outside request context, for
-instance from the command-line, you need to flush the cache manager manually
-(until https://github.com/ddeboer/FOSHttpCacheBundle/issues/32 is done):
+proxy when the manager is flushed. The manager is flushed automatically at the
+right moment:
 
-```php
-$cacheManager
-    ->invalidateRoute(...)
-    ->invalidatePath(...)
-    ->flush();
-```
-
-The performance impact of sending invalidation requests is kept to a minimum by:
+* when handling a HTTP request, after the response has been sent to the client
+  (Symfony’s [kernel.terminate event](http://symfony.com/doc/current/components/http_kernel/introduction.html#the-kernel-terminate-event))
+* when running a console command, after the command has finished (Symfony’s
+  [console.terminate event](http://symfony.com/doc/current/components/console/events.html#the-consoleevents-terminate-event)).
 
-* flushing the cache manager only after the response by your controller has been sent to the client’s browser
-(during Symfony’s [kernel.terminate event](http://symfony.com/doc/current/components/http_kernel/introduction.html#the-kernel-terminate-event)).
-* sending all invalidation requests in parallel.
+You can also [flush the cache manager manually](https://github.com/FriendsOfSymfony/FOSHttpCache/blob/master/doc/cache-invalidator.md#flushing).

Tests/EventListener/InvalidationListenerTest.php

@@ -2,25 +2,17 @@
 
 namespace FOS\HttpCacheBundle\Tests\EventListener;
 
-use Doctrine\Common\Annotations\AnnotationReader;
-use FOS\HttpCache\Invalidation\Method\BanInterface;
-use FOS\HttpCache\Invalidation\Method\PurgeInterface;
-use FOS\HttpCacheBundle\Configuration\Invalidate;
 use FOS\HttpCacheBundle\Configuration\InvalidatePath;
 use FOS\HttpCacheBundle\Configuration\InvalidateRoute;
 use FOS\HttpCacheBundle\EventListener\InvalidationListener;
 use FOS\HttpCacheBundle\Invalidator\Invalidator;
 use FOS\HttpCacheBundle\Invalidator\InvalidatorCollection;
-use FOS\HttpCacheBundle\Tests\EventListener\Fixture\FooControllerTagAtMethod;
-use Sensio\Bundle\FrameworkExtraBundle\EventListener\ControllerListener;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
 use Symfony\Component\HttpKernel\Event\PostResponseEvent;
-use \Mockery;
-use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
+use \Mockery;
 
 class InvalidationListenerTest extends \PHPUnit_Framework_TestCase
 {
@@ -133,6 +125,17 @@ public function testInvalidateRoute()
         $this->getListener()->onKernelTerminate($event);
     }
 
+    public function testOnConsoleTerminate()
+    {
+        $this->cacheManager->shouldReceive('flush')->once()->andReturn(2);
+
+        $event = \Mockery::mock('\Symfony\Component\Console\Event\ConsoleEvent');
+        $event->shouldReceive('getInput->getOption')->with('verbose')->andReturn(true);
+        $event->shouldReceive('getOutput->writeln')->with('Sent 2 invalidation requests')->once();
+
+        $this->getListener()->onConsoleTerminate($event);
+    }
+
     protected function getEvent(Request $request, Response $response = null)
     {
         return new PostResponseEvent(

composer.json

@@ -31,6 +31,7 @@
         "mockery/mockery": "0.8.*",
         "monolog/monolog": "*",
         "sensio/framework-extra-bundle": "~2.3",
+        "symfony/console": "~2.3",
         "symfony/security": "~2.3",
         "symfony/expression-language": "~2.4"
     },