8000 bug #50309 [HttpFoundation] UrlHelper is now aware of RequestContext … · symfony/symfony@106cd49 · GitHub
[go: up one dir, main page]
Skip to content

Commit 106cd49

Browse files
nicolas-grekasnicolas-grekas
committed
bug #50309 [HttpFoundation] UrlHelper is now aware of RequestContext changes (giosh94mhz)
This PR was merged into the 5.4 branch. Discussion ---------- [HttpFoundation] UrlHelper is now aware of RequestContext changes | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | yes | Tickets | | License | MIT | Doc PR | `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. In my application I have a CLI command that dynamically create the RequestContext, based on database queries and other user-driven configuration. With this information at hand, I retrieve the router and set the new context that should then be used on any other URL generation. This works for the Router, but then I render some twig templates (to send formatted email) and found that the `UrlHelper` is using the old context, and not helping at all :) Also, the helper is final and without interface, so I have no way of decorating or replacing it. Long story short: in my opinion, the `RequestContext` should be treated just like the `Request`, and so we should use `RequestContextAwareInterface` just like we use the `RequestStack`. ....or maybe the context should be carried out with the `RequestStack`? Any other ideas? ~~no longer relevant: this PR introduce a BC on the constructor of `UrlHelper`, but since it's final maybe is not required to keep backward compatility. If not, I may update the class to support both `RequestContextAwareInterface` and `RequestContext` as the second parameter.~~ Commits ------- a016392 UrlHelper is now aware of RequestContext changes
2 parents 8c5f5ae + a016392 commit 106cd49

File tree

4 files changed

+65
-13
lines changed

4 files changed

+65
-13
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/services.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ class_exists(WorkflowEvents::class) ? WorkflowEvents::ALIASES : []
110110
->set('url_helper', UrlHelper::class)
111111
->args([
112112
service('request_stack'),
113-
service('router.request_context')->ignoreOnInvalid(),
113+
service('router')->ignoreOnInvalid(),
114114
])
115115
->alias(UrlHelper::class, 'url_helper')
116116

‎src/Symfony/Bundle/FrameworkBundle/composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"symfony/deprecation-contracts": "^2.1|^3",
2525
"symfony/event-dispatcher": "^5.1|^6.0",
2626
"symfony/error-handler": "^4.4.1|^5.0.1|^6.0",
27-
"symfony/http-foundation": "^5.3|^6.0",
27+
"symfony/http-foundation": "^5.4.24|^6.2.11",
2828
"symfony/http-kernel": "^5.4|^6.0",
2929
"symfony/polyfill-mbstring": "~1.0",
3030
"symfony/polyfill-php80": "^1.16",

‎src/Symfony/Component/HttpFoundation/Tests/UrlHelperTest.php

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use Symfony\Component\HttpFoundation\RequestStack;
1717
use Symfony\Component\HttpFoundation\UrlHelper;
1818
use Symfony\Component\Routing\RequestContext;
19+
use Symfony\Component\Routing\RequestContextAwareInterface;
1920

2021
class UrlHelperTest extends TestCase
2122
{
@@ -64,11 +65,46 @@ public function testGenerateAbsoluteUrlWithRequestContext($path, $baseUrl, $host
6465
}
6566

6667
$requestContext = new RequestContext($baseUrl, 'GET', $host, $scheme, $httpPort, $httpsPort, $path);
68+
6769
$helper = new UrlHelper(new RequestStack(), $requestContext);
6870

6971
$this->assertEquals($expected, $helper->getAbsoluteUrl($path));
7072
}
7173

74+
/**
75+
* @dataProvider getGenerateAbsoluteUrlRequestContextData
76+
*/
77+
public function testGenerateAbsoluteUrlWithRequestContextAwareInterface($path, $baseUrl, $host, $scheme, $httpPort, $httpsPort, $expected)
78+
{
79+
if (!class_exists(RequestContext::class)) {
80+
$this->markTestSkipped('The Routing component is needed to run tests that depend on its request context.');
81+
}
82+
83+
$requestContext = new RequestContext($baseUrl, 'GET', $host, $scheme, $httpPort, $httpsPort, $path);
84+
$contextAware = new class($requestContext) implements RequestContextAwareInterface {
85+
private $requestContext;
86+
87+
public function __construct($requestContext)
88+
{
89+
$this->requestContext = $requestContext;
90+
}
91+
92+
public function setContext(RequestContext $context)
93+
{
94+
$this->requestContext = $context;
95+
}
96+
97+
public function getContext()
98+
{
99+
return $this->requestContext;
100+
}
101+
};
102+
103+
$helper = new UrlHelper(new RequestStack(), $contextAware);
104+
105+
$this->assertEquals($expected, $helper->getAbsoluteUrl($path));
106+
}
107+
72108
/**
73109
* @dataProvider getGenerateAbsoluteUrlRequestContextData
74110
*/

‎src/Symfony/Component/HttpFoundation/UrlHelper.php

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
namespace Symfony\Component\HttpFoundation;
1313

1414
use Symfony\Component\Routing\RequestContext;
15+
use Symfony\Component\Routing\RequestContextAwareInterface;
1516

1617
/**
1718
* A helper service for manipulating URLs within and outside the request scope.
@@ -23,8 +24,15 @@ final class UrlHelper
2324
private $requestStack;
2425
private $requestContext;
2526

26-
public function __construct(RequestStack $requestStack, RequestContext $requestContext = null)
27+
/**
28+
* @param RequestContextAwareInterface|RequestContext|null $requestContext
29+
*/
30+
public function __construct(RequestStack $requestStack, $requestContext = null)
2731
{
32+
if (null !== $requestContext && !$requestContext instanceof RequestContext && !$requestContext instanceof RequestContextAwareInterface) {
33+
throw new \TypeError(__METHOD__.': Argument #2 ($requestContext) must of type Symfony\Component\Routing\RequestContextAwareInterface|Symfony\Component\Routing\RequestContext|null, '.get_debug_type($requestContext).' given.');
34+
}
35+
2836
$this->requestStack = $requestStack;
2937
$this->requestContext = $requestContext;
3038
}
@@ -73,28 +81,36 @@ public function getRelativePath(string $path): string
7381

7482
private function getAbsoluteUrlFromContext(string $path): string
7583
{
76-
if (null === $this->requestContext || '' === $host = $this->requestContext->getHost()) {
84+
if (null === $context = $this->requestContext) {
85+
return $path;
86+
}
87+
88+
if ($context instanceof RequestContextAwareInterface) {
89+
$context = $context->getContext();
90+
}
91+
92+
if ('' === $host = $context->getHost()) {
7793
return $path;
7894
}
7995

80-
$scheme = $this->requestContext->getScheme();
96+
$scheme = $context->getScheme();
8197
$port = '';
8298

83-
if ('http' === $scheme && 80 !== $this->requestContext->getHttpPort()) {
84-
$port = ':'.$this->requestContext->getHttpPort();
85-
} elseif ('https' === $scheme && 443 !== $this->requestContext->getHttpsPort()) {
86-
$port = ':'.$this->requestContext->getHttpsPort();
99+
if ('http' === $scheme && 80 !== $context->getHttpPort()) {
100+
$port = ':'.$context->getHttpPort();
101+
} elseif ('https' === $scheme && 443 !== $context->getHttpsPort()) {
102+
$port = ':'.$context->getHttpsPort();
87103
}
88104

89105
if ('#' === $path[0]) {
90-
$queryString = $this->requestContext->getQueryString();
91-
$path = $this->requestContext->getPathInfo().($queryString ? '?'.$queryString : '').$path;
106+
$queryString = $context->getQueryString();
107+
$path = $context->getPathInfo().($queryString ? '?'.$queryString : '').$path;
92108
} elseif ('?' === $path[0]) {
93-
$path = $this->requestContext->getPathInfo().$path;
109+
$path = $context->getPathInfo().$path;
94110
}
95111

96112
if ('/' !== $path[0]) {
97-
$path = rtrim($this->requestContext->getBaseUrl(), '/').'/'.$path;
113+
$path = rtrim($context->getBaseUrl(), '/').'/'.$path;
98114
}
99115

100116
return $scheme.'://'.$host.$port.$path;

0 commit comments

Comments
 (0)
0