returns

Author: mbuliard

src/LiveComponent/assets/dist/Backend/BackendResponse.d.ts

@@ -4,5 +4,5 @@ export default class {
     private liveUrl;
     constructor(response: Response);
     getBody(): Promise<string>;
-    getLiveUrl(): Promise<string | null>;
+    getLiveUrl(): string | null;
 }

src/LiveComponent/assets/dist/live_controller.js

@@ -112,9 +112,9 @@ class BackendResponse {
         }
         return this.body;
     }
-    async getLiveUrl() {
+    getLiveUrl() {
         if (undefined === this.liveUrl) {
-            this.liveUrl = await this.response.headers.get('X-Live-Url');
+            this.liveUrl = this.response.headers.get('X-Live-Url');
         }
         return this.liveUrl;
     }
@@ -2144,7 +2144,7 @@ class Component {
                 return response;
             }
             this.processRerender(html, backendResponse);
-            const liveUrl = await backendResponse.getLiveUrl();
+            const liveUrl = backendResponse.getLiveUrl();
             if (liveUrl) {
                 history.replaceState(history.state, '', new URL(liveUrl + window.location.hash, window.location.origin));
             }

src/LiveComponent/assets/src/Backend/BackendResponse.ts

@@ -15,9 +15,9 @@ export default class {
         return this.body;
     }
 
-    async getLiveUrl(): Promise<string | null> {
+    getLiveUrl(): string | null {
         if (undefined === this.liveUrl) {
-            this.liveUrl = await this.response.headers.get('X-Live-Url');
+            this.liveUrl = this.response.headers.get('X-Live-Url');
         }
 
         return this.liveUrl;

src/LiveComponent/assets/src/Component/index.ts

@@ -328,7 +328,7 @@ export default class Component {
             }
 
             this.processRerender(html, backendResponse);
-            const liveUrl = await backendResponse.getLiveUrl();
+            const liveUrl = backendResponse.getLiveUrl();
             if (liveUrl) {
                 history.replaceState(
                     history.state,

src/LiveComponent/doc/index.rst

@@ -2680,11 +2680,11 @@ The ``query`` value will appear in the URL like ``/search?query=my+important+que
 Map the parameter to path instead of query
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. versionadded:: 2.27
+.. versionadded:: 2.28
 
-    The ``mapPath`` option was added in LiveComponents 2.27.
+    The ``mapPath`` option was added in LiveComponents 2.28.
 
-Instead of setting the LiveProp as a query parameter, you can set it as route parameter.
+Instead of setting the ``LiveProp`` as a query parameter, you can set it as route parameter.
 definition::
 
     // ...
@@ -2700,7 +2700,7 @@ definition::
     }
 
 
-The if the symfony route is defined like this::
+If the symfony route is defined like this::
 
     // src/Controller/NodeController.php
     // ...
@@ -2713,7 +2713,7 @@ The if the symfony route is defined like this::
 
 Then the ``id`` value will appear in the URL like ``https://my.domain/node/my-node-id``.
 
-If the route parameter name is different from the LiveProp name, the ``as`` option can be used to map the LiveProp.
+If the route parameter name is different from the LiveProp name, the ``as`` option can be used to map the ``LiveProp``.
 
 If the route parameter is not defined, the ``mapPath`` option will be ignored and the LiveProp value will fallback to a query parameter.
 

src/LiveComponent/src/EventListener/LiveComponentSubscriber.php

@@ -258,8 +258,6 @@ public function onKernelView(ViewEvent $event): void
         $mountedComponent = $request->attributes->get('_mounted_component');
         if (!$request->attributes->get('_component_default_action', false)) {
             // On custom action, props may be updated by the server side
-            // @todo discuss name responseProps
-            // @todo maybe always set in, including default action and use only this, ignoring `props` and `updated` for UrlFactory ?
             $liveRequestData = $request->attributes->get('_live_request_data');
             $liveRequestData['responseProps'] = (array) $mountedComponent->getComponent();
             $request->attributes->set('_live_request_data', $liveRequestData);

src/LiveComponent/src/Util/UrlFactory.php

@@ -74,15 +74,19 @@ private function replaceQueryString($url, array $props): string
             $queryString;
     }
 
-    // Keep the query parameters of the previous request
+    /**
+     * Keep the query parameters of the previous request.
+     */
     private function getPreviousQueryParameters(string $query): array
     {
         parse_str($query, $previousQueryParams);
 
         return $previousQueryParams;
     }
 
-    // Symfony router will set props in query if they do not match route parameter
+    /**
+     * Symfony router will set props in query if they do not match route parameter.
+     */
     private function getRemnantProps(string $newUrl): array
     {
         parse_str(parse_url($newUrl)['query'] ?? '', $remnantQueryParams);

src/LiveComponent/tests/Unit/EventListener/LiveUrlSubscriberTest.php

@@ -72,7 +72,7 @@ public function testDoNothing(
         $this->assertNull($response->headers->get('X-Live-Url'));
     }
 
-    public function getData(): iterable
+    public static function provideTestUrlFactoryReceivesPathAndQuertyPropsFromRequestData(): iterable
     {
         yield 'prop_without_matching_property' => [
             'liveRequestData' => [
@@ -137,9 +137,9 @@ public function getData(): iterable
     }
 
     /**
-     * @dataProvider getData
+     * @dataProvider provideTestUrlFactoryReceivesPathAndQuertyPropsFromRequestData
      */
-    public function testProps(
+    public function testUrlFactoryReceivesPathAndQuertyPropsFromRequestData(
         array $liveRequestData,
         array $expectedPathProps = [],
         array $expectedQueryProps = [],

src/LiveComponent/tests/Unit/Util/UrlFactoryTest.php

@@ -19,7 +19,7 @@
 
 class UrlFactoryTest extends TestCase
 {
-    public function getData(): \Generator
+    public static function provideTestCreate(): \Generator
     {
         yield 'keep_default_url' => [];
 
@@ -104,7 +104,7 @@ public function getData(): \Generator
     }
 
     /**
-     * @dataProvider getData
+     * @dataProvider provideTestCreate
      */
     public function testCreate(
         array $input = [],