Merge pull request #165 from sebadob/static-asset-precompression

Implement precompression of static assets

Cargo.toml

@@ -29,9 +29,11 @@ rust-version = "1.71"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+brotli = "3.3"
 clap = { version = "4.0", features = ["derive"] }
 serde = { version = "1.0", features = ["derive"] }
 anyhow = "1.0"
+libflate = "2"
 log = "0.4"
 flexi_logger = "0.25"
 lightningcss = { version = "1.0.0-alpha.47", features = ["browserslist"] }

src/command/build.rs

@@ -1,5 +1,6 @@
 use std::sync::Arc;
 
+use crate::ext::compress;
 use crate::{
     compile,
     compile::ChangeSet,
@@ -46,6 +47,18 @@ pub async fn build_proj(proj: &Arc<Project>) -> Result<bool> {
     if !compile::style(proj, &changes).await.await??.is_success() {
         return Ok(false);
     }
+
+    // it is important to do the precompression of the static files before building the
+    // server to make it possible to include them as assets into the binary itself
+    if proj.release
+        && proj.precompress
+        && compress::compress_static_files(proj.site.root_dir.clone().into())
+            .await
+            .is_err()
+    {
+        return Ok(false);
+    }
+
     if !compile::server(proj, &changes).await.await??.is_success() {
         return Ok(false);
     }

src/compile/tests.rs

@@ -10,6 +10,7 @@ use super::server::build_cargo_server_cmd;
 fn release_opts() -> Opts {
     Opts {
         release: true,
+        precompress: false, // if set to true, testing could take quite a while longer
         hot_reload: false,
         project: None,
         verbose: 0,
@@ -21,6 +22,7 @@ fn release_opts() -> Opts {
 fn dev_opts() -> Opts {
     Opts {
         release: false,
+        precompress: false,
         hot_reload: false,
         project: None,
         verbose: 0,

src/config/cli.rs

@@ -16,6 +16,10 @@ pub struct Opts {
     #[arg(short, long)]
     pub release: bool,
 
+    /// Precompress static assets with gzip and brotli. Applies to release builds only.
+    #[arg(short = 'P', long)]
+    pub precompress: bool,
+
     /// Turn on partial hot-reloading. Requires rust nightly [beta]
     #[arg(long)]
     pub hot_reload: bool,

src/config/project.rs

@@ -35,6 +35,7 @@ pub struct Project {
     pub style: StyleConfig,
     pub watch: bool,
     pub release: bool,
+    pub precompress: bool,
     pub hot_reload: bool,
     pub site: Arc<Site>,
     pub end2end: Option<End2EndConfig>,
@@ -51,6 +52,7 @@ impl Debug for Project {
             .field("style", &self.style)
             .field("watch", &self.watch)
             .field("release", &self.release)
+            .field("precompress", &self.precompress)
             .field("hot_reload", &self.hot_reload)
             .field("site", &self.site)
             .field("end2end", &self.end2end)
@@ -89,6 +91,7 @@ impl Project {
                 style: StyleConfig::new(&config)?,
                 watch,
                 release: cli.release,
+                precompress: cli.precompress,
                 hot_reload: cli.hot_reload,
                 site: Arc::new(Site::new(&config)),
                 end2end: End2EndConfig::resolve(&config),

src/config/snapshots/cargo_leptos__config__tests__project.snap

@@ -62,6 +62,7 @@ Config {
             },
             watch: true,
             release: false,
+            precompress: false,
             hot_reload: false,
             site: Site {
                 addr: 127.0.0.1:3000,
@@ -87,6 +88,7 @@ Config {
     ],
     cli: Opts {
         release: false,
+        precompress: false,
         hot_reload: false,
         project: None,
         features: [],

src/config/snapshots/cargo_leptos__config__tests__workspace.snap

@@ -53,6 +53,7 @@ Config {
             },
             watch: true,
             release: false,
+            precompress: false,
             hot_reload: false,
             site: Site {
                 addr: 127.0.0.1:3000,
@@ -123,6 +124,7 @@ Config {
             },
             watch: true,
             release: false,
+            precompress: false,
             hot_reload: false,
             site: Site {
                 addr: 127.0.0.1:3000,
@@ -143,6 +145,7 @@ Config {
     ],
     cli: Opts {
         release: false,
+        precompress: false,
         hot_reload: false,
         project: None,
         features: [],

src/config/snapshots/cargo_leptos__config__tests__workspace_in_subdir_project2.snap

@@ -57,6 +57,7 @@ Config {
             },
             watch: true,
             release: false,
+            precompress: false,
             hot_reload: false,
             site: Site {
                 addr: 127.0.0.1:3000,
@@ -77,6 +78,7 @@ Config {
     ],
     cli: Opts {
         release: false,
+        precompress: false,
         hot_reload: false,
         project: None,
         features: [],

src/config/snapshots/cargo_leptos__config__tests__workspace_project1.snap

@@ -53,6 +53,7 @@ Config {
             },
             watch: true,
             release: false,
+            precompress: false,
             hot_reload: false,
             site: Site {
                 addr: 127.0.0.1:3000,
@@ -73,6 +74,7 @@ Config {
     ],
     cli: Opts {
         release: false,
+        precompress: false,
         hot_reload: false,
         project: Some(
             "project1",

src/config/snapshots/cargo_leptos__config__tests__workspace_project2.snap

@@ -57,6 +57,7 @@ Config {
             },
             watch: true,
             release: false,
+            precompress: false,
             hot_reload: false,
             site: Site {
                 addr: 127.0.0.1:3000,
@@ -77,6 +78,7 @@ Config {
     ],
     cli: Opts {
         release: false,
+        precompress: false,
         hot_reload: false,
         project: Some(
             "project2",

src/config/tests.rs

@@ -3,6 +3,7 @@ use super::Config;
 fn opts(project: Option<&str>) -> crate::config::Opts {
     crate::config::Opts {
         release: false,
+        precompress: false,
         hot_reload: false,
         project: project.map(|s| s.to_string()),
         verbose: 0,