feature symfony#59088 [DependencyInjection] Make #[AsTaggedItem] repeatable (alexandre-daubois)

This PR was merged into the 7.3 branch.

Discussion
----------

[DependencyInjection] Make `#[AsTaggedItem]` repeatable

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | Fix symfony#59085
| License       | MIT

Allow to repeat the `AsTaggedItem` attribute:

```php
#[AsTaggedItem(index: 'multi_hello_1', priority: 1)]
#[AsTaggedItem(index: 'multi_hello_2', priority: 2)]
class MultiTagHelloNamedService
{
}
```

Commits
-------

34e3466 [DependencyInjection] Make `#[AsTaggedItem]` repeatable

Author: fabpot

src/Symfony/Component/DependencyInjection/Attribute/AsTaggedItem.php

@@ -16,7 +16,7 @@
  *
  * @author Nicolas Grekas <[email protected]>
  */
-#[\Attribute(\Attribute::TARGET_CLASS)]
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
 class AsTaggedItem
 {
     /**

src/Symfony/Component/DependencyInjection/CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Make `#[AsTaggedItem]` repeatable
+
 7.2
 ---
 

src/Symfony/Component/DependencyInjection/Compiler/PriorityTaggedServiceTrait.php

@@ -92,6 +92,21 @@ private function findAndSortTaggedServices(string|TaggedIteratorArgument $tagNam
 
                 $services[] = [$priority, ++$i, $index, $serviceId, $class];
             }
+
+            if ($class) {
+                $attributes = (new \ReflectionClass($class))->getAttributes(AsTaggedItem::class);
+                $attributeCount = \count($attributes);
+
+                foreach ($attributes as $attribute) {
+                    $instance = $attribute->newInstance();
+
+                    if (!$instance->index && 1 < $attributeCount) {
+                        throw new InvalidArgumentException(\sprintf('Attribute "%s" on class "%s" cannot have an empty index when repeated.', AsTaggedItem::class, $class));
+                    }
+
+                    $services[] = [$instance->priority ?? 0, ++$i, $instance->index ?? $serviceId, $serviceId, $class];
+                }
+            }
         }
 
         uasort($services, static fn ($a, $b) => $b[0] <=> $a[0] ?: $a[1] <=> $b[1]);

src/Symfony/Component/DependencyInjection/Tests/Compiler/PriorityTaggedServiceTraitTest.php

@@ -218,6 +218,9 @@ public function testTaggedItemAttributes()
         $container->register('service5', HelloNamedService2::class)
             ->setAutoconfigured(true)
             ->addTag('my_custom_tag');
+        $container->register('service6', MultiTagHelloNamedService::class)
+            ->setAutoconfigured(true)
+            ->addTag('my_custom_tag');
 
         (new ResolveInstanceofConditionalsPass())->process($container);
 
@@ -226,14 +229,33 @@ public function testTaggedItemAttributes()
         $tag = new TaggedIteratorArgument('my_custom_tag', 'foo', 'getFooBar', exclude: ['service4', 'service5']);
         $expected = [
             'service3' => new TypedReference('service3', HelloNamedService2::class),
+            'multi_hello_2' => new TypedReference('service6', MultiTagHelloNamedService::class),
             'hello' => new TypedReference('service2', HelloNamedService::class),
+            'multi_hello_1' => new TypedReference('service6', MultiTagHelloNamedService::class),
             'service1' => new TypedReference('service1', FooTagClass::class),
         ];
+
         $services = $priorityTaggedServiceTraitImplementation->test($tag, $container);
         $this->assertSame(array_keys($expected), array_keys($services));
         $this->assertEquals($expected, $priorityTaggedServiceTraitImplementation->test($tag, $container));
     }
 
+    public function testTaggedItemAttributesRepeatedWithoutNameThrows()
+    {
+        $container = new ContainerBuilder();
+        $container->register('service1', MultiNoNameTagHelloNamedService::class)
+            ->setAutoconfigured(true)
+            ->addTag('my_custom_tag');
+
+        (new ResolveInstanceofConditionalsPass())->process($container);
+        $tag = new TaggedIteratorArgument('my_custom_tag', 'foo', 'getFooBar', exclude: ['service4', 'service5']);
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Attribute "Symfony\Component\DependencyInjection\Attribute\AsTaggedItem" on class "Symfony\Component\DependencyInjection\Tests\Compiler\MultiNoNameTagHelloNamedService" cannot have an empty index when repeated.');
+
+        (new PriorityTaggedServiceTraitImplementation())->test($tag, $container);
+    }
+
     public function testResolveIndexedTags()
     {
         $container = new ContainerBuilder();
@@ -283,6 +305,18 @@ class HelloNamedService2
 {
 }
 
+#[AsTaggedItem(index: 'multi_hello_1', priority: 1)]
+#[AsTaggedItem(index: 'multi_hello_2', priority: 2)]
+class MultiTagHelloNamedService
+{
+}
+
+#[AsTaggedItem(priority: 1)]
+#[AsTaggedItem(priority: 2)]
+class MultiNoNameTagHelloNamedService
+{
+}
+
 interface HelloInterface
 {
     public static function getFooBar(): string;