1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
use crate::errors::*;
use crate::router::{RouterLoadState, RouterState};
use crate::state::{
AnyFreeze, Freeze, FrozenApp, GlobalState, MakeRx, MakeUnrx, PageStateStore, ThawPrefs,
};
use crate::translator::Translator;
use std::cell::{Cell, RefCell};
use std::rc::Rc;
use sycamore_router::navigate;
/// This encapsulates all elements of context currently provided to Perseus templates. While this can be used manually, there are macros
/// to make this easier for each thing in here.
#[derive(Clone, Debug)]
pub struct RenderCtx {
/// Whether or not we're being executed on the server-side. This can be used to gate `web_sys` functions and the like that expect
/// to be run in the browser.
pub is_server: bool,
/// A translator for templates to use. This will still be present in non-i18n apps, but it will have no message IDs and support for
/// the non-existent locale `xx-XX`. This uses an `Arc<T>` for thread-safety.
pub translator: Translator,
/// The router's state.
pub router: RouterState,
/// The page state store for the app. This is a type map to which pages can add state that they need to access later. Usually, this will be interfaced with through
/// the `#[perseus::template_with_rx_state(...)]` macro, but it can be used manually as well to get the state of one page from another (provided that the target page has already
/// been visited).
pub page_state_store: PageStateStore,
/// The user-provided global state. This is stored on the heap to avoid a type parameter that would be needed every time we had to access the render context (which would be very difficult
/// to pass around inside Perseus).
///
/// Because we store `dyn Any` in here, we initialize it as `Option::None`, and then the template macro (which does the heavy lifting for global state) will find that it can't downcast
/// to the user's global state type, which will prompt it to deserialize whatever global state it was given and then write that here.
pub global_state: GlobalState,
/// A previous state the app was once in, still serialized. This will be rehydrated gradually by the template macro.
pub frozen_app: Rc<RefCell<Option<(FrozenApp, ThawPrefs)>>>,
/// Whether or not this page is the very first to have been rendered since the browser loaded the app. This will be reset on full reloads, and is used internally to determine whether or
/// not we should look for stored HSR state.
pub is_first: Rc<Cell<bool>>,
#[cfg(all(feature = "live-reload", debug_assertions))]
/// An indicator `Signal` used to allow the root to instruct the app that we're about to reload because of an instruction from the live reloading server. Hooking into this to run code
/// before live reloading takes place is NOT supported, as no guarantee can be made that your code will run before Perseus reloads the page fully (at which point no more code will run).
pub live_reload_indicator: sycamore::prelude::ReadSignal<bool>,
}
impl Freeze for RenderCtx {
/// 'Freezes' the relevant parts of the render configuration to a serialized `String` that can later be used to re-initialize the app to the same state at the time of freezing.
fn freeze(&self) -> String {
let frozen_app = FrozenApp {
global_state: self.global_state.0.borrow().freeze(),
route: match &*self.router.get_load_state().get_untracked() {
RouterLoadState::Loaded { path, .. } => path,
RouterLoadState::Loading { path, .. } => path,
// If we encounter this during re-hydration, we won't try to set the URL in the browser
RouterLoadState::Server => "SERVER",
}
.to_string(),
page_state_store: self.page_state_store.freeze_to_hash_map(),
};
serde_json::to_string(&frozen_app).unwrap()
}
}
impl RenderCtx {
/// Commands Perseus to 'thaw' the app from the given frozen state. You'll also need to provide preferences for thawing, which allow you to control how different pages should prioritize
/// frozen state over existing (or *active*) state. Once you call this, assume that any following logic will not run, as this may navigate to a different route in your app. How you get
/// the frozen state to supply to this is up to you.
///
/// If the app has already been thawed from a previous frozen state, any state used from that will be considered *active* for this thawing.
///
/// This will return an error if the frozen state provided is invalid. However, if the frozen state for an individual page is invalid, it will be silently ignored in favor of either the
/// active state or the server-provided state.
pub fn thaw(&self, new_frozen_app: &str, thaw_prefs: ThawPrefs) -> Result<(), ClientError> {
let new_frozen_app: FrozenApp = serde_json::from_str(new_frozen_app)
.map_err(|err| ClientError::ThawFailed { source: err })?;
let route = new_frozen_app.route.clone();
// Set everything in the render context
let mut frozen_app = self.frozen_app.borrow_mut();
*frozen_app = Some((new_frozen_app, thaw_prefs));
// I'm not absolutely certain about destructor behavior with navigation or how that could change with the new primitives, so better to be safe than sorry
drop(frozen_app);
// Check if we're on the same page now as we were at freeze-time
let curr_route = match &*self.router.get_load_state().get_untracked() {
RouterLoadState::Loaded { path, .. } => path.to_string(),
RouterLoadState::Loading { path, .. } => path.to_string(),
// The user is trying to thaw on the server, which is an absolutely horrific idea (we should be generating state, and loops could happen)
RouterLoadState::Server => panic!("attempted to thaw frozen state on server-side (you can only do this in the browser)"),
};
if curr_route == route {
// We'll need to imperatively instruct the router to reload the current page (Sycamore can't do this yet)
// We know the last verdict will be available because the only way we can be here is if we have a page
self.router.reload();
} else {
// We aren't, navigate to the old route as usual
navigate(&route);
}
Ok(())
}
/// An internal getter for the frozen state for the given page. When this is called, it will also add any frozen state
/// it finds to the page state store, overriding what was already there.
fn get_frozen_page_state_and_register<R>(
&mut self,
url: &str,
) -> Option<<R::Unrx as MakeRx>::Rx>
where
R: Clone + AnyFreeze + MakeUnrx,
// We need this so that the compiler understands that the reactive version of the unreactive version of `R` has the same properties as `R` itself
<<R as MakeUnrx>::Unrx as MakeRx>::Rx: Clone + AnyFreeze + MakeUnrx,
{
let frozen_app_full = self.frozen_app.borrow();
if let Some((frozen_app, thaw_prefs)) = &*frozen_app_full {
// Check against the thaw preferences if we should prefer frozen state over active state
if thaw_prefs.page.should_use_frozen_state(url) {
// Get the serialized and unreactive frozen state from the store
match frozen_app.page_state_store.get(url) {
Some(state_str) => {
// Deserialize into the unreactive version
let unrx = match serde_json::from_str::<R::Unrx>(state_str) {
Ok(unrx) => unrx,
// The frozen state could easily be corrupted, so we'll fall back to the active state (which is already reactive)
// We break out here to avoid double-storing this and trying to make a reactive thing reactive
Err(_) => return None,
};
// This returns the reactive version of the unreactive version of `R`, which is why we have to make everything else do the same
// Then we convince the compiler that that actually is `R` with the ludicrous trait bound at the beginning of this function
let rx = unrx.make_rx();
// And we do want to add this to the page state store
self.page_state_store.add(url, rx.clone());
// Now we should remove this from the frozen state so we don't fall back to it again
drop(frozen_app_full);
let mut frozen_app_val = self.frozen_app.take().unwrap(); // We're literally in a conditional that checked this
frozen_app_val.0.page_state_store.remove(url);
let mut frozen_app = self.frozen_app.borrow_mut();
*frozen_app = Some(frozen_app_val);
Some(rx)
}
// If there's nothing in the frozen state, we'll fall back to the active state
None => self.page_state_store.get::<<R::Unrx as MakeRx>::Rx>(url),
}
} else {
None
}
} else {
None
}
}
/// An internal getter for the active (already registered) state for the given page.
fn get_active_page_state<R>(&self, url: &str) -> Option<<R::Unrx as MakeRx>::Rx>
where
R: Clone + AnyFreeze + MakeUnrx,
// We need this so that the compiler understands that the reactive version of the unreactive version of `R` has the same properties as `R` itself
<<R as MakeUnrx>::Unrx as MakeRx>::Rx: Clone + AnyFreeze + MakeUnrx,
{
self.page_state_store.get::<<R::Unrx as MakeRx>::Rx>(url)
}
/// Gets either the active state or the frozen state for the given page. If `.thaw()` has been called, thaw preferences will be registered, which this will use to decide whether to use
/// frozen or active state. If neither is available, the caller should use generated state instead.
///
/// This takes a single type parameter for the reactive state type, from which the unreactive state type can be derived.
pub fn get_active_or_frozen_page_state<R>(
&mut self,
url: &str,
) -> Option<<R::Unrx as MakeRx>::Rx>
where
R: Clone + AnyFreeze + MakeUnrx,
// We need this so that the compiler understands that the reactive version of the unreactive version of `R` has the same properties as `R` itself
<<R as MakeUnrx>::Unrx as MakeRx>::Rx: Clone + AnyFreeze + MakeUnrx,
{
let frozen_app_full = self.frozen_app.borrow();
if let Some((_, thaw_prefs)) = &*frozen_app_full {
// Check against the thaw preferences if we should prefer frozen state over active state
if thaw_prefs.page.should_use_frozen_state(url) {
drop(frozen_app_full);
// We'll fall back to active state if no frozen state is available
match self.get_frozen_page_state_and_register::<R>(url) {
Some(state) => Some(state),
None => self.get_active_page_state::<R>(url),
}
} else {
drop(frozen_app_full);
// We're preferring active state, but we'll fall back to frozen state if none is available
match self.get_active_page_state::<R>(url) {
Some(state) => Some(state),
None => self.get_frozen_page_state_and_register::<R>(url),
}
}
} else {
// No frozen state exists, so we of course shouldn't prioritize it
self.get_active_page_state::<R>(url)
}
}
/// An internal getter for the frozen global state. When this is called, it will also add any frozen state to the registered
/// global state, removing whatever was there before.
fn get_frozen_global_state_and_register<R>(&mut self) -> Option<<R::Unrx as MakeRx>::Rx>
where
R: Clone + AnyFreeze + MakeUnrx,
// We need this so that the compiler understands that the reactive version of the unreactive version of `R` has the same properties as `R` itself
<<R as MakeUnrx>::Unrx as MakeRx>::Rx: Clone + AnyFreeze + MakeUnrx,
{
let frozen_app_full = self.frozen_app.borrow();
if let Some((frozen_app, thaw_prefs)) = &*frozen_app_full {
// Check against the thaw preferences if we should prefer frozen state over active state
if thaw_prefs.global_prefer_frozen {
// Get the serialized and unreactive frozen state from the store
match frozen_app.global_state.as_str() {
// See `rx_state.rs` for why this would be the default value
"None" => None,
state_str => {
// Deserialize into the unreactive version
let unrx = match serde_json::from_str::<R::Unrx>(state_str) {
Ok(unrx) => unrx,
// The frozen state could easily be corrupted
Err(_) => return None,
};
// This returns the reactive version of the unreactive version of `R`, which is why we have to make everything else do the same
// Then we convince the compiler that that actually is `R` with the ludicrous trait bound at the beginning of this function
let rx = unrx.make_rx();
// And we'll register this as the new active global state
let mut active_global_state = self.global_state.0.borrow_mut();
*active_global_state = Box::new(rx.clone());
// Now we should remove this from the frozen state so we don't fall back to it again
drop(frozen_app_full);
let mut frozen_app_val = self.frozen_app.take().unwrap(); // We're literally in a conditional that checked this
frozen_app_val.0.global_state = "None".to_string();
let mut frozen_app = self.frozen_app.borrow_mut();
*frozen_app = Some(frozen_app_val);
Some(rx)
}
}
} else {
None
}
} else {
None
}
}
/// An internal getter for the active (already registered) global state.
fn get_active_global_state<R>(&self) -> Option<<R::Unrx as MakeRx>::Rx>
where
R: Clone + AnyFreeze + MakeUnrx,
// We need this so that the compiler understands that the reactive version of the unreactive version of `R` has the same properties as `R` itself
<<R as MakeUnrx>::Unrx as MakeRx>::Rx: Clone + AnyFreeze + MakeUnrx,
{
self.global_state
.0
.borrow()
.as_any()
.downcast_ref::<<R::Unrx as MakeRx>::Rx>()
.cloned()
}
/// Gets either the active or the frozen global state, depending on thaw preferences. Otherwise, this is exactly the same as `.get_active_or_frozen_state()`.
pub fn get_active_or_frozen_global_state<R>(&mut self) -> Option<<R::Unrx as MakeRx>::Rx>
where
R: Clone + AnyFreeze + MakeUnrx,
// We need this so that the compiler understands that the reactive version of the unreactive version of `R` has the same properties as `R` itself
<<R as MakeUnrx>::Unrx as MakeRx>::Rx: Clone + AnyFreeze + MakeUnrx,
{
let frozen_app_full = self.frozen_app.borrow();
if let Some((_, thaw_prefs)) = &*frozen_app_full {
// Check against the thaw preferences if we should prefer frozen state over active state
if thaw_prefs.global_prefer_frozen {
drop(frozen_app_full);
// We'll fall back to the active state if there's no frozen state
match self.get_frozen_global_state_and_register::<R>() {
Some(state) => Some(state),
None => self.get_active_global_state::<R>(),
}
} else {
drop(frozen_app_full);
// We'll fall back to the frozen state there's no active state available
match self.get_active_global_state::<R>() {
Some(state) => Some(state),
None => self.get_frozen_global_state_and_register::<R>(),
}
}
} else {
// No frozen state exists, so we of course shouldn't prioritize it
self.get_active_global_state::<R>()
}
}
/// Registers a serialized and unreactive state string to the page state store, returning a fully reactive version.
pub fn register_page_state_str<R>(
&mut self,
url: &str,
state_str: &str,
) -> Result<<R::Unrx as MakeRx>::Rx, ClientError>
where
R: Clone + AnyFreeze + MakeUnrx,
// We need this so that the compiler understands that the reactive version of the unreactive version of `R` has the same properties as `R` itself
<<R as MakeUnrx>::Unrx as MakeRx>::Rx: Clone + AnyFreeze + MakeUnrx,
{
// Deserialize it (we know nothing about the calling situation, so we assume it could be invalid, hence the fallible return type)
let unrx = serde_json::from_str::<R::Unrx>(state_str)
.map_err(|err| ClientError::StateInvalid { source: err })?;
let rx = unrx.make_rx();
self.page_state_store.add(url, rx.clone());
Ok(rx)
}
/// Registers a serialized and unreactive state string as the new active global state, returning a fully reactive version.
pub fn register_global_state_str<R>(
&mut self,
state_str: &str,
) -> Result<<R::Unrx as MakeRx>::Rx, ClientError>
where
R: Clone + AnyFreeze + MakeUnrx,
// We need this so that the compiler understands that the reactive version of the unreactive version of `R` has the same properties as `R` itself
<<R as MakeUnrx>::Unrx as MakeRx>::Rx: Clone + AnyFreeze + MakeUnrx,
{
// Deserialize it (we know nothing about the calling situation, so we assume it could be invalid, hence the fallible return type)
let unrx = serde_json::from_str::<R::Unrx>(state_str)
.map_err(|err| ClientError::StateInvalid { source: err })?;
let rx = unrx.make_rx();
let mut active_global_state = self.global_state.0.borrow_mut();
*active_global_state = Box::new(rx.clone());
Ok(rx)
}
}
/// Gets the `RenderCtx` efficiently.
#[macro_export]
macro_rules! get_render_ctx {
() => {
::sycamore::context::use_context::<::perseus::templates::RenderCtx>()
};
}