bug #1199 [TwigComponent] Fix twig:lint bug with anonymous component tag (smnandre)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[TwigComponent] Fix twig:lint bug with anonymous component tag

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| Tickets       | Fix #1089
| License       | MIT

Sincerely i'm not sure how to handle this properly "today"..

There is a lot of things i'd like to refactor in a future version, and the fact than auto-closing tags and classic ones are handled by two entirely different processes is at the top of my todo :)

But right now, i'm not sure we can do better than a quick patch, allowing the "lint:twig" to not crash for anonymous <twig:Foo></twig:Foo> tags.

Timeline of what "bugs":
- the lint:twig command find all templates, and for each one create an empty template loader, then parse & compile the template
- during the parsing, the ComponentParser calls [ComponentFactory::metadataFor](https://github.com/symfony/ux/blob/46d0b6885830b8cf546cd2c2479be2024f154ed3/src/TwigComponent/src/Twig/ComponentTokenParser.php#L50) to find the template matching the component name
- if no class-based component matches, the ComponentFactory calls the the [ComponentTemplateFinder](https://github.com/symfony/ux/blob/2.x/src/TwigComponent/src/ComponentTemplateFinder.php)
- the ComponentTemplateFinder then asks the Loader if a matching template exists
- but as the Loader is temporary "empty".... 🐞

So we must ether:
- A) stop resolving template during the parser/compiler work
- B) ensure the TemplateFinder always contains the real "full" loader
- C) change the way the lint:twig command works

A is my long-term objective, but clearly not "today".
C is not so easy, as the corresponding code is hidden between 3 private methods

So....  first suggestion (dirty but working)

Commits
-------

632954e [TwigComponent] Fix twig:lint bug with anonymous component tag

Author: weaverryan

src/TwigComponent/src/ComponentTemplateFinder.php

@@ -12,24 +12,32 @@
 namespace Symfony\UX\TwigComponent;
 
 use Twig\Environment;
+use Twig\Loader\LoaderInterface;
 
 /**
  * @author Matheo Daninos <matheo.daninos@gmail.com>
  */
 final class ComponentTemplateFinder implements ComponentTemplateFinderInterface
 {
+    private readonly LoaderInterface $loader;
+
     public function __construct(
-        private Environment $environment,
+        Environment|LoaderInterface $loader,
         private readonly ?string $directory = null,
     ) {
+        if ($loader instanceof Environment) {
+            trigger_deprecation('symfony/ux-twig-component', '2.13', 'The "%s()" method will require "%s $loader" as first argument in 3.0. Passing an "Environment" instance is deprecated.', __METHOD__, LoaderInterface::class);
+            $loader = $loader->getLoader();
+        }
+        $this->loader = $loader;
         if (null === $this->directory) {
             trigger_deprecation('symfony/ux-twig-component', '2.13', 'The "%s()" method will require "string $directory" argument in 3.0. Not defining it or passing null is deprecated.', __METHOD__);
         }
     }
 
     public function findAnonymousComponentTemplate(string $name): ?string
     {
-        $loader = $this->environment->getLoader();
+        $loader = $this->loader;
         $componentPath = rtrim(str_replace(':', '/', $name));
 
         // Legacy auto-naming rules < 2.13

src/TwigComponent/src/DependencyInjection/TwigComponentExtension.php

@@ -65,11 +65,9 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $container->register('ux.twig_component.component_template_finder', ComponentTemplateFinder::class)
             ->setArguments([
-                new Reference('twig'),
+                new Reference('twig.loader'),
                 $config['anonymous_template_directory'],
-            ])
-        ;
-
+            ]);
         $container->setAlias(ComponentRendererInterface::class, 'ux.twig_component.component_renderer');
 
         $container->registerAttributeForAutoconfiguration(
@@ -101,8 +99,6 @@ class_exists(AbstractArgument::class) ? new AbstractArgument(sprintf('Added in %
             ])
         ;
 
-        $container->register(ComponentTemplateFinder::class, 'ux.twig_component.component_template_finder');
-
         $container->register('ux.twig_component.twig.component_extension', ComponentExtension::class)
             ->addTag('twig.extension')
             ->addTag('container.service_subscriber', ['key' => ComponentRenderer::class, 'id' => 'ux.twig_component.component_renderer'])

src/TwigComponent/tests/Unit/ComponentTemplateFinderTest.php

@@ -16,6 +16,7 @@
 use Symfony\UX\TwigComponent\ComponentTemplateFinder;
 use Twig\Environment;
 use Twig\Loader\ArrayLoader;
+use Twig\Loader\LoaderInterface;
 
 /**
  * @author Simon André <smn.andre@gmail.com>
@@ -36,8 +37,8 @@ public function testFindTemplate(): void
             'components/b.html.twig',
             'components/c',
         ];
-        $environment = $this->createEnvironment($templates);
-        $finder = new ComponentTemplateFinder($environment, 'components');
+        $loader = $this->createLoader($templates);
+        $finder = new ComponentTemplateFinder($loader, 'components');
 
         $this->assertEquals('components/aa.html.twig', $finder->findAnonymousComponentTemplate('aa'));
         $this->assertEquals('components/aa/bb.html.twig', $finder->findAnonymousComponentTemplate('aa:bb'));
@@ -84,6 +85,17 @@ public function testFindTemplateWithLegacyAutonaming(): void
         $this->assertNull($finder->findAnonymousComponentTemplate('nope:bar'));
     }
 
+    /**
+     * @group legacy
+     */
+    public function testTriggerDeprecationWhenEnvironmentAsFirstArgument(): void
+    {
+        $environment = $this->createEnvironment([]);
+
+        $this->expectDeprecation('Since symfony/ux-twig-component 2.13: The "Symfony\UX\TwigComponent\ComponentTemplateFinder::__construct()" method will require "Twig\Loader\LoaderInterface $loader" as first argument in 3.0. Passing an "Environment" instance is deprecated.');
+        $finder = new ComponentTemplateFinder($environment, 'foo');
+    }
+
     /**
      * @group legacy
      */
@@ -106,18 +118,21 @@ public function testFindTemplateWithinDirectory(): void
             'bar/foo/bar.html.twig',
             'foo/foo/bar.html.twig',
         ];
-        $environment = $this->createEnvironment($templates);
-        $finder = new ComponentTemplateFinder($environment, 'foo');
+        $loader = $this->createLoader($templates);
+        $finder = new ComponentTemplateFinder($loader, 'foo');
 
         $this->assertEquals('foo/bar.html.twig', $finder->findAnonymousComponentTemplate('bar'));
         $this->assertEquals('foo/foo/bar.html.twig', $finder->findAnonymousComponentTemplate('foo:bar'));
         $this->assertEquals('foo/foo/bar.html.twig', $finder->findAnonymousComponentTemplate('foo:bar'));
     }
 
-    private function createEnvironment(array $templates): Environment
+    private function createLoader(array $templates): LoaderInterface
     {
-        $loader = new ArrayLoader(array_combine($templates, $templates));
+        return new ArrayLoader(array_combine($templates, $templates));
+    }
 
-        return new Environment($loader);
+    private function createEnvironment(array $templates): Environment
+    {
+        return new Environment($this->createLoader($templates));
     }
 }