8000 [FrameworkBundle] Add missing BC layer for deprecated ControllerNameParser injections by chalasr · Pull Request #31739 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

[FrameworkBundle] Add missing BC layer for deprecated ControllerNameParser injections #31739

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.

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

Merged
merged 1 commit into from
Jun 4, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions UPGRADE-4.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ DependencyInjection
factory: ['@factory_service', method]
```

FrameworkBundle
---------------

* The `$parser` argument of `ControllerResolver::__construct()` and `DelegatingLoader::__construct()`
has been deprecated.
* The `ControllerResolver` and `DelegatingLoader` classes have been marked as `final`.
* The `controller_name_converter` and `resolve_controller_name_subscriber` services have been deprecated.

Messenger
---------

Expand Down
5 changes: 5 additions & 0 deletions UPGRADE-5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,11 @@ FrameworkBundle
* Removed support for legacy translations directories `src/Resources/translations/` and `src/Resources/<BundleName>/translations/`, use `translations/` instead.
* Support for the legacy directory structure in `translation:update` and `debug:translation` commands has been removed.
* Removed the "Psr\SimpleCache\CacheInterface" / "cache.app.simple" service, use "Symfony\Contracts\Cache\CacheInterface" / "cache.app" instead.
* The `$parser` argument of `ControllerResolver::__construct()` and `DelegatingLoader::__construct()`
has been removed.
* The `ControllerResolver` and `DelegatingLoader` classes have been made `final`.
* The `controller_name_converter` and `resolve_controller_name_subscriber` services have been removed.


HttpFoundation
--------------
Expand Down
7 changes: 7 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
CHANGELOG
=========

4.4.0
-----

* Deprecated the `$parser` argument of `ControllerResolver::__construct()` and `DelegatingLoader::__construct()`
* Deprecated the `controller_name_converter` and `resolve_controller_name_subscriber` services
* The `ControllerResolver` and `DelegatingLoader` classes have been marked as `final`

4.3.0
-----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@ class ControllerNameParser
{
protected $kernel;

public function __construct(KernelInterface $kernel)
public function __construct(KernelInterface $kernel, bool $triggerDeprecation = true)
{
$this->kernel = $kernel;

if ($triggerDeprecation) {
@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.1.', __CLASS__), E_USER_DEPRECATED);
}
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,30 @@

/**
* @author Fabien Potencier <fabien@symfony.com>
*
* @final since Symfony 4.4
*/
class ControllerResolver extends ContainerControllerResolver
{
/**
* @deprecated since Symfony 4.4
*/
protected $parser;

public function __construct(ContainerInterface $container, ControllerNameParser $parser, LoggerInterface $logger = null)
/**
* @param LoggerInterface|null $logger
*/
public function __construct(ContainerInterface $container, $logger = null)
{
$this->parser = $parser;
if ($logger instanceof ControllerNameParser) {
@trigger_error(sprintf('Passing a "%s" instance as 2nd argument to "%s()" is deprecated since Symfony 4.4, pass a "%s" instance or null instead.', ControllerNameParser::class, __METHOD__, LoggerInterface::class), E_USER_DEPRECATED);
$this->parser = $logger;
$logger = 2 < \func_num_args() ? func_get_arg(2) : null;
} elseif (2 < \func_num_args() && func_get_arg(2) instanceof ControllerNameParser) {
$this->parser = func_get_arg(2);
} elseif ($logger && !$logger instanceof LoggerInterface) {
throw new \TypeError(sprintf('Argument 2 of "%s()" must be an instance of "%s" or null, "%s" given.', __METHOD__, LoggerInterface::class, \is_object($logger) ? \get_class($logger) : \gettype($logger)), E_USER_DEPRECATED);
}

parent::__construct($container, $logger);
}
Expand All @@ -35,7 +51,7 @@ public function __construct(ContainerInterface $container, ControllerNameParser
*/
protected function createController($controller)
{
if (false === strpos($controller, '::') && 2 === substr_count($controller, ':')) {
if ($this->parser && false === strpos($controller, '::') && 2 === substr_count($controller, ':')) {
// controller in the a:b:c notation then
$deprecatedNotation = $controller;
$controller = $this->parser->parse($deprecatedNotation, false);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,12 @@ class ResolveControllerNameSubscriber implements EventSubscriberInterface
{
private $parser;

public function __construct(ControllerNameParser $parser)
public function __construct(ControllerNameParser $parser, bool $triggerDeprecation = true)
{
if ($triggerDeprecation) {
@trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.1.', __CLASS__), E_USER_DEPRECATED);
}

$this->parser = $parser;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@
</service>

<service id="routing.loader" class="Symfony\Bundle\FrameworkBundle\Routing\DelegatingLoader" public="true">
<argument type="service" id="controller_name_converter" />
<argument type="service" id="routing.resolver" />
<argument type="collection" />
<argument type="service" id=".legacy_controller_name_converter" /> <!-- deprecated since Symfony 4.4 -->
</service>

<service id="router.default" class="Symfony\Bundle\FrameworkBundle\Routing\Router">
Expand Down
18 changes: 14 additions & 4 deletions src/Symfony/Bundle/FrameworkBundle/Resources/config/web.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,21 @@
<services>
<defaults public="false" />

<service id="controller_name_converter" class="Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser">
<service id=".legacy_controller_name_converter" class="Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser">
<tag name="monolog.logger" channel="request" />
<argument type="service" id="kernel" />
<argument>false</argument>
</service>

<service id="controller_name_converter" alias=".legacy_controller_name_converter">
<deprecated>The "%alias_id%" service is deprecated since Symfony 4.3.</deprecated>< 8000 /td>
</service>

<service id="controller_resolver" class="Symfony\Bundle\FrameworkBundle\Controller\ControllerResolver">
<tag name="monolog.logger" channel="request" />
<argument type="service" id="service_container" />
<argument type="service" id="controller_name_converter" />
<argument type="service" id="logger" on-invalid="ignore" />
<argument type="service" id=".legacy_controller_name_converter" />
</service>

<service id="argument_metadata_factory" class="Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadataFactory" />
Expand Down Expand Up @@ -81,10 +86,15 @@
<tag name="kernel.event_subscriber" />
</service>

<service id="resolve_controller_name_subscriber" class="Symfony\Bundle\FrameworkBundle\EventListener\ResolveControllerNameSubscriber">
<argument type="service" id="controller_name_converter" />
<service id=".legacy_resolve_controller_name_subscriber" class="Symfony\Bundle\FrameworkBundle\EventListener\ResolveControllerNameSubscriber">
<argument type="service" id=".legacy_controller_name_converter" />
<argument>false</argument>
<tag name="kernel.event_subscriber" />
</service>
<service id="resolve_controller_name_subscriber" alias=".legacy_resolve_controller_name_subscriber">
<deprecated>The "%alias_id%" service is deprecated since Symfony 4.3.</deprecated>
</service>

<service id="disallow_search_engine_index_response_listener" class="Symfony\Component\HttpKernel\EventListener\DisallowRobotsIndexingListener">
<tag name="kernel.event_subscriber" />
</service>
Expand Down
23 changes: 18 additions & 5 deletions src/Symfony/Bundle/FrameworkBundle/Routing/DelegatingLoader.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,33 @@
* to the fully-qualified form (from a:b:c to class::method).
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @final since Symfony 4.4
*/
class DelegatingLoader extends BaseDelegatingLoader
{
/**
* @deprecated since Symfony 4.4
*/
protected $parser;
private $loading = false;
private $defaultOptions;

/**
* @param ControllerNameParser $parser A ControllerNameParser instance
* @param LoaderResolverInterface $resolver A LoaderResolverInterface instance
* @param LoaderResolverInterface $resolver
* @param array $defaultOptions
*/
public function __construct(ControllerNameParser $parser, LoaderResolverInterface $resolver, array $defaultOptions = [])
public function __construct($resolver, $defaultOptions = [])
{
$this->parser = $parser;
if ($resolver instanceof ControllerNameParser) {
@trigger_error(sprintf('Passing a "%s" instance as first argument to "%s()" is deprecated since Symfony 4.4, pass a "%s" instance instead.', ControllerNameParser::class, __METHOD__, LoaderResolverInterface::class), E_USER_DEPRECATED);
$this->parser = $resolver;
$resolver = $defaultOptions;
$defaultOptions = 2 < \func_num_args() ? func_get_arg(2) : [];
} elseif (2 < \func_num_args() && func_get_arg(2) instanceof ControllerNameParser) {
$this->parser = func_get_arg(2);
}

$this->defaultOptions = $defaultOptions;

parent::__construct($resolver);
Expand Down Expand Up @@ -86,7 +99,7 @@ public function load($resource, $type = null)
continue;
}

if (2 === substr_count($controller, ':')) {
if ($this->parser && 2 === substr_count($controller, ':')) {
$deprecatedNotation = $controller;

try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ public function testGetControllerWithBundleNotation()
->willReturn('Symfony\Bundle\FrameworkBundle\Tests\Controller\ContainerAwareController::testAction')
;

$resolver = $this->createControllerResolver(null, null, $parser);
$resolver = $this->createLegacyControllerResolver(null, null, $parser);
$request = Request::create('/');
$request->attributes->set('_controller', $shortName);

Expand Down Expand Up @@ -105,7 +105,7 @@ class_exists(AbstractControllerTest::class);
$container = new Container();
$container->set(TestAbstractController::class, $controller);

$resolver = $this->createControllerResolver(null, $container);
$resolver = $this->createLegacyControllerResolver(null, $container);

$request = Request::create('/');
$request->attributes->set('_controller', TestAbstractController::class.'::fooAction');
Expand All @@ -127,7 +127,7 @@ class_exists(AbstractControllerTest::class);
$container = new Container();
$container->set(DummyController::class, $controller);

$resolver = $this->createControllerResolver(null, $container);
$resolver = $this->createLegacyControllerResolver(null, $container);

$request = Request::create('/');
$request->attributes->set('_controller', DummyController::class.'::fooAction');
Expand Down Expand Up @@ -176,7 +176,7 @@ class_exists(AbstractControllerTest::class);
$this->assertSame($controllerContainer, $controller->getContainer());
}

protected function createControllerResolver(LoggerInterface $logger = null, Psr11ContainerInterface $container = null, ControllerNameParser $parser = null)
protected function createLegacyControllerResolver(LoggerInterface $logger = null, Psr11ContainerInterface $container = null, ControllerNameParser $parser = null)
{
if (!$parser) {
$parser = $this->createMockParser();
Expand All @@ -189,6 +189,15 @@ protected function createControllerResolver(LoggerInterface $logger = null, Psr1
return new ControllerResolver($container, $parser, $logger);
}

protected function createControllerResolver(LoggerInterface $logger = null, Psr11ContainerInterface $container = null)
{
if (!$container) {
$container = $this->createMockContainer();
}

return new ControllerResolver($container, $logger);
}

protected function createMockParser()
{
return $this->getMockBuilder('Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser')->disableOriginalConstructor()->getMock();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\HttpKernelInterface;

/**
* @group legacy
*/
class ResolveControllerNameSubscriberTest extends TestCase
{
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@

class DelegatingLoaderTest extends TestCase
{
/**
* @group legacy
* @expectedDeprecation Passing a "Symfony\Bundle\FrameworkBundle\Controller\ControllerNameParser" instance as first argument to "Symfony\Bundle\FrameworkBundle\Routing\DelegatingLoader::__construct()" is deprecated since Symfony 4.4, pass a "Symfony\Component\Config\Loader\LoaderResolverInterface" instance instead.
*/
public function testConstructorApi()
{
$controllerNameParser = $this->getMockBuilder(ControllerNameParser::class)
Expand All @@ -24,10 +28,6 @@ public function testConstructorApi()

public function testLoadDefaultOptions()
{
$controllerNameParser = $this->getMockBuilder(ControllerNameParser::class)
->disableOriginalConstructor()
->getMock();

$loaderResolver = $this->getMockBuilder(LoaderResolverInterface::class)
->disableOriginalConstructor()
->getMock();
Expand All @@ -46,7 +46,7 @@ public function testLoadDefaultOptions()
->method('load')
->willReturn($routeCollection);

$delegatingLoader = new DelegatingLoader($controllerNameParser, $loaderResolver, ['utf8' => true]);
$delegatingLoader = new DelegatingLoader($loaderResolver, ['utf8' => true]);

$loadedRouteCollection = $delegatingLoader->load('foo');
$this->assertCount(2, $loadedRouteCollection);
Expand Down
0