Merge pull request #908 from FriendsOfSymfony/exception_controller

Exception controller

Author: lsmith77

Controller/ExceptionController.php

@@ -11,6 +11,7 @@
 
 namespace FOS\RestBundle\Controller;
 
+use FOS\RestBundle\Util\StopFormatListenerException;
 use FOS\RestBundle\View\ExceptionWrapperHandlerInterface;
 use Symfony\Bundle\FrameworkBundle\Templating\TemplateReference;
 use Symfony\Component\HttpKernel\Exception\FlattenException as HttpFlattenException;
@@ -209,9 +210,13 @@ protected function getStatusCode($exception)
      */
     protected function getFormat(Request $request, $format)
     {
-        $formatNegotiator = $this->container->get('fos_rest.format_negotiator');
-        $format = $formatNegotiator->getBestFormat($request) ?: $format;
-        $request->attributes->set('_format', $format);
+        try {
+            $formatNegotiator = $this->container->get('fos_rest.format_negotiator');
+            $format = $formatNegotiator->getBestFormat($request) ?: $format;
+            $request->attributes->set('_format', $format);
+        } catch (StopFormatListenerException $e) {
+            $format = $request->getRequestFormat();
+        }
 
         return $format;
     }

DependencyInjection/Compiler/TwigExceptionPass.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+
+/**
+ * Remove the 'twig.exception_listener' service if 'fos_rest.exception_listener' is activated
+ */
+class TwigExceptionPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->has('fos_rest.exception_listener') && $container->has('twig.exception_listener')) {
+            $container->removeDefinition('twig.exception_listener');
+        }
+    }
+}

DependencyInjection/Configuration.php

@@ -229,7 +229,9 @@ private function addExceptionSection(ArrayNodeDefinition $rootNode)
                     ->fixXmlConfig('code', 'codes')
                     ->fixXmlConfig('message', 'messages')
                     ->addDefaultsIfNotSet()
+                    ->canBeEnabled()
                     ->children()
+                        ->scalarNode('exception_controller')->defaultNull()->end()
                         ->arrayNode('codes')
                             ->useAttributeAsKey('name')
                             ->prototype('scalar')->end()

DependencyInjection/FOSRestExtension.php

@@ -132,6 +132,13 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter($this->getAlias().'.routing.loader.default_format', $config['routing_loader']['default_format']);
         $container->setParameter($this->getAlias().'.routing.loader.include_format', $config['routing_loader']['include_format']);
 
+        if ($config['exception']['enabled']) {
+            $loader->load('exception_listener.xml');
+            if ($config['exception']['exception_controller']) {
+                $container->setParameter('fos_rest.exception_listener.controller', $config['exception']['exception_controller']);
+            }
+        }
+
         foreach ($config['exception']['codes'] as $exception => $code) {
             if (!is_numeric($code)) {
                 $config['exception']['codes'][$exception] = constant("\FOS\RestBundle\Util\Codes::$code");

FOSRestBundle.php

@@ -15,6 +15,7 @@
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use FOS\RestBundle\DependencyInjection\Compiler\ConfigurationCheckPass;
 use FOS\RestBundle\DependencyInjection\Compiler\FormatListenerRulesPass;
+use FOS\RestBundle\DependencyInjection\Compiler\TwigExceptionPass;
 
 /**
  * @author Lukas Kahwe Smith <[email protected]>
@@ -29,5 +30,6 @@ public function build(ContainerBuilder $container)
     {
         $container->addCompilerPass(new ConfigurationCheckPass());
         $container->addCompilerPass(new FormatListenerRulesPass());
+        $container->addCompilerPass(new TwigExceptionPass());
     }
 }

Resources/config/exception_listener.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="fos_rest.exception_listener.class">Symfony\Component\HttpKernel\EventListener\ExceptionListener</parameter>
+        <parameter key="fos_rest.controller.exception.class">FOS\RestBundle\Controller\ExceptionController</parameter>
+        <parameter key="fos_rest.exception_listener.controller">fos_rest.controller.exception:showAction</parameter>
+
+    </parameters>
+
+    <services>
+        <service id="fos_rest.exception_listener" class="%fos_rest.exception_listener.class%">
+            <tag name="kernel.event_subscriber" />
+            <tag name="monolog.logger" channel="request" />
+            <argument>%fos_rest.exception_listener.controller%</argument>
+            <argument type="service" id="logger" on-invalid="null" />
+        </service>
+
+        <service id="fos_rest.controller.exception" class="%fos_rest.controller.exception.class%">
+            <call method="setContainer">
+                <argument type="service" id="service_container" />
+            </call>
+        </service>
+    </services>
+</container>

Resources/doc/4-exception-controller-support.md

@@ -7,15 +7,28 @@ provides an extra controller for that job. Using this custom ExceptionController
 it is possible to leverage the View layer when building responses for uncaught
 Exceptions.
 
-To enable the RestBundle view-layer-aware ExceptionController update the twig
-section of your config as follows:
+The ExceptionController can be enabled either via the FOSRestBundle configuration
+and optionally an explicit controller action can be configured as well:
+
+```yaml
+# app/config/config.yml
+fos_rest:
+    exception:
+        enabled: true
+        exception_controller: 'Acme\DemoBundle\Controller\ExceptionController::showAction'
+```
+
+Alternatively the TwigBundle configuration can be used to enable the ExceptionController:
 
 ```yaml
 # app/config/config.yml
 twig:
     exception_controller: 'FOS\RestBundle\Controller\ExceptionController::showAction'
 ```
 
+When enabling the RestBundle view-layer-aware ExceptionController it automatically
+disables the TwigBundle exception listener and subsequent configuration.
+
 To map Exception classes to HTTP response status codes an “exception map” may
 be configured, where the keys match a fully qualified class name and the values
 are either an integer HTTP response status code or a string matching a class

Tests/FOSRestBundleTest.php

@@ -23,7 +23,7 @@ class FOSRestBundleTest extends \PHPUnit_Framework_TestCase
     public function testBuild()
     {
         $container = $this->getMock('\Symfony\Component\DependencyInjection\ContainerBuilder');
-        $container->expects($this->exactly(2))
+        $container->expects($this->exactly(3))
             ->method('addCompilerPass')
             ->with($this->isInstanceOf('\Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface'));