[Live] add batch action controller

kbond · weaverryan · commit b47ece1d2d84 · 2022-09-27T10:28:35.000-04:00
diff --git a/src/LiveComponent/src/Controller/BatchActionController.php b/src/LiveComponent/src/Controller/BatchActionController.php
@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Controller;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\UX\TwigComponent\MountedComponent;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ *
+ * @internal
+ */
+final class BatchActionController
+{
+    public function __construct(private HttpKernelInterface $kernel)
+    {
+    }
+
+    public function __invoke(Request $request, MountedComponent $mounted, string $serviceId, array $actions): ?Response
+    {
+        $request->attributes->set('_mounted_component', $mounted);
+
+        foreach ($actions as $action) {
+            $name = $action['name'] ?? throw new BadRequestHttpException('Invalid JSON');
+
+            $subRequest = $request->duplicate(attributes: [
+                '_controller' => [$serviceId, $name],
+                '_component_action_args' => $action['args'] ?? [],
+                '_mounted_component' => $mounted,
+                '_route' => 'live_component',
+            ]);
+
+            $response = $this->kernel->handle($subRequest, HttpKernelInterface::SUB_REQUEST, false);
+
+            if ($response->isRedirection()) {
+                return $response;
+            }
+        }
+
+        return null;
+    }
+}
diff --git a/src/LiveComponent/src/DependencyInjection/LiveComponentExtension.php b/src/LiveComponent/src/DependencyInjection/LiveComponentExtension.php
@@ -20,6 +20,7 @@
 use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\LiveComponent\ComponentValidator;
 use Symfony\UX\LiveComponent\ComponentValidatorInterface;
+use Symfony\UX\LiveComponent\Controller\BatchActionController;
 use Symfony\UX\LiveComponent\EventListener\AddLiveAttributesSubscriber;
 use Symfony\UX\LiveComponent\EventListener\LiveComponentSubscriber;
 use Symfony\UX\LiveComponent\Form\Type\LiveCollectionType;
@@ -70,6 +71,13 @@ function (ChildDefinition $definition, AsLiveComponent $attribute) {
             ])
         ;
 
+        $container->register('ux.live_component.batch_action_controller', BatchActionController::class)
+            ->setPublic(true)
+            ->setArguments([
+                new Reference('http_kernel'),
+            ])
+        ;
+
         $container->register('ux.live_component.event_subscriber', LiveComponentSubscriber::class)
             ->addTag('kernel.event_subscriber')
             ->addTag('container.service_subscriber', ['key' => ComponentFactory::class, 'id' => 'ux.twig_component.component_factory'])
diff --git a/src/LiveComponent/src/EventListener/LiveComponentSubscriber.php b/src/LiveComponent/src/EventListener/LiveComponentSubscriber.php
@@ -29,6 +29,7 @@
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
 use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
 use Symfony\UX\LiveComponent\Attribute\LiveArg;
+use Symfony\UX\LiveComponent\Controller\BatchActionController;
 use Symfony\UX\LiveComponent\LiveComponentHydrator;
 use Symfony\UX\TwigComponent\ComponentFactory;
 use Symfony\UX\TwigComponent\ComponentMetadata;
@@ -69,6 +70,11 @@ public function onKernelRequest(RequestEvent $event): void
             return;
         }
 
+        if (!$event->isMainRequest()) {
+            // sub request
+            return;
+        }
+
         // the default "action" is get, which does nothing
         $action = $request->get('action', 'get');
         $componentName = (string) $request->get('component');
@@ -107,6 +113,22 @@ public function onKernelRequest(RequestEvent $event): void
             throw new BadRequestHttpException('Invalid CSRF token.');
         }
 
+        if ('_batch' === $action) {
+            // use batch controller
+            $data = $this->parseDataFor($request);
+
+            $request->attributes->set('_controller', 'ux.live_component.batch_action_controller');
+            $request->attributes->set('serviceId', $metadata->getServiceId());
+            $request->attributes->set('actions', $data['actions']);
+            $request->attributes->set('mounted', $this->container->get(LiveComponentHydrator::class)->hydrate(
+                $this->container->get(ComponentFactory::class)->get($componentName),
+                $data['data'],
+                $componentName,
+            ));
+
+            return;
+        }
+
         $request->attributes->set('_controller', sprintf('%s::%s', $metadata->getServiceId(), $action));
     }
 
@@ -118,18 +140,13 @@ public function onKernelController(ControllerEvent $event): void
             return;
         }
 
-        $actionArguments = [];
-        if ($request->query->has('data')) {
-            // ?data=
-            $data = json_decode($request->query->get('data'), true, 512, \JSON_THROW_ON_ERROR);
-        } else {
-            // OR body of the request is JSON
-            $requestData = json_decode($request->getContent(), true, 512, \JSON_THROW_ON_ERROR);
-            $data = $requestData['data'] ?? [];
-            $actionArguments = $requestData['args'] ?? [];
+        $controller = $event->getController();
+
+        if ($controller instanceof BatchActionController) {
+            return;
         }
 
-        if (!\is_array($controller = $event->getController()) || 2 !== \count($controller)) {
+        if (!\is_array($controller) || 2 !== \count($controller)) {
             throw new \RuntimeException('Not a valid live component.');
         }
 
@@ -143,13 +160,21 @@ public function onKernelController(ControllerEvent $event): void
             throw new NotFoundHttpException(sprintf('The action "%s" either doesn\'t exist or is not allowed in "%s". Make sure it exist and has the LiveAction attribute above it.', $action, \get_class($component)));
         }
 
-        $mounted = $this->container->get(LiveComponentHydrator::class)->hydrate(
-            $component,
-            $data,
-            $request->attributes->get('_component_name')
-        );
+        if ($event->isMainRequest()) {
+            $data = $this->parseDataFor($request);
+
+            $request->attributes->set('_component_action_args', $data['args']);
+            $request->attributes->set('_mounted_component', $this->container->get(LiveComponentHydrator::class)->hydrate(
+                $component,
+                $data['data'],
+                $request->attributes->get('_component_name')
+            ));
+        } else {
+            // sub-request
+            $event->setController([$request->attributes->get('_mounted_component')->getComponent(), $action]);
+        }
 
-        $request->attributes->set('_mounted_component', $mounted);
+        $actionArguments = $request->attributes->get('_component_action_args', []);
 
         // extra variables to be made available to the controller
         // (for "actions" only)
@@ -160,12 +185,45 @@ public function onKernelController(ControllerEvent $event): void
         }
     }
 
+    /**
+     * @return array{
+     *     data: array,
+     *     args: array,
+     *     actions: array
+     * }
+     */
+    private function parseDataFor(Request $request): array
+    {
+        if ($request->query->has('data')) {
+            return [
+                'data' => json_decode($request->query->get('data'), true, 512, \JSON_THROW_ON_ERROR),
+                'args' => [],
+                'actions' => [],
+            ];
+        }
+
+        $requestData = json_decode($request->getContent(), true, 512, \JSON_THROW_ON_ERROR);
+
+        return [
+            'data' => $requestData['data'] ?? [],
+            'args' => $requestData['args'] ?? [],
+            'actions' => $requestData['actions'] ?? [],
+        ];
+    }
+
     public function onKernelView(ViewEvent $event): void
     {
         if (!$this->isLiveComponentRequest($request = $event->getRequest())) {
             return;
         }
 
+        if (!$event->isMainRequest()) {
+            // sub-request, so skip rendering
+            $event->setResponse(new Response());
+
+            return;
+        }
+
         $event->setResponse($this->createResponse($request->attributes->get('_mounted_component')));
     }
 
diff --git a/src/LiveComponent/tests/Fixtures/Component/WithActions.php b/src/LiveComponent/tests/Fixtures/Component/WithActions.php
@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\LiveComponent\Tests\Fixtures\Component;
+
+use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
+use Symfony\UX\LiveComponent\Attribute\LiveAction;
+use Symfony\UX\LiveComponent\Attribute\LiveArg;
+use Symfony\UX\LiveComponent\Attribute\LiveProp;
+use Symfony\UX\LiveComponent\DefaultActionTrait;
+
+#[AsLiveComponent('with_actions')]
+final class WithActions
+{
+    use DefaultActionTrait;
+
+    #[LiveProp]
+    public array $items = ['initial'];
+
+    #[LiveAction]
+    public function add(#[LiveArg] string $what, UrlGeneratorInterface $router): void
+    {
+        $this->items[] = $what;
+    }
+
+    #[LiveAction]
+    public function redirect(UrlGeneratorInterface $router): RedirectResponse
+    {
+        return new RedirectResponse($router->generate('homepage'));
+    }
+
+    #[LiveAction]
+    public function exception(): void
+    {
+        throw new \RuntimeException('Exception message');
+    }
+
+    public function nonLive(): void
+    {
+    }
+}
diff --git a/src/LiveComponent/tests/Fixtures/templates/components/with_actions.html.twig b/src/LiveComponent/tests/Fixtures/templates/components/with_actions.html.twig
@@ -0,0 +1,5 @@
+<ul{{ attributes }}>
+    {% for item in items %}
+        <li>{{ item }}</li>
+    {% endfor %}
+</ul>
diff --git a/src/LiveComponent/tests/Functional/Controller/BatchActionControllerTest.php b/src/LiveComponent/tests/Functional/Controller/BatchActionControllerTest.php
