QueryStringPropsExtractor, renamed to RequestPropsExtractor shall get props also from path. RequestInitializeSubscriber also renamed

Author: mbuliard

src/LiveComponent/src/DependencyInjection/LiveComponentExtension.php

@@ -34,7 +34,7 @@
 use Symfony\UX\LiveComponent\EventListener\InterceptChildComponentRenderSubscriber;
 use Symfony\UX\LiveComponent\EventListener\LiveComponentSubscriber;
 use Symfony\UX\LiveComponent\EventListener\LiveUrlSubscriber;
-use Symfony\UX\LiveComponent\EventListener\QueryStringInitializeSubscriber;
+use Symfony\UX\LiveComponent\EventListener\RequestInitializeSubscriber;
 use Symfony\UX\LiveComponent\EventListener\ResetDeterministicIdSubscriber;
 use Symfony\UX\LiveComponent\Form\Type\LiveCollectionType;
 use Symfony\UX\LiveComponent\Hydration\HydrationExtensionInterface;
@@ -51,7 +51,7 @@
 use Symfony\UX\LiveComponent\Util\FingerprintCalculator;
 use Symfony\UX\LiveComponent\Util\LiveComponentStack;
 use Symfony\UX\LiveComponent\Util\LiveControllerAttributesCreator;
-use Symfony\UX\LiveComponent\Util\QueryStringPropsExtractor;
+use Symfony\UX\LiveComponent\Util\RequestPropsExtractor;
 use Symfony\UX\LiveComponent\Util\TwigAttributeHelperFactory;
 use Symfony\UX\TwigComponent\ComponentFactory;
 use Symfony\UX\TwigComponent\ComponentRenderer;
@@ -139,8 +139,8 @@ function (ChildDefinition $definition, AsLiveComponent $attribute) {
 
         $container->register('ux.live_component.live_url_subscriber', LiveUrlSubscriber::class)
             ->setArguments([
-                new Reference('router'),
                 new Reference('ux.live_component.metadata_factory'),
+                new Reference('ux.live_component.url_factory'),
             ])
             ->addTag('kernel.event_subscriber')
         ;
@@ -210,6 +210,9 @@ function (ChildDefinition $definition, AsLiveComponent $attribute) {
 
         $container->register('ux.live_component.attribute_helper_factory', TwigAttributeHelperFactory::class);
 
+        $container->register('ux.live_component.url_factory', UrlFactory::class)
+            ->setArguments([new Reference('router')]);
+
         $container->register('ux.live_component.live_controller_attributes_creator', LiveControllerAttributesCreator::class)
             ->setArguments([
                 new Reference('ux.live_component.metadata_factory'),
@@ -233,12 +236,12 @@ function (ChildDefinition $definition, AsLiveComponent $attribute) {
             ->addTag('container.service_subscriber', ['key' => LiveControllerAttributesCreator::class, 'id' => 'ux.live_component.live_controller_attributes_creator'])
         ;
 
-        $container->register('ux.live_component.query_string_props_extractor', QueryStringPropsExtractor::class)
+        $container->register('ux.live_component.query_string_props_extractor', RequestPropsExtractor::class)
             ->setArguments([
                 new Reference('ux.live_component.component_hydrator'),
             ]);
 
-        $container->register('ux.live_component.query_string_initializer_subscriber', QueryStringInitializeSubscriber::class)
+        $container->register('ux.live_component.query_string_initializer_subscriber', RequestInitializeSubscriber::class)
             ->setArguments([
                 new Reference('request_stack'),
                 new Reference('ux.live_component.metadata_factory'),

src/LiveComponent/src/EventListener/QueryStringInitializeSubscriber.php renamed to src/LiveComponent/src/EventListener/RequestInitializeSubscriber.php

@@ -16,20 +16,20 @@
 use Symfony\Component\PropertyAccess\Exception\ExceptionInterface as PropertyAccessExceptionInterface;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 use Symfony\UX\LiveComponent\Metadata\LiveComponentMetadataFactory;
-use Symfony\UX\LiveComponent\Util\QueryStringPropsExtractor;
+use Symfony\UX\LiveComponent\Util\RequestPropsExtractor;
 use Symfony\UX\TwigComponent\Event\PostMountEvent;
 
 /**
  * @author Nicolas Rigaud <[email protected]>
  *
  * @internal
  */
-class QueryStringInitializeSubscriber implements EventSubscriberInterface
+class RequestInitializeSubscriber implements EventSubscriberInterface
 {
     public function __construct(
         private readonly RequestStack $requestStack,
         private readonly LiveComponentMetadataFactory $metadataFactory,
-        private readonly QueryStringPropsExtractor $queryStringPropsExtractor,
+        private readonly RequestPropsExtractor $requestPropsExtractor,
         private readonly PropertyAccessorInterface $propertyAccessor,
     ) {
     }
@@ -60,11 +60,11 @@ public function onPostMount(PostMountEvent $event): void
             return;
         }
 
-        $queryStringData = $this->queryStringPropsExtractor->extract($request, $metadata, $event->getComponent());
+        $requestData = $this->requestPropsExtractor->extract($request, $metadata, $event->getComponent());
 
         $component = $event->getComponent();
 
-        foreach ($queryStringData as $name => $value) {
+        foreach ($requestData as $name => $value) {
             try {
                 $this->propertyAccessor->setValue($component, $name, $value);
             } catch (PropertyAccessExceptionInterface $exception) {

src/LiveComponent/src/Util/QueryStringPropsExtractor.php renamed to src/LiveComponent/src/Util/RequestPropsExtractor.php

@@ -26,28 +26,28 @@
  *
  * @internal
  */
-final class QueryStringPropsExtractor
+final class RequestPropsExtractor
 {
     public function __construct(private readonly LiveComponentHydrator $hydrator)
     {
     }
 
     /**
-     * Extracts relevant query parameters from the current URL and hydrates them.
+     * Extracts relevant props parameters from the current URL and hydrates them.
      */
     public function extract(Request $request, LiveComponentMetadata $metadata, object $component): array
     {
-        $query = $request->query->all();
+        $parameters = array_merge($request->attributes->all(), $request->query->all());
 
-        if (empty($query)) {
+        if (empty($parameters)) {
             return [];
         }
         $data = [];
 
         foreach ($metadata->getAllLivePropsMetadata($component) as $livePropMetadata) {
             if ($queryMapping = $livePropMetadata->urlMapping()) {
                 $frontendName = $livePropMetadata->calculateFieldName($component, $livePropMetadata->getName());
-                if (null !== ($value = $query[$queryMapping->as ?? $frontendName] ?? null)) {
+                if (null !== ($value = $parameters[$queryMapping->as ?? $frontendName] ?? null)) {
                     if ('' === $value) {
                         // BC layer when "symfony/type-info" is not available
                         if ($livePropMetadata instanceof LegacyLivePropMetadata) {

src/LiveComponent/tests/Functional/EventListener/QueryStringInitializerSubscriberTest.php renamed to src/LiveComponent/tests/Functional/EventListener/RequestInitializerSubscriberTest.php

@@ -14,7 +14,7 @@
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Zenstruck\Browser\Test\HasBrowser;
 
-class QueryStringInitializerSubscriberTest extends KernelTestCase
+class RequestInitializerSubscriberTest extends KernelTestCase
 {
     use HasBrowser;
 

src/LiveComponent/tests/Functional/Util/QueryStringPropsExtractorTest.php renamed to src/LiveComponent/tests/Functional/Util/RequestPropsExtractorTest.php

@@ -16,20 +16,21 @@
 use Symfony\UX\LiveComponent\Metadata\LiveComponentMetadataFactory;
 use Symfony\UX\LiveComponent\Tests\Fixtures\Dto\Address;
 use Symfony\UX\LiveComponent\Tests\LiveComponentTestHelper;
-use Symfony\UX\LiveComponent\Util\QueryStringPropsExtractor;
+use Symfony\UX\LiveComponent\Util\RequestPropsExtractor;
 
-class QueryStringPropsExtractorTest extends KernelTestCase
+class RequestPropsExtractorTest extends KernelTestCase
 {
     use LiveComponentTestHelper;
 
     /**
      * @dataProvider getQueryStringTests
      */
-    public function testExtract(string $queryString, array $expected)
+    public function testExtractFromQueryString(string $queryString, array $expected, array $attributes = []): void
     {
-        $extractor = new QueryStringPropsExtractor($this->hydrator());
+        $extractor = new RequestPropsExtractor($this->hydrator());
 
         $request = Request::create('/'.!empty($queryString) ? '?'.$queryString : '');
+        $request->attributes->add($attributes);
 
         /** @var LiveComponentMetadataFactory $metadataFactory */
         $metadataFactory = self::getContainer()->get('ux.live_component.metadata_factory');
@@ -65,6 +66,10 @@ public function getQueryStringTests(): iterable
             'invalid array value' => ['arrayProp=foo', []],
             'invalid object value' => ['objectProp=foo', []],
             'aliased prop' => ['q=foo', ['boundPropWithAlias' => 'foo']],
+            'attribute prop' => ['', ['stringProp' => 'foo'], ['stringProp' => 'foo']],
+            'attribute aliased prop' => ['', ['boundPropWithAlias' => 'foo'], ['q' => 'foo']],
+            'attribute not bound prop' => ['', [], ['unboundProp' => 'foo']],
+            'query priority' => ['stringProp=foo', ['stringProp' => 'foo'], ['stringProp' => 'bar']],
         ];
     }
 }