"""Integration tests for dynamic route page behavior.""" import time from contextlib import contextmanager from typing import Generator from urllib.parse import urlsplit import pytest from selenium.webdriver.common.by import By from reflex.testing import AppHarness def DynamicRoute(): """App for testing dynamic routes.""" import reflex as rx class DynamicState(rx.State): order: list[str] = [] page_id: str = "" def on_load(self): self.order.append(self.page_id or "no page id") @rx.var def next_page(self) -> str: try: return str(int(self.page_id) + 1) except ValueError: return "0" @rx.var def token(self) -> str: return self.get_token() def index(): return rx.fragment( rx.input(value=DynamicState.token, is_read_only=True, id="token"), rx.input(value=DynamicState.page_id, is_read_only=True, id="page_id"), rx.link("index", href="/", id="link_index"), rx.link("page_X", href="/static/x", id="link_page_x"), rx.link( "next", href="/page/" + DynamicState.next_page, id="link_page_next" # type: ignore ), rx.list( rx.foreach(DynamicState.order, lambda i: rx.list_item(rx.text(i))), # type: ignore ), ) app = rx.App(state=DynamicState) app.add_page(index) app.add_page(index, route="/page/[page_id]", on_load=DynamicState.on_load) # type: ignore app.add_page(index, route="/static/x", on_load=DynamicState.on_load) # type: ignore app.compile() @pytest.fixture(scope="session") def dynamic_route(tmp_path_factory) -> Generator[AppHarness, None, None]: """Start DynamicRoute app at tmp_path via AppHarness. Args: tmp_path_factory: pytest tmp_path_factory fixture Yields: running AppHarness instance """ with AppHarness.create( root=tmp_path_factory.mktemp("dynamic_route"), app_source=DynamicRoute, # type: ignore ) as harness: yield harness @pytest.fixture def driver(dynamic_route: AppHarness): """Get an instance of the browser open to the dynamic_route app. Args: dynamic_route: harness for DynamicRoute app Yields: WebDriver instance. """ assert dynamic_route.app_instance is not None, "app is not running" driver = dynamic_route.frontend() try: assert dynamic_route.poll_for_clients() yield driver finally: driver.quit() @contextmanager def poll_for_navigation(driver, timeout: int = 5) -> Generator[None, None, None]: """Wait for driver url to change. Use as a contextmanager, and apply the navigation event inside the context block, polling will occur after the context block exits. Args: driver: WebDriver instance. timeout: Time to wait for url to change. Yields: None """ prev_url = driver.current_url yield AppHarness._poll_for(lambda: prev_url != driver.current_url, timeout=timeout) def test_on_load_navigate(dynamic_route: AppHarness, driver): """Click links to navigate between dynamic pages with on_load event. Args: dynamic_route: harness for DynamicRoute app. driver: WebDriver instance. """ assert dynamic_route.app_instance is not None token_input = driver.find_element(By.ID, "token") link = driver.find_element(By.ID, "link_page_next") assert token_input assert link # wait for the backend connection to send the token token = dynamic_route.poll_for_value(token_input) assert token is not None # click the link a few times for ix in range(10): # wait for navigation, then assert on url with poll_for_navigation(driver): link.click() assert urlsplit(driver.current_url).path == f"/page/{ix}/" link = driver.find_element(By.ID, "link_page_next") page_id_input = driver.find_element(By.ID, "page_id") assert link assert page_id_input assert dynamic_route.poll_for_value(page_id_input) == str(ix) # look up the backend state and assert that `on_load` was called for all # navigation events backend_state = dynamic_route.app_instance.state_manager.states[token] time.sleep(0.2) assert backend_state.order == [str(ix) for ix in range(10)] def test_on_load_navigate_non_dynamic(dynamic_route: AppHarness, driver): """Click links to navigate between static pages with on_load event. Args: dynamic_route: harness for DynamicRoute app. driver: WebDriver instance. """ assert dynamic_route.app_instance is not None token_input = driver.find_element(By.ID, "token") link = driver.find_element(By.ID, "link_page_x") assert token_input assert link # wait for the backend connection to send the token token = dynamic_route.poll_for_value(token_input) assert token is not None with poll_for_navigation(driver): link.click() assert urlsplit(driver.current_url).path == "/static/x/" # look up the backend state and assert that `on_load` was called once backend_state = dynamic_route.app_instance.state_manager.states[token] time.sleep(0.2) assert backend_state.order == ["no page id"] # go back to the index and navigate back to the static route link = driver.find_element(By.ID, "link_index") with poll_for_navigation(driver): link.click() assert urlsplit(driver.current_url).path == "/" link = driver.find_element(By.ID, "link_page_x") with poll_for_navigation(driver): link.click() assert urlsplit(driver.current_url).path == "/static/x/" time.sleep(0.2) assert backend_state.order == ["no page id", "no page id"]