minor #322 [LiveComponent] Move defaultAction validation to compiler pass (norkunas)

This PR was merged into the 2.x branch.

Discussion
----------

[LiveComponent] Move defaultAction validation to compiler pass

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| Tickets       | N/A
| License       | MIT

Completes `todo` note which was in source code :)

Commits
-------

367da01 [LiveComponent] Move defaultAction validation to compiler pass

Author: weaverryan

src/LiveComponent/src/DependencyInjection/Compiler/ComponentDefaultActionPass.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * @author Kevin Bond <[email protected]>
+ *
+ * @experimental
+ *
+ * @internal
+ */
+final class ComponentDefaultActionPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container): void
+    {
+        foreach ($container->findTaggedServiceIds('twig.component') as $class => $component) {
+            if (!($component[0]['live'] ?? false)) {
+                continue;
+            }
+
+            $defaultAction = trim($component[0]['default_action'] ?? '__invoke', '()');
+
+            if (!method_exists($class, $defaultAction)) {
+                throw new \LogicException(sprintf('Live component "%s" (%s) requires the default action method "%s".%s', $class, $component[0]['key'], $defaultAction, '__invoke' === $defaultAction ? ' Either add this method or use the DefaultActionTrait' : ''));
+            }
+        }
+    }
+}

src/LiveComponent/src/EventListener/LiveComponentSubscriber.php

@@ -89,11 +89,6 @@ public function onKernelRequest(RequestEvent $event): void
         if ('get' === $action) {
             $defaultAction = trim($metadata->get('default_action', '__invoke'), '()');
 
-            if (!method_exists($metadata->getClass(), $defaultAction)) {
-                // todo should this check be in a compiler pass to ensure fails at compile time?
-                throw new \LogicException(sprintf('Live component "%s" (%s) requires the default action method "%s".%s', $metadata->getClass(), $componentName, $defaultAction, '__invoke' === $defaultAction ? ' Either add this method or use the DefaultActionTrait' : ''));
-            }
-
             // set default controller for "default" action
             $request->attributes->set('_controller', sprintf('%s::%s', $metadata->getServiceId(), $defaultAction));
             $request->attributes->set('_component_default_action', true);

src/LiveComponent/src/LiveComponentBundle.php

@@ -14,6 +14,7 @@
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
+use Symfony\UX\LiveComponent\DependencyInjection\Compiler\ComponentDefaultActionPass;
 use Symfony\UX\LiveComponent\DependencyInjection\Compiler\OptionalDependencyPass;
 
 /**
@@ -27,5 +28,6 @@ public function build(ContainerBuilder $container): void
     {
         // must run before Symfony\Component\Serializer\DependencyInjection\SerializerPass
         $container->addCompilerPass(new OptionalDependencyPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, 100);
+        $container->addCompilerPass(new ComponentDefaultActionPass());
     }
 }

src/LiveComponent/tests/Fixtures/Component/ComponentWithArrayProp.php

@@ -4,13 +4,16 @@
 
 use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\LiveComponent\Attribute\LiveProp;
+use Symfony\UX\LiveComponent\DefaultActionTrait;
 
 /**
  * @author Kevin Bond <[email protected]>
  */
 #[AsLiveComponent('component_with_array_prop')]
 final class ComponentWithArrayProp
 {
+    use DefaultActionTrait;
+
     #[LiveProp]
     public array $prop = [];
 }

src/LiveComponent/tests/Fixtures/Component/CustomAttributes.php

@@ -3,12 +3,13 @@
 namespace Symfony\UX\LiveComponent\Tests\Fixtures\Component;
 
 use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\LiveComponent\DefaultActionTrait;
 
 /**
  * @author Kevin Bond <[email protected]>
  */
 #[AsLiveComponent('custom_attributes', attributesVar: '_custom_attributes')]
 final class CustomAttributes
 {
-
+    use DefaultActionTrait;
 }