feat: remove localized global state (#268)

arctic-hen7 · web-flow · commit 2017f69a978f · 2023-04-03T06:46:20.000+01:00
* feat: removed localized global state This completely axes the feature, and returns global state to a one-per-app system. BREAKING CHANGE: removed localized global state (global state functions should no longer take a locale) * fix: transmitted global state in locale redirection pages This fixes #267, but only when global state is unlocalized. * fix: fixed broken examples * fix: fixed broken demo example * chore(deps): updated dependencies extensively Not strictly relevant to this PR, but important nonetheless. Note that this includes a progression of the `minify-html-onepass` crate version, which *could* cause problems, so that should be reverted to v0.10.1 if there are issues.
diff --git a/examples/core/basic/Cargo.toml b/examples/core/basic/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [target.'cfg(engine)'.dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/capsules/Cargo.toml b/examples/core/capsules/Cargo.toml
@@ -13,7 +13,7 @@ serde_json = "1"
 lazy_static = "1"
 
 [target.'cfg(engine)'.dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/custom_server/Cargo.toml b/examples/core/custom_server/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [target.'cfg(engine)'.dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/error_views/Cargo.toml b/examples/core/error_views/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [target.'cfg(engine)'.dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/freezing_and_thawing/Cargo.toml b/examples/core/freezing_and_thawing/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/freezing_and_thawing/src/global_state.rs b/examples/core/freezing_and_thawing/src/global_state.rs
@@ -12,7 +12,7 @@ pub struct AppState {
 }
 
 #[engine_only_fn]
-async fn get_build_state(_locale: String) -> AppState {
+async fn get_build_state() -> AppState {
     AppState {
         test: "Hello World!".to_string(),
     }
diff --git a/examples/core/global_state/Cargo.toml b/examples/core/global_state/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/global_state/src/global_state.rs b/examples/core/global_state/src/global_state.rs
@@ -22,7 +22,7 @@ pub struct AppState {
 // Global state will be generated for each locale in your app (but we don't
 // worry about that in this example)
 #[engine_only_fn]
-async fn get_build_state(_locale: String) -> AppState {
+async fn get_build_state() -> AppState {
     AppState {
         test: "Hello from the build process!".to_string(),
     }
@@ -34,19 +34,15 @@ async fn get_build_state(_locale: String) -> AppState {
 // prevent your app from accessing global state during the build process, so be
 // certain that's what you want if you go down that path.
 #[engine_only_fn]
-async fn get_request_state(_locale: String, _req: Request) -> AppState {
+async fn get_request_state(_req: Request) -> AppState {
     AppState {
         test: "Hello from the server!".to_string(),
     }
 }
 
 // You can even combine build state with request state, just like in a template!
 #[engine_only_fn]
-async fn amalgamate_states(
-    _locale: String,
-    build_state: AppState,
-    request_state: AppState,
-) -> AppState {
+async fn amalgamate_states(build_state: AppState, request_state: AppState) -> AppState {
     AppState {
         test: format!(
             "Message from the builder: '{}' Message from the server: '{}'",
diff --git a/examples/core/helper_build_state/Cargo.toml b/examples/core/helper_build_state/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [target.'cfg(engine)'.dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/i18n/Cargo.toml b/examples/core/i18n/Cargo.toml
@@ -15,7 +15,7 @@ fluent-bundle = "0.15"
 urlencoding = "2.1"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/idb_freezing/Cargo.toml b/examples/core/idb_freezing/Cargo.toml
@@ -13,7 +13,7 @@ serde_json = "1"
 wasm-bindgen-futures = "0.4"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/idb_freezing/src/global_state.rs b/examples/core/idb_freezing/src/global_state.rs
@@ -12,7 +12,7 @@ pub struct AppState {
 }
 
 #[engine_only_fn]
-async fn get_build_state(_locale: String) -> AppState {
+async fn get_build_state() -> AppState {
     AppState {
         test: "Hello World!".to_string(),
     }
diff --git a/examples/core/index_view/Cargo.toml b/examples/core/index_view/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/js_interop/Cargo.toml b/examples/core/js_interop/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [target.'cfg(engine)'.dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/plugins/Cargo.toml b/examples/core/plugins/Cargo.toml
@@ -10,10 +10,10 @@ perseus = { path = "../../../packages/perseus", features = [ "hydrate" ] }
 sycamore = "^0.8.1"
 serde = { version = "1", features = [ "derive" ] }
 serde_json = "1"
-toml = "0.5"
+toml = "0.7"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/preload/Cargo.toml b/examples/core/preload/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [target.'cfg(engine)'.dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/rx_state/Cargo.toml b/examples/core/rx_state/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/set_headers/Cargo.toml b/examples/core/set_headers/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 ureq = "2"
 
 [target.'cfg(engine)'.dependencies]
diff --git a/examples/core/state_generation/Cargo.toml b/examples/core/state_generation/Cargo.toml
@@ -13,7 +13,7 @@ serde_json = "1"
 anyhow = "1"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/state_generation/src/templates/incremental_generation.rs b/examples/core/state_generation/src/templates/incremental_generation.rs
@@ -56,7 +56,8 @@ async fn get_build_state(
         // This tells Perseus to return an error that's the client's fault, with the
         // HTTP status code 404 (not found) and the message 'illegal page'. Note that
         // this is a `BlamedError<std::io::Error>`, but we could use any error type that
-        // implements `std::error::Error` or can be converted into a boxed `std::error::Error`.
+        // implements `std::error::Error` or can be converted into a boxed
+        // `std::error::Error`.
         return Err(BlamedError {
             // If we used `None` instead, it would default to 400 for the client and 500 for the
             // server
diff --git a/examples/core/static_content/Cargo.toml b/examples/core/static_content/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/suspense/Cargo.toml b/examples/core/suspense/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [target.'cfg(engine)'.dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/core/unreactive/Cargo.toml b/examples/core/unreactive/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/examples/demos/auth/src/global_state.rs b/examples/demos/auth/src/global_state.rs
@@ -6,7 +6,7 @@ pub fn get_global_state_creator() -> GlobalStateCreator {
 }
 
 #[engine_only_fn]
-async fn get_build_state(_locale: String) -> AppState {
+async fn get_build_state() -> AppState {
     AppState {
         // We explicitly tell the first page that no login state has been checked yet
         auth: AuthData {
diff --git a/examples/demos/fetching/Cargo.toml b/examples/demos/fetching/Cargo.toml
@@ -20,4 +20,4 @@ perseus-axum = { package = "perseus-integration", path = "../../../packages/pers
 reqwest = "0.11"
 
 [target.'cfg(client)'.dependencies]
-reqwasm = "0.4"
+reqwasm = "0.5"
diff --git a/examples/demos/full_page_layout/Cargo.toml b/examples/demos/full_page_layout/Cargo.toml
@@ -12,7 +12,7 @@ serde = { version = "1", features = ["derive"] }
 serde_json = "1"
 
 [target.'cfg(engine)'.dev-dependencies]
-fantoccini = "0.17"
+fantoccini = "0.19"
 
 [target.'cfg(engine)'.dependencies]
 tokio = { version = "1", features = [ "macros", "rt", "rt-multi-thread" ] }
diff --git a/packages/perseus-actix-web/Cargo.toml b/packages/perseus-actix-web/Cargo.toml
@@ -15,7 +15,7 @@ categories = ["wasm", "web-programming::http-server", "development-tools", "asyn
 
 [dependencies]
 perseus = { path = "../perseus", version = "0.4.0-beta.22" }
-actix-web = "4.2"
+actix-web = "4.3"
 actix-files = "0.6"
 futures = "0.3"
 
diff --git a/packages/perseus-axum/Cargo.toml b/packages/perseus-axum/Cargo.toml
@@ -16,6 +16,7 @@ categories = ["wasm", "web-programming::http-server", "development-tools", "asyn
 [dependencies]
 perseus = { path = "../perseus", version = "0.4.0-beta.22" }
 axum = "0.6"
+# Axum requires v0.3 of this
 tower-http = { version = "0.3", features = [ "fs" ] }
 
 [features]
diff --git a/packages/perseus-cli/Cargo.toml b/packages/perseus-cli/Cargo.toml
@@ -27,36 +27,36 @@ path = "tests/lib.rs"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-include_dir = "0.6"
+include_dir = "0.7"
 thiserror = "1"
 fmterr = "0.1"
 cargo_toml = "0.15"
 indicatif = "=0.17.0-beta.1" # Not stable, but otherwise error handling is just about impossible
-console = "0.14"
+console = "0.15"
 serde = "1"
 serde_json = "1"
-clap = { version = "3.2", features = [ "color", "derive", "unstable-v4" ] }
+clap = { version = "4.2", features = [ "color", "derive" ] }
 fs_extra = "1"
 tokio = { version = "1", features = [ "macros", "rt-multi-thread", "sync" ] }
 warp = "0.3"
-command-group = "1"
-ctrlc = { version = "3.0", features = ["termination"] }
+command-group = "2"
+ctrlc = { version = "3.2", features = ["termination"] }
 notify = "=5.0.0-pre.13"
 futures = "0.3"
 tokio-stream = "0.1"
 reqwest = { version = "0.11", features = [ "json", "stream" ] }
 tar = "0.4"
 flate2 = "1"
-directories = "4"
+directories = "5"
 cargo_metadata = "0.15"
 cargo-lock = "8"
-minify-js = "0.4"
+minify-js = "=0.4.3" # Be careful changing this, and test extensively!
 walkdir = "2"
 
 [dev-dependencies]
 assert_cmd = "2"
 assert_fs = "1"
-predicates = "2"
+predicates = "3"
 ureq = "2"
 
 [lib]
diff --git a/packages/perseus-macro/Cargo.toml b/packages/perseus-macro/Cargo.toml
@@ -17,9 +17,9 @@ proc-macro = true
 
 [dependencies]
 quote = "1"
-syn = "1"
+syn = "1" # Needs to remain on v1 until `darling` updates
 proc-macro2 = "1"
-darling = "0.13"
+darling = "0.14"
 
 [dev-dependencies]
 trybuild = { version = "1.0", features = ["diff"] }
diff --git a/packages/perseus/Cargo.toml b/packages/perseus/Cargo.toml
@@ -36,14 +36,14 @@ http = "0.2"
 urlencoding = "2.1"
 chrono = "0.4"
 # Be very careful about changing this! Patches may be required in Perseus.
-minify-html-onepass = "=0.10.1"
+minify-html-onepass = "=0.10.8"
 
 # These dependencies will also be available in documentation
 [target.'cfg(any(client, clientdoc))'.dependencies]
 rexie = { version = "0.4", optional = true, default-features = false }
 js-sys = { version = "0.3", optional = true }
 # Note that this is not needed in production, but that can't be specified, so it will just be compiled away to nothing
-console_error_panic_hook = { version = "0.1.6", optional = true }
+console_error_panic_hook = { version = "0.1.7", optional = true }
 # TODO review feature flags here
 web-sys = { version = "0.3", features = [ "Headers", "Navigator", "NodeList", "Request", "RequestInit", "RequestMode", "Response", "ReadableStream", "Window", "CustomEvent", "CustomEventInit" ] }
 wasm-bindgen = "0.2"
diff --git a/packages/perseus/src/reactor/mod.rs b/packages/perseus/src/reactor/mod.rs
@@ -162,6 +162,7 @@ impl<G: Html, M: MutableStore, T: TranslationsManager> TryFrom<PerseusAppBase<G,
                     return Err(ClientInvariantError::RenderCfg.into())
                 }
             };
+        // NOTE: This will be transmitted on all pages, including local redirection ones
         let global_state_ty = match WindowVariable::<Value>::new_obj("__PERSEUS_GLOBAL_STATE") {
             WindowVariable::Some(val) => {
                 let state = TemplateState::from_value(val);
diff --git a/packages/perseus/src/server/html_shell.rs b/packages/perseus/src/server/html_shell.rs
@@ -267,8 +267,18 @@ impl HtmlShell {
     ///
     /// Further, this will preload the Wasm binary, making redirection snappier
     /// (but initial load slower), a tradeoff that generally improves UX.
-    pub(crate) fn locale_redirection_fallback(mut self, redirect_url: &str) -> Self {
+    pub(crate) fn locale_redirection_fallback(
+        mut self,
+        redirect_url: &str,
+        global_state: &TemplateState,
+    ) -> Self {
         self.locale = "xx-XX".to_string();
+
+        // We still have to inject the global state, which is unlocalized (see #267)
+        let global_state = escape_page_data(&global_state.state.to_string());
+        let global_state = format!("window.__PERSEUS_GLOBAL_STATE = `{}`;", global_state);
+        self.scripts_before_boundary.push(global_state);
+
         // This will be used if JavaScript is completely disabled (it's then the site's
         // responsibility to show a further message)
         let dumb_redirect = format!(
diff --git a/packages/perseus/src/state/global_state.rs b/packages/perseus/src/state/global_state.rs
diff --git a/packages/perseus/src/turbine/build.rs b/packages/perseus/src/turbine/build.rs
diff --git a/packages/perseus/src/turbine/export.rs b/packages/perseus/src/turbine/export.rs
diff --git a/packages/perseus/src/turbine/mod.rs b/packages/perseus/src/turbine/mod.rs
diff --git a/packages/perseus/src/turbine/serve.rs b/packages/perseus/src/turbine/serve.rs
diff --git a/packages/perseus/src/turbine/server.rs b/packages/perseus/src/turbine/server.rs
diff --git a/website/Cargo.toml b/website/Cargo.toml

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ pub struct AppState {`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`#[engine_only_fn]`
`15`		`-async fn get_build_state(_locale: String) -> AppState {`
	`15`	`+async fn get_build_state() -> AppState {`
`16`	`16`	`AppState {`
`17`	`17`	`test: "Hello World!".to_string(),`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ pub fn get_global_state_creator() -> GlobalStateCreator {`
`6`	`6`	`}`
`7`	`7`
`8`	`8`	`#[engine_only_fn]`
`9`		`-async fn get_build_state(_locale: String) -> AppState {`
	`9`	`+async fn get_build_state() -> AppState {`
`10`	`10`	`AppState {`
`11`	`11`	`// We explicitly tell the first page that no login state has been checked yet`
`12`	`12`	`auth: AuthData {`
Original file line number	Diff line number	Diff line change
`@@ -162,6 +162,7 @@ impl<G: Html, M: MutableStore, T: TranslationsManager> TryFrom<PerseusAppBase<G,`
`162`	`162`	`return Err(ClientInvariantError::RenderCfg.into())`
`163`	`163`	`}`
`164`	`164`	`};`
	`165`	`+ // NOTE: This will be transmitted on all pages, including local redirection ones`
`165`	`166`	`let global_state_ty = match WindowVariable::<Value>::new_obj("__PERSEUS_GLOBAL_STATE") {`
`166`	`167`	`WindowVariable::Some(val) => {`
`167`	`168`	`let state = TemplateState::from_value(val);`