Skip to content

[DependencyInjection] Ensure Definition::getTags() contains a list of attributes for each tag #62683

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
GromNaN wants to merge 2 commits into from
Closed

[DependencyInjection] Ensure Definition::getTags() contains a list of attributes for each tag #62683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d36d4f
[DependencyInjection] Ensure Definition::getTags() contains a list of…
GromNaN Dec 7, 2025
08da57b
Fix tags set in DecoratorServicePassTest
GromNaN Dec 7, 2025
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
2 changes: 1 addition & 1 deletion src/Symfony/Component/DependencyInjection/Definition.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@ public function isAutoconfigured(): bool
*/
public function setTags(array $tags): static
{
$this->tags = $tags;
$this->tags = array_map('array_values', $tags);

return $this;
}
Expand Down
30 changes: 15 additions & 15 deletions src/Symfony/Component/DependencyInjection/Tests/Compiler/DecoratorServicePassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,18 +187,18 @@ public function testProcessMovesTagsFromDecoratedDefinitionToDecoratingDefinitio
$container = new ContainerBuilder();
$container
->register('foo')
->setTags(['bar' => ['attr' => 'baz']])
->setTags(['bar' => [['attr' => 'baz']]])
;
$container
->register('baz')
->setTags(['foobar' => ['attr' => 'bar']])
->setTags(['foobar' => [['attr' => 'bar']]])
->setDecoratedService('foo')
;

$this->process($container);

$this->assertEmpty($container->getDefinition('baz.inner')->getTags());
$this->assertEquals(['bar' => ['attr' => 'baz'], 'foobar' => ['attr' => 'bar'], 'container.decorator' => [['id' => 'foo', 'inner' => 'baz.inner']]], $container->getDefinition('baz')->getTags());
$this->assertEquals(['bar' => [['attr' => 'baz']], 'foobar' => [['attr' => 'bar']], 'container.decorator' => [['id' => 'foo', 'inner' => 'baz.inner']]], $container->getDefinition('baz')->getTags());
}

public function testProcessMovesTagsFromDecoratedDefinitionToDecoratingDefinitionMultipleTimes()
Expand All @@ -207,7 +207,7 @@ public function testProcessMovesTagsFromDecoratedDefinitionToDecoratingDefinitio
$container
->register('foo')
->setPublic(true)
->setTags(['bar' => ['attr' => 'baz']])
->setTags(['bar' => [['attr' => 'baz']]])
;
$container
->register('deco1')
Expand All @@ -221,64 +221,64 @@ public function testProcessMovesTagsFromDecoratedDefinitionToDecoratingDefinitio
$this->process($container);

$this->assertEmpty($container->getDefinition('deco1')->getTags());
$this->assertEquals(['bar' => ['attr' => 'baz'], 'container.decorator' => [['id' => 'foo', 'inner' => 'deco1.inner']]], $container->getDefinition('deco2')->getTags());
$this->assertEquals(['bar' => [['attr' => 'baz']], 'container.decorator' => [['id' => 'foo', 'inner' => 'deco1.inner']]], $container->getDefinition('deco2')->getTags());
}

public function testProcessLeavesServiceLocatorTagOnOriginalDefinition()
{
$container = new ContainerBuilder();
$container
->register('foo')
->setTags(['container.service_locator' => [0 => []], 'bar' => ['attr' => 'baz']])
->setTags(['container.service_locator' => [0 => []], 'bar' => [['attr' => 'baz']]])
;
$container
->register('baz')
->setTags(['foobar' => ['attr' => 'bar']])
->setTags(['foobar' => [['attr' => 'bar']]])
->setDecoratedService('foo')
;

$this->process($container);

$this->assertEquals(['container.service_locator' => [0 => []]], $container->getDefinition('baz.inner')->getTags());
$this->assertEquals(['bar' => ['attr' => 'baz'], 'foobar' => ['attr' => 'bar'], 'container.decorator' => [['id' => 'foo', 'inner' => 'baz.inner']]], $container->getDefinition('baz')->getTags());
$this->assertEquals(['bar' => [['attr' => 'baz']], 'foobar' => [['attr' => 'bar']], 'container.decorator' => [['id' => 'foo', 'inner' => 'baz.inner']]], $container->getDefinition('baz')->getTags());
}

public function testProcessLeavesServiceSubscriberTagOnOriginalDefinition()
{
$container = new ContainerBuilder();
$container
->register('foo')
->setTags(['container.service_subscriber' => [], 'container.service_subscriber.locator' => [], 'bar' => ['attr' => 'baz']])
->setTags(['container.service_subscriber' => [], 'container.service_subscriber.locator' => [], 'bar' => [['attr' => 'baz']]])
;
$container
->register('baz')
->setTags(['foobar' => ['attr' => 'bar']])
->setTags(['foobar' => [['attr' => 'bar']]])
->setDecoratedService('foo')
;

$this->process($container);

$this->assertEquals(['container.service_subscriber' => [], 'container.service_subscriber.locator' => []], $container->getDefinition('baz.inner')->getTags());
$this->assertEquals(['bar' => ['attr' => 'baz'], 'foobar' => ['attr' => 'bar'], 'container.decorator' => [['id' => 'foo', 'inner' => 'baz.inner']]], $container->getDefinition('baz')->getTags());
$this->assertEquals(['bar' => [['attr' => 'baz']], 'foobar' => [['attr' => 'bar']], 'container.decorator' => [['id' => 'foo', 'inner' => 'baz.inner']]], $container->getDefinition('baz')->getTags());
}

public function testProcessLeavesProxyTagOnOriginalDefinition()
{
$container = new ContainerBuilder();
$container
->register('foo')
->setTags(['proxy' => 'foo', 'bar' => ['attr' => 'baz']])
->setTags(['proxy' => ['foo'], 'bar' => [['attr' => 'baz']]])
;
$container
->register('baz')
->setTags(['foobar' => ['attr' => 'bar']])
->setTags(['foobar' => [['attr' => 'bar']]])
->setDecoratedService('foo')
;

$this->process($container);

$this->assertEquals(['proxy' => 'foo'], $container->getDefinition('baz.inner')->getTags());
$this->assertEquals(['bar' => ['attr' => 'baz'], 'foobar' => ['attr' => 'bar'], 'container.decorator' => [['id' => 'foo', 'inner' => 'baz.inner']]], $container->getDefinition('baz')->getTags());
$this->assertEquals(['proxy' => ['foo']], $container->getDefinition('baz.inner')->getTags());
$this->assertEquals(['bar' => [['attr' => 'baz']], 'foobar' => [['attr' => 'bar']], 'container.decorator' => [['id' => 'foo', 'inner' => 'baz.inner']]], $container->getDefinition('baz')->getTags());
}

public function testCannotDecorateSyntheticService()
Expand Down
13 changes: 13 additions & 0 deletions src/Symfony/Component/DependencyInjection/Tests/DefinitionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,19 @@ public function testSetGetConfigurator()
$this->assertEquals('foo', $def->getConfigurator(), '->getConfigurator() returns the configurator');
}

public function testSetTagsAreInList()
{
$def = new Definition('stdClass');
$def->setTags([
'tag1' => [5 => ['attr1' => 'value1'], 3 => []],
'tag2' => [1 => ['attr2' => 'value2']],
]);
$this->assertSame([
'tag1' => [['attr1' => 'value1'], []],
'tag2' => [['attr2' => 'value2']],
], $def->getTags(), '->setTags() reindex the tags arrays');
}

public function testClearTags()
{
$def = new Definition('stdClass');
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Translation/Tests/DependencyInjection/TranslationPathsPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public function testProcess()
->setArguments([null, null, null, null, null, null, [], []])
;
$container->register(ControllerArguments::class, ControllerArguments::class)
->setTags(['controller.service_arguments'])
->setTags(['controller.service_arguments' => []])
Copy link
Member Author

@GromNaN GromNaN Dec 7, 2025

Choose a reason for hiding this comment

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

It seems to me to be a breaking change if people inject random values via
Definition::setTags() and expect to retrieve these values with Definition::getTags().

;
$container->register(ServiceArguments::class, ServiceArguments::class)
->setArguments([new Reference('translator')])
Expand Down
Loading