Added native ErrorRenderer as fallback system and deprecating templates

yceruto · yceruto · commit dafcc2123405 · 2019-05-07T08:35:03.000-04:00
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/JsonLoginTest.php b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/JsonLoginTest.php
@@ -70,6 +70,6 @@ public function testDefaultJsonLoginBadRequest()
 
         $this->assertSame(400, $response->getStatusCode());
         $this->assertSame('application/json', $response->headers->get('Content-Type'));
-        $this->assertArraySubset(['error' => ['code' => 400, 'message' => 'Bad Request']], json_decode($response->getContent(), true));
+        $this->assertArraySubset(['title' => 'Bad Request', 'status' => 400, 'detail' => 'Invalid JSON.'], json_decode($response->getContent(), true));
     }
 }
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLogin/bundles.php b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLogin/bundles.php
@@ -12,6 +12,5 @@
 return [
     new Symfony\Bundle\SecurityBundle\SecurityBundle(),
     new Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
-    new Symfony\Bundle\TwigBundle\TwigBundle(),
     new Symfony\Bundle\SecurityBundle\Tests\Functional\Bundle\JsonLoginBundle\JsonLoginBundle(),
 ];
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLogin/config.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLogin/config.yml
@@ -1,5 +1,5 @@
 imports:
-    - { resource: ./../config/default.yml }
+    - { resource: ./../config/framework.yml }
 
 security:
     encoders:
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLogin/custom_handlers.yml b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLogin/custom_handlers.yml
@@ -1,5 +1,5 @@
 imports:
-    - { resource: ./../config/default.yml }
+    - { resource: ./../config/framework.yml }
 
 security:
     encoders:
diff --git a/src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php b/src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php
@@ -11,10 +11,15 @@
 
 namespace Symfony\Bundle\TwigBundle\Controller;
 
+use Symfony\Component\ErrorHandler\ErrorRenderer\ErrorRenderer;
+use Symfony\Component\ErrorHandler\ErrorRenderer\HtmlErrorRenderer;
+use Symfony\Component\ErrorHandler\ErrorRenderer\JsonErrorRenderer;
+use Symfony\Component\ErrorHandler\ErrorRenderer\TxtErrorRenderer;
+use Symfony\Component\ErrorHandler\ErrorRenderer\XmlErrorRenderer;
+use Symfony\Component\ErrorHandler\Exception\ErrorRendererNotFoundException;
 use Symfony\Component\ErrorHandler\Exception\FlattenException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
 use Twig\Environment;
 use Twig\Error\LoaderError;
 use Twig\Loader\ExistsLoaderInterface;
@@ -30,15 +35,22 @@ class ExceptionController
 {
     protected $twig;
     protected $debug;
+    private $errorRenderer;
 
     /**
      * @param Environment $twig
      * @param bool        $debug Show error (false) or exception (true) pages by default
      */
-    public function __construct(Environment $twig, bool $debug)
+    public function __construct(Environment $twig, bool $debug, ErrorRenderer $errorRenderer = null)
     {
         $this->twig = $twig;
         $this->debug = $debug;
+        $this->errorRenderer = $errorRenderer ?? new ErrorRenderer([
+            new HtmlErrorRenderer($debug),
+            new JsonErrorRenderer($debug),
+            new XmlErrorRenderer($debug),
+            new TxtErrorRenderer($debug),
+        ]);
     }
 
     /**
@@ -49,26 +61,12 @@ public function __construct(Environment $twig, bool $debug)
      * be used.
      *
      * @return Response
-     *
-     * @throws \InvalidArgumentException When the exception template does not exist
      */
-    public function showAction(Request $request, FlattenException $exception, DebugLoggerInterface $logger = null)
+    public function showAction(Request $request, FlattenException $exception)
     {
-        $currentContent = $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1));
-        $showException = $request->attributes->get('showException', $this->debug); // As opposed to an additional parameter, this maintains BC
-
-        $code = $exception->getStatusCode();
-
-        return new Response($this->twig->render(
-            (string) $this->findTemplate($request, $request->getRequestFormat(), $code, $showException),
-            [
-                'status_code' => $code,
-                'status_text' => isset(Response::$statusTexts[$code]) ? Response::$statusTexts[$code] : '',
-                'exception' => $exception,
-                'logger' => $logger,
-                'currentContent' => $currentContent,
-            ]
-        ), 200, ['Content-Type' => $request->getMimeType($request->getRequestFormat()) ?: 'text/html']);
+        return new Response($this->render($exception, $request), 200, [
+            'Content-Type' => $request->getMimeType($request->getRequestFormat())
+        ]);
     }
 
     /**
@@ -94,32 +92,45 @@ protected function getAndCleanOutputBuffering($startObLevel)
      * @param bool    $showException
      *
      * @return string
+     *
+     * @deprecated since Symfony 4.4
      */
     protected function findTemplate(Request $request, $format, $code, $showException)
     {
-        $name = $showException ? 'exception' : 'error';
-        if ($showException && 'html' == $format) {
-            $name = 'exception_full';
+        @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.4, use "findTwigTemplate()" method instead.', __METHOD__), E_USER_DEPRECATED);
+
+        if ($template = $this->findTwigTemplate($code, $format, $showException)) {
+            return $template;
         }
 
+        // default to a generic HTML exception
+        $request->setRequestFormat('html');
+
+        return sprintf('@Twig/Exception/%s.html.twig', $showException ? 'exception_full' : 'error');
+    }
+
+    protected function findTwigTemplate(int $statusCode, string $format, bool $showException): ?string
+    {
         // For error pages, try to find a template for the specific HTTP status code and format
         if (!$showException) {
-            $template = sprintf('@Twig/Exception/%s%s.%s.twig', $name, $code, $format);
+            $template = sprintf('@Twig/Exception/error%s.%s.twig', $statusCode, $format);
             if ($this->templateExists($template)) {
                 return $template;
             }
         }
 
+        $name = 'error';
+        if ($showException) {
+            $name = 'html' === $format ? 'exception_full' : 'exception';
+        }
+
         // try to find a template for the given format
         $template = sprintf('@Twig/Exception/%s.%s.twig', $name, $format);
         if ($this->templateExists($template)) {
             return $template;
         }
 
-        // default to a generic HTML exception
-        $request->setRequestFormat('html');
-
-        return sprintf('@Twig/Exception/%s.html.twig', $showException ? 'exception_full' : $name);
+        return null;
     }
 
     // to be removed when the minimum required version of Twig is >= 3.0
@@ -141,4 +152,32 @@ protected function templateExists($template)
 
         return false;
     }
+
+    private function render(FlattenException $exception, Request $request): string
+    {
+        $statusCode = $exception->getStatusCode();
+        $logger = $request->attributes->get('logger');
+        $showException = $request->attributes->get('showException', $this->debug);
+        $currentContent = $this->getAndCleanOutputBuffering($request->headers->get('X-Php-Ob-Level', -1));
+
+        $template = $this->findTwigTemplate($statusCode, $request->getRequestFormat(), $showException);
+
+        if (null === $template) {
+            try {
+                // fallback to the native renderer system
+                return $this->errorRenderer->render($exception, $request->getRequestFormat());
+            } catch (ErrorRendererNotFoundException $e) {
+                $request->setRequestFormat('html');
+                $template = sprintf('@Twig/Exception/%s.html.twig', $showException ? 'exception_full' : 'error');
+            }
+        }
+
+        return $this->twig->render($template, [
+            'status_code' => $statusCode,
+            'status_text' => Response::$statusTexts[$statusCode] ?? '',
+            'exception' => $exception,
+            'logger' => $logger,
+            'currentContent' => $currentContent,
+        ]);
+    }
 }
diff --git a/src/Symfony/Bundle/TwigBundle/Controller/PreviewErrorController.php b/src/Symfony/Bundle/TwigBundle/Controller/PreviewErrorController.php
@@ -47,7 +47,6 @@ public function previewErrorPageAction(Request $request, $code)
             '_controller' => $this->controller,
             'exception' => $exception,
             'logger' => null,
-            'format' => $request->getRequestFormat(),
             'showException' => false,
         ]);
 
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml b/src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml
@@ -140,6 +140,7 @@
         <service id="twig.controller.exception" class="Symfony\Bundle\TwigBundle\Controller\ExceptionController" public="true">
             <argument type="service" id="twig" />
             <argument>%kernel.debug%</argument>
+            <argument type="service" id="error_handler.error_renderer" on-invalid="null" />
         </service>
 
         <service id="twig.controller.preview_error" class="Symfony\Bundle\TwigBundle\Controller\PreviewErrorController" public="true">
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.atom.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.atom.twig
@@ -1 +1,2 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 {{ include('@Twig/Exception/error.xml.twig') }}
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.js.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.js.twig
@@ -1,3 +1,4 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 /*
 {{ status_code }} {{ status_text }}
 
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.json.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.json.twig
@@ -1 +1,2 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 {{ { 'error': { 'code': status_code, 'message': status_text } }|json_encode|raw }}
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.rdf.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.rdf.twig
@@ -1 +1,2 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 {{ include('@Twig/Exception/error.xml.twig') }}
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.txt.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.txt.twig
@@ -1,3 +1,4 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 Oops! An Error Occurred
 =======================
 
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.xml.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/error.xml.twig
@@ -1,3 +1,4 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 <?xml version="1.0" encoding="{{ _charset }}" ?>
 
 <error code="{{ status_code }}" message="{{ status_text }}" />
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.js.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.js.twig
@@ -1,3 +1,4 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 /*
 {{ include('@Twig/Exception/exception.txt.twig', { exception: exception }) }}
 */
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.json.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.json.twig
@@ -1 +1,2 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 {{ { 'error': { 'code': status_code, 'message': status_text, 'exception': exception.toarray } }|json_encode|raw }}
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.rdf.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.rdf.twig
@@ -1 +1,2 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 {{ include('@Twig/Exception/exception.xml.twig', { exception: exception }) }}
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.txt.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.txt.twig
@@ -1,3 +1,4 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 [exception] {{ status_code ~ ' | ' ~ status_text ~ ' | ' ~ exception.class }}
 [message] {{ exception.message }}
 {% for i, e in exception.toarray %}
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.xml.twig b/src/Symfony/Bundle/TwigBundle/Resources/views/Exception/exception.xml.twig
@@ -1,3 +1,4 @@
+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}
 <?xml version="1.0" encoding="{{ _charset }}" ?>
 
 <error code="{{ status_code }}" message="{{ status_text }}">
diff --git a/src/Symfony/Bundle/TwigBundle/Tests/Controller/ExceptionControllerTest.php b/src/Symfony/Bundle/TwigBundle/Tests/Controller/ExceptionControllerTest.php
@@ -13,6 +13,8 @@
 
 use Symfony\Bundle\TwigBundle\Controller\ExceptionController;
 use Symfony\Bundle\TwigBundle\Tests\TestCase;
+use Symfony\Component\ErrorHandler\ErrorRenderer\ErrorRenderer;
+use Symfony\Component\ErrorHandler\ErrorRenderer\ErrorRendererInterface;
 use Symfony\Component\ErrorHandler\Exception\FlattenException;
 use Symfony\Component\HttpFoundation\Request;
 use Twig\Environment;
@@ -35,11 +37,27 @@ public function testShowActionCanBeForcedToShowErrorPage()
         $this->assertEquals('<html>not found</html>', $response->getContent());
     }
 
+    public function testFallbackToErrorRendererIfNoTemplateForRequestedFormat()
+    {
+        $twig = $this->createTwigEnv(['@Twig/Exception/error.html.twig' => '<html></html>']);
+
+        $request = $this->createRequest('foo');
+        $exception = FlattenException::create(new \Exception('bar'));
+        $errorRenderer = new ErrorRenderer([
+            new FooErrorRenderer(),
+        ]);
+        $controller = new ExceptionController($twig, false, $errorRenderer);
+        $response = $controller->showAction($request, $exception);
+
+        $this->assertSame('foo', $request->getRequestFormat());
+        $this->assertSame('bar', $response->getContent());
+    }
+
     public function testFallbackToHtmlIfNoTemplateForRequestedFormat()
     {
         $twig = $this->createTwigEnv(['@Twig/Exception/error.html.twig' => '<html></html>']);
 
-        $request = $this->createRequest('txt');
+        $request = $this->createRequest('foo');
         $exception = FlattenException::create(new \Exception());
         $controller = new ExceptionController($twig, false);
 
@@ -52,7 +70,7 @@ public function testFallbackToHtmlWithFullExceptionIfNoTemplateForRequestedForma
     {
         $twig = $this->createTwigEnv(['@Twig/Exception/exception_full.html.twig' => '<html></html>']);
 
-        $request = $this->createRequest('txt');
+        $request = $this->createRequest('foo');
         $request->attributes->set('showException', true);
         $exception = FlattenException::create(new \Exception());
         $controller = new ExceptionController($twig, false);
@@ -90,3 +108,17 @@ private function createTwigEnv(array $templates)
         return new Environment(new ArrayLoader($templates));
     }
 }
+
+
+class FooErrorRenderer implements ErrorRendererInterface
+{
+    public static function getFormat(): string
+    {
+        return 'foo';
+    }
+
+    public function render(FlattenException $exception): string
+    {
+        return $exception->getMessage();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,6 @@ public function testDefaultJsonLoginBadRequest()`
`70`	`70`
`71`	`71`	`$this->assertSame(400, $response->getStatusCode());`
`72`	`72`	`$this->assertSame('application/json', $response->headers->get('Content-Type'));`
`73`		`- $this->assertArraySubset(['error' => ['code' => 400, 'message' => 'Bad Request']], json_decode($response->getContent(), true));`
	`73`	`+ $this->assertArraySubset(['title' => 'Bad Request', 'status' => 400, 'detail' => 'Invalid JSON.'], json_decode($response->getContent(), true));`
`74`	`74`	`}`
`75`	`75`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}`
`1`	`2`	`{{ include('@Twig/Exception/error.xml.twig') }}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}`
`1`	`2`	`/*`
`2`	`3`	`{{ status_code }} {{ status_text }}`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+{% deprecated 'The template "' ~ _self ~'" is deprecated since Symfony 4.4, will be removed in 5.0.' %}`
`1`	`2`	`{{ { 'error': { 'code': status_code, 'message': status_text } }\|json_encode\|raw }}`