Merge pull request #940 from FriendsOfSymfony/exception_fallback_format

make it possible to define a separate fallback format for exceptions

Author: lsmith77

Controller/ExceptionController.php

@@ -211,7 +211,7 @@ protected function getStatusCode($exception)
     protected function getFormat(Request $request, $format)
     {
         try {
-            $formatNegotiator = $this->container->get('fos_rest.format_negotiator');
+            $formatNegotiator = $this->container->get('fos_rest.exception_format_negotiator');
             $format = $formatNegotiator->getBestFormat($request) ?: $format;
             $request->attributes->set('_format', $format);
         } catch (StopFormatListenerException $e) {

DependencyInjection/Compiler/FormatListenerRulesPass.php

@@ -39,6 +39,7 @@ public function process(ContainerBuilder $container)
                 'path' => "^/$path/",
                 'priorities' => array('html', 'json'),
                 'fallback_format' => 'html',
+                'exception_fallback_format' => 'html',
                 'prefer_extension' => true,
             );
 
@@ -65,8 +66,14 @@ protected function addRule(array $rule, ContainerBuilder $container)
             $rule['prefer_extension'] = '2.0';
         }
 
+        $exceptionFallbackFormat = $rule['exception_fallback_format'];
+        unset($rule['exception_fallback_format']);
         $container->getDefinition('fos_rest.format_negotiator')
             ->addMethodCall('add', array($matcher, $rule));
+
+        $rule['fallback_format'] = $exceptionFallbackFormat;
+        $container->getDefinition('fos_rest.exception_format_negotiator')
+            ->addMethodCall('add', array($matcher, $rule));
     }
 
     protected function createRequestMatcher(ContainerBuilder $container, $path = null, $host = null, $methods = null)

DependencyInjection/Configuration.php

@@ -212,6 +212,7 @@ private function addFormatListenerSection(ArrayNodeDefinition $rootNode)
                                     ->booleanNode('stop')->defaultFalse()->end()
                                     ->booleanNode('prefer_extension')->defaultTrue()->end()
                                     ->scalarNode('fallback_format')->defaultValue('html')->end()
+                                    ->scalarNode('exception_fallback_format')->defaultNull()->end()
                                     ->arrayNode('priorities')
                                         ->beforeNormalization()->ifString()->then(function ($v) { return preg_split('/\s*,\s*/', $v); })->end()
                                         ->prototype('scalar')->end()

DependencyInjection/FOSRestExtension.php

@@ -163,6 +163,12 @@ public function load(array $configs, ContainerBuilder $container)
         if (!empty($config['format_listener']['rules'])) {
             $loader->load('format_listener.xml');
 
+            foreach ($config['format_listener']['rules'] as $key => $rule) {
+                if (!isset($rule['exception_fallback_format'])) {
+                    $config['format_listener']['rules'][$key]['exception_fallback_format'] = $rule['fallback_format'];
+                }
+            }
+
             $container->setParameter(
                 $this->getAlias().'.format_listener.rules',
                 $config['format_listener']['rules']

Resources/config/util.xml

@@ -13,6 +13,7 @@
 
     <services>
         <service id="fos_rest.format_negotiator" class="%fos_rest.format_negotiator.class%" />
+        <service id="fos_rest.exception_format_negotiator" class="%fos_rest.format_negotiator.class%" />
         <service id="fos_rest.inflector.doctrine" class="%fos_rest.inflector.class%" />
         <service id="fos_rest.request_matcher" class="%fos_rest.request_matcher.class%" public="false" />
         <service id="fos_rest.violation_formatter" class="%fos_rest.violation_formatter.class%" />

Resources/doc/3-listener-support.rst

@@ -396,6 +396,9 @@ Setting ``priorities`` to a non empty array enables Accept header negotiations.
                 - { path: '^/image', priorities: ['jpeg', 'gif'], fallback_format: false, prefer_extension: true }
                 # setting fallback_format to null means that in case of a priority mismatch the next rule will be considered
                 - { path: '^/admin', methods: [ 'GET', 'POST'], priorities: [ 'xml', 'html'], fallback_format: ~, prefer_extension: false }
+                # setting fallback_format to null, while setting exception_fallback_format to xml, will mean that in case of an exception, xml will be used
+                - { path: '^/api', priorities: [ 'xml', 'json'], fallback_format: ~, exception_fallback_format: xml, prefer_extension: false }
+                # setting a priority to */* basically means any format will be matched
                 - { path: '^/', priorities: [ 'text/html', '*/*'], fallback_format: html, prefer_extension: true }
 
 For example using the above configuration and the following Accept header:

Resources/doc/configuration-reference.rst

@@ -90,6 +90,7 @@ Full default configuration
                     methods:              null
                     prefer_extension:     true
                     fallback_format:      html
+                    exception_fallback_format: ~
                     priorities:           []
             media_type:
                 version_regex:        '/(v|version)=(?P<version>[0-9\.]+)/'

Tests/DependencyInjection/Compiler/FormatListenerRulesPassTest.php

@@ -46,14 +46,18 @@ public function testRulesAreAddedWhenFormatListenerAndProfilerToolbarAreEnabled(
                         'path' => '^/',
                         'priorities' => array('html', 'json'),
                         'fallback_format' => 'html',
+                        'exception_fallback_format' => 'html',
                         'prefer_extension' => true,
                 ),
             ) )
         );
 
-        $container->expects($this->exactly(2))
+        $container->expects($this->exactly(4))
             ->method('getDefinition')
-            ->with('fos_rest.format_negotiator')
+            ->with($this->logicalOr(
+                $this->equalTo('fos_rest.format_negotiator'),
+                $this->equalTo('fos_rest.exception_format_negotiator')
+            ))
             ->will($this->returnValue($definition));
 
         $compiler = new FormatListenerRulesPass();
@@ -88,14 +92,18 @@ public function testNoRulesAreAddedWhenProfilerToolbarAreDisabled()
                         'path' => '^/',
                         'priorities' => array('html', 'json'),
                         'fallback_format' => 'html',
+                        'exception_fallback_format' => 'html',
                         'prefer_extension' => true,
                     ),
                 ) )
             );
 
-        $container->expects($this->exactly(1))
+        $container->expects($this->exactly(2))
             ->method('getDefinition')
-            ->with('fos_rest.format_negotiator')
+            ->with($this->logicalOr(
+                $this->equalTo('fos_rest.format_negotiator'),
+                $this->equalTo('fos_rest.exception_format_negotiator')
+            ))
             ->will($this->returnValue($definition));
 
         $compiler = new FormatListenerRulesPass();