feat(i18n): ✨ passed locale to build and request state (#43)

BREAKING CHANGE: build/request state now take locale as second parameter (request state takes request as third now)

Author: arctic-hen7

examples/basic/src/templates/index.rs

@@ -37,7 +37,7 @@ pub fn get_template<G: GenericNode>() -> Template<G> {
         .set_headers_fn(Rc::new(set_headers))
 }
 
-pub async fn get_build_props(_path: String) -> RenderFnResultWithCause<String> {
+pub async fn get_build_props(_path: String, _locale: String) -> RenderFnResultWithCause<String> {
     Ok(serde_json::to_string(&IndexPageProps {
         greeting: "Hello World!".to_string(),
     })?) // This `?` declares the default, that the server is the cause of the error

examples/i18n/src/templates/post.rs

@@ -37,7 +37,7 @@ pub fn get_template<G: GenericNode>() -> Template<G> {
         }))
 }
 
-pub async fn get_static_props(path: String) -> RenderFnResultWithCause<String> {
+pub async fn get_static_props(path: String, _locale: String) -> RenderFnResultWithCause<String> {
     // This is just an example
     let title = urlencoding::decode(&path).unwrap();
     let content = format!(

examples/showcase/src/templates/amalgamation.rs

@@ -42,13 +42,17 @@ pub fn amalgamate_states(states: States) -> RenderFnResultWithCause<Option<Strin
     })?))
 }
 
-pub async fn get_build_state(_path: String) -> RenderFnResultWithCause<String> {
+pub async fn get_build_state(_path: String, _locale: String) -> RenderFnResultWithCause<String> {
     Ok(serde_json::to_string(&AmalagamationPageProps {
         message: "Hello from the build process!".to_string(),
     })?)
 }
 
-pub async fn get_request_state(_path: String, _req: Request) -> RenderFnResultWithCause<String> {
+pub async fn get_request_state(
+    _path: String,
+    _locale: String,
+    _req: Request,
+) -> RenderFnResultWithCause<String> {
     // Err(perseus::GenericErrorWithCause {
     //     error: "this is a test error!".into(),
     //     cause: perseus::ErrorCause::Client(None)

examples/showcase/src/templates/index.rs

@@ -27,7 +27,7 @@ pub fn get_template<G: GenericNode>() -> Template<G> {
         }))
 }
 
-pub async fn get_static_props(_path: String) -> RenderFnResultWithCause<String> {
+pub async fn get_static_props(_path: String, _locale: String) -> RenderFnResultWithCause<String> {
     Ok(serde_json::to_string(&IndexPageProps {
         greeting: "Hello World!".to_string(),
     })?)

examples/showcase/src/templates/ip.rs

@@ -31,7 +31,11 @@ pub fn get_template<G: GenericNode>() -> Template<G> {
         }))
 }
 
-pub async fn get_request_state(_path: String, req: Request) -> RenderFnResultWithCause<String> {
+pub async fn get_request_state(
+    _path: String,
+    _locale: String,
+    req: Request,
+) -> RenderFnResultWithCause<String> {
     // Err(perseus::GenericErrorWithCause {
     //     error: "this is a test error!".into(),
     //     cause: perseus::ErrorCause::Client(None)

examples/showcase/src/templates/post.rs

@@ -39,7 +39,7 @@ pub fn get_template<G: GenericNode>() -> Template<G> {
         }))
 }
 
-pub async fn get_static_props(path: String) -> RenderFnResultWithCause<String> {
+pub async fn get_static_props(path: String, _locale: String) -> RenderFnResultWithCause<String> {
     // This path is illegal, and can't be rendered
     if path == "post/tests" {
         return Err(GenericErrorWithCause {

examples/showcase/src/templates/time.rs

@@ -33,7 +33,7 @@ pub fn get_template<G: GenericNode>() -> Template<G> {
         .build_paths_fn(Rc::new(get_build_paths))
 }
 
-pub async fn get_build_state(path: String) -> RenderFnResultWithCause<String> {
+pub async fn get_build_state(path: String, _locale: String) -> RenderFnResultWithCause<String> {
     // This path is illegal, and can't be rendered
     if path == "timeisr/tests" {
         return Err(GenericErrorWithCause {

examples/showcase/src/templates/time_root.rs

@@ -31,7 +31,7 @@ pub fn get_template<G: GenericNode>() -> Template<G> {
         .build_state_fn(Rc::new(get_build_state))
 }
 
-pub async fn get_build_state(_path: String) -> RenderFnResultWithCause<String> {
+pub async fn get_build_state(_path: String, _locale: String) -> RenderFnResultWithCause<String> {
     Ok(serde_json::to_string(&TimePageProps {
         time: format!("{:?}", std::time::SystemTime::now()),
     })?)

packages/perseus/src/build.rs

@@ -85,7 +85,7 @@ pub async fn build_template(
         if template.uses_build_state() && template.revalidates() {
             // We pass in the path to get a state (including the template path for consistency with the incremental logic)
             let initial_state = template
-                .get_build_state(full_path_without_locale.clone())
+                .get_build_state(full_path_without_locale.clone(), translator.get_locale())
                 .await?;
             // Write that intial state to a static JSON file
             mutable_store
@@ -112,7 +112,7 @@ pub async fn build_template(
         } else if template.uses_build_state() {
             // We pass in the path to get a state (including the template path for consistency with the incremental logic)
             let initial_state = template
-                .get_build_state(full_path_without_locale.clone())
+                .get_build_state(full_path_without_locale.clone(), translator.get_locale())
                 .await?;
             // Write that intial state to a static JSON file
             immutable_store

packages/perseus/src/serve.rs

@@ -96,7 +96,11 @@ async fn render_request_state(
     req: Request,
 ) -> Result<(String, String, Option<String>), ServerError> {
     // Generate the initial state (this may generate an error, but there's no file that can't exist)
-    let state = Some(template.get_request_state(path.to_string(), req).await?);
+    let state = Some(
+        template
+            .get_request_state(path.to_string(), translator.get_locale(), req)
+            .await?,
+    );
     // Use that to render the static HTML
     let html = sycamore::render_to_string(|| {
         template.render_for_template(state.clone(), Rc::clone(&translator), true)
@@ -177,7 +181,10 @@ async fn revalidate(
     // We need to regenerate and cache this page for future usage (until the next revalidation)
     let state = Some(
         template
-            .get_build_state(format!("{}/{}", template.get_path(), path))
+            .get_build_state(
+                format!("{}/{}", template.get_path(), path),
+                translator.get_locale(),
+            )
             .await?,
     );
     let html = sycamore::render_to_string(|| {
@@ -297,7 +304,11 @@ pub async fn get_page_for_template(
                 // All this uses the mutable store because this will be done at runtime
                 None => {
                     // We need to generate and cache this page for future usage
-                    let state = Some(template.get_build_state(path.to_string()).await?);
+                    let state = Some(
+                        template
+                            .get_build_state(path.to_string(), locale.to_string())
+                            .await?,
+                    );
                     let html_val = sycamore::render_to_string(|| {
                         template.render_for_template(state.clone(), Rc::clone(&translator), true)
                     });

packages/perseus/src/template.rs

@@ -120,12 +120,14 @@ make_async_trait!(GetBuildPathsFnType, RenderFnResult<Vec<String>>);
 make_async_trait!(
     GetBuildStateFnType,
     RenderFnResultWithCause<String>,
-    path: String
+    path: String,
+    locale: String
 );
 make_async_trait!(
     GetRequestStateFnType,
     RenderFnResultWithCause<String>,
     path: String,
+    locale: String,
     req: Request
 );
 make_async_trait!(ShouldRevalidateFnType, RenderFnResultWithCause<bool>);
@@ -279,10 +281,15 @@ impl<G: GenericNode> Template<G> {
         }
     }
     /// Gets the initial state for a template. This needs to be passed the full path of the template, which may be one of those generated by
-    /// `.get_build_paths()`.
-    pub async fn get_build_state(&self, path: String) -> Result<String, ServerError> {
+    /// `.get_build_paths()`. This also needs the locale being rendered to so that more compelx applications like custom documentation
+    /// systems can be enabled.
+    pub async fn get_build_state(
+        &self,
+        path: String,
+        locale: String,
+    ) -> Result<String, ServerError> {
         if let Some(get_build_state) = &self.get_build_state {
-            let res = get_build_state.call(path).await;
+            let res = get_build_state.call(path, locale).await;
             match res {
                 Ok(res) => Ok(res),
                 Err(GenericErrorWithCause { error, cause }) => Err(ServerError::RenderFnFailed {
@@ -302,14 +309,15 @@ impl<G: GenericNode> Template<G> {
     }
     /// Gets the request-time state for a template. This is equivalent to SSR, and will not be performed at build-time. Unlike
     /// `.get_build_paths()` though, this will be passed information about the request that triggered the render. Errors here can be caused
-    /// by either the server or the client, so the user must specify an [`ErrorCause`].
+    /// by either the server or the client, so the user must specify an [`ErrorCause`]. This is also passed the locale being rendered to.
     pub async fn get_request_state(
         &self,
         path: String,
+        locale: String,
         req: Request,
     ) -> Result<String, ServerError> {
         if let Some(get_request_state) = &self.get_request_state {
-            let res = get_request_state.call(path, req).await;
+            let res = get_request_state.call(path, locale, req).await;
             match res {
                 Ok(res) => Ok(res),
                 Err(GenericErrorWithCause { error, cause }) => Err(ServerError::RenderFnFailed {