bug #2096 Fix compatibility with symfony 3.4 and \Error (GuigZ-)

This PR was merged into the 2.7 branch.

Discussion
----------

Fix compatibility with symfony 3.4 and \Error

Commits
-------

62a422d fix(throwable): fix template data with symfony 3.4

Author: xabbuh

Controller/ExceptionController.php

@@ -11,12 +11,12 @@
 
 namespace FOS\RestBundle\Controller;
 
+use FOS\RestBundle\Exception\FlattenException as FosFlattenException;
 use FOS\RestBundle\Util\ExceptionValueMap;
 use FOS\RestBundle\View\View;
 use FOS\RestBundle\View\ViewHandlerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Debug\Exception\FlattenException as LegacyFlattenException;
 use Symfony\Component\ErrorHandler\Exception\FlattenException;
 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
 use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
@@ -73,7 +73,12 @@ public function showAction(Request $request, $exception, DebugLoggerInterface $l
         }
         $templateData = $this->getTemplateData($currentContent, $code, $exception, $logger);
 
-        $view = $this->createView($exception, $code, $templateData, $request, $this->showException);
+        if ($exception instanceof \Exception) {
+            $view = $this->createView($exception, $code, $templateData, $request, $this->showException);
+        } else {
+            $view = $this->createViewFromThrowable($exception, $code, $templateData, $request, $this->showException);
+        }
+
         $response = $this->viewHandler->handle($view);
 
         return $response;
@@ -90,11 +95,7 @@ public function showAction(Request $request, $exception, DebugLoggerInterface $l
      */
     protected function createView(\Exception $exception, $code, array $templateData, Request $request, $showException)
     {
-        $view = new View($exception, $code, $exception instanceof HttpExceptionInterface ? $exception->getHeaders() : []);
-        $view->setTemplateVar('raw_exception');
-        $view->setTemplateData($templateData);
-
-        return $view;
+        return $this->createViewFromThrowable($exception, $code, $templateData);
     }
 
     /**
@@ -109,22 +110,31 @@ protected function getStatusCode(\Exception $exception)
         return $this->getStatusCodeFromThrowable($exception);
     }
 
+    private function createViewFromThrowable(\Throwable $exception, $code, array $templateData): View
+    {
+        $view = new View($exception, $code, $exception instanceof HttpExceptionInterface ? $exception->getHeaders() : []);
+        $view->setTemplateVar('raw_exception');
+        $view->setTemplateData($templateData);
+
+        return $view;
+    }
+
     /**
      * Determines the template parameters to pass to the view layer.
      *
      * @param string               $currentContent
      * @param int                  $code
-     * @param \Exception           $exception
+     * @param \Throwable           $throwable
      * @param DebugLoggerInterface $logger
      *
      * @return array
      */
-    private function getTemplateData($currentContent, $code, \Exception $exception, DebugLoggerInterface $logger = null)
+    private function getTemplateData($currentContent, $code, \Throwable $throwable, DebugLoggerInterface $logger = null)
     {
         if (class_exists(FlattenException::class)) {
-            $exception = FlattenException::createFromThrowable($exception);
+            $exception = FlattenException::createFromThrowable($throwable);
         } else {
-            $exception = LegacyFlattenException::create($exception);
+            $exception = FosFlattenException::createFromThrowable($throwable);
         }
 
         return [

Exception/FlattenException.php

@@ -0,0 +1,76 @@
+<?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\Exception;
+
+use Symfony\Component\Debug\Exception\FlattenException as LegacyFlattenException;
+use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
+use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
+
+if (method_exists(LegacyFlattenException::class, 'createFromThrowable')) {
+    /**
+     * @internal
+     */
+    class FlattenException extends LegacyFlattenException
+    {
+    }
+} else {
+    /**
+     * @internal
+     */
+    class FlattenException extends LegacyFlattenException
+    {
+        private $traceAsString;
+
+        /**
+         * @return static
+         */
+        public static function createFromThrowable(\Throwable $exception, int $statusCode = null, array $headers = [])
+        {
+            $e = new static();
+            $e->setMessage($exception->getMessage());
+            $e->setCode($exception->getCode());
+
+            if ($exception instanceof HttpExceptionInterface) {
+                $statusCode = $exception->getStatusCode();
+                $headers = array_merge($headers, $exception->getHeaders());
+            } elseif ($exception instanceof RequestExceptionInterface) {
+                $statusCode = 400;
+            }
+
+            if (null === $statusCode) {
+                $statusCode = 500;
+            }
+
+            $e->setStatusCode($statusCode);
+            $e->setHeaders($headers);
+            $e->setTraceFromThrowable($exception);
+            $e->setClass($exception instanceof FatalThrowableError ? $exception->getOriginalClassName() : \get_class($exception));
+            $e->setFile($exception->getFile());
+            $e->setLine($exception->getLine());
+
+            $previous = $exception->getPrevious();
+
+            if ($previous instanceof \Throwable) {
+                $e->setPrevious(static::createFromThrowable($previous));
+            }
+
+            return $e;
+        }
+
+        public function setTraceFromThrowable(\Throwable $throwable)
+        {
+            $this->traceAsString = $throwable->getTraceAsString();
+
+            return $this->setTrace($throwable->getTrace(), $throwable->getFile(), $throwable->getLine());
+        }
+    }
+}

Tests/Controller/ExceptionControllerTest.php

@@ -0,0 +1,52 @@
+<?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\Tests\Controller;
+
+use FOS\RestBundle\Controller\ExceptionController;
+use FOS\RestBundle\Util\ExceptionValueMap;
+use FOS\RestBundle\View\View;
+use FOS\RestBundle\View\ViewHandlerInterface;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class ExceptionControllerTest extends TestCase
+{
+    /**
+     * @dataProvider provideThrowables
+     */
+    public function testShowActionWithError(\Throwable $throwable): void
+    {
+        $request = Request::create('/');
+        $request->headers->set('X-Php-Ob-Level', '2');
+
+        $response = new Response();
+
+        $viewHandler = $this->createMock(ViewHandlerInterface::class);
+        $viewHandler->expects($this->once())
+            ->method('handle')
+            ->with($this->isInstanceOf(View::class))
+            ->willReturn($response);
+
+        $controller = new ExceptionController($viewHandler, new ExceptionValueMap([]), true);
+
+        $this->assertSame($response, $controller->showAction($request, $throwable));
+    }
+
+    public function provideThrowables(): array
+    {
+        return [
+            [new \Error()],
+            [new \Exception()],
+        ];
+    }
+}