test_client_storage.py 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760
  1. """Integration tests for client side storage."""
  2. from __future__ import annotations
  3. import time
  4. from typing import Generator
  5. import pytest
  6. from selenium.webdriver import Firefox
  7. from selenium.webdriver.common.by import By
  8. from selenium.webdriver.remote.webdriver import WebDriver
  9. from reflex.state import (
  10. State,
  11. StateManagerDisk,
  12. StateManagerMemory,
  13. StateManagerRedis,
  14. _substate_key,
  15. )
  16. from reflex.testing import AppHarness
  17. from . import utils
  18. def ClientSide():
  19. """App for testing client-side state."""
  20. import reflex as rx
  21. class ClientSideState(rx.State):
  22. state_var: str = ""
  23. input_value: str = ""
  24. class ClientSideSubState(ClientSideState):
  25. # cookies with default settings
  26. c1: str = rx.Cookie()
  27. c2: str = rx.Cookie("c2 default")
  28. # cookies with custom settings
  29. c3: str = rx.Cookie(max_age=2) # expires after 2 second
  30. c4: str = rx.Cookie(same_site="strict")
  31. c5: str = rx.Cookie(path="/foo/") # only accessible on `/foo/`
  32. c6: str = rx.Cookie(name="c6")
  33. c7: str = rx.Cookie("c7 default")
  34. # local storage with default settings
  35. l1: str = rx.LocalStorage()
  36. l2: str = rx.LocalStorage("l2 default")
  37. # local storage with custom settings
  38. l3: str = rx.LocalStorage(name="l3")
  39. l4: str = rx.LocalStorage("l4 default")
  40. # Sync'd local storage
  41. l5: str = rx.LocalStorage(sync=True)
  42. l6: str = rx.LocalStorage(sync=True, name="l6")
  43. # Session storage
  44. s1: str = rx.SessionStorage()
  45. s2: str = rx.SessionStorage("s2 default")
  46. s3: str = rx.SessionStorage(name="s3")
  47. def set_l6(self, my_param: str):
  48. self.l6 = my_param
  49. @rx.event
  50. def set_var(self):
  51. setattr(self, self.state_var, self.input_value)
  52. self.state_var = self.input_value = ""
  53. class ClientSideSubSubState(ClientSideSubState):
  54. c1s: str = rx.Cookie()
  55. l1s: str = rx.LocalStorage()
  56. s1s: str = rx.SessionStorage()
  57. @rx.event
  58. def set_var(self):
  59. setattr(self, self.state_var, self.input_value)
  60. self.state_var = self.input_value = ""
  61. def index():
  62. return rx.fragment(
  63. rx.input(
  64. value=ClientSideState.router.session.client_token,
  65. read_only=True,
  66. id="token",
  67. ),
  68. rx.input(
  69. placeholder="state var",
  70. value=ClientSideState.state_var,
  71. on_change=ClientSideState.setvar("state_var"),
  72. id="state_var",
  73. ),
  74. rx.input(
  75. placeholder="input value",
  76. value=ClientSideState.input_value,
  77. on_change=ClientSideState.setvar("input_value"),
  78. id="input_value",
  79. ),
  80. rx.button(
  81. "Set ClientSideSubState",
  82. on_click=ClientSideSubState.set_var,
  83. id="set_sub_state",
  84. ),
  85. rx.button(
  86. "Set ClientSideSubSubState",
  87. on_click=ClientSideSubSubState.set_var,
  88. id="set_sub_sub_state",
  89. ),
  90. rx.box(ClientSideSubState.c1, id="c1"),
  91. rx.box(ClientSideSubState.c2, id="c2"),
  92. rx.box(ClientSideSubState.c3, id="c3"),
  93. rx.box(ClientSideSubState.c4, id="c4"),
  94. rx.box(ClientSideSubState.c5, id="c5"),
  95. rx.box(ClientSideSubState.c6, id="c6"),
  96. rx.box(ClientSideSubState.c7, id="c7"),
  97. rx.box(ClientSideSubState.l1, id="l1"),
  98. rx.box(ClientSideSubState.l2, id="l2"),
  99. rx.box(ClientSideSubState.l3, id="l3"),
  100. rx.box(ClientSideSubState.l4, id="l4"),
  101. rx.box(ClientSideSubState.l5, id="l5"),
  102. rx.box(ClientSideSubState.l6, id="l6"),
  103. rx.box(ClientSideSubState.s1, id="s1"),
  104. rx.box(ClientSideSubState.s2, id="s2"),
  105. rx.box(ClientSideSubState.s3, id="s3"),
  106. rx.box(ClientSideSubSubState.c1s, id="c1s"),
  107. rx.box(ClientSideSubSubState.l1s, id="l1s"),
  108. rx.box(ClientSideSubSubState.s1s, id="s1s"),
  109. )
  110. app = rx.App()
  111. app.add_page(index)
  112. app.add_page(index, route="/foo")
  113. @pytest.fixture(scope="module")
  114. def client_side(tmp_path_factory) -> Generator[AppHarness, None, None]:
  115. """Start ClientSide app at tmp_path via AppHarness.
  116. Args:
  117. tmp_path_factory: pytest tmp_path_factory fixture
  118. Yields:
  119. running AppHarness instance
  120. """
  121. with AppHarness.create(
  122. root=tmp_path_factory.mktemp("client_side"),
  123. app_source=ClientSide,
  124. ) as harness:
  125. yield harness
  126. @pytest.fixture
  127. def driver(client_side: AppHarness) -> Generator[WebDriver, None, None]:
  128. """Get an instance of the browser open to the client_side app.
  129. Args:
  130. client_side: harness for ClientSide app
  131. Yields:
  132. WebDriver instance.
  133. """
  134. assert client_side.app_instance is not None, "app is not running"
  135. driver = client_side.frontend()
  136. try:
  137. yield driver
  138. finally:
  139. driver.quit()
  140. @pytest.fixture()
  141. def local_storage(driver: WebDriver) -> Generator[utils.LocalStorage, None, None]:
  142. """Get an instance of the local storage helper.
  143. Args:
  144. driver: WebDriver instance.
  145. Yields:
  146. Local storage helper.
  147. """
  148. ls = utils.LocalStorage(driver)
  149. yield ls
  150. ls.clear()
  151. @pytest.fixture()
  152. def session_storage(driver: WebDriver) -> Generator[utils.SessionStorage, None, None]:
  153. """Get an instance of the session storage helper.
  154. Args:
  155. driver: WebDriver instance.
  156. Yields:
  157. Session storage helper.
  158. """
  159. ss = utils.SessionStorage(driver)
  160. yield ss
  161. ss.clear()
  162. @pytest.fixture(autouse=True)
  163. def delete_all_cookies(driver: WebDriver) -> Generator[None, None, None]:
  164. """Delete all cookies after each test.
  165. Args:
  166. driver: WebDriver instance.
  167. Yields:
  168. None
  169. """
  170. yield
  171. driver.delete_all_cookies()
  172. def cookie_info_map(driver: WebDriver) -> dict[str, dict[str, str]]:
  173. """Get a map of cookie names to cookie info.
  174. Args:
  175. driver: WebDriver instance.
  176. Returns:
  177. A map of cookie names to cookie info.
  178. """
  179. return {cookie_info["name"]: cookie_info for cookie_info in driver.get_cookies()}
  180. @pytest.mark.asyncio
  181. async def test_client_side_state(
  182. client_side: AppHarness,
  183. driver: WebDriver,
  184. local_storage: utils.LocalStorage,
  185. session_storage: utils.SessionStorage,
  186. ):
  187. """Test client side state.
  188. Args:
  189. client_side: harness for ClientSide app.
  190. driver: WebDriver instance.
  191. local_storage: Local storage helper.
  192. session_storage: Session storage helper.
  193. """
  194. app = client_side.app_instance
  195. assert app is not None
  196. assert client_side.frontend_url is not None
  197. def poll_for_token():
  198. token_input = driver.find_element(By.ID, "token")
  199. assert token_input
  200. # wait for the backend connection to send the token
  201. token = client_side.poll_for_value(token_input)
  202. assert token is not None
  203. return token
  204. def set_sub(var: str, value: str):
  205. # Get a reference to the cookie manipulation form.
  206. state_var_input = driver.find_element(By.ID, "state_var")
  207. input_value_input = driver.find_element(By.ID, "input_value")
  208. set_sub_state_button = driver.find_element(By.ID, "set_sub_state")
  209. AppHarness._poll_for(lambda: state_var_input.get_attribute("value") == "")
  210. AppHarness._poll_for(lambda: input_value_input.get_attribute("value") == "")
  211. # Set the values.
  212. state_var_input.send_keys(var)
  213. input_value_input.send_keys(value)
  214. set_sub_state_button.click()
  215. def set_sub_sub(var: str, value: str):
  216. # Get a reference to the cookie manipulation form.
  217. state_var_input = driver.find_element(By.ID, "state_var")
  218. input_value_input = driver.find_element(By.ID, "input_value")
  219. set_sub_sub_state_button = driver.find_element(By.ID, "set_sub_sub_state")
  220. AppHarness._poll_for(lambda: state_var_input.get_attribute("value") == "")
  221. AppHarness._poll_for(lambda: input_value_input.get_attribute("value") == "")
  222. # Set the values.
  223. state_var_input.send_keys(var)
  224. input_value_input.send_keys(value)
  225. set_sub_sub_state_button.click()
  226. token = poll_for_token()
  227. # get a reference to all cookie and local storage elements
  228. c1 = driver.find_element(By.ID, "c1")
  229. c2 = driver.find_element(By.ID, "c2")
  230. c3 = driver.find_element(By.ID, "c3")
  231. c4 = driver.find_element(By.ID, "c4")
  232. c5 = driver.find_element(By.ID, "c5")
  233. c6 = driver.find_element(By.ID, "c6")
  234. c7 = driver.find_element(By.ID, "c7")
  235. l1 = driver.find_element(By.ID, "l1")
  236. l2 = driver.find_element(By.ID, "l2")
  237. l3 = driver.find_element(By.ID, "l3")
  238. l4 = driver.find_element(By.ID, "l4")
  239. s1 = driver.find_element(By.ID, "s1")
  240. s2 = driver.find_element(By.ID, "s2")
  241. s3 = driver.find_element(By.ID, "s3")
  242. c1s = driver.find_element(By.ID, "c1s")
  243. l1s = driver.find_element(By.ID, "l1s")
  244. s1s = driver.find_element(By.ID, "s1s")
  245. # assert on defaults where present
  246. assert c1.text == ""
  247. assert c2.text == "c2 default"
  248. assert c3.text == ""
  249. assert c4.text == ""
  250. assert c5.text == ""
  251. assert c6.text == ""
  252. assert c7.text == "c7 default"
  253. assert l1.text == ""
  254. assert l2.text == "l2 default"
  255. assert l3.text == ""
  256. assert l4.text == "l4 default"
  257. assert s1.text == ""
  258. assert s2.text == "s2 default"
  259. assert s3.text == ""
  260. assert c1s.text == ""
  261. assert l1s.text == ""
  262. assert s1s.text == ""
  263. # no cookies should be set yet!
  264. assert not driver.get_cookies()
  265. local_storage_items = local_storage.items()
  266. local_storage_items.pop("last_compiled_time", None)
  267. local_storage_items.pop("theme", None)
  268. assert not local_storage_items
  269. # set some cookies and local storage values
  270. set_sub("c1", "c1 value")
  271. set_sub("c2", "c2 value")
  272. set_sub("c4", "c4 value")
  273. set_sub("c5", "c5 value")
  274. set_sub("c6", "c6 throwaway value")
  275. set_sub("c6", "c6 value")
  276. set_sub("c7", "c7 value")
  277. set_sub("l1", "l1 value")
  278. set_sub("l2", "l2 value")
  279. set_sub("l3", "l3 value")
  280. set_sub("l4", "l4 value")
  281. set_sub("s1", "s1 value")
  282. set_sub("s2", "s2 value")
  283. set_sub("s3", "s3 value")
  284. set_sub_sub("c1s", "c1s value")
  285. set_sub_sub("l1s", "l1s value")
  286. set_sub_sub("s1s", "s1s value")
  287. state_name = client_side.get_full_state_name(["_client_side_state"])
  288. sub_state_name = client_side.get_full_state_name(
  289. ["_client_side_state", "_client_side_sub_state"]
  290. )
  291. sub_sub_state_name = client_side.get_full_state_name(
  292. ["_client_side_state", "_client_side_sub_state", "_client_side_sub_sub_state"]
  293. )
  294. exp_cookies = {
  295. f"{sub_state_name}.c1": {
  296. "domain": "localhost",
  297. "httpOnly": False,
  298. "name": f"{sub_state_name}.c1",
  299. "path": "/",
  300. "sameSite": "Lax",
  301. "secure": False,
  302. "value": "c1%20value",
  303. },
  304. f"{sub_state_name}.c2": {
  305. "domain": "localhost",
  306. "httpOnly": False,
  307. "name": f"{sub_state_name}.c2",
  308. "path": "/",
  309. "sameSite": "Lax",
  310. "secure": False,
  311. "value": "c2%20value",
  312. },
  313. f"{sub_state_name}.c4": {
  314. "domain": "localhost",
  315. "httpOnly": False,
  316. "name": f"{sub_state_name}.c4",
  317. "path": "/",
  318. "sameSite": "Strict",
  319. "secure": False,
  320. "value": "c4%20value",
  321. },
  322. "c6": {
  323. "domain": "localhost",
  324. "httpOnly": False,
  325. "name": "c6",
  326. "path": "/",
  327. "sameSite": "Lax",
  328. "secure": False,
  329. "value": "c6%20value",
  330. },
  331. f"{sub_state_name}.c7": {
  332. "domain": "localhost",
  333. "httpOnly": False,
  334. "name": f"{sub_state_name}.c7",
  335. "path": "/",
  336. "sameSite": "Lax",
  337. "secure": False,
  338. "value": "c7%20value",
  339. },
  340. f"{sub_sub_state_name}.c1s": {
  341. "domain": "localhost",
  342. "httpOnly": False,
  343. "name": f"{sub_sub_state_name}.c1s",
  344. "path": "/",
  345. "sameSite": "Lax",
  346. "secure": False,
  347. "value": "c1s%20value",
  348. },
  349. }
  350. AppHarness._poll_for(
  351. lambda: all(cookie_key in cookie_info_map(driver) for cookie_key in exp_cookies)
  352. )
  353. cookies = cookie_info_map(driver)
  354. for exp_cookie_key, exp_cookie_data in exp_cookies.items():
  355. assert cookies.pop(exp_cookie_key) == exp_cookie_data
  356. # assert all cookies have been popped for this page
  357. assert not cookies
  358. # Test cookie with expiry by itself to avoid timing flakiness
  359. set_sub("c3", "c3 value")
  360. AppHarness._poll_for(lambda: f"{sub_state_name}.c3" in cookie_info_map(driver))
  361. c3_cookie = cookie_info_map(driver)[f"{sub_state_name}.c3"]
  362. assert c3_cookie.pop("expiry") is not None
  363. assert c3_cookie == {
  364. "domain": "localhost",
  365. "httpOnly": False,
  366. "name": f"{sub_state_name}.c3",
  367. "path": "/",
  368. "sameSite": "Lax",
  369. "secure": False,
  370. "value": "c3%20value",
  371. }
  372. time.sleep(2) # wait for c3 to expire
  373. if not isinstance(driver, Firefox):
  374. # Note: Firefox does not remove expired cookies Bug 576347
  375. assert f"{sub_state_name}.c3" not in cookie_info_map(driver)
  376. local_storage_items = local_storage.items()
  377. local_storage_items.pop("last_compiled_time", None)
  378. local_storage_items.pop("theme", None)
  379. assert local_storage_items.pop(f"{sub_state_name}.l1") == "l1 value"
  380. assert local_storage_items.pop(f"{sub_state_name}.l2") == "l2 value"
  381. assert local_storage_items.pop("l3") == "l3 value"
  382. assert local_storage_items.pop(f"{sub_state_name}.l4") == "l4 value"
  383. assert local_storage_items.pop(f"{sub_sub_state_name}.l1s") == "l1s value"
  384. assert not local_storage_items
  385. session_storage_items = session_storage.items()
  386. session_storage_items.pop("token", None)
  387. assert session_storage_items.pop(f"{sub_state_name}.s1") == "s1 value"
  388. assert session_storage_items.pop(f"{sub_state_name}.s2") == "s2 value"
  389. assert session_storage_items.pop("s3") == "s3 value"
  390. assert session_storage_items.pop(f"{sub_sub_state_name}.s1s") == "s1s value"
  391. assert not session_storage_items
  392. assert c1.text == "c1 value"
  393. assert c2.text == "c2 value"
  394. assert c3.text == "c3 value"
  395. assert c4.text == "c4 value"
  396. assert c5.text == "c5 value"
  397. assert c6.text == "c6 value"
  398. assert c7.text == "c7 value"
  399. assert l1.text == "l1 value"
  400. assert l2.text == "l2 value"
  401. assert l3.text == "l3 value"
  402. assert l4.text == "l4 value"
  403. assert s1.text == "s1 value"
  404. assert s2.text == "s2 value"
  405. assert s3.text == "s3 value"
  406. assert c1s.text == "c1s value"
  407. assert l1s.text == "l1s value"
  408. assert s1s.text == "s1s value"
  409. # navigate to the /foo route
  410. with utils.poll_for_navigation(driver):
  411. driver.get(client_side.frontend_url + "/foo")
  412. # get new references to all cookie and local storage elements
  413. c1 = driver.find_element(By.ID, "c1")
  414. c2 = driver.find_element(By.ID, "c2")
  415. c3 = driver.find_element(By.ID, "c3")
  416. c4 = driver.find_element(By.ID, "c4")
  417. c5 = driver.find_element(By.ID, "c5")
  418. c6 = driver.find_element(By.ID, "c6")
  419. c7 = driver.find_element(By.ID, "c7")
  420. l1 = driver.find_element(By.ID, "l1")
  421. l2 = driver.find_element(By.ID, "l2")
  422. l3 = driver.find_element(By.ID, "l3")
  423. l4 = driver.find_element(By.ID, "l4")
  424. s1 = driver.find_element(By.ID, "s1")
  425. s2 = driver.find_element(By.ID, "s2")
  426. s3 = driver.find_element(By.ID, "s3")
  427. c1s = driver.find_element(By.ID, "c1s")
  428. l1s = driver.find_element(By.ID, "l1s")
  429. s1s = driver.find_element(By.ID, "s1s")
  430. assert c1.text == "c1 value"
  431. assert c2.text == "c2 value"
  432. assert c3.text == "" # cookie expired so value removed from state
  433. assert c4.text == "c4 value"
  434. assert c5.text == "c5 value"
  435. assert c6.text == "c6 value"
  436. assert c7.text == "c7 value"
  437. assert l1.text == "l1 value"
  438. assert l2.text == "l2 value"
  439. assert l3.text == "l3 value"
  440. assert l4.text == "l4 value"
  441. assert s1.text == "s1 value"
  442. assert s2.text == "s2 value"
  443. assert s3.text == "s3 value"
  444. assert c1s.text == "c1s value"
  445. assert l1s.text == "l1s value"
  446. assert s1s.text == "s1s value"
  447. # reset the backend state to force refresh from client storage
  448. async with client_side.modify_state(f"{token}_{state_name}") as state:
  449. state.reset()
  450. driver.refresh()
  451. # wait for the backend connection to send the token (again)
  452. token_input = driver.find_element(By.ID, "token")
  453. assert token_input
  454. token = client_side.poll_for_value(token_input)
  455. assert token is not None
  456. # get new references to all cookie and local storage elements (again)
  457. c1 = driver.find_element(By.ID, "c1")
  458. c2 = driver.find_element(By.ID, "c2")
  459. c3 = driver.find_element(By.ID, "c3")
  460. c4 = driver.find_element(By.ID, "c4")
  461. c5 = driver.find_element(By.ID, "c5")
  462. c6 = driver.find_element(By.ID, "c6")
  463. c7 = driver.find_element(By.ID, "c7")
  464. l1 = driver.find_element(By.ID, "l1")
  465. l2 = driver.find_element(By.ID, "l2")
  466. l3 = driver.find_element(By.ID, "l3")
  467. l4 = driver.find_element(By.ID, "l4")
  468. s1 = driver.find_element(By.ID, "s1")
  469. s2 = driver.find_element(By.ID, "s2")
  470. s3 = driver.find_element(By.ID, "s3")
  471. c1s = driver.find_element(By.ID, "c1s")
  472. l1s = driver.find_element(By.ID, "l1s")
  473. s1s = driver.find_element(By.ID, "s1s")
  474. assert c1.text == "c1 value"
  475. assert c2.text == "c2 value"
  476. assert c3.text == "" # temporary cookie expired after reset state!
  477. assert c4.text == "c4 value"
  478. assert c5.text == "c5 value"
  479. assert c6.text == "c6 value"
  480. assert c7.text == "c7 value"
  481. assert l1.text == "l1 value"
  482. assert l2.text == "l2 value"
  483. assert l3.text == "l3 value"
  484. assert l4.text == "l4 value"
  485. assert s1.text == "s1 value"
  486. assert s2.text == "s2 value"
  487. assert s3.text == "s3 value"
  488. assert c1s.text == "c1s value"
  489. assert l1s.text == "l1s value"
  490. assert s1s.text == "s1s value"
  491. # make sure c5 cookie shows up on the `/foo` route
  492. AppHarness._poll_for(lambda: f"{sub_state_name}.c5" in cookie_info_map(driver))
  493. assert cookie_info_map(driver)[f"{sub_state_name}.c5"] == {
  494. "domain": "localhost",
  495. "httpOnly": False,
  496. "name": f"{sub_state_name}.c5",
  497. "path": "/foo/",
  498. "sameSite": "Lax",
  499. "secure": False,
  500. "value": "c5%20value",
  501. }
  502. # Open a new tab to check that sync'd local storage is working
  503. main_tab = driver.window_handles[0]
  504. driver.switch_to.new_window("window")
  505. driver.get(client_side.frontend_url)
  506. # New tab should have a different state token.
  507. assert poll_for_token() != token
  508. # Set values and check them in the new tab.
  509. set_sub("l5", "l5 value")
  510. set_sub("l6", "l6 value")
  511. l5 = driver.find_element(By.ID, "l5")
  512. l6 = driver.find_element(By.ID, "l6")
  513. assert AppHarness._poll_for(lambda: l6.text == "l6 value")
  514. assert l5.text == "l5 value"
  515. # Set session storage values in the new tab
  516. set_sub("s1", "other tab s1")
  517. s1 = driver.find_element(By.ID, "s1")
  518. s2 = driver.find_element(By.ID, "s2")
  519. s3 = driver.find_element(By.ID, "s3")
  520. assert AppHarness._poll_for(lambda: s1.text == "other tab s1")
  521. assert s2.text == "s2 default"
  522. assert s3.text == ""
  523. # Switch back to main window.
  524. driver.switch_to.window(main_tab)
  525. # The values should have updated automatically.
  526. l5 = driver.find_element(By.ID, "l5")
  527. l6 = driver.find_element(By.ID, "l6")
  528. assert AppHarness._poll_for(lambda: l6.text == "l6 value")
  529. assert l5.text == "l5 value"
  530. s1 = driver.find_element(By.ID, "s1")
  531. s2 = driver.find_element(By.ID, "s2")
  532. s3 = driver.find_element(By.ID, "s3")
  533. assert AppHarness._poll_for(lambda: s1.text == "s1 value")
  534. assert s2.text == "s2 value"
  535. assert s3.text == "s3 value"
  536. # Simulate state expiration
  537. if isinstance(client_side.state_manager, StateManagerRedis):
  538. await client_side.state_manager.redis.delete(
  539. _substate_key(token, State.get_full_name())
  540. )
  541. await client_side.state_manager.redis.delete(_substate_key(token, state_name))
  542. await client_side.state_manager.redis.delete(
  543. _substate_key(token, sub_state_name)
  544. )
  545. await client_side.state_manager.redis.delete(
  546. _substate_key(token, sub_sub_state_name)
  547. )
  548. elif isinstance(client_side.state_manager, (StateManagerMemory, StateManagerDisk)):
  549. del client_side.state_manager.states[token]
  550. if isinstance(client_side.state_manager, StateManagerDisk):
  551. client_side.state_manager.token_expiration = 0
  552. client_side.state_manager._purge_expired_states()
  553. # Ensure the state is gone (not hydrated)
  554. async def poll_for_not_hydrated():
  555. state = await client_side.get_state(_substate_key(token or "", state_name))
  556. return not state.is_hydrated
  557. assert await AppHarness._poll_for_async(poll_for_not_hydrated)
  558. # Trigger event to get a new instance of the state since the old was expired.
  559. set_sub("c1", "c1 post expire")
  560. # get new references to all cookie and local storage elements (again)
  561. c1 = driver.find_element(By.ID, "c1")
  562. c2 = driver.find_element(By.ID, "c2")
  563. c3 = driver.find_element(By.ID, "c3")
  564. c4 = driver.find_element(By.ID, "c4")
  565. c5 = driver.find_element(By.ID, "c5")
  566. c6 = driver.find_element(By.ID, "c6")
  567. c7 = driver.find_element(By.ID, "c7")
  568. l1 = driver.find_element(By.ID, "l1")
  569. l2 = driver.find_element(By.ID, "l2")
  570. l3 = driver.find_element(By.ID, "l3")
  571. l4 = driver.find_element(By.ID, "l4")
  572. s1 = driver.find_element(By.ID, "s1")
  573. s2 = driver.find_element(By.ID, "s2")
  574. s3 = driver.find_element(By.ID, "s3")
  575. c1s = driver.find_element(By.ID, "c1s")
  576. l1s = driver.find_element(By.ID, "l1s")
  577. s1s = driver.find_element(By.ID, "s1s")
  578. assert c1.text == "c1 post expire"
  579. assert c2.text == "c2 value"
  580. assert c3.text == "" # temporary cookie expired after reset state!
  581. assert c4.text == "c4 value"
  582. assert c5.text == "c5 value"
  583. assert c6.text == "c6 value"
  584. assert c7.text == "c7 value"
  585. assert l1.text == "l1 value"
  586. assert l2.text == "l2 value"
  587. assert l3.text == "l3 value"
  588. assert l4.text == "l4 value"
  589. assert s1.text == "s1 value"
  590. assert s2.text == "s2 value"
  591. assert s3.text == "s3 value"
  592. assert c1s.text == "c1s value"
  593. assert l1s.text == "l1s value"
  594. assert s1s.text == "s1s value"
  595. # Get the backend state and ensure the values are still set
  596. async def get_sub_state():
  597. root_state = await client_side.get_state(
  598. _substate_key(token or "", sub_state_name)
  599. )
  600. state = root_state.substates[client_side.get_state_name("_client_side_state")]
  601. sub_state = state.substates[
  602. client_side.get_state_name("_client_side_sub_state")
  603. ]
  604. return sub_state
  605. async def poll_for_c1_set():
  606. sub_state = await get_sub_state()
  607. return sub_state.c1 == "c1 post expire"
  608. assert await AppHarness._poll_for_async(poll_for_c1_set)
  609. sub_state = await get_sub_state()
  610. assert sub_state.c1 == "c1 post expire"
  611. assert sub_state.c2 == "c2 value"
  612. assert sub_state.c3 == ""
  613. assert sub_state.c4 == "c4 value"
  614. assert sub_state.c5 == "c5 value"
  615. assert sub_state.c6 == "c6 value"
  616. assert sub_state.c7 == "c7 value"
  617. assert sub_state.l1 == "l1 value"
  618. assert sub_state.l2 == "l2 value"
  619. assert sub_state.l3 == "l3 value"
  620. assert sub_state.l4 == "l4 value"
  621. assert sub_state.s1 == "s1 value"
  622. assert sub_state.s2 == "s2 value"
  623. assert sub_state.s3 == "s3 value"
  624. sub_sub_state = sub_state.substates[
  625. client_side.get_state_name("_client_side_sub_sub_state")
  626. ]
  627. assert sub_sub_state.c1s == "c1s value"
  628. assert sub_sub_state.l1s == "l1s value"
  629. assert sub_sub_state.s1s == "s1s value"
  630. # clear the cookie jar and local storage, ensure state reset to default
  631. driver.delete_all_cookies()
  632. local_storage.clear()
  633. # refresh the page to trigger re-hydrate
  634. driver.refresh()
  635. # wait for the backend connection to send the token (again)
  636. token_input = driver.find_element(By.ID, "token")
  637. assert token_input
  638. token = client_side.poll_for_value(token_input)
  639. assert token is not None
  640. # all values should be back to their defaults
  641. c1 = driver.find_element(By.ID, "c1")
  642. c2 = driver.find_element(By.ID, "c2")
  643. c3 = driver.find_element(By.ID, "c3")
  644. c4 = driver.find_element(By.ID, "c4")
  645. c5 = driver.find_element(By.ID, "c5")
  646. c6 = driver.find_element(By.ID, "c6")
  647. c7 = driver.find_element(By.ID, "c7")
  648. l1 = driver.find_element(By.ID, "l1")
  649. l2 = driver.find_element(By.ID, "l2")
  650. l3 = driver.find_element(By.ID, "l3")
  651. l4 = driver.find_element(By.ID, "l4")
  652. c1s = driver.find_element(By.ID, "c1s")
  653. l1s = driver.find_element(By.ID, "l1s")
  654. # assert on defaults where present
  655. assert c1.text == ""
  656. assert c2.text == "c2 default"
  657. assert c3.text == ""
  658. assert c4.text == ""
  659. assert c5.text == ""
  660. assert c6.text == ""
  661. assert c7.text == "c7 default"
  662. assert l1.text == ""
  663. assert l2.text == "l2 default"
  664. assert l3.text == ""
  665. assert l4.text == "l4 default"
  666. assert c1s.text == ""
  667. assert l1s.text == ""