anycms-spa 0.7.4

SPA integration with Web Frameworks
Documentation 
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

//! The `spa!` macro's `exclude:` arm must (a) keep excluded globs out of the
//! embedded asset set while (b) leaving every other invocation shape intact.
//! Each framework's macro expands separately, so each gets its own invocation.

use anycms_spa::spa;
use rust_embed::RustEmbed;

// The new shape: precompressed companions stay on disk (for the CDN/nginx
// lane) but are not embedded into the binary.
#[cfg(feature = "axum")]
spa!(ExcludedSpa, "tests/fixtures/site", exclude: ["*.gz", "*.br"]);
#[cfg(feature = "actix")]
spa!(ExcludedSpa, "tests/fixtures/site", exclude: ["*.gz", "*.br"]);
#[cfg(feature = "salvo")]
spa!(ExcludedSpa, "tests/fixtures/site", exclude: ["*.gz", "*.br"]);

// The old shapes must keep compiling — they forward to the terminal arm with
// an empty exclude list.
#[cfg(feature = "axum")]
spa!(PlainSpa, "tests/fixtures/site");
#[cfg(feature = "actix")]
spa!(PlainSpa, "tests/fixtures/site", { });
#[cfg(feature = "salvo")]
spa!(PlainSpa, "tests/fixtures/site", "/", ["index.html"], { });

fn embedded_paths<E: RustEmbed>() -> Vec<String> {
    E::iter().map(|p| p.to_string()).collect()
}

// The macro must be invocable from a nested module, not just the crate root —
// the generated SPA static refers to the struct via `super::`, which resolves
// at any depth (0.7.3 fix; `crate::$struct` only worked at the root).
mod nested {
    use anycms_spa::spa;

    #[cfg(feature = "axum")]
    spa!(NestedSpa, "tests/fixtures/site", exclude: ["*.gz", "*.br"]);
    #[cfg(feature = "actix")]
    spa!(NestedSpa, "tests/fixtures/site", exclude: ["*.gz", "*.br"]);
    #[cfg(feature = "salvo")]
    spa!(NestedSpa, "tests/fixtures/site", exclude: ["*.gz", "*.br"]);

    #[cfg(any(feature = "axum", feature = "actix", feature = "salvo"))]
    pub(super) fn embedded_paths() -> Vec<String> {
        use rust_embed::RustEmbed;
        NestedSpa::iter().map(|p| p.to_string()).collect()
    }
}

#[test]
fn exclude_globs_are_not_embedded() {
    let paths = embedded_paths::<ExcludedSpa>();
    assert!(paths.contains(&"index.html".to_string()));
    assert!(paths.contains(&"app.js".to_string()));
    assert!(paths.contains(&"data.json".to_string()));
    assert!(
        !paths.iter().any(|p| p.ends_with(".gz") || p.ends_with(".br")),
        "compressed companions leaked into the embed: {paths:?}"
    );
}

#[test]
fn legacy_shapes_still_embed_everything() {
    // No exclude → the companions ARE embedded (pre-0.7.2 behavior, e.g. for
    // static file servers that serve the .gz/.br directly).
    let paths = embedded_paths::<PlainSpa>();
    assert!(paths.contains(&"app.js.gz".to_string()));
    assert!(paths.contains(&"app.js.br".to_string()));
}

#[test]
fn macro_works_inside_nested_module() {
    let paths = nested::embedded_paths();
    assert!(paths.contains(&"index.html".to_string()));
    assert!(
        !paths.iter().any(|p| p.ends_with(".gz") || p.ends_with(".br")),
        "nested-module invocation leaked companions: {paths:?}"
    );
}