UrlHelper is now aware of RequestContext changes

RequestContext in routing can change at runtime after the
UrlHelper has been created, so using a RequestContextAwareInterface
instance (i.e. the router) will workaround URL generation issues.

Author: giosh94mhz

Tests/UrlHelperTest.php

@@ -16,6 +16,7 @@
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\UrlHelper;
 use Symfony\Component\Routing\RequestContext;
+use Symfony\Component\Routing\RequestContextAwareInterface;
 
 class UrlHelperTest extends TestCase
 {
@@ -64,11 +65,46 @@ public function testGenerateAbsoluteUrlWithRequestContext($path, $baseUrl, $host
         }
 
         $requestContext = new RequestContext($baseUrl, 'GET', $host, $scheme, $httpPort, $httpsPort, $path);
+
         $helper = new UrlHelper(new RequestStack(), $requestContext);
 
         $this->assertEquals($expected, $helper->getAbsoluteUrl($path));
     }
 
+    /**
+     * @dataProvider getGenerateAbsoluteUrlRequestContextData
+     */
+    public function testGenerateAbsoluteUrlWithRequestContextAwareInterface($path, $baseUrl, $host, $scheme, $httpPort, $httpsPort, $expected)
+    {
+        if (!class_exists(RequestContext::class)) {
+            $this->markTestSkipped('The Routing component is needed to run tests that depend on its request context.');
+        }
+
+        $requestContext = new RequestContext($baseUrl, 'GET', $host, $scheme, $httpPort, $httpsPort, $path);
+        $contextAware = new class($requestContext) implements RequestContextAwareInterface {
+            private $requestContext;
+
+            public function __construct($requestContext)
+            {
+                $this->requestContext = $requestContext;
+            }
+
+            public function setContext(RequestContext $context)
+            {
+                $this->requestContext = $context;
+            }
+
+            public function getContext()
+            {
+                return $this->requestContext;
+            }
+        };
+
+        $helper = new UrlHelper(new RequestStack(), $contextAware);
+
+        $this->assertEquals($expected, $helper->getAbsoluteUrl($path));
+    }
+
     /**
      * @dataProvider getGenerateAbsoluteUrlRequestContextData
      */

UrlHelper.php

@@ -12,6 +12,7 @@
 namespace Symfony\Component\HttpFoundation;
 
 use Symfony\Component\Routing\RequestContext;
+use Symfony\Component\Routing\RequestContextAwareInterface;
 
 /**
  * A helper service for manipulating URLs within and outside the request scope.
@@ -23,8 +24,15 @@ final class UrlHelper
     private $requestStack;
     private $requestContext;
 
-    public function __construct(RequestStack $requestStack, RequestContext $requestContext = null)
+    /**
+     * @param RequestContextAwareInterface|RequestContext|null $requestContext
+     */
+    public function __construct(RequestStack $requestStack, $requestContext = null)
     {
+        if (null !== $requestContext && !$requestContext instanceof RequestContext && !$requestContext instanceof RequestContextAwareInterface) {
+            throw new \TypeError(__METHOD__.': Argument #2 ($requestContext) must of type Symfony\Component\Routing\RequestContextAwareInterface|Symfony\Component\Routing\RequestContext|null, '.get_debug_type($requestContext).' given.');
+        }
+
         $this->requestStack = $requestStack;
         $this->requestContext = $requestContext;
     }
@@ -73,28 +81,36 @@ public function getRelativePath(string $path): string
 
     private function getAbsoluteUrlFromContext(string $path): string
     {
-        if (null === $this->requestContext || '' === $host = $this->requestContext->getHost()) {
+        if (null === $context = $this->requestContext) {
+            return $path;
+        }
+
+        if ($context instanceof RequestContextAwareInterface) {
+            $context = $context->getContext();
+        }
+
+        if ('' === $host = $context->getHost()) {
             return $path;
         }
 
-        $scheme = $this->requestContext->getScheme();
+        $scheme = $context->getScheme();
         $port = '';
 
-        if ('http' === $scheme && 80 !== $this->requestContext->getHttpPort()) {
-            $port = ':'.$this->requestContext->getHttpPort();
-        } elseif ('https' === $scheme && 443 !== $this->requestContext->getHttpsPort()) {
-            $port = ':'.$this->requestContext->getHttpsPort();
+        if ('http' === $scheme && 80 !== $context->getHttpPort()) {
+            $port = ':'.$context->getHttpPort();
+        } elseif ('https' === $scheme && 443 !== $context->getHttpsPort()) {
+            $port = ':'.$context->getHttpsPort();
         }
 
         if ('#' === $path[0]) {
-            $queryString = $this->requestContext->getQueryString();
-            $path = $this->requestContext->getPathInfo().($queryString ? '?'.$queryString : '').$path;
+            $queryString = $context->getQueryString();
+            $path = $context->getPathInfo().($queryString ? '?'.$queryString : '').$path;
         } elseif ('?' === $path[0]) {
-            $path = $this->requestContext->getPathInfo().$path;
+            $path = $context->getPathInfo().$path;
         }
 
         if ('/' !== $path[0]) {
-            $path = rtrim($this->requestContext->getBaseUrl(), '/').'/'.$path;
+            $path = rtrim($context->getBaseUrl(), '/').'/'.$path;
         }
 
         return $scheme.'://'.$host.$port.$path;