Cache-Control Feature

* Added ability to set Cache-Control headers
* Moved cache-control header settings into controller
* Removed extraneous "use" statement
* Updated test to pass empty array for cacheConfig

Author: Craig Menning

Controller/Controller.php

@@ -36,6 +36,11 @@ class Controller
      */
     protected $exposedRoutesExtractor;
 
+    /**
+     * @var array
+     */
+    protected $cacheControl;
+
     /**
      * @var boolean
      */
@@ -46,12 +51,14 @@ class Controller
      *
      * @param mixed                           $serializer             Any object with a serialize($data, $format) method
      * @param ExposedRoutesExtractorInterface $exposedRoutesExtractor The extractor service.
+     * @param array                           $cacheControl
      * @param boolean                         $debug
      */
-    public function __construct($serializer, ExposedRoutesExtractorInterface $exposedRoutesExtractor, $debug = false)
+    public function __construct($serializer, ExposedRoutesExtractorInterface $exposedRoutesExtractor, array $cacheControl = array(), $debug = false)
     {
         $this->serializer = $serializer;
         $this->exposedRoutesExtractor = $exposedRoutesExtractor;
+        $this->cacheControl = $cacheControl;
         $this->debug = $debug;
     }
 
@@ -96,6 +103,40 @@ public function indexAction(Request $request, $_format)
             $content = $callback.'('.$content.');';
         }
 
-        return new Response($content, 200, array('Content-Type' => $request->getMimeType($_format)));
+        $response = new Response($content, 200, array('Content-Type' => $request->getMimeType($_format)));
+
+        return $this->setCacheHeaders($response);
+    }
+
+    /**
+     * @param Response $response
+     *
+     * @return Response
+     */
+    protected function setCacheHeaders(Response $response)
+    {
+        if (empty($this->cacheControl['enabled'])) {
+            return $response;
+        }
+
+        $this->cacheControl['public'] ? $response->setPublic() : $response->setPrivate();
+
+        if (is_integer($this->cacheControl['maxage'])) {
+            $response->setMaxAge($this->cacheControl['maxage']);
+        }
+
+        if (is_integer($this->cacheControl['smaxage'])) {
+            $response->setSharedMaxAge($this->cacheControl['smaxage']);
+        }
+
+        if ($this->cacheControl['expires'] !== null) {
+            $response->setExpires(new \DateTime($this->cacheControl['expires']));
+        }
+
+        if (!empty($this->cacheControl['vary'])) {
+            $response->setVary($this->cacheControl['vary']);
+        }
+
+        return $response;
     }
 }

DependencyInjection/Configuration.php

@@ -41,6 +41,21 @@ public function getConfigTreeBuilder()
                     ->prototype('scalar')->end()
                 ->end()
                 ->scalarNode('request_context_base_url')->defaultNull()->end()
+                ->arrayNode('cache_control')
+                    ->children()
+                        ->booleanNode('public')->defaultFalse()->end()
+                        ->scalarNode('expires')->defaultNull()->end()
+                        ->scalarNode('maxage')->defaultNull()->end()
+                        ->scalarNode('smaxage')->defaultNull()->end()
+                        ->arrayNode('vary')
+                            ->beforeNormalization()
+                                ->ifTrue(function($v) { return !is_array($v); })
+                                ->then(function($v) { return array($v); })
+                            ->end()
+                            ->prototype('scalar')->end()
+                        ->end()
+                    ->end()
+                ->end()
             ->end();
 
         return $builder;

DependencyInjection/FOSJsRoutingExtension.php

@@ -52,5 +52,12 @@ public function load(array $configs, ContainerBuilder $container)
         if (isset($config['request_context_base_url'])) {
             $container->setParameter('fos_js_routing.request_context_base_url', $config['request_context_base_url']);
         }
+
+        if (isset($config['cache_control'])) {
+            $config['cache_control']['enabled'] = true;
+        } else {
+            $config['cache_control'] = array('enabled' => false);
+        }
+        $container->setParameter('fos_js_routing.cache_control', $config['cache_control']);
     }
 }

Resources/config/controllers.xml

@@ -9,6 +9,7 @@
         <service id="fos_js_routing.controller" class="%fos_js_routing.controller.class%">
             <argument type="service" id="fos_js_routing.serializer" />
             <argument type="service" id="fos_js_routing.extractor" />
+            <argument>%fos_js_routing.cache_control%</argument>
             <argument>%kernel.debug%</argument>
         </service>
     </services>

Resources/config/services.xml

@@ -5,6 +5,7 @@
 
     <parameters>
         <parameter key="fos_js_routing.extractor.class">FOS\JsRoutingBundle\Extractor\ExposedRoutesExtractor</parameter>
+        <parameter key="fos_js_routing.cache_control.class">FOS\JsRoutingBundle\CacheControl\CacheControl</parameter>
     </parameters>
 
     <services>

Resources/doc/README.markdown

@@ -154,6 +154,17 @@ You can prevent to expose a route by configuring it as below:
         options:
             expose: false
 
+You can enable HTTP caching as below:
+
+    # app/config/config.yml
+    fos_js_routing:
+        cache_control:
+            # All are optional, defaults shown
+            public: false   # can be true (public) or false (private)
+            maxage: null    # integer value, e.g. 300
+            smaxage: null   # integer value, e.g. 300
+            expires: null   # anything that can be fed to "new \DateTime($expires)", e.g. "5 minutes"
+            vary: []        # string or array, e.g. "Cookie" or [ Cookie, Accept ]
 
 Commands
 --------

Tests/Controller/ControllerTest.php

@@ -49,7 +49,7 @@ public function testGenerateWithCallback()
 
     public function testIndexActionWithoutRoutes()
     {
-        $controller = new Controller($this->getSerializer(), $this->getExtractor(), sys_get_temp_dir(), array());
+        $controller = new Controller($this->getSerializer(), $this->getExtractor(), array(), sys_get_temp_dir());
         $response   = $controller->indexAction($this->getRequest('/'), 'json');
 
         $this->assertEquals('{"base_url":"","routes":[],"prefix":"","host":"","scheme":""}', $response->getContent());