# Memory serve

**memory-serve** enables fast static file serving for axum web applications,
by keeping all assets in memory.

It loads static web assets like HTML, stylesheets, images and
scripts into the rust binary at compile time and exposes them as an
[axum](https://github.com/tokio-rs/axum) Router. It automatically adds cache
headers and handles file compression.

During development (debug builds) files are served dynamically,
they are read and compressed at request time.

In release mode text-based files like HTML or javascript
are compressed using [brotli](https://en.wikipedia.org/wiki/Brotli)
at compile time and decompressed at startup, to minimize the binary size.

All files are served with an
[etag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag)
header and
[If-None-Match](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
requests are handled accordingly.

Text-based files are served in plain or with gzip or brotli compression
based on the abilities and preferences of the client.

Routing can be configured in a flexible manner, for instance to accommodate
an SPA.

## Compatibility

memory-serve is designed to work with [axum](https://github.com/tokio-rs/axum)

## Usage

Because memory-serve is used both from your `build.rs` (to load assets at
compile time) and from your application code (to serve them), it must be added
to **both** `[dependencies]` and `[build-dependencies]` in your `Cargo.toml`:

```toml
[dependencies]
memory-serve = "2"

[build-dependencies]
memory-serve = "2"
```

Omitting the `[build-dependencies]` entry results in a compile error from the
build script, like `error[E0433]: cannot find module or crate 'memory_serve'`.

Call `load_directory` with a relative path from your `build.rs`. See [the Cargo book](https://doc.rust-lang.org/cargo/reference/build-scripts.html) for more information about build scripts. See the example project in the memory-serve repository
for an example `build.rs`. Calling `load_directory` makes sure that your assets are loaded at compile time.

Call the `load!` macro from your application to create a `MemoryServe` instance.

When an instance of `MemoryServe` is created, we can bind it to your axum instance.
Calling [`MemoryServe::into_router()`] on the `MemoryServe` instance produces an axum
[`Router`](https://docs.rs/axum/latest/axum/routing/struct.Router.html) that
can either be merged in another `Router` or used directly in a server by
calling [`Router::into_make_service()`](https://docs.rs/axum/latest/axum/routing/struct.Router.html#method.into_make_service).

### Named directories

Multiple directories can be included using `load_names_directories` from your `build.rs` script.
This takes a list of tuples, with the name and the path of your asset directories.

You can use the names as specified in the `load_names_directories` call to load the specific
`MemoryServe` instance by passing the name as a string to the `load!` macro.

### Features

Use the `force-embed` feature flag to always include assets in the binary - also in debug builds.

### Environment variables

Use `MEMORY_SERVE_QUIET=1` to not print log messages at compile time.

## Example

`build.rs`:
```rust
fn main() {
    memory_serve::load_directory("./public");
}
```

`main.rs`:
```rust
use axum::{response::Html, routing::get, Router};
use std::net::SocketAddr;

#[tokio::main]
async fn main() {
    let memory_router = memory_serve::load!()
        .index_file(Some("/index.html"))
        .into_router();

    // possible other routes can be added at this point, like API routes
    let app = Router::new()
        .merge(memory_router);

    let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
    let listener = tokio::net::TcpListener::bind(addr).await.unwrap();
    axum::serve(listener, app).await.unwrap();
}
```

## Configuration options

An instance of the `MemoryServe` struct can be configured by calling
the following configuration methods:

| method                                   | Default value           | Description                                                |
| ---------------------------------------- | ----------------------- | ---------------------------------------------------------- |
| [`MemoryServe::index_file`]              | `Some("/index.html")`   | Which file to serve on the route "/"                       |
| [`MemoryServe::index_on_subdirectories`] | `false`                 | Whether to serve the corresponding index in subdirectories |
| [`MemoryServe::fallback`]                | `None`                  | Which file to serve if no route matched the request        |
| [`MemoryServe::fallback_status`]         | `StatusCode::NOT_FOUND` | The HTTP status code to serve for routes that did not match |
| [`MemoryServe::enable_gzip`]             | `true` (release) [^1]   | Allow serving gzip encoded files                           |
| [`MemoryServe::enable_brotli`]           | `true` (release) [^1]   | Allow serving brotli encoded files                         |
| [`MemoryServe::html_cache_control`]      | `CacheControl::Short`   | Cache control header to serve on HTML files                |
| [`MemoryServe::cache_control`]           | `CacheControl::Medium`  | Cache control header to serve on other files               |
| [`MemoryServe::add_alias`]               | `[]`                    | Create a route / file alias                                |
| [`MemoryServe::enable_clean_url`]        | `false`                 | Enable clean URLs                                          |

See [`Cache control`](#cache-control) for the cache control options.

[^1]: Compression defaults to enabled in release builds and disabled in debug
builds (where assets are served dynamically).

## Logging

During compilation, problems that occur with the inclusion or compression
of assets are logged as a warning from the build script:

```txt
warning: memory-serve-test@0.0.0: Loading static assets from /home/user/project/my-project/static
warning: memory-serve-test@0.0.0: Embedding assets into binary
warning: memory-serve-test@0.0.0: including /blog/index.html 431 -> 175 bytes (compressed)
```

When running the resulting executable, all registered routes and asset
sizes are logged using the [`tracing`](https://docs.rs/tracing/latest/tracing/)
crate. To print or log them, use [`tracing-subscriber`](https://docs.rs/tracing/latest/tracing_subscriber/).
Example output:

```txt
 INFO memory_serve: serving /assets/icon.jpg 1366 bytes
 INFO memory_serve: serving /assets/index.css 1552 bytes
 INFO memory_serve: serving /assets/index.css (brotli compressed) 509 bytes
 INFO memory_serve: serving /assets/index.css (gzip compressed) 624 bytes
 INFO memory_serve: serving /assets/index.js 20 bytes
 INFO memory_serve: serving /assets/stars.svg 2255 bytes
 INFO memory_serve: serving /assets/stars.svg (brotli compressed) 907 bytes
 INFO memory_serve: serving /assets/stars.svg (gzip compressed) 1048 bytes
 INFO memory_serve: serving /index.html 437 bytes
 INFO memory_serve: serving /index.html (brotli compressed) 178 bytes
 INFO memory_serve: serving /index.html (gzip compressed) 274 bytes
 INFO memory_serve: serving /index.html as index on /
```

## Cache control

There are 5 different values to choose from for the cache-control settings:

| Option                    | Description                                                                         | Value                                          |
| ------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------- |
| [`CacheControl::Long`]    | clients can keep assets that have cache busting for a year                          | `max-age=31536000, immutable`                  |
| [`CacheControl::Medium`]  | assets without cache busting are revalidated after a day and can be kept for a week | `max-age=604800, stale-while-revalidate=86400` |
| [`CacheControl::Short`]   | cache kept for max 5 minutes, only at the client (not in a proxy)                   | `max-age=300, private`                         |
| [`CacheControl::NoCache`] | do not cache if freshness is really vital                                           | `no-cache`                                     |
| [`CacheControl::Custom`]  | Custom value                                                                        | _user defined_                                 |
