add url and route_id to routerdata as a replacement for pagedata

Author: adhami3310

reflex/.templates/web/utils/state.js

@@ -370,7 +370,10 @@ export const applyEvent = async (event, socket, navigate, params) => {
         ...Object.fromEntries(new URLSearchParams(window.location.search)),
         ...params(),
       },
-      asPath: window.location.pathname + window.location.search,
+      asPath:
+        window.location.pathname +
+        window.location.search +
+        window.location.hash,
     };
   }
 

reflex/app.py

@@ -1741,7 +1741,7 @@ async def process(
                     if (path := router_data.get(constants.RouteVar.PATH))
                     else "404"
                 ).removeprefix("/")
-                state.router = RouterData(router_data)
+                state.router = RouterData.from_router_data(router_data)
 
             # Preprocess the event.
             update = await app._preprocess(state, event)

reflex/istate/data.py

@@ -2,6 +2,8 @@
 
 import dataclasses
 from collections.abc import Mapping
+from typing import TYPE_CHECKING
+from urllib.parse import _NetlocResultMixinStr, urlsplit
 
 from reflex import constants
 from reflex.utils import format
@@ -90,6 +92,35 @@ def serialize_frozen_dict_str_str(obj: _FrozenDictStrStr) -> dict:
     return dict(obj._data)
 
 
+class ReflexURL(str, _NetlocResultMixinStr):
+    """A class representing a URL split result."""
+
+    if TYPE_CHECKING:
+        scheme: str
+        netloc: str
+        path: str
+        query: str
+        fragment: str
+
+    def __new__(cls, url: str):
+        """Create a new ReflexURL instance.
+
+        Args:
+            url: the URL to split.
+
+        Returns:
+            A new ReflexURL instance.
+        """
+        (scheme, netloc, path, query, fragment) = urlsplit(url)
+        obj = super().__new__(cls, url)
+        object.__setattr__(obj, "scheme", scheme)
+        object.__setattr__(obj, "netloc", netloc)
+        object.__setattr__(obj, "path", path)
+        object.__setattr__(obj, "query", query)
+        object.__setattr__(obj, "fragment", fragment)
+        return obj
+
+
 @dataclasses.dataclass(frozen=True)
 class PageData:
     """An object containing page data."""
@@ -158,20 +189,33 @@ def __init__(self, router_data: dict | None = None):
         object.__setattr__(self, "session_id", session_id)
 
 
-@dataclasses.dataclass(frozen=True, init=False)
+@dataclasses.dataclass(frozen=True)
 class RouterData:
     """An object containing RouterData."""
 
     session: SessionData = dataclasses.field(default_factory=SessionData)
     headers: HeaderData = dataclasses.field(default_factory=HeaderData)
     page: PageData = dataclasses.field(default_factory=PageData)
+    url: ReflexURL = dataclasses.field(default=ReflexURL(""))
+    route_id: str = ""
 
-    def __init__(self, router_data: dict | None = None):
-        """Initialize the RouterData object.
+    @classmethod
+    def from_router_data(cls, router_data: dict) -> "RouterData":
+        """Create a RouterData object from the given router_data.
 
         Args:
             router_data: the router_data dict.
+
+        Returns:
+            A RouterData object initialized with the provided router_data.
         """
-        object.__setattr__(self, "session", SessionData(router_data))
-        object.__setattr__(self, "headers", HeaderData(router_data))
-        object.__setattr__(self, "page", PageData(router_data))
+        return cls(
+            session=SessionData(router_data),
+            headers=HeaderData(router_data),
+            page=PageData(router_data),
+            url=ReflexURL(
+                router_data.get(constants.RouteVar.HEADERS, {}).get("origin", "")
+                + router_data.get(constants.RouteVar.ORIGIN, "")
+            ),
+            route_id=router_data.get(constants.RouteVar.PATH, ""),
+        )

tests/units/test_app.py

@@ -1085,7 +1085,7 @@ def _dynamic_state_event(name, val, **kwargs):
             "token": token,
             **on_load_internal.router_data,
         }
-        exp_router = RouterData(exp_router_data)
+        exp_router = RouterData.from_router_data(exp_router_data)
         process_coro = process(
             app,
             event=on_load_internal,

tests/units/test_state.py

@@ -70,6 +70,8 @@
 
 
 formatted_router = {
+    "route_id": "",
+    "url": "",
     "session": {"client_token": "", "client_ip": "", "session_id": ""},
     "headers": {
         "host": "",
@@ -885,7 +887,7 @@ def test_get_client_token(test_state, router_data):
         test_state: The test state.
         router_data: The router data fixture.
     """
-    test_state.router = RouterData(router_data)
+    test_state.router = RouterData.from_router_data(router_data)
     assert (
         test_state.router.session.client_token == "b181904c-3953-4a79-dc18-ae9518c22f05"
     )
@@ -898,7 +900,7 @@ def test_get_sid(test_state, router_data):
         test_state: A state.
         router_data: The router data fixture.
     """
-    test_state.router = RouterData(router_data)
+    test_state.router = RouterData.from_router_data(router_data)
     assert test_state.router.session.session_id == "9fpxSzPb9aFMb4wFAAAH"
 
 
@@ -911,7 +913,7 @@ def test_get_headers(test_state, router_data, router_data_headers):
         router_data_headers: The expected headers.
     """
     print(router_data_headers)
-    test_state.router = RouterData(router_data)
+    test_state.router = RouterData.from_router_data(router_data)
     print(test_state.router.headers)
     assert dataclasses.asdict(test_state.router.headers) == {
         format.to_snake_case(k): v for k, v in router_data_headers.items()
@@ -929,23 +931,23 @@ def test_get_client_ip(test_state, router_data):
         test_state: A state.
         router_data: The router data fixture.
     """
-    test_state.router = RouterData(router_data)
+    test_state.router = RouterData.from_router_data(router_data)
     assert test_state.router.session.client_ip == "127.0.0.1"
 
 
 def test_get_current_page(test_state):
     assert test_state.router.page.path == ""
 
     route = "mypage/subpage"
-    test_state.router = RouterData({RouteVar.PATH: route})
+    test_state.router = RouterData.from_router_data({RouteVar.PATH: route})
     assert test_state.router.page.path == route
 
 
 def test_get_query_params(test_state):
     assert test_state.router.page.params == {}
 
     params = {"p1": "a", "p2": "b"}
-    test_state.router = RouterData({RouteVar.QUERY: params})
+    test_state.router = RouterData.from_router_data({RouteVar.QUERY: params})
     assert dict(test_state.router.page.params) == params
 
 
@@ -1996,7 +1998,9 @@ async def test_state_proxy(
     assert child_state is not None
     parent_state = child_state.parent_state
     assert parent_state is not None
-    router_data = RouterData({"query": {}, "token": token, "sid": "test_sid"})
+    router_data = RouterData.from_router_data(
+        {"query": {}, "token": token, "sid": "test_sid"}
+    )
     grandchild_state.router = router_data
     namespace = mock_app.event_namespace
     assert namespace is not None
@@ -2707,12 +2711,12 @@ class MutableContainsBase(BaseState):
         dict_val[MutableContainsBase.get_full_name()]["items" + FIELD_MARKER][0], Foo
     )
     val = json_dumps(dict_val)
-    f_items = '[{"tags": ["123", "456"]}]'
-    f_formatted_router = str(formatted_router).replace("'", '"')
-    assert (
-        val
-        == f'{{"{MutableContainsBase.get_full_name()}": {{"items{FIELD_MARKER}": {f_items}, "router{FIELD_MARKER}": {f_formatted_router}}}}}'
-    )
+    assert json.loads(val) == {
+        MutableContainsBase.get_full_name(): {
+            f"items{FIELD_MARKER}": [{"tags": ["123", "456"]}],
+            f"router{FIELD_MARKER}": formatted_router,
+        }
+    }
 
 
 def test_reset_with_mutables():

tests/units/utils/test_format.py

@@ -548,6 +548,8 @@ def test_format_query_params(input, output):
 
 
 formatted_router = {
+    "route_id": "",
+    "url": "",
     "session": {"client_token": "", "client_ip": "", "session_id": ""},
     "headers": {
         "host": "",