bug #53924 [FrameworkBundle] Check if the _route attribute exists on the request (xvilo)

nicolas-grekas · nicolas-grekas · commit 81b312d2fa2e · 2024-02-14T16:49:04.000+01:00
This PR was submitted for the 6.4 branch but it was squashed and merged into the 5.4 branch instead. Discussion ---------- [FrameworkBundle] Check if the _route attribute exists on the request | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | License | MIT The _route attribute does not always exist in some codebases when RedirectController is used. `$request->attributes->get()` will default to `null` if the value does not exist, yielding a PHP error as the return type is set to string. ``` Symfony\Bundle\FrameworkBundle\DataCollector\RouterDataCollector::guessRoute(): Return value must be of type string, null returned ``` Commits ------- 8a615b3 [FrameworkBundle] Check if the _route attribute exists on the request
diff --git a/src/Symfony/Bundle/FrameworkBundle/DataCollector/RouterDataCollector.php b/src/Symfony/Bundle/FrameworkBundle/DataCollector/RouterDataCollector.php
@@ -28,7 +28,7 @@ public function guessRoute(Request $request, $controller)
             $controller = $controller[0];
         }
 
-        if ($controller instanceof RedirectController) {
+        if ($controller instanceof RedirectController && $request->attributes->has('_route')) {
             return $request->attributes->get('_route');
         }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DataCollector/RouterDataCollectorTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DataCollector/RouterDataCollectorTest.php
@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\DataCollector;
+
+use Symfony\Bundle\FrameworkBundle\Controller\RedirectController;
+use Symfony\Bundle\FrameworkBundle\DataCollector\RouterDataCollector;
+use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
+use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Event\ControllerEvent;
+use Symfony\Component\HttpKernel\KernelInterface;
+
+class RouterDataCollectorTest extends TestCase
+{
+    public function testRouteRedirectControllerNoRouteAtrribute()
+    {
+        $collector = new RouterDataCollector();
+
+        $request = Request::create('http://test.com/foo?bar=baz');
+        $response = new RedirectResponse('http://test.com/redirect');
+
+        $event = $this->createControllerEvent($request);
+
+        $collector->onKernelController($event);
+        $collector->collect($request, $response);
+
+        $this->assertTrue($collector->getRedirect());
+        $this->assertEquals('http://test.com/redirect', $collector->getTargetUrl());
+        $this->assertEquals('n/a', $collector->getTargetRoute());
+    }
+
+    public function testRouteRedirectControllerWithRouteAttribute()
+    {
+        $collector = new RouterDataCollector();
+
+        $request = Request::create('http://test.com/foo?bar=baz');
+        $request->attributes->set('_route', 'current-route');
+
+        $response = new RedirectResponse('http://test.com/redirect');
+
+        $event = $this->createControllerEvent($request);
+
+        $collector->onKernelController($event);
+        $collector->collect($request, $response);
+
+        $this->assertTrue($collector->getRedirect());
+        $this->assertEquals('http://test.com/redirect', $collector->getTargetUrl());
+        $this->assertEquals('current-route', $collector->getTargetRoute());
+    }
+
+    protected function createControllerEvent(Request $request): ControllerEvent
+    {
+        $kernel = $this->createMock(KernelInterface::class);
+
+        return new ControllerEvent($kernel, new RedirectController(), $request, null);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function guessRoute(Request $request, $controller)`
`28`	`28`	`$controller = $controller[0];`
`29`	`29`	`}`
`30`	`30`
`31`		`- if ($controller instanceof RedirectController) {`
	`31`	`+ if ($controller instanceof RedirectController && $request->attributes->has('_route')) {`
`32`	`32`	`return $request->attributes->get('_route');`
`33`	`33`	`}`
`34`	`34`