Merge pull request #523 from fieg/serializer-max-depth

Added support for JMSSerializer MaxDepth exclusion strategy

Author: lsmith77

Controller/Annotations/View.php

@@ -40,6 +40,11 @@ class View extends Template
      */
     protected $populateDefaultVars = true;
 
+    /**
+     * @var bool
+     */
+    protected $serializerEnableMaxDepthChecks;
+
     /**
      * Returns the annotation alias name.
      *
@@ -118,4 +123,20 @@ public function isPopulateDefaultVars()
     {
         return $this->populateDefaultVars;
     }
+
+    /**
+     * @param bool $serializerEnableMaxDepthChecks
+     */
+    public function setSerializerEnableMaxDepthChecks($serializerEnableMaxDepthChecks)
+    {
+        $this->serializerEnableMaxDepthChecks = $serializerEnableMaxDepthChecks;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getSerializerEnableMaxDepthChecks()
+    {
+        return $this->serializerEnableMaxDepthChecks;
+    }
 }

EventListener/ViewResponseListener.php

@@ -96,6 +96,11 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
                 $context->setGroups($configuration->getSerializerGroups());
                 $view->setSerializationContext($context);
             }
+            if ($configuration->getSerializerEnableMaxDepthChecks()) {
+                $context = $view->getSerializationContext() ?: new SerializationContext();
+                $context->enableMaxDepthChecks();
+                $view->setSerializationContext($context);
+            }
             $populateDefaultVars = $configuration->isPopulateDefaultVars();
         } else {
             $populateDefaultVars = true;

Resources/doc/3-listener-support.md

@@ -141,6 +141,20 @@ public function getUsersAction()
 }
 ```
 
+Enabling the MaxDepth exclusion strategy support for the serializer can be configured as follows:
+
+```php
+<?php
+
+/**
+ * @View(serializerEnableMaxDepthChecks=true)
+ */
+public function getUsersAction()
+{
+    //...
+}
+```
+
 See the following example code for more details:
 https://github.com/liip/LiipHelloBundle/blob/master/Controller/ExtraController.php
 

Tests/EventListener/ViewResponseListenerTest.php

@@ -265,6 +265,56 @@ public function testStatusCode($annotationCode, $viewCode, $expectedCode)
         $this->assertSame($expectedCode, $response->getStatusCode());
     }
 
+    public static function  serializerEnableMaxDepthChecksProvider()
+    {
+        return array(
+            array(false, get_class(null)),
+            array(true, 'JMS\Serializer\Exclusion\DepthExclusionStrategy'),
+        );
+    }
+
+    /**
+     * @dataProvider serializerEnableMaxDepthChecksProvider
+     */
+    public function testSerializerEnableMaxDepthChecks($enableMaxDepthChecks, $expectedClass)
+    {
+        $viewAnnotation = new ViewAnnotation(array());
+        $viewAnnotation->setSerializerEnableMaxDepthChecks($enableMaxDepthChecks);
+
+        $request = new Request();
+        $request->setRequestFormat('json');
+        $request->attributes->set('_view', $viewAnnotation);
+
+        $this->viewHandler = new ViewHandler(array('json' => true));
+        $this->viewHandler->setContainer($this->container);
+
+        // This is why we avoid container dependencies!
+        $that = $this;
+        $this->container->expects($this->exactly(2))
+            ->method('get')
+            ->with($this->logicalOr('fos_rest.view_handler', 'fos_rest.templating'))
+            ->will($this->returnCallback(function ($service) use ($that) {
+                        return $service === 'fos_rest.view_handler' ?
+                            $that->viewHandler :
+                            $that->templating;
+                    }));
+
+        $this->templating->expects($this->any())
+            ->method('render')
+            ->will($this->returnValue('foo'));
+
+        $view = new View();
+
+        $event = $this->getResponseEvent($request, $view);
+
+        $this->listener->onKernelView($event);
+
+        $context = $view->getSerializationContext();
+        $exclusionStrategy = $context->getExclusionStrategy();
+
+        $this->assertEquals($expectedClass, get_class($exclusionStrategy));
+    }
+
     public function getDataForDefaultVarsCopy()
     {
         return array(