Skip to content

[FrameworkBundle] Improve DX of RedirectController #25259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[FrameworkBundle] Improve DX of RedirectController #25259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Controller/RedirectController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,13 @@ public function urlRedirectAction(Request $request, string $path, bool $permanen

return new RedirectResponse($url, $statusCode);
}

public function __invoke(Request $request): Response
{
if (null !== $route = $request->attributes->get('route')) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That looks like alot of magic. It might be cleaner to just create a new controller with invoke for one action. And possibly deprecate it in RedirectController so there is no ambiguity.

return $this->redirectAction($request, $route, $request->attributes->getBoolean('permanent', false), $request->attributes->get('ignoreAttributes', false));
}

return $this->urlRedirectAction($request, $request->attributes->get('path'), $request->attributes->getBoolean('permanent', false), $request->attributes->get('scheme'), $request->attributes->get('httpPort'), $request->attributes->get('httpsPort'));
}
}
198 changes: 151 additions & 47 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Controller/RedirectControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,31 @@ public function testEmptyRoute()
}
}

public function testEmptyRouteInvoke()
{
$request = new Request(array(), array(), array('route' => '', 'permanent' => true));
$controller = new RedirectController();

try {
$controller($request);
$this->fail('Expected Symfony\Component\HttpKernel\Exception\HttpException to be thrown');
} catch (HttpException $e) {
$this->assertSame(410, $e->getStatusCode());
}

$request = new Request(array(), array(), array('route' => '', 'permanent' => false));
try {
$controller($request);
$this->fail('Expected Symfony\Component\HttpKernel\Exception\HttpException to be thrown');
} catch (HttpException $e) {
$this->assertSame(404, $e->getStatusCode());
}
}

/**
* @dataProvider provider
*/
public function testRoute($permanent, $ignoreAttributes, $expectedCode, $expectedAttributes)
public function testRoute($permanent, $ignoreAttributes, $expectedCode, $expectedAttributes, bool $invoke)
{
$request = new Request();

Expand All @@ -56,15 +77,13 @@ public function testRoute($permanent, $ignoreAttributes, $expectedCode, $expecte
$attributes = array(
'route' => $route,
'permanent' => $permanent,
'_route' => 'current-route',
'_route_params' => array(
'route' => $route,
'permanent' => $permanent,
'additional-parameter' => 'value',
'ignoreAttributes' => $ignoreAttributes,
),
'additional-parameter' => 'value',
'ignoreAttributes' => $ignoreAttributes,
);

$attributes['_route_params'] = $attributes;
$attributes['_route'] = 'current-route';

$request->attributes = new ParameterBag($attributes);

$router = $this->getMockBuilder(UrlGeneratorInterface::class)->getMock();
Expand All @@ -76,7 +95,7 @@ public function testRoute($permanent, $ignoreAttributes, $expectedCode, $expecte

$controller = new RedirectController($router);

$returnResponse = $controller->redirectAction($request, $route, $permanent, $ignoreAttributes);
$returnResponse = $invoke ? $controller($request) : $controller->redirectAction($request, $route, $permanent, $ignoreAttributes);

$this->assertRedirectUrl($returnResponse, $url);
$this->assertEquals($expectedCode, $returnResponse->getStatusCode());
Expand All @@ -85,10 +104,14 @@ public function testRoute($permanent, $ignoreAttributes, $expectedCode, $expecte
public function provider()
{
return array(
array(true, false, 301, array('additional-parameter' => 'value')),
array(false, false, 302, array('additional-parameter' => 'value')),
array(false, true, 302, array()),
array(false, array('additional-parameter'), 302, array()),
array(true, false, 301, array('additional-parameter' => 'value'), false),
array(true, false, 301, array('additional-parameter' => 'value'), true),
array(false, false, 302, array('additional-parameter' => 'value'), false),
array(false, false, 302, array('additional-parameter' => 'value'), true),
array(false, true, 302, array(), false),
array(false, true, 302, array(), true),
array(false, array('additional-parameter'), 302, array(), false),
array(false, array('additional-parameter'), 302, array(), true),
);
}

Expand All @@ -112,6 +135,27 @@ public function testEmptyPath()
}
}

public function testEmptyPathInvoke()
{
$request = new Request(array(), array(), array('path' => '', 'permanent' => true));
$controller = new RedirectController();

try {
$controller($request);
$this->fail('Expected Symfony\Component\HttpKernel\Exception\HttpException to be thrown');
} catch (HttpException $e) {
$this->assertSame(410, $e->getStatusCode());
}

$request = new Request(array(), array(), array('path' => '', 'permanent' => false));
try {
$controller($request);
$this->fail('Expected Symfony\Component\HttpKernel\Exception\HttpException to be thrown');
} catch (HttpException $e) {
$this->assertSame(404, $e->getStatusCode());
}
}

public function testFullURL()
{
$request = new Request();
Expand All @@ -122,6 +166,16 @@ public function testFullURL()
$this->assertEquals(302, $returnResponse->getStatusCode());
}

public function testFullURLInvoke()
{
$request = new Request(array(), array(), array('path' => 'http://foo.bar/'));
$controller = new RedirectController();
$returnResponse = $controller($request);

$this->assertRedirectUrl($returnResponse, 'http://foo.bar/');
$this->assertEquals(302, $returnResponse->getStatusCode());
}

public function testUrlRedirectDefaultPorts()
{
$host = 'www.example.com';
Expand All @@ -143,84 +197,132 @@ public function testUrlRedirectDefaultPorts()
$this->assertRedirectUrl($returnValue, $expectedUrl);
}

public function testUrlRedirectDefaultPortsInvoke()
{
$host = 'www.example.com';
$baseUrl = '/base';
$path = '/redirect-path';
$httpPort = 1080;
$httpsPort = 1443;

$expectedUrl = "https://$host:$httpsPort$baseUrl$path";
$request = $this->createRequestObject('http', $host, $httpPort, $baseUrl, '', array('path' => $path, 'permanent' => false, 'scheme' => 'https', 'httpPort' => $httpPort));
$controller = $this->createRedirectController(null, $httpsPort);
$returnValue = $controller($request);
$this->assertRedirectUrl($returnValue, $expectedUrl);

$expectedUrl = "http://$host:$httpPort$baseUrl$path";
$request = $this->createRequestObject('https', $host, $httpPort, $baseUrl, '', array('path' => $path, 'permanent' => false, 'scheme' => 'http'));
$controller = $this->createRedirectController($httpPort);
$returnValue = $controller($request);
$this->assertRedirectUrl($returnValue, $expectedUrl);
}

public function urlRedirectProvider()
{
return array(
// Standard ports
array('http', null, null, 'http', 80, ''),
array('http', 80, null, 'http', 80, ''),
array('https', null, null, 'http', 80, ''),
array('https', 80, null, 'http', 80, ''),

array('http', null, null, 'https', 443, ''),
array('http', null, 443, 'https', 443, ''),
array('https', null, null, 'https', 443, ''),
array('https', null, 443, 'https', 443, ''),
array('http', null, null, 'http', 80, '', false),
array('http', null, null, 'http', 80, '', true),
array('http', 80, null, 'http', 80, '', false),
array('http', 80, null, 'http', 80, '', true),
array('https', null, null, 'http', 80, '', false),
array('https', null, null, 'http', 80, '', true),
array('https', 80, null, 'http', 80, '', false),
array('https', 80, null, 'http', 80, '', true),

array('http', null, null, 'https', 443, '', false),
array('http', null, null, 'https', 443, '', true),
array('http', null, 443, 'https', 443, '', false),
array('http', null, 443, 'https', 443, '', true),
array('https', null, null, 'https', 443, '', false),
array('https', null, null, 'https', 443, '', true),
array('https', null, 443, 'https', 443, '', false),
array('https', null, 443, 'https', 443, '', true),

// Non-standard ports
array('http', null, null, 'http', 8080, ':8080'),
array('http', 4080, null, 'http', 8080, ':4080'),
array('http', 80, null, 'http', 8080, ''),
array('https', null, null, 'http', 8080, ''),
array('https', null, 8443, 'http', 8080, ':8443'),
array('https', null, 443, 'http', 8080, ''),

array('https', null, null, 'https', 8443, ':8443'),
array('https', null, 4443, 'https', 8443, ':4443'),
array('https', null, 443, 'https', 8443, ''),
array('http', null, null, 'https', 8443, ''),
array('http', 8080, 4443, 'https', 8443, ':8080'),
array('http', 80, 4443, 'https', 8443, ''),
array('http', null, null, 'http', 8080, ':8080', false),
array('http', null, null, 'http', 8080, ':8080', true),
array('http', 4080, null, 'http', 8080, ':4080', false),
array('http', 4080, null, 'http', 8080, ':4080', true),
array('http', 80, null, 'http', 8080, '', false),
array('http', 80, null, 'http', 8080, '', true),
array('https', null, null, 'http', 8080, '', false),
array('https', null, null, 'http', 8080, '', true),
array('https', null, 8443, 'http', 8080, ':8443', false),
array('https', null, 8443, 'http', 8080, ':8443', true),
array('https', null, 443, 'http', 8080, '', false),
array('https', null, 443, 'http', 8080, '', true),

array('https', null, null, 'https', 8443, ':8443', false),
array('https', null, null, 'https', 8443, ':8443', true),
array('https', null, 4443, 'https', 8443, ':4443', false),
array('https', null, 4443, 'https', 8443, ':4443', true),
array('https', null, 443, 'https', 8443, '', false),
array('https', null, 443, 'https', 8443, '', true),
array('http', null, null, 'https', 8443, '', false),
array('http', null, null, 'https', 8443, '', true),
array('http', 8080, 4443, 'https', 8443, ':8080', false),
array('http', 8080, 4443, 'https', 8443, ':8080', true),
array('http', 80, 4443, 'https', 8443, '', false),
array('http', 80, 4443, 'https', 8443, '', true),
);
}

/**
* @dataProvider urlRedirectProvider
*/
public function testUrlRedirect($scheme, $httpPort, $httpsPort, $requestScheme, $requestPort, $expectedPort)
public function testUrlRedirect($scheme, $httpPort, $httpsPort, $requestScheme, $requestPort, $expectedPort, bool $invoke)
{
$host = 'www.example.com';
$baseUrl = '/base';
$path = '/redirect-path';
$expectedUrl = "$scheme://$host$expectedPort$baseUrl$path";

$request = $this->createRequestObject($requestScheme, $host, $requestPort, $baseUrl);
$attributes = $invoke ? array('path' => $path, 'permanent' => false, 'scheme' => $scheme, 'httpPort' => $httpPort, 'httpsPort' => $httpsPort) : array();
$request = $this->createRequestObject($requestScheme, $host, $requestPort, $baseUrl, '', $attributes);
$controller = $this->createRedirectController();

$returnValue = $controller->urlRedirectAction($request, $path, false, $scheme, $httpPort, $httpsPort);
$returnValue = $invoke ? $controller($request) : $controller->urlRedirectAction($request, $path, false, $scheme, $httpPort, $httpsPort);
$this->assertRedirectUrl($returnValue, $expectedUrl);
}

public function pathQueryParamsProvider()
{
return array(
array('http://www.example.com/base/redirect-path', '/redirect-path', ''),
array('http://www.example.com/base/redirect-path?foo=bar', '/redirect-path?foo=bar', ''),
array('http://www.example.com/base/redirect-path?foo=bar', '/redirect-path', 'foo=bar'),
array('http://www.example.com/base/redirect-path?foo=bar&abc=example', '/redirect-path?foo=bar', 'abc=example'),
array('http://www.example.com/base/redirect-path?foo=bar&abc=example&baz=def', '/redirect-path?foo=bar', 'abc=example&baz=def'),
array('http://www.example.com/base/redirect-path', '/redirect-path', '', false),
array('http://www.example.com/base/redirect-path', '/redirect-path', '', true),
array('http://www.example.com/base/redirect-path?foo=bar', '/redirect-path?foo=bar', '', false),
array('http://www.example.com/base/redirect-path?foo=bar', '/redirect-path?foo=bar', '', true),
array('http://www.example.com/base/redirect-path?foo=bar', '/redirect-path', 'foo=bar', false),
array('http://www.example.com/base/redirect-path?foo=bar', '/redirect-path', 'foo=bar', true),
array('http://www.example.com/base/redirect-path?foo=bar&abc=example', '/redirect-path?foo=bar', 'abc=example', false),
array('http://www.example.com/base/redirect-path?foo=bar&abc=example', '/redirect-path?foo=bar', 'abc=example', true),
array('http://www.example.com/base/redirect-path?foo=bar&abc=example&baz=def', '/redirect-path?foo=bar', 'abc=example&baz=def', false),
array('http://www.example.com/base/redirect-path?foo=bar&abc=example&baz=def', '/redirect-path?foo=bar', 'abc=example&baz=def', true),
);
}

/**
* @dataProvider pathQueryParamsProvider
*/
public function testPathQueryParams($expectedUrl, $path, $queryString)
public function testPathQueryParams($expectedUrl, $path, $queryString, bool $invoke)
{
$scheme = 'http';
$host = 'www.example.com';
$baseUrl = '/base';
$port = 80;

$request = $this->createRequestObject($scheme, $host, $port, $baseUrl, $queryString);
$attributes = $invoke ? array('path' => $path, 'permanent' => false, 'scheme' => $scheme, 'port' => $port) : array();
$request = $this->createRequestObject($scheme, $host, $port, $baseUrl, $queryString, $attributes);

$controller = $this->createRedirectController();

$returnValue = $controller->urlRedirectAction($request, $path, false, $scheme, $port, null);
$returnValue = $invoke ? $controller($request) : $controller->urlRedirectAction($request, $path, false, $scheme, $port, null);
$this->assertRedirectUrl($returnValue, $expectedUrl);
}

private function createRequestObject($scheme, $host, $port, $baseUrl, $queryString = '')
private function createRequestObject($scheme, $host, $port, $baseUrl, $queryString = '', $attributes = array())
{
$request = $this->getMockBuilder('Symfony\Component\HttpFoundation\Request')->getMock();
$request
Expand All @@ -244,6 +346,8 @@ private function createRequestObject($scheme, $host, $port, $baseUrl, $queryStri
->method('getQueryString')
->will($this->returnValue($queryString));

$request->attributes = new ParameterBag($attributes);

return $request;
}

Expand Down