Adding an exception in case of a conflict

Author: weaverryan

src/TwigComponent/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 -   `true` attribute values now render just the attribute name, `false` excludes it entirely.
 
+-   The first argument to ``AsTwigComponent`` is now optional and defaults to the class name.
+
 ## 2.7.0
 
 -   `PreMount` and `PostMount` hooks can now return nothing.

src/TwigComponent/src/DependencyInjection/Compiler/TwigComponentPass.php

@@ -14,6 +14,7 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\DependencyInjection\Reference;
 
 /**
@@ -28,6 +29,7 @@ public function process(ContainerBuilder $container): void
         $componentConfig = [];
 
         $componentReferences = [];
+        $componentNames = [];
         foreach ($container->findTaggedServiceIds('twig.component') as $id => $tags) {
             $definition = $container->findDefinition($id);
 
@@ -37,14 +39,19 @@ public function process(ContainerBuilder $container): void
             foreach ($tags as $tag) {
                 if (!\array_key_exists('key', $tag)) {
                     $fqcn = $definition->getClass();
-                    $tag['key'] = substr($fqcn, strrpos($fqcn, '\\') + 1);
+                    $name = substr($fqcn, strrpos($fqcn, '\\') + 1);
+                    if (\in_array($name, $componentNames, true)) {
+                        throw new LogicException(sprintf('Failed creating the "%s" component with the automatic name "%s": another component already has this name. To fix this, give the component an explicit name (hint: using "%s" will override the existing component).', $fqcn, $name, $name));
+                    }
+                    $tag['key'] = $name;
                 }
 
                 $tag['service_id'] = $id;
                 $tag['class'] = $definition->getClass();
                 $tag['template'] = $tag['template'] ?? sprintf('components/%s.html.twig', str_replace(':', '/', $tag['key']));
                 $componentConfig[$tag['key']] = $tag;
                 $componentReferences[$tag['key']] = new Reference($id);
+                $componentNames[] = $tag['key'];
             }
         }
 

src/TwigComponent/tests/Fixtures/Kernel.php

@@ -63,5 +63,17 @@ protected function configureContainer(ContainerConfigurator $c): void
                 ->tag('twig.component')
             ;
         }
+
+        if ('missing_key_with_collision' === $this->environment) {
+            $services->set('component_b_1', ComponentB::class)
+                ->tag('twig.component', [
+                    'key' => 'ComponentB',
+                ])
+            ;
+            // this will try to reuse the same ComponentB name
+            $services->set('component_b_2', ComponentB::class)
+                ->tag('twig.component')
+            ;
+        }
     }
 }

src/TwigComponent/tests/Integration/ComponentFactoryTest.php

@@ -12,6 +12,7 @@
 namespace Symfony\UX\TwigComponent\Tests\Integration;
 
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\UX\TwigComponent\ComponentFactory;
 use Symfony\UX\TwigComponent\Tests\Fixtures\Component\ComponentA;
 use Symfony\UX\TwigComponent\Tests\Fixtures\Component\ComponentB;
@@ -117,6 +118,16 @@ public function testTwigComponentServiceTagWithoutKeyUsesShortClassName(): void
         self::assertInstanceOf(ComponentB::class, $component);
     }
 
+    public function testTwigComponentServiceTagWithoutKeyButCollissionCausesAnException(): void
+    {
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('Failed creating the "Symfony\UX\TwigComponent\Tests\Fixtures\Component\ComponentB" component with the automatic name "ComponentB": another component already has this name. To fix this, give the component an explicit name (hint: using "ComponentB" will override the existing component).');
+
+        self::bootKernel(['environment' => 'missing_key_with_collision']);
+        $component = $this->createComponent('ComponentB');
+        self::assertInstanceOf(ComponentB::class, $component);
+    }
+
     public function testCanGetMetadataForComponentByName(): void
     {
         $metadata = $this->factory()->metadataFor('component_a');