10000 [DependencyInjection] autoconfigure behavior describing tags on decorators by xabbuh · Pull Request #38999 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[DependencyInjection] autoconfigure behavior describing tags on decorators #38999

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

Merged
merged 1 commit into from
Nov 13, 2020
Merged

[DependencyInjection] autoconfigure behavior describing tags on decorators #38999

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
8 changes: 8 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,14 @@ public function load(array $configs, ContainerBuilder $container)

$container->registerForAutoconfiguration(RouteLoaderInterface::class)
->addTag('routing.route_loader');

$container->setParameter('container.behavior_describing_tags', [
'container.service_locator',
'container.service_subscriber',
'kernel.event_subscriber',
'kernel.locale_aware',
'kernel.reset',
]);
}

/**
Expand Down
14 changes: 14 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1656,6 +1656,20 @@ public function testMailer(string $configFile, array $expectedTransports): void
$this->assertSame(['redirected@example.org', 'redirected1@example.org'], $l->getArgument(1));
}

public function testRegisterParameterCollectingBehaviorDescribingTags()
{
$container = $this->createContainerFromFile('default_config');

$this->assertTrue($container->hasParameter('container.behavior_describing_tags'));
$this->assertEquals([
'container.service_locator',
'container.service_subscriber',
'kernel.event_subscriber',
'kernel.locale_aware',
'kernel.reset',
], $container->getParameter('container.behavior_describing_tags'));
}

protected function createContainer(array $data = [])
{
return new ContainerBuilder(new EnvPlaceholderParameterBag(array_merge([
Expand Down
22 changes: 16 additions & 6 deletions src/Symfony/Component/DependencyInjection/Compiler/ResolveInstanceofConditionalsPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,26 @@ public function process(ContainerBuilder $container)
}
}

$tagsToKeep = [];

if ($container->hasParameter('container.behavior_describing_tags')) {
$tagsToKeep = $container->getParameter('container.behavior_describing_tags');
}

foreach ($container->getDefinitions() as $id => $definition) {
if ($definition instanceof ChildDefinition) {
// don't apply "instanceof" to children: it will be applied to their parent
continue;
}
$container->setDefinition($id, $this->processDefinition($container, $id, $definition));
$container->setDefinition($id, $this->processDefinition($container, $id, $definition, $tagsToKeep));
}

if ($container->hasParameter('container.behavior_describing_tags')) {
$container->getParameterBag()->remove('container.behavior_describing_tags');
}
}

private function processDefinition(ContainerBuilder $container, string $id, Definition $definition): Definition
private function processDefinition(ContainerBuilder $container, string $id, Definition $definition, array $tagsToKeep): Definition
{
$instanceofConditionals = $definition->getInstanceofConditionals();
$autoconfiguredInstanceof = $definition->isAutoconfigured() ? $container->getAutoconfiguredInstanceof() : [];
Expand Down Expand Up @@ -115,10 +125,10 @@ private function processDefinition(ContainerBuilder $container, string $id, Defi
}

// Don't add tags to service decorators
if (null === $definition->getDecoratedService()) {
$i = \count($instanceofTags);
while (0 <= --$i) {
foreach ($instanceofTags[$i] as $k => $v) {
$i = \count($instanceofTags);
while (0 <= --$i) {
foreach ($instanceofTags[$i] as $k => $v) {
if (null === $definition->getDecoratedService() || \in_array($k, $tagsToKeep, true)) {
foreach ($v as $v) {
if ($definition->hasTag($k) && \in_array($v, $definition->getTag($k))) {
continue;
Expand Down
60 changes: 60 additions & 0 deletions ...ny/Component/DependencyInjection/Tests/Compiler/ResolveInstanceofConditionalsPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@
name 8000 space Symfony\Component\DependencyInjection\Tests\Compiler;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Config\Resource\ResourceInterface;
use Symfony\Component\Config\ResourceCheckerInterface;
use Symfony\Component\DependencyInjection\Argument\BoundArgument;
use Symfony\Component\DependencyInjection\ChildDefinition;
use Symfony\Component\DependencyInjection\Compiler\ResolveChildDefinitionsPass;
use Symfony\Component\DependencyInjection\Compiler\ResolveInstanceofConditionalsPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Contracts\Service\ResetInterface;
use Symfony\Contracts\Service\ServiceSubscriberInterface;

class ResolveInstanceofConditionalsPassTest extends TestCase
{
Expand Down Expand Up @@ -325,4 +329,60 @@ public function testDecoratorsAreNotAutomaticallyTagged()

$this->assertSame(['manual' => [[]]], $container->getDefinition('decorator')->getTags());
}

public function testDecoratorsKeepBehaviorDescribingTags()
{
$container = new ContainerBuilder();

$container->setParameter('container.behavior_describing_tags', [
'container.service_subscriber',
'kernel.reset',
]);

$container->register('decorator', DecoratorWithBehavior::class)
->setAutoconfigured(true)
->setDecoratedService('decorated')
;

$container->registerForAutoconfiguration(ResourceCheckerInterface::class)
->addTag('config_cache.resource_checker')
;
$container->registerForAutoconfiguration(ServiceSubscriberInterface::class)
->addTag('container.service_subscriber')
;
$container->registerForAutoconfiguration(ResetInterface::class)
->addTag('kernel.reset', ['method' => 'reset'])
;

(new ResolveInstanceofConditionalsPass())->process($container);

$this->assertEquals([
'container.service_subscriber' => [0 => []],
'kernel.reset' => [
[
'method' => 'reset',
],
],
], $container->getDefinition('decorator')->getTags());
$this->assertFalse($container->hasParameter('container.behavior_describing_tags'));
}
}

class DecoratorWithBehavior implements ResetInterface, ResourceCheckerInterface, ServiceSubscriberInterface
{
public function reset()
{
}

public function supports(ResourceInterface $metadata)
{
}

public function isFresh(ResourceInterface $resource, $timestamp)
{
}

public static function getSubscribedServices()
{
}
}
0