Merge branch 'ogizanagi-stop_swallow_exceptions' into 1.0

Author: dunglas

Controller/ExceptionController.php

@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * This file is part of the DunglasApiBundle package.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Dunglas\ApiBundle\Controller;
+
+use Dunglas\ApiBundle\Exception\DeserializationException;
+use Dunglas\ApiBundle\JsonLd\Response;
+use Symfony\Component\Debug\Exception\FlattenException;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Log\DebugLoggerInterface;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+/**
+ * Render a normalized exception for a given {@see \Symfony\Component\Debug\Exception\FlattenException}.
+ *
+ * @author Baptiste Meyer <[email protected]>
+ */
+class ExceptionController
+{
+    /**
+     * @var NormalizerInterface
+     */
+    private $normalizer;
+
+    /**
+     * @param NormalizerInterface $normalizer
+     */
+    public function __construct(NormalizerInterface $normalizer)
+    {
+        $this->normalizer = $normalizer;
+    }
+
+    /**
+     * Converts a {@see \Symfony\Component\Debug\Exception\FlattenException}
+     * to a {@see \Dunglas\ApiBundle\JsonLd\Response}.
+     *
+     * @param Request                   $request
+     * @param FlattenException          $exception
+     * @param DebugLoggerInterface|null $logger
+     *
+     * @return Response
+     */
+    public function showAction(Request $request, FlattenException $exception, DebugLoggerInterface $logger = null)
+    {
+        if (
+            DeserializationException::class === $exception->getClass() ||
+            is_subclass_of($exception->getClass(), DeserializationException::class)
+        ) {
+            $exception->setStatusCode(Response::HTTP_BAD_REQUEST);
+        }
+
+        return new Response(
+            $this->normalizer->normalize($exception, 'hydra-error'),
+            $exception->getStatusCode(),
+            $exception->getHeaders()
+        );
+    }
+}

Hydra/EventListener/RequestExceptionListener.php

@@ -11,60 +11,27 @@
 
 namespace Dunglas\ApiBundle\Hydra\EventListener;
 
-use Dunglas\ApiBundle\Exception\DeserializationException;
-use Dunglas\ApiBundle\JsonLd\Response;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
-use Symfony\Component\HttpKernel\Exception\HttpException;
-use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+use Symfony\Component\HttpKernel\EventListener\ExceptionListener;
 
 /**
  * Handle requests errors.
  *
  * @author Samuel ROZE <[email protected]>
  * @author Kévin Dunglas <[email protected]>
  */
-class RequestExceptionListener
+class RequestExceptionListener extends ExceptionListener
 {
-    /**
-     * @var NormalizerInterface
-     */
-    private $normalizer;
-
-    public function __construct(NormalizerInterface $normalizer)
-    {
-        $this->normalizer = $normalizer;
-    }
-
     /**
      * @param GetResponseForExceptionEvent $event
      */
     public function onKernelException(GetResponseForExceptionEvent $event)
     {
-        if (!$event->isMasterRequest()) {
+        // Normalize exceptions with hydra errors only for resources
+        if (!$event->getRequest()->attributes->has('_resource')) {
             return;
         }
 
-        $request = $event->getRequest();
-        $exception = $event->getException();
-
-        if ($exception instanceof HttpException) {
-            $status = $exception->getStatusCode();
-            $headers = $exception->getHeaders();
-        } elseif ($exception instanceof DeserializationException) {
-            $status = Response::HTTP_BAD_REQUEST;
-            $headers = [];
-        } else {
-            $status = Response::HTTP_INTERNAL_SERVER_ERROR;
-            $headers = [];
-        }
-
-        // Normalize exceptions with hydra errors only for resources
-        if ($request->attributes->has('_resource')) {
-            $event->setResponse(new Response(
-                $this->normalizer->normalize($exception, 'hydra-error'),
-                $status,
-                $headers
-            ));
-        }
+        parent::onKernelException($event);
     }
 }

Hydra/Serializer/ErrorNormalizer.php

@@ -11,11 +11,13 @@
 
 namespace Dunglas\ApiBundle\Hydra\Serializer;
 
+use Symfony\Component\Debug\Exception\FlattenException;
 use Symfony\Component\Routing\RouterInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
 /**
- * Converts {@see \Exception} to a Hydra error representation.
+ * Converts {@see \Exception} or {@see \Symfony\Component\Debug\Exception\FlattenException}
+ * to a Hydra error representation.
  *
  * @author Kévin Dunglas <[email protected]>
  * @author Samuel ROZE <[email protected]>
@@ -46,7 +48,7 @@ public function __construct(RouterInterface $router, $debug)
      */
     public function normalize($object, $format = null, array $context = array())
     {
-        if ($object instanceof \Exception) {
+        if ($object instanceof \Exception || $object instanceof FlattenException) {
             $message = $object->getMessage();
 
             if ($this->debug) {
@@ -73,6 +75,6 @@ public function normalize($object, $format = null, array $context = array())
      */
     public function supportsNormalization($data, $format = null)
     {
-        return 'hydra-error' === $format && $data instanceof \Exception;
+        return 'hydra-error' === $format && ($data instanceof \Exception || $data instanceof FlattenException);
     }
 }

Resources/config/hydra.xml

@@ -14,6 +14,12 @@
             <argument>%api.description%</argument>
         </service>
 
+        <!-- Controllers -->
+
+        <service id="api.hydra.controller.exception" class="Dunglas\ApiBundle\Controller\ExceptionController">
+            <argument type="service" id="api.hydra.normalizer.error" />
+        </service>
+
         <!-- Event listeners -->
 
         <service id="api.hydra.listener.link_header_response" class="Dunglas\ApiBundle\Hydra\EventListener\LinkHeaderResponseListener">
@@ -23,9 +29,11 @@
         </service>
 
         <service id="api.hydra.listener.request_exception" class="Dunglas\ApiBundle\Hydra\EventListener\RequestExceptionListener">
-            <argument type="service" id="api.hydra.normalizer.error" />
+            <argument type="string">api.hydra.controller.exception:showAction</argument>
+            <argument type="service" id="logger" on-invalid="null" />
 
-            <tag name="kernel.event_listener" event="kernel.exception" method="onKernelException" />
+            <tag name="kernel.event_listener" event="kernel.exception" method="onKernelException" priority="-96" />
+            <tag name="monolog.logger" channel="request" />
         </service>
 
         <!-- Serializer -->

Tests/DependencyInjection/DunglasApiExtensionTest.php

@@ -174,6 +174,7 @@ private function getContainerBuilderProphecy($withDoctrine = true)
         $containerBuilderProphecy->setDefinition('api.json_ld.normalizer.datetime', $definitionArgument)->shouldBeCalled();
         $containerBuilderProphecy->setDefinition('api.json_ld.encoder', $definitionArgument)->shouldBeCalled();
         $containerBuilderProphecy->setDefinition('api.hydra.documentation_builder', $definitionArgument)->shouldBeCalled();
+        $containerBuilderProphecy->setDefinition('api.hydra.controller.exception', $definitionArgument)->shouldBeCalled();
         $containerBuilderProphecy->setDefinition('api.hydra.listener.link_header_response', $definitionArgument)->shouldBeCalled();
         $containerBuilderProphecy->setDefinition('api.hydra.listener.request_exception', $definitionArgument)->shouldBeCalled();
         $containerBuilderProphecy->setDefinition('api.hydra.normalizer.collection', $definitionArgument)->shouldBeCalled();