hydrate_middleware.py 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. """Middleware to hydrate the state."""
  2. from __future__ import annotations
  3. import dataclasses
  4. from typing import TYPE_CHECKING
  5. from reflex import constants
  6. from reflex.event import Event, get_hydrate_event
  7. from reflex.middleware.middleware import Middleware
  8. from reflex.state import BaseState, StateUpdate, _resolve_delta
  9. if TYPE_CHECKING:
  10. from reflex.app import App
  11. @dataclasses.dataclass(init=True)
  12. class HydrateMiddleware(Middleware):
  13. """Middleware to handle initial app hydration."""
  14. async def preprocess(
  15. self, app: App, state: BaseState, event: Event
  16. ) -> StateUpdate | None:
  17. """Preprocess the event.
  18. Args:
  19. app: The app to apply the middleware to.
  20. state: The client state.
  21. event: The event to preprocess.
  22. Returns:
  23. An optional delta or list of state updates to return.
  24. """
  25. # If this is not the hydrate event, return None
  26. if event.name != get_hydrate_event(state):
  27. return None
  28. # Clear client storage, to respect clearing cookies
  29. state._reset_client_storage()
  30. # Mark state as not hydrated (until on_loads are complete)
  31. setattr(state, constants.CompileVars.IS_HYDRATED, False)
  32. # Get the initial state.
  33. delta = await _resolve_delta(state.dict())
  34. # since a full dict was captured, clean any dirtiness
  35. state._clean()
  36. # Return the state update.
  37. return StateUpdate(delta=delta, events=[])