Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit fbfc623

Browse filesBrowse files
moynzzzfabpot
moynzzz
authored and
fabpot
committed
[FrameworkBundle][HttpKernel] Provide intuitive error message when a controller fails because it's not registered as a service
1 parent 59e6380 commit fbfc623
Copy full SHA for fbfc623

File tree

Expand file treeCollapse file tree

5 files changed

+231
-4
lines changed
Filter options
Expand file treeCollapse file tree

5 files changed

+231
-4
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/debug.xml

Copy file name to clipboardExpand all lines: src/Symfony/Bundle/FrameworkBundle/Resources/config/debug.xml
+5Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,10 @@
2323
<argument type="service" id="debug.argument_resolver.inner" />
2424
<argument type="service" id="debug.stopwatch" />
2525
</service>
26+
27+
<service id="argument_resolver.not_tagged_controller" class="Symfony\Component\HttpKernel\Controller\ArgumentResolver\NotTaggedControllerValueResolver">
28+
<tag name="controller.argument_value_resolver" priority="-200" />
29+
<argument />
30+
</service>
2631
</services>
2732
</container>

‎src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/NotTaggedControllerValueResolver.php

Copy file name to clipboard
+81Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\HttpKernel\Controller\ArgumentResolver;
13+
14+
use Psr\Container\ContainerInterface;
15+
use Symfony\Component\DependencyInjection\Exception\RuntimeException;
16+
use Symfony\Component\HttpFoundation\Request;
17+
use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
18+
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
19+
20+
/**
21+
* Provides an intuitive error message when controller fails because it is not registered as a service.
22+
*
23+
* @author Simeon Kolev <simeon.kolev9@gmail.com>
24+
*/
25+
final class NotTaggedControllerValueResolver implements ArgumentValueResolverInterface
26+
{
27+
private $container;
28+
29+
public function __construct(ContainerInterface $container)
30+
{
31+
$this->container = $container;
32+
}
33+
34+
/**
35+
* {@inheritdoc}
36+
*/
37+
public function supports(Request $request, ArgumentMetadata $argument)
38+
{
39+
$controller = $request->attributes->get('_controller');
40+
41+
if (\is_array($controller) && \is_callable($controller, true) && \is_string($controller[0])) {
42+
$controller = $controller[0].'::'.$controller[1];
43+
} elseif (!\is_string($controller) || '' === $controller) {
44+
return false;
45+
}
46+
47+
if ('\\' === $controller[0]) {
48+
$controller = ltrim($controller, '\\');
49+
}
50+
51+
if (!$this->container->has($controller) && false !== $i = strrpos($controller, ':')) {
52+
$controller = substr($controller, 0, $i).strtolower(substr($controller, $i));
53+
}
54+
55+
return false === $this->container->has($controller);
56+
}
57+
58+
/**
59+
* {@inheritdoc}
60+
*/
61+
public function resolve(Request $request, ArgumentMetadata $argument)
62+
{
63+
if (\is_array($controller = $request->attributes->get('_controller'))) {
64+
$controller = $controller[0].'::'.$controller[1];
65+
}
66+
67+
if ('\\' === $controller[0]) {
68+
$controller = ltrim($controller, '\\');
69+
}
70+
71+
if (!$this->container->has($controller)) {
72+
$i = strrpos($controller, ':');
73+
$controller = substr($controller, 0, $i).strtolower(substr($controller, $i));
74+
}
75+
76+
$what = sprintf('argument $%s of "%s()"', $argument->getName(), $controller);
77+
$message = sprintf('Could not resolve %s, maybe you forgot to register the controller as a service or missed tagging it with the "controller.service_arguments"?', $what);
78+
79+
throw new RuntimeException($message);
80+
}
81+
}

‎src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
+15-4Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,19 @@ class RegisterControllerArgumentLocatorsPass implements CompilerPassInterface
3434
private $resolverServiceId;
3535
private $controllerTag;
3636
private $controllerLocator;
37+
private $notTaggedControllerResolverServiceId;
3738

38-
public function __construct(string $resolverServiceId = 'argument_resolver.service', string $controllerTag = 'controller.service_arguments', string $controllerLocator = 'argument_resolver.controller_locator')
39+
public function __construct(string $resolverServiceId = 'argument_resolver.service', string $controllerTag = 'controller.service_arguments', string $controllerLocator = 'argument_resolver.controller_locator', string $notTaggedControllerResolverServiceId = 'argument_resolver.not_tagged_controller')
3940
{
4041
$this->resolverServiceId = $resolverServiceId;
4142
$this->controllerTag = $controllerTag;
4243
$this->controllerLocator = $controllerLocator;
44+
$this->notTaggedControllerResolverServiceId = $notTaggedControllerResolverServiceId;
4345
}
4446

4547
public function process(ContainerBuilder $container)
4648
{
47-
if (false === $container->hasDefinition($this->resolverServiceId)) {
49+
if (false === $container->hasDefinition($this->resolverServiceId) && false === $container->hasDefinition($this->notTaggedControllerResolverServiceId)) {
4850
return;
4951
}
5052

@@ -181,8 +183,17 @@ public function process(ContainerBuilder $container)
181183
}
182184
}
183185

184-
$container->getDefinition($this->resolverServiceId)
185-
->replaceArgument(0, $controllerLocatorRef = ServiceLocatorTagPass::register($container, $controllers));
186+
$controllerLocatorRef = ServiceLocatorTagPass::register($container, $controllers);
187+
188+
if ($container->hasDefinition($this->resolverServiceId)) {
189+
$container->getDefinition($this->resolverServiceId)
190+
->replaceArgument(0, $controllerLocatorRef);
191+
}
192+
193+
if ($container->hasDefinition($this->notTaggedControllerResolverServiceId)) {
194+
$container->getDefinition($this->notTaggedControllerResolverServiceId)
195+
->replaceArgument(0, $controllerLocatorRef);
196+
}
186197

187198
$container->setAlias($this->controllerLocator, (string) $controllerLocatorRef);
188199
}

‎src/Symfony/Component/HttpKernel/Tests/Controller/ArgumentResolver/NotTaggedControllerValueResolverTest.php

Copy file name to clipboard
+117Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\HttpKernel\Tests\Controller\ArgumentResolver;
13+
14+
use PHPUnit\Framework\TestCase;
15+
use Symfony\Component\DependencyInjection\ServiceLocator;
16+
use Symfony\Component\HttpFoundation\Request;
17+
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\NotTaggedControllerValueResolver;
18+
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
19+
20+
class NotTaggedControllerValueResolverTest extends TestCase
21+
{
22+
public function testDoSupportWhenControllerDoNotExists()
23+
{
24+
$resolver = new NotTaggedControllerValueResolver(new ServiceLocator([]));
25+
$argument = new ArgumentMetadata('dummy', \stdClass::class, false, false, null);
26+
$request = $this->requestWithAttributes(['_controller' => 'my_controller']);
27+
28+
$this->assertTrue($resolver->supports($request, $argument));
29+
}
30+
31+
public function testDoNotSupportWhenControllerExists()
32+
{
33+
$resolver = new NotTaggedControllerValueResolver(new ServiceLocator([
34+
'App\\Controller\\Mine::method' => function () {
35+
return new ServiceLocator([
36+
'dummy' => function () {
37+
return new \stdClass();
38+
},
39+
]);
40+
},
41+
]));
42+
$argument = new ArgumentMetadata('dummy', \stdClass::class, false, false, null);
43+
$request = $this->requestWithAttributes(['_controller' => 'App\\Controller\\Mine::method']);
44+
45+
$this->assertFalse($resolver->supports($request, $argument));
46+
}
47+
48+
public function testDoNotSupportEmptyController()
49+
{
50+
$resolver = new NotTaggedControllerValueResolver(new ServiceLocator([]));
51+
$argument = new ArgumentMetadata('dummy', \stdClass::class, false, false, null);
52+
$request = $this->requestWithAttributes(['_controller' => '']);
53+
$this->assertFalse($resolver->supports($request, $argument));
54+
}
55+
56+
/**
57+
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
58+
* @expectedExceptionMessage Could not resolve argument $dummy of "App\Controller\Mine::method()", maybe you forgot to register the controller as a service or missed tagging it with the "controller.service_arguments"?
59+
*/
60+
public function testController()
61+
{
62+
$resolver = new NotTaggedControllerValueResolver(new ServiceLocator([]));
63+
$argument = new ArgumentMetadata('dummy', \stdClass::class, false, false, null);
64+
$request = $this->requestWithAttributes(['_controller' => 'App\\Controller\\Mine::method']);
65+
$this->assertTrue($resolver->supports($request, $argument));
66+
$resolver->resolve($request, $argument);
67+
}
68+
69+
/**
70+
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
71+
* @expectedExceptionMessage Could not resolve argument $dummy of "App\Controller\Mine::method()", maybe you forgot to register the controller as a service or missed tagging it with the "controller.service_arguments"?
72+
*/
73+
public function testControllerWithATrailingBackSlash()
74+
{
75+
$resolver = new NotTaggedControllerValueResolver(new ServiceLocator([]));
76+
$argument = new ArgumentMetadata('dummy', \stdClass::class, false, false, null);
77+
$request = $this->requestWithAttributes(['_controller' => '\\App\\Controller\\Mine::method']);
78+
$this->assertTrue($resolver->supports($request, $argument));
79+
$resolver->resolve($request, $argument);
80+
}
81+
82+
/**
83+
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
84+
* @expectedExceptionMessage Could not resolve argument $dummy of "App\Controller\Mine::method()", maybe you forgot to register the controller as a service or missed tagging it with the "controller.service_arguments"?
85+
*/
86+
public function testControllerWithMethodNameStartUppercase()
87+
{
88+
$resolver = new NotTaggedControllerValueResolver(new ServiceLocator([]));
89+
$argument = new ArgumentMetadata('dummy', \stdClass::class, false, false, null);
90+
$request = $this->requestWithAttributes(['_controller' => 'App\\Controller\\Mine::Method']);
91+
$this->assertTrue($resolver->supports($request, $argument));
92+
$resolver->resolve($request, $argument);
93+
}
94+
95+
/**
96+
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
97+
* @expectedExceptionMessage Could not resolve argument $dummy of "App\Controller\Mine::method()", maybe you forgot to register the controller as a service or missed tagging it with the "controller.service_arguments"?
98+
*/
99+
public function testControllerNameIsAnArray()
100+
{
101+
$resolver = new NotTaggedControllerValueResolver(new ServiceLocator([]));
102+
$argument = new ArgumentMetadata('dummy', \stdClass::class, false, false, null);
103+
$request = $this->requestWithAttributes(['_controller' => ['App\\Controller\\Mine', 'method']]);
104+
$this->assertTrue($resolver->supports($request, $argument));
105+
$resolver->resolve($request, $argument);
106+
}
107+
108+
private function requestWithAttributes(array $attributes)
109+
{
110+
$request = Request::create('/');
111+
foreach ($attributes as $name => $value) {
112+
$request->attributes->set($name, $value);
113+
}
114+
115+
return $request;
116+
}
117+
}

‎src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/HttpKernel/Tests/DependencyInjection/RegisterControllerArgumentLocatorsPassTest.php
+13Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,19 @@ public function testBindingsOnChildDefinitions()
376376
$this->assertInstanceOf(ServiceClosureArgument::class, $locator['someArg']);
377377
$this->assertEquals(new Reference('parent'), $locator['someArg']->getValues()[0]);
378378
}
379+
380+
public function testNotTaggedControllerServiceReceivesLocatorArgument()
381+
{
382+
$container = new ContainerBuilder();
383+
$resolver = $container->register('argument_resolver.not_tagged_controller')->addArgument([]);
384+
385+
$pass = new RegisterControllerArgumentLocatorsPass();
386+
$pass->process($container);
387+
388+
$locatorArgument = $container->getDefinition('argument_resolver.not_tagged_controller')->getArgument(0);
389+
390+
$this->assertInstanceOf(Reference::class, $locatorArgument);
391+
}
379392
}
380393

381394
class RegisterTestController

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.