Merge pull request #1169 from Hikariii/customHandlerExceptions

do not hide Exceptions from custom handlers but correctly handle null
schmittjoh · Mar 14, 2020 · 80c71ca · 80c71ca
2 parents 0e28668 + 61eb3d7
commit 80c71ca
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 3 deletions.
diff --git a/src/GraphNavigator/SerializationGraphNavigator.php b/src/GraphNavigator/SerializationGraphNavigator.php
@@ -195,9 +195,11 @@ public function accept($data, ?array $type = null)
                 if (null !== $handler = $this->handlerRegistry->getHandler(GraphNavigatorInterface::DIRECTION_SERIALIZATION, $type['name'], $this->format)) {
                     try {
                         $rs = \call_user_func($handler, $this->visitor, $data, $type, $this->context);
-                    } finally {
+                    } catch (NotAcceptableException $e) {
                         $this->context->stopVisiting($data);
+                        throw $e;
                     }
+                    $this->context->stopVisiting($data);
 
                     return $rs;
                 }

diff --git a/tests/Serializer/GraphNavigatorTest.php b/tests/Serializer/GraphNavigatorTest.php
@@ -128,17 +128,42 @@ public function testNavigatorChangeTypeOnSerialization()
 
         $navigator = new SerializationGraphNavigator($this->metadataFactory, $this->handlerRegistry, $this->accessor, $this->dispatcher);
         $navigator->initialize($this->serializationVisitor, $this->context);
+        $this->context->initialize(TestSubscribingHandler::FORMAT, $this->serializationVisitor, $navigator, $this->metadataFactory);
+
         $navigator->accept($object, null);
     }
 
+    public function testExposeAcceptHandlerExceptionOnSerialization()
+    {
+        $object = new SerializableClass();
+        $typeName = 'JsonSerializable';
+        $msg = 'Useful serialization error with relevant context information';
+
+        $handler = static function ($visitor, $data, array $type, SerializationContext $context) use ($msg) {
+            $context->startVisiting(new \stdClass());
+            throw new \RuntimeException($msg);
+        };
+        $this->handlerRegistry->registerHandler(GraphNavigatorInterface::DIRECTION_SERIALIZATION, $typeName, TestSubscribingHandler::FORMAT, $handler);
+
+        $this->context->method('getFormat')->willReturn(TestSubscribingHandler::FORMAT);
+
+        $navigator = new SerializationGraphNavigator($this->metadataFactory, $this->handlerRegistry, $this->accessor, $this->dispatcher);
+        $navigator->initialize($this->serializationVisitor, $this->context);
+        $this->context->initialize(TestSubscribingHandler::FORMAT, $this->serializationVisitor, $navigator, $this->metadataFactory);
+
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage($msg);
+        $navigator->accept($object, ['name' => $typeName, 'params' => []]);
+    }
+
     protected function setUp(): void
     {
         $this->deserializationVisitor = $this->getMockBuilder(DeserializationVisitorInterface::class)->getMock();
         $this->serializationVisitor = $this->getMockBuilder(SerializationVisitorInterface::class)->getMock();
 
         $this->context = $this->getMockBuilder(SerializationContext::class)
             ->enableOriginalConstructor()
-            ->setMethodsExcept(['getExclusionStrategy'])
+            ->setMethodsExcept(['getExclusionStrategy', 'initialize', 'startVisiting', 'stopVisiting'])
             ->getMock();
 
         $this->deserializationContext = $this->getMockBuilder(DeserializationContext::class)
@@ -168,11 +193,13 @@ class SerializableClass
 
 class TestSubscribingHandler implements SubscribingHandlerInterface
 {
+    public const FORMAT = 'foo';
+
     public static function getSubscribingMethods()
     {
         return [[
             'type' => 'JsonSerializable',
-            'format' => 'foo',
+            'format' => self::FORMAT,
             'direction' => GraphNavigatorInterface::DIRECTION_SERIALIZATION,
             'method' => 'serialize',
         ],