Send live action arguments to backend

Author: norkunas

src/LiveComponent/assets/dist/live_controller.js

@@ -1070,7 +1070,7 @@ class default_1 extends Controller {
         directives.forEach((directive) => {
             const _executeAction = () => {
                 this._clearWaitingDebouncedRenders();
-                this._makeRequest(directive.action);
+                this._makeRequest(directive.action, directive.named);
             };
             let handled = false;
             directive.modifiers.forEach((modifier) => {
@@ -1162,11 +1162,14 @@ class default_1 extends Controller {
             }, this.debounceValue || DEFAULT_DEBOUNCE);
         }
     }
-    _makeRequest(action) {
+    _makeRequest(action, values) {
         const splitUrl = this.urlValue.split('?');
         let [url] = splitUrl;
         const [, queryString] = splitUrl;
         const params = new URLSearchParams(queryString || '');
+        if (typeof values === 'object' && Object.keys(values).length > 0) {
+            params.set('values', new URLSearchParams(values).toString());
+        }
         const fetchOptions = {};
         fetchOptions.headers = {
             'Accept': 'application/vnd.live-component+json',

src/LiveComponent/assets/src/live_controller.ts

@@ -144,7 +144,7 @@ export default class extends Controller {
                 // taking precedence
                 this._clearWaitingDebouncedRenders();
 
-                this._makeRequest(directive.action);
+                this._makeRequest(directive.action, directive.named);
             }
 
             let handled = false;
@@ -296,12 +296,16 @@ export default class extends Controller {
         }
     }
 
-    _makeRequest(action: string|null) {
+    _makeRequest(action: string|null, values: Record<string,unknown>) {
         const splitUrl = this.urlValue.split('?');
         let [url] = splitUrl
         const [, queryString] = splitUrl;
         const params = new URLSearchParams(queryString || '');
 
+        if (typeof values === 'object' && Object.keys(values).length > 0) {
+            params.set('values', new URLSearchParams(values).toString());
+        }
+
         const fetchOptions: RequestInit = {};
         fetchOptions.headers = {
             'Accept': 'application/vnd.live-component+json',

src/LiveComponent/assets/test/controller/action.test.ts

@@ -35,6 +35,8 @@ describe('LiveController Action Tests', () => {
                 data-action="live#action"
                 data-action-name="save"
             >Save</button>
+
+            <button data-action="live#action" data-action-name="sendNamedArgs(a=1, b=2, c=3)">Send named args</button>
         </div>
     `;
 
@@ -64,4 +66,15 @@ describe('LiveController Action Tests', () => {
 
         expect(postMock.lastOptions().body.get('comments')).toEqual('hi WEAVER');
     });
+
+    it('Sends action named args', async () => {
+        const data = { comments: 'hi' };
+        const { element } = await startStimulus(template(data));
+
+        fetchMock.postOnce('http://localhost/_components/my_component/sendNamedArgs?values=a%3D1%26b%3D2%26c%3D3', {
+            html: template({ comments: 'hi' }),
+        });
+
+        getByText(element, 'Send named args').click();
+    });
 });

src/LiveComponent/src/ArgumentResolver/LiveActionArgumentValueResolver.php

@@ -0,0 +1,41 @@
+<?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\ArgumentResolver;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+
+/**
+ * @author Tomas Norkūnas <norkunas.tom@gmail.com>
+ *
+ * @experimental
+ */
+class LiveActionArgumentValueResolver implements ArgumentValueResolverInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function supports(Request $request, ArgumentMetadata $argument): bool
+    {
+        if ($argument->isVariadic() || !$request->attributes->has('_live_values')) {
+            return false;
+        }
+
+        return isset($request->attributes->get('_live_values')[$argument->getName()]);
+    }
+
+    public function resolve(Request $request, ArgumentMetadata $argument): iterable
+    {
+        yield $request->attributes->get('_live_values')[$argument->getName()];
+    }
+}

src/LiveComponent/src/DependencyInjection/LiveComponentExtension.php

@@ -16,6 +16,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\HttpKernel\Controller\ArgumentResolver\LiveActionArgumentValueResolver;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
 use Symfony\UX\LiveComponent\Attribute\AsLiveComponent;
@@ -93,5 +94,8 @@ function (ChildDefinition $definition, AsLiveComponent $attribute) {
         ;
 
         $container->setAlias(ComponentValidatorInterface::class, ComponentValidator::class);
+
+        $container->register(LiveActionArgumentValueResolver::class)
+            ->addTag('controller.argument_value_resolver', ['priority' => -200]);
     }
 }

src/LiveComponent/src/EventListener/LiveComponentSubscriber.php

@@ -144,7 +144,7 @@ public function onKernelController(ControllerEvent $event): void
         // extra variables to be made available to the controller
         // (for "actions" only)
         parse_str($request->query->get('values'), $values);
-        $request->attributes->add($values);
+        $request->attributes->set('_live_values', $values);
         $request->attributes->set('_component', $component);
     }
 

src/LiveComponent/tests/Unit/ArgumentResolver/LiveActionArgumentValueResolverTest.php

@@ -0,0 +1,94 @@
+<?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\Unit\ArgumentResolver;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+use Symfony\UX\LiveComponent\ArgumentResolver\LiveActionArgumentValueResolver;
+
+final class LiveActionArgumentValueResolverTest extends TestCase
+{
+    /**
+     * @dataProvider provideTestSupportsData
+     */
+    public function testSupports(Request $request, ArgumentMetadata $metadata, bool $expectedSupport)
+    {
+        $resolver = new LiveActionArgumentValueResolver();
+
+        self::assertSame($expectedSupport, $resolver->supports($request, $metadata));
+    }
+
+    public function provideTestSupportsData(): iterable
+    {
+        yield 'unsupported no values' => [
+            self::createRequest(),
+            self::createArgumentMetadata('test', 'string'),
+            false,
+        ];
+
+        yield 'unsupported empty values' => [
+            self::createRequest(['_live_values' => []]),
+            self::createArgumentMetadata('test', 'string'),
+            false,
+        ];
+
+        yield 'unsupported variadic' => [
+            self::createRequest(['_live_values' => ['test' => '1']]),
+            self::createArgumentMetadata('test', 'string', true),
+            false,
+        ];
+
+        yield 'supported argument' => [
+            self::createRequest(['_live_values' => ['test' => '1']]),
+            self::createArgumentMetadata('test', 'string'),
+            true,
+        ];
+    }
+
+    /**
+     * @dataProvider provideTestResolveData
+     */
+    public function testResolve(Request $request, ArgumentMetadata $metadata, $expected)
+    {
+        $resolver = new LiveActionArgumentValueResolver();
+        /** @var \Generator $results */
+        $results = $resolver->resolve($request, $metadata);
+
+        self::assertSame($expected, iterator_to_array($results));
+    }
+
+    public function provideTestResolveData(): iterable
+    {
+        yield 'resolves string value' => [
+            self::createRequest(['_live_values' => ['test' => '1']]),
+            self::createArgumentMetadata('test', 'string'),
+            ['1'],
+        ];
+
+        yield 'resolves array value' => [
+            self::createRequest(['_live_values' => ['test' => ['inner' => '1']]]),
+            self::createArgumentMetadata('test', 'array'),
+            [['inner' => '1']],
+        ];
+    }
+
+    private static function createRequest(array $attributes = []): Request
+    {
+        return new Request([], [], $attributes);
+    }
+
+    private static function createArgumentMetadata(string $name, string $type, bool $variadic = false): ArgumentMetadata
+    {
+        return new ArgumentMetadata($name, $type, $variadic, false, null);
+    }
+}