bug #2105 handle all Throwable instances during serialization (xabbuh)

This PR was merged into the 2.7 branch.

Discussion
----------

handle all Throwable instances during serialization

fixes #2095, replaces #2104

Commits
-------

0e48be8 handle all Throwable instances during serialization

Author: xabbuh

Serializer/Normalizer/AbstractExceptionNormalizer.php

@@ -44,17 +44,17 @@ public function __construct(ExceptionValueMap $messagesMap, $debug)
     /**
      * Extracts the exception message.
      *
-     * @param \Exception $exception
+     * @param \Throwable $throwable
      * @param int|null   $statusCode
      *
      * @return string
      */
-    protected function getExceptionMessage(\Exception $exception, $statusCode = null)
+    protected function getMessageFromThrowable(\Throwable $throwable, $statusCode = null)
     {
-        $showMessage = $this->messagesMap->resolveException($exception);
+        $showMessage = $this->messagesMap->resolveThrowable($throwable);
 
         if ($showMessage || $this->debug) {
-            return $exception->getMessage();
+            return $throwable->getMessage();
         }
 
         return array_key_exists($statusCode, Response::$statusTexts) ? Response::$statusTexts[$statusCode] : 'error';

Serializer/Normalizer/ExceptionHandler.php

@@ -25,12 +25,24 @@ class ExceptionHandler extends AbstractExceptionNormalizer implements Subscribin
     public static function getSubscribingMethods()
     {
         return [
+            [
+                'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
+                'format' => 'json',
+                'type' => \Error::class,
+                'method' => 'serializeErrorToJson',
+            ],
             [
                 'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
                 'format' => 'json',
                 'type' => \Exception::class,
                 'method' => 'serializeToJson',
             ],
+            [
+                'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
+                'format' => 'xml',
+                'type' => \Error::class,
+                'method' => 'serializeErrorToXml',
+            ],
             [
                 'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
                 'format' => 'xml',
@@ -59,6 +71,17 @@ public function serializeToJson(
         return $visitor->visitArray($data, $type, $context);
     }
 
+    public function serializeErrorToJson(
+        JsonSerializationVisitor $visitor,
+        \Throwable $exception,
+        array $type,
+        Context $context
+    ) {
+        $data = $this->convertThrowableToArray($exception, $context);
+
+        return $visitor->visitArray($data, $type, $context);
+    }
+
     /**
      * @param XmlSerializationVisitor $visitor
      * @param \Exception              $exception
@@ -93,24 +116,58 @@ public function serializeToXml(
         }
     }
 
+    public function serializeErrorToXml(
+        XmlSerializationVisitor $visitor,
+        \Throwable $exception,
+        array $type,
+        Context $context
+    ) {
+        $data = $this->convertThrowableToArray($exception, $context);
+
+        $document = $visitor->getDocument(true);
+
+        if (!$visitor->getCurrentNode()) {
+            $visitor->createRoot();
+        }
+
+        foreach ($data as $key => $value) {
+            $entryNode = $document->createElement($key);
+            $visitor->getCurrentNode()->appendChild($entryNode);
+            $visitor->setCurrentNode($entryNode);
+
+            $node = $context->getNavigator()->accept($value, null, $context);
+            if (null !== $node) {
+                $visitor->getCurrentNode()->appendChild($node);
+            }
+
+            $visitor->revertCurrentNode();
+        }
+    }
+
     /**
      * @param \Exception $exception
      * @param Context    $context
      *
      * @return array
      */
     protected function convertToArray(\Exception $exception, Context $context)
+    {
+        return $this->convertThrowableToArray($exception, $context);
+    }
+
+    private function convertThrowableToArray(\Throwable $throwable, Context $context): array
     {
         $data = [];
 
         if ($context->hasAttribute('template_data')) {
             $templateData = $context->getAttribute('template_data');
+
             if (array_key_exists('status_code', $templateData)) {
                 $data['code'] = $statusCode = $templateData['status_code'];
             }
         }
 
-        $data['message'] = $this->getExceptionMessage($exception, isset($statusCode) ? $statusCode : null);
+        $data['message'] = $this->getMessageFromThrowable($throwable, isset($statusCode) ? $statusCode : null);
 
         return $data;
     }

Serializer/Normalizer/ExceptionNormalizer.php

@@ -31,7 +31,7 @@ public function normalize($object, $format = null, array $context = [])
             $data['code'] = $statusCode = $context['template_data']['status_code'];
         }
 
-        $data['message'] = $this->getExceptionMessage($object, isset($statusCode) ? $statusCode : null);
+        $data['message'] = $this->getMessageFromThrowable($object, isset($statusCode) ? $statusCode : null);
 
         return $data;
     }