rebase and returns

Author: mbuliard

src/LiveComponent/CHANGELOG.md

@@ -1,16 +1,14 @@
 # CHANGELOG
 
-## 2.29.0
-
--   Add new `mapPath` options (default `false`) to `UrlMapping` of a `LiveProp`
-    to allow the prop to be mapped to the path instead of the query in the url.
-
 ## 2.28.0
 
 -   Add new modifiers for input validations, useful to prevent uneccessary HTTP requests:
     - `min_length` and `max_length`: validate length from textual input elements
     - `min_value` and `max_value`: validate value from numeral input elements
 
+-   Add new `mapPath` options (default `false`) to `UrlMapping` of a `LiveProp`
+    to allow the prop to be mapped to the path instead of the query in the url.
+
 ```twig
 <!-- Do not trigger model update until 3 characters are typed -->
 <input data-model="min_length(3)|username" type="text" value="" />

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;
     }
@@ -1805,109 +1805,7 @@ class ExternalMutationTracker {
         return element.tagName === 'FONT' && element.getAttribute('style') === 'vertical-align: inherit;';
     }
 }
-function isValueEmpty(value) {
-    if (null === value || value === '' || undefined === value || (Array.isArray(value) && value.length === 0)) {
-        return true;
-    }
-    if (typeof value !== 'object') {
-        return false;
-    }
-    for (const key of Object.keys(value)) {
-        if (!isValueEmpty(value[key])) {
-            return false;
-        }
-    }
-    return true;
-}
-function toQueryString(data) {
-    const buildQueryStringEntries = (data, entries = {}, baseKey = '') => {
-        Object.entries(data).forEach(([iKey, iValue]) => {
-            const key = baseKey === '' ? iKey : `${baseKey}[${iKey}]`;
-            if ('' === baseKey && isValueEmpty(iValue)) {
-                entries[key] = '';
-            }
-            else if (null !== iValue) {
-                if (typeof iValue === 'object') {
-                    entries = { ...entries, ...buildQueryStringEntries(iValue, entries, key) };
-                }
-                else {
-                    entries[key] = encodeURIComponent(iValue)
-                        .replace(/%20/g, '+')
-                        .replace(/%2C/g, ',');
-                }
-            }
-        });
-        return entries;
-    };
-    const entries = buildQueryStringEntries(data);
-    return Object.entries(entries)
-        .map(([key, value]) => `${key}=${value}`)
-        .join('&');
-}
-function fromQueryString(search) {
-    search = search.replace('?', '');
-    if (search === '')
-        return {};
-    const insertDotNotatedValueIntoData = (key, value, data) => {
-        const [first, second, ...rest] = key.split('.');
-        if (!second) {
-            data[key] = value;
-            return value;
-        }
-        if (data[first] === undefined) {
-            data[first] = Number.isNaN(Number.parseInt(second)) ? {} : [];
-        }
-        insertDotNotatedValueIntoData([second, ...rest].join('.'), value, data[first]);
-    };
-    const entries = search.split('&').map((i) => i.split('='));
-    const data = {};
-    entries.forEach(([key, value]) => {
-        value = decodeURIComponent(String(value || '').replace(/\+/g, '%20'));
-        if (!key.includes('[')) {
-            data[key] = value;
-        }
-        else {
-            if ('' === value)
-                return;
-            const dotNotatedKey = key.replace(/\[/g, '.').replace(/]/g, '');
-            insertDotNotatedValueIntoData(dotNotatedKey, value, data);
-        }
-    });
-    return data;
-}
-class UrlUtils extends URL {
-    has(key) {
-        const data = this.getData();
-        return Object.keys(data).includes(key);
-    }
-    set(key, value) {
-        const data = this.getData();
-        data[key] = value;
-        this.setData(data);
-    }
-    get(key) {
-        return this.getData()[key];
-    }
-    remove(key) {
-        const data = this.getData();
-        delete data[key];
-        this.setData(data);
-    }
-    getData() {
-        if (!this.search) {
-            return {};
-        }
-        return fromQueryString(this.search);
-    }
-    setData(data) {
-        this.search = toQueryString(data);
-    }
-}
-class HistoryStrategy {
-    static replace(url) {
-        history.replaceState(history.state, '', url);
-    }
-}
+
 class UnsyncedInputsTracker {
     constructor(component, modelElementResolver) {
         this.elementEventListeners = [
@@ -2255,7 +2153,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

@@ -2740,9 +2740,9 @@ The ``query`` value will appear in the URL like ``/search?query=my+important+que
 Map the parameter to path instead of query
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. versionadded:: 2.29
+.. versionadded:: 2.28
 
-    The ``mapPath`` option was added in LiveComponents 2.29.
+    The ``mapPath`` option was added in LiveComponents 2.28.
 
 Instead of setting the ``LiveProp`` as a query parameter, it can be set as route parameter
 by passing the ``mapPath`` option to the ``UrlMapping`` defined for the ``LiveProp``::

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/EventListener/LiveUrlSubscriber.php

@@ -36,19 +36,20 @@ public function onKernelResponse(ResponseEvent $event): void
         if (!$event->isMainRequest()) {
             return;
         }
+
         $request = $event->getRequest();
         if (!$request->attributes->has('_live_component')) {
             return;
         }
 
-        $newUrl = null;
-        if ($previousLocation = $request->headers->get(self::URL_HEADER)) {
-            $liveProps = $this->getLivePropsToMap($request);
-            $newUrl = $this->urlFactory->createFromPreviousAndProps($previousLocation, $liveProps['path'], $liveProps['query']);
+        $newLiveUrl = null;
+        if ($previousLiveUrl = $request->headers->get(self::URL_HEADER)) {
+            $liveProps = $this->getLivePropsFromRequest($request);
+            $newLiveUrl = $this->urlFactory->createFromPreviousAndProps($previousLiveUrl, $liveProps['path'], $liveProps['query']);
         }
 
-        if ($newUrl) {
-            $event->getResponse()->headers->set(self::URL_HEADER, $newUrl);
+        if ($newLiveUrl) {
+            $event->getResponse()->headers->set(self::URL_HEADER, $newLiveUrl);
         }
     }
 
@@ -59,7 +60,13 @@ public static function getSubscribedEvents(): array
         ];
     }
 
-    private function getLivePropsToMap(Request $request): array
+    /**
+     * @return array{
+     *     path: array<string, mixed>,
+     *     query: array<string, mixed>
+     * }
+     */
+    private function getLivePropsFromRequest(Request $request): array
     {
         $componentName = $request->attributes->get('_live_component');
         $metadata = $this->metadataFactory->getMetadata($componentName);

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 = [],