diff --git a/docs/next/en-US/SUMMARY.md b/docs/next/en-US/SUMMARY.md index f913193673..0c01450bf0 100644 --- a/docs/next/en-US/SUMMARY.md +++ b/docs/next/en-US/SUMMARY.md @@ -28,7 +28,7 @@ - [Request State](/docs/strategies/request-state) - [Revalidation](/docs/strategies/revalidation) - [Incremental Generation](/docs/strategies/incremental) - - [State Amalgamation](/docs/strategies/amlagamation) + - [State Amalgamation](/docs/strategies/amalgamation) - [CLI](/docs/cli) - [Ejecting](/docs/ejecting) - [Testing](/docs/testing/intro) @@ -40,12 +40,12 @@ - [Stores](/docs/stores) - [Static Exporting](/docs/exporting) - [Plugins](/docs/plugins/intro) - - [Functional Actions](/docs/plugins/functional) - - [Control Actions](/docs/plugins/control) - - [Using Plugins](/docs/plugins/using) - - [The `tinker` Action](/docs/plugins/tinker) - - [Writing Plugins](/docs/plugins/writing) - - [Security Considerations](/docs/plugins/security) + - [Functional Actions](/docs/plugins/functional) + - [Control Actions](/docs/plugins/control) + - [Using Plugins](/docs/plugins/using) + - [The `tinker` Action](/docs/plugins/tinker) + - [Writing Plugins](/docs/plugins/writing) + - [Security Considerations](/docs/plugins/security) - [Deploying](/docs/deploying/intro) - [Server Deployment](/docs/deploying/serverful) - [Serverless Deployment](/docs/deploying/serverless) diff --git a/docs/next/en-US/define-app.md b/docs/next/en-US/define-app.md index 22f96d9ac1..fb948855d1 100644 --- a/docs/next/en-US/define-app.md +++ b/docs/next/en-US/define-app.md @@ -25,6 +25,7 @@ Here's a list of everything you can provide to the macro and what each one does - `default` -- the default locale of your app (e.g. `en-US`) - `other` -- a list of the other locales your app supports - `static_aliases` (optional) -- a list of aliases to static files in your project (e.g. for a favicon) +- `plugins` (optional) -- a list of plugins to add to extend Perseus (see [here](:plugins/intro)) - `dist_path` (optional) -- a custom path to distribution artifacts (this is relative to `.perseus/`!) - `mutable_store` (optional) -- a custom mutable store - `translations_manager` (optional) -- a custom translations manager diff --git a/docs/next/en-US/deploying/size.md b/docs/next/en-US/deploying/size.md index a98e0ffec2..f714cf747d 100644 --- a/docs/next/en-US/deploying/size.md +++ b/docs/next/en-US/deploying/size.md @@ -6,4 +6,4 @@ If you've worked with Rust and Wasm before, you may be familiar with `wasm-opt`, The easiest way to apply size optimizations for Perseus is the [`perseus-size-opt` plugin](https://github.com/arctic-hen7/perseus-size-opt), which prevents the need for ejecting to apply optimizations in `.perseus/`, and requires only a single line of code to use. Check it out [here](https://github.com/arctic-hen7/perseus-size-opt) for more details! It's recommended that all Perseus apps use this plugin before they deploy to production, because it can result in size decreases of upwards of 100kb, which translates into real increases in loading time for your users. -_Note: every size optimization has a trade-off with either speed or compile-time, and you should test the performance of your app after applying these optimizations to make sure you're happy with the results, because the balance between speed and size will be different for every app. That said, using even all these optimizations usually has a negligible performance impact._ +*Note: every size optimization has a trade-off with either speed or compile-time, and you should test the performance of your app after applying these optimizations to make sure you're happy with the results, because the balance between speed and size will be different for every app. That said, using even all these optimizations usually has a negligible performance impact.* diff --git a/docs/next/en-US/second-app.md b/docs/next/en-US/second-app.md index 9f29d00bb3..46a44178ca 100644 --- a/docs/next/en-US/second-app.md +++ b/docs/next/en-US/second-app.md @@ -15,7 +15,7 @@ Much like the _Hello World!_ app, we'll start off by creating a new directory fo The only difference between this and the last `Cargo.toml` we created is two new dependencies: - [`serde`](https://serde.rs) -- a really useful Rust library for serializing/deserializing data -- [`serde_json`](https://github.com/serde-rs/json) -- Serde's integration for JSON, which lets us pass around properties for more advanced pages in Perseus +- [`serde_json`](https://github.com/serde-rs/json) -- Serde's integration for JSON, which lets us pass around properties for more advanced pages in Perseus (you may not explicitly use this, but you'll need it as a dependency for some Perseus macros) The next thing to do is to create `index.html`, which is pretty much the same as last time: @@ -79,6 +79,7 @@ First, we import a whole ton of stuff: - `RenderFnResultWithCause` -- see below for an explanation of this - `Template` -- as before - `GenericNode` -- as before + - `http::header::{HeaderMap, HeaderName}` -- some types for adding HTTP headers to our page - `serde` - `Serialize` -- a trait for `struct`s that can be turned into a string (like JSON) - `Deserialize` -- a trait for `struct`s that can be *de*serialized from a string (like JSON) @@ -98,9 +99,9 @@ Any template can take arguments in Perseus, which should always be given inside ### `index_page()` -This is the actual component that your page is. Technically, you could just put this under `template_fn()`, but it's conventional to break it out independently. By annotating it with `#[component(IndexPage)]`, we tell Sycamore to turn it into a complex `struct` that can be called inside `template!` (which we do in `template_fn()`). +This is the actual component that your page is. By annotating it with `#[component(IndexPage)]`, we tell Sycamore to turn it into a complex `struct` that can be called inside `template!` (which we do in `template_fn()`), and the `#[perseus::template(IndexPage)]` tells Perseus to do a little bit of work behind the scenes so that you can use `index_page` directly in the later `.template()` call. In previous versions of Perseus, you needed to do that boilerplate work yourself. -Note that this takes `IndexPageProps` as an argument, which it can then access in the `template!`. This is Sycamore's interpolation system, which you can read about [here](https://sycamore-rs.netlify.app/docs/basics/template), but all you need to know is that it's basically seamless and works exactly as you'd expect. +Note that `index_page()` takes `IndexPageProps` as an argument, which it can then access in the `template!`. This is Sycamore's interpolation system, which you can read about [here](https://sycamore-rs.netlify.app/docs/basics/template), but all you need to know is that it's basically seamless and works exactly as you'd expect. The only other thing we do here is define an `` (an HTML link) to `/about`. This link, and any others you define, will automatically be detected by Sycamore's systems, which will pass them to Perseus' routing logic, which means your users **never leave the page**. In this way, Perseus only pulls in the content that needs to change, and gives your users the feeling of a lightning-fast and weightless app. @@ -110,11 +111,15 @@ _Note: external links will automatically be excluded from this, and you can excl This function is what we call in `lib.rs`, and it combines everything else in this file to produce an actual Perseus `Template` to be used. Note the name of the template as `index`, which Perseus interprets as special, which causes this template to be rendered at `/` (the landing page). -Perseus' templating system is extremely versatile, and here we're using it to define our page itself through `.template()`, and to define a function that will modify the document `` (which allows us to add a title) with `.head()`. Notably, we also use the _build state_ rendering strategy, which tells Perseus to call the `get_build_props()` function when your app builds to get some state. More on that now. +Perseus' templating system is extremely versatile, and here we're using it to define our page itself through `.template()`, and to define a function that will modify the document `` (which allows us to add a title) with `.head()`. Notably, we also use the _build state_ rendering strategy, which tells Perseus to call the `get_build_props()` function when your app builds to get some state. More on that in a moment. #### `.template()` -The result of this function is what Perseus will call when it wants to render your template (which it does more than you might think), and it passes it the props that your template takes as an `Option`. This might seem a bit weird, but there are reasons under the hood. All you need to know here is that if your template takes any properties, they **will** be here, and it's safe to `.unwrap()` them for deserialization. +This function is what Perseus will call when it wants to render your template (which it does more than you might think). If you've used the `#[perseus::template(...)]` macro on `index_page()`, you can provide `index_page` directly here, but it can be useful to understand what that macro is doing. + +Behind the scenes, that macro transforms your `index_page()` function to take properties as an `Option` instead of as `IndexPageProps`, because Perseus actually passes your properties around internally as `String`s. At first, this might seem weird, but it avoids a few common problems that would increase your final Wasm binary size and make your website take a very long time to load. Interestingly, it's actually also more performant to use `String`s everywhere, because we need to perform that conversion anyway when we send your properties to a user's browser. + +If that all went over your head, don't worry, that's just what Perseus does behind the scenes, and what you used to have to do by hand! The `#[perseus::template(...)]` macro does all that for you now. #### `.head()` @@ -122,11 +127,17 @@ This is very similar to `template_fn`, except it can't be reactive. In other wor All this does though is set the ``. If you inspect the source code of the HTML in your browser, you'll find a big comment in the `<head>` that says `<!--PERSEUS_INTERPOLATED_HEAD_BEGINS-->`, that separates the stuff that should remain the same on every page from the stuff that should update for each page. +**Warning:** the parameter that this function takes is an `Option<String>` (as it is for `.template()`), though there is currently no macro for handling this. That means you'll have to manually deserialize that parameter to `IndexPageProps` if you want to use it. Note that it's perfectly safe to `.unwrap()` the `Option<String>` if you know your template uses properties, because Perseus will provide them (we just can't easily prove that to the Rust compiler). + ### `get_build_props()` This function is part of Perseus' secret sauce (actually _open_ sauce), and it will be called when the CLI builds your app to create properties that the template will take (it expects a string, hence the serialization). Here, we just hard-code a greeting in to be used, but the real power of this comes when you start using the fact that this function is `async`. You might query a database to get a list of blog posts, or pull in a Markdown documentation page and parse it, the possibilities are endless! -Note that this function returns a `RenderFnResultWithCause<String>`, which means that it returns a normal Rust `Result<String, E>`, where `E` is a `GenericErrorWithCause`, a Perseus type that combines an arbitrary error message with a declaration of who caused the error (either the client or the server). This becomes important when you combine this rendering strategy with others, which are explained in depth later in the book. Note that we use `?` in this example on errors from modules like `serde_json`, showing how versatile this type is. If you don't explicitly construct `GenericErrorWithCause`, blame for the error will be assigned to the server, resulting in a _500 Internal Server Error_ HTTP status code. +This function returns a rather special type, `RenderFnResultWithCause<IndexPageProps>`, which declares that your function will return `IndexPageProps` if it succeeds, and a special error if it fails. That error can be anything you want (it's a `Box<dyn std::error::Error>` internally), but it will also have a blame assigned to it that records whether it was the server or the client that caused the error, which will impact the final HTTP status code. You can use the `blame_err!` macro to create these errors easily, but any time you use `?` in functions that return this type will simply use the default of blaming the server and returning an HTTP status code of *500 Internal Server Error*. + +It may seem a little pointless to blame the client in the build process, but the reason this can happen is because, in more advanced uses of Perseus (particularly [incremental generation](:strategies/incremental)), this function could be called as a result of a client's request with parameters that it provides, which could be invalid. Essentially, know that it's a thing that's important in more complex use-cases of Perseus. + +That `#[perseus::autoserde(build_state)]` is also something you'll see quite a lot of (but not in older versions of Perseus). It's a convenience macro that automatically serializes the return of your function to a `String` for Perseus to use internally, which is basically just the opposite of the `#[perseus::template(IndexPage)]` annotation we used earlier. You don't technically need this, but it eliminates some boilerplate code that you don't need to bother writing yourself. ### `set_headers_fn()` diff --git a/docs/next/en-US/strategies/amalgamation.md b/docs/next/en-US/strategies/amalgamation.md index b9cb5491d7..dd2b7c061d 100644 --- a/docs/next/en-US/strategies/amalgamation.md +++ b/docs/next/en-US/strategies/amalgamation.md @@ -10,4 +10,4 @@ Here's an example from [here](https://github.com/arctic-hen7/perseus/blob/main/e {{#include ../../../../examples/showcase/src/templates/amalgamation.rs}} ``` -This example illustrates a very simple amalgamation, taking the states of both strategies to produce a new state that combines the two. Note that this also uses `RenderFnWithCause` as a return type (see the section on the [_build state_](:strategies/build-state) strategy for more information). It will be passed an instance of `States`, which you can learn more about in the [API docs](https://docs.rs/perseus). +This example illustrates a very simple amalgamation, taking the states of both strategies to produce a new state that combines the two. Note that this also uses `RenderFnWithCause` as a return type (see the section on the [_build state_](:strategies/build-state) strategy for more information). It will be passed an instance of `States`, which you can learn more about in the [API docs](https://docs.rs/perseus). As usual, serialization of your returned state is done with the `#[perseus::autoserde(amalgamate_states)]` macro, though the components of `States` will **not** be deserialized, and you'll have to do that manually. diff --git a/docs/next/en-US/strategies/build-state.md b/docs/next/en-US/strategies/build-state.md index e9d39cd7f5..b887ab4ce0 100644 --- a/docs/next/en-US/strategies/build-state.md +++ b/docs/next/en-US/strategies/build-state.md @@ -16,7 +16,7 @@ On its own, this strategy will simply generate properties for your template to t {{#include ../../../../examples/showcase/src/templates/index.rs}} ``` -Note that Perseus passes around properties to pages as `String`s, so the function used for this strategy is expected to return a string. Note also the return type `RenderFnResultWithCause`, a Perseus type that represents the possibility of returning almost any kind of error, with an attached cause declaration that blames either the client or the server for the error. Most of the time, the server will be at fault (e.g. if serializing some obvious properties fails), and this is the default if you use `?` or `.into()` on another error type to run an automatic conversion. However, if you want to explicitly state a different cause (or provide a different HTTP status code), you can construct `GenericErrorWithCause`, as done in the below example (under the next subheading) if the path is `post/tests`. We set the error (a `Box<dyn std::error::Error>`) and then set the cause to be the client (they navigated to an illegal page) and tell the server to return a 404, which means our app will display something like _Page not found_. +Note that Perseus passes around properties to pages as `String`s, so the function used for this strategy is expected to return a string, but this serialization is done for you with the `#[perseus::autoserde(build_state)]` macro. Note also the return type `RenderFnResultWithCause`, a Perseus type that represents the possibility of returning almost any kind of error, with an attached cause declaration that blames either the client or the server for the error. Most of the time, the server will be at fault (e.g. if serializing some obvious properties fails), and this is the default if you use `?` or `.into()` on another error type to run an automatic conversion. However, if you want to explicitly state a different cause (or provide a different HTTP status code), you can construct `GenericErrorWithCause` or use the more convenient `blame_err!` macro, as done in the below example (under the next subheading) if the path is `post/tests`. We set the error (a `Box<dyn std::error::Error>`) and then set the cause to be the client (they navigated to an illegal page) and tell the server to return a 404, which means our app will display something like _Page not found_. ### With _Build Paths_ or _Incremental Generation_ diff --git a/docs/next/en-US/strategies/request-state.md b/docs/next/en-US/strategies/request-state.md index fe5dc03d6e..e8daae7cc7 100644 --- a/docs/next/en-US/strategies/request-state.md +++ b/docs/next/en-US/strategies/request-state.md @@ -12,7 +12,7 @@ Here's an example taken from [here](https://github.com/arctic-hen7/perseus/blob/ {{#include ../../../../examples/showcase/src/templates/ip.rs}} ``` -Note that, just like _build state_, this strategy generates stringified properties that will be passed to the page to render it, and it also uses `RenderFnWithCause` (see the section on [build state](:strategies/build-state) for more information). The key difference though is that this strategy receives a second, very powerful parameter: the HTTP request that the user sent (`perseus::Request`). +Note that, just like _build state_, this strategy generates stringified properties that will be passed to the page to render it (serialization is handled by `#[perseus::autoserde(request_state)]`), and it also uses `RenderFnWithCause` (see the section on [build state](:strategies/build-state) for more information). The key difference though is that this strategy receives a second, very powerful parameter: the HTTP request that the user sent (`perseus::Request`). <details> <summary>How do you get the user's request information?</summary> diff --git a/docs/next/en-US/templates/intro.md b/docs/next/en-US/templates/intro.md index 6cafb0ce98..1dab2c4c2b 100644 --- a/docs/next/en-US/templates/intro.md +++ b/docs/next/en-US/templates/intro.md @@ -28,7 +28,9 @@ You can define a template like so (taken from [the basic example](https://github It's seen as convention in Perseus to define each template in its own file, which should expose a `get_template()` file. Note that this is just convention, and as long as you get an instance of `Template<G>` to the `define_app!` macro, it really doesn't matter. That said, using community conventions makes your code easier to understand and debug for others. -There's a list of all the methods available on a template [here](https://docs.rs/perseus/0.2/perseus/template/struct.Template.html#implementations), along with explanations of what they all do. Technically, you could just define a template without calling any of these, but that would just render a blank page, which would probably be useless. +There's a list of all the methods available on a template [here](https://docs.rs/perseus/0.3/perseus/template/struct.Template.html#implementations), along with explanations of what they all do. Technically, you could just define a template without calling any of these, but that would just render a blank page, which would probably be useless. + +Also note the use of the `#[perseus::template(...)]` macro on the `about_page` function in the above example. As mentioned elsewhere in the book, this will perform some boilerplate work for you: namely deserializing your template's properties for you (if it takes any). While you don't have to use this, it makes things more convenient and there's no reason not to. ## Routing diff --git a/docs/next/en-US/templates/setting-headers.md b/docs/next/en-US/templates/setting-headers.md index 165bcc7ac8..3842ceb7f1 100644 --- a/docs/next/en-US/templates/setting-headers.md +++ b/docs/next/en-US/templates/setting-headers.md @@ -8,4 +8,4 @@ Perseus supports inserting arbitrary HTTP headers for any response from the serv {{#include ../../../../examples/basic/src/templates/index.rs}} ``` -Of note here is the `set_headers_fn` function, which returns a `HeaderMap`. This is then used on the template with `.set_headers_fn()`. Note that the function you provide will be given the state as an argument (ignored here), and you must return some headers (you can't return an error). +Of note here is the `set_headers_fn` function, which returns a `HeaderMap`. This is then used on the template with `.set_headers_fn()`. Note that the function you provide will be given the state as an argument (ignored here, but it will be deserialized for you with `#[perseus::autoserde(set_headers)]`), and you must return some headers (you can't return an error).