[HttpKernel] Deprecate passing objects as URI attributes to the ESI and SSI renderers

jakzal · jakzal · commit 105d3cc16c0c · 2016-01-31T11:36:51.000Z
diff --git a/CHANGELOG-3.1.md b/CHANGELOG-3.1.md
@@ -0,0 +1,12 @@
+CHANGELOG for 3.1.x
+===================
+
+This changelog references the relevant changes (bug and security fixes) done
+in 3.1 minor versions.
+
+To get the diff for a specific change, go to https://github.com/symfony/symfony/commit/XXX where XXX is the change hash
+To get the diff between two versions, go to https://github.com/symfony/symfony/compare/v3.1.0...v3.1.1
+
+* 3.1.0
+
+ * bug #17611 [HttpKernel] Deprecate passing objects as URI attributes to the ESI and SSI renderers
diff --git a/UPGRADE-3.1.md b/UPGRADE-3.1.md
@@ -16,6 +16,13 @@ Form
  * The `choices_as_values` option of the `ChoiceType` has been deprecated and
    will be removed in Symfony 4.0.
 
+HttpKernel
+----------
+
+ * Passing objects as URI attributes to the ESI and SSI renderers has been
+   deprecated and will be removed in Symfony 4.0. The inline fragment
+   renderer should be used with object attributes.
+
 Serializer
 ----------
 
diff --git a/src/Symfony/Component/HttpKernel/Fragment/AbstractSurrogateFragmentRenderer.php b/src/Symfony/Component/HttpKernel/Fragment/AbstractSurrogateFragmentRenderer.php
@@ -64,6 +64,10 @@ public function __construct(SurrogateInterface $surrogate = null, FragmentRender
     public function render($uri, Request $request, array $options = array())
     {
         if (!$this->surrogate || !$this->surrogate->hasSurrogateCapability($request)) {
+            if ($uri instanceof ControllerReference && $this->containsNonScalars($uri->attributes)) {
+                @trigger_error('Passing objects as part of URI attributes to the ESI and SSI rendering strategies is deprecated since version 3.1, and will be removed in 4.0. Use a different rendering strategy or pass scalar values.', E_USER_DEPRECATED);
+            }
+
             return $this->inlineStrategy->render($uri, $request, $options);
         }
 
@@ -92,4 +96,17 @@ private function generateSignedFragmentUri($uri, Request $request)
 
         return substr($fragmentUri, strlen($request->getSchemeAndHttpHost()));
     }
+
+    private function containsNonScalars(array $values)
+    {
+        foreach ($values as $value) {
+            if (is_array($value) && $this->containsNonScalars($value)) {
+                return true;
+            } elseif (!is_scalar($value) && null !== $value) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/Tests/Fragment/EsiFragmentRendererTest.php b/src/Symfony/Component/HttpKernel/Tests/Fragment/EsiFragmentRendererTest.php
@@ -25,6 +25,32 @@ public function testRenderFallbackToInlineStrategyIfEsiNotSupported()
         $strategy->render('/', Request::create('/'));
     }
 
+    /**
+     * @group legacy
+     */
+    public function testRenderFallbackWithObjectAttributesIsDeprecated()
+    {
+        $deprecations = array();
+        set_error_handler(function ($type, $message) use (&$deprecations) {
+            if (E_USER_DEPRECATED === $type) {
+                $deprecations[] = $message;
+            }
+        });
+
+        $strategy = new EsiFragmentRenderer(new Esi(), $this->getInlineStrategy(true), new UriSigner('foo'));
+
+        $request = Request::create('/');
+
+        $reference = new ControllerReference('main_controller', array('foo' => array('a' => array(), 'b' => new \stdClass())), array());
+
+        $strategy->render($reference, $request);
+
+        $this->assertCount(1, $deprecations);
+        $this->assertContains('Passing objects as part of URI attributes to the ESI and SSI rendering strategies is deprecated', $deprecations[0]);
+
+        restore_error_handler();
+    }
+
     public function testRender()
     {
         $strategy = new EsiFragmentRenderer(new Esi(), $this->getInlineStrategy());
