Merge pull request #39 from BrowserSync/prevent-cache

prevent the browser cache as a default

crates/bsnext_core/src/optional_layers.rs

@@ -5,7 +5,9 @@ use axum::routing::MethodRouter;
 use axum::{middleware, Extension};
 use axum_extra::middleware::option_layer;
 use bsnext_input::route::{CompType, CompressionOpts, CorsOpts, DelayKind, DelayOpts, Opts};
+use bsnext_resp::cache_opts::CacheOpts;
 use bsnext_resp::{response_modifications_layer, InjectHandling};
+use http::header::{CACHE_CONTROL, EXPIRES, PRAGMA};
 use http::{HeaderName, HeaderValue};
 use std::collections::BTreeMap;
 use std::convert::Infallible;
@@ -38,10 +40,25 @@ pub fn optional_layers(app: MethodRouter, opts: &Opts) -> MethodRouter {
     let set_response_headers_layer = opts
         .headers
         .as_ref()
-        .map(|headers| map_response_with_state(headers.clone(), set_resp_headers));
+        .map(|headers| map_response_with_state(headers.clone(), set_resp_headers_from_strs));
+
+    let prevent_cache_headers_layer = matches!(opts.cache, CacheOpts::Prevent).then(|| {
+        let mut headers: Vec<(HeaderName, HeaderValue)> = vec![];
+        headers.push((
+            HeaderName::from(CACHE_CONTROL),
+            HeaderValue::from_static("no-store, no-cache, must-revalidate"),
+        ));
+        headers.push((
+            HeaderName::from(PRAGMA),
+            HeaderValue::from_static("no-cache"),
+        ));
+        headers.push((HeaderName::from(EXPIRES), HeaderValue::from_static("0")));
+        map_response_with_state(headers, set_resp_headers)
+    });
 
     let optional_stack = ServiceBuilder::new()
         .layer(option_layer(inject_layer))
+        .layer(option_layer(prevent_cache_headers_layer))
         .layer(option_layer(set_response_headers_layer))
         .layer(option_layer(cors_enabled_layer))
         .layer(option_layer(delay_enabled_layer));
@@ -74,7 +91,7 @@ async fn delay_mw(
     }
 }
 
-async fn set_resp_headers<B>(
+async fn set_resp_headers_from_strs<B>(
     State(header_map): State<BTreeMap<String, String>>,
     mut response: Response<B>,
 ) -> Response<B> {
@@ -102,6 +119,17 @@ async fn set_resp_headers<B>(
     response
 }
 
+async fn set_resp_headers<B>(
+    State(header_map): State<Vec<(HeaderName, HeaderValue)>>,
+    mut response: Response<B>,
+) -> Response<B> {
+    let headers = response.headers_mut();
+    for (k, v) in header_map {
+        headers.insert(k, v);
+    }
+    response
+}
+
 fn comp_opts_to_layer(comp: &CompressionOpts) -> Option<CompressionLayer> {
     match comp {
         CompressionOpts::Bool(false) => None,

crates/bsnext_core/src/snapshots/bsnext_core__handler_stack__test__handler_stack_01.snap

@@ -16,6 +16,7 @@ Raw {
             true,
         ),
         headers: None,
+        cache: Prevent,
         compression: None,
     },
 }

crates/bsnext_core/src/snapshots/bsnext_core__handler_stack__test__handler_stack_02.snap

@@ -19,6 +19,7 @@ DirsProxy {
                     true,
                 ),
                 headers: None,
+                cache: Prevent,
                 compression: None,
             },
             fallback_route: None,
@@ -38,6 +39,7 @@ DirsProxy {
                     true,
                 ),
                 headers: None,
+                cache: Prevent,
                 compression: None,
             },
             fallback_route: None,
@@ -56,6 +58,7 @@ DirsProxy {
             true,
         ),
         headers: None,
+        cache: Prevent,
         compression: None,
     },
 }

crates/bsnext_core/src/snapshots/bsnext_core__handler_stack__test__handler_stack_03.snap

@@ -20,6 +20,7 @@ Raw {
             true,
         ),
         headers: None,
+        cache: Prevent,
         compression: None,
     },
 }

crates/bsnext_core/tests/snapshots/delays__delays-2.snap

@@ -6,6 +6,9 @@ expression: "(parts2.headers, body2)"
     {
         "content-type": "text/html; charset=utf-8",
         "content-length": "20",
+        "cache-control": "no-store, no-cache, must-revalidate",
+        "pragma": "no-cache",
+        "expires": "0",
     },
     "second - 500ms delay",
 )

crates/bsnext_core/tests/snapshots/delays__delays.snap

@@ -6,6 +6,9 @@ expression: "(parts1.headers, body1)"
     {
         "content-type": "text/html; charset=utf-8",
         "content-length": "19",
+        "cache-control": "no-store, no-cache, must-revalidate",
+        "pragma": "no-cache",
+        "expires": "0",
     },
     "first - 200ms delay",
 )

crates/bsnext_core/tests/snapshots/headers__headers-2.snap

@@ -10,6 +10,9 @@ expression: "(parts2.headers, body2)"
         "access-control-allow-origin": "localhost",
         "access-control-expose-headers": "*",
         "abc": "def",
+        "cache-control": "no-store, no-cache, must-revalidate",
+        "pragma": "no-cache",
+        "expires": "0",
     },
     "other route",
 )

crates/bsnext_core/tests/snapshots/headers__headers.snap

@@ -6,6 +6,9 @@ expression: "(parts1.headers, body1)"
     {
         "content-type": "application/json",
         "content-length": "8",
+        "cache-control": "no-store, no-cache, must-revalidate",
+        "pragma": "no-cache",
+        "expires": "0",
     },
     "[ 1, 2 ]",
 )

crates/bsnext_core/tests/snapshots/server__tests__handlers.snap

@@ -1,9 +1,12 @@
 ---
 source: crates/bsnext_core/tests/tests.rs
-expression: res.headers()
+expression: parts.headers
 ---
 {
     "content-type": "text/html; charset=utf-8",
     "content-length": "4",
     "a": "b",
+    "cache-control": "no-store, no-cache, must-revalidate",
+    "pragma": "no-cache",
+    "expires": "0",
 }

crates/bsnext_core/tests/snapshots/tests__handlers.snap

@@ -1,9 +1,12 @@
 ---
 source: crates/bsnext_core/tests/tests.rs
-expression: res.headers()
+expression: parts.headers
 ---
 {
     "content-type": "text/html; charset=utf-8",
     "content-length": "4",
     "a": "b",
+    "cache-control": "no-store, no-cache, must-revalidate",
+    "pragma": "no-cache",
+    "expires": "0",
 }

crates/bsnext_core/tests/tests.rs

@@ -1,4 +1,5 @@
 use bsnext_core::server::router::common::{from_yaml, uri_to_res_parts};
+use http::header::{CACHE_CONTROL, CONTENT_TYPE};
 use http::HeaderValue;
 
 #[tokio::test]
@@ -94,3 +95,41 @@ async fn test_route_list() -> Result<(), anyhow::Error> {
     assert_eq!(status, 200);
     Ok(())
 }
+
+#[tokio::test]
+async fn test_cache_prevent() -> Result<(), anyhow::Error> {
+    let input = r#"
+    servers:
+      - bind_address: 0.0.0.0:3000
+        routes:
+          - path: /
+            html: home
+    "#;
+    let state = from_yaml(input)?;
+    let (parts, ..) = uri_to_res_parts(state, "/").await;
+    assert_eq!(
+        parts.headers.get(CONTENT_TYPE).unwrap(),
+        "text/html; charset=utf-8"
+    );
+    assert_eq!(
+        parts.headers.get(CACHE_CONTROL).unwrap(),
+        "no-store, no-cache, must-revalidate"
+    );
+    Ok(())
+}
+
+#[tokio::test]
+async fn test_cache_default() -> Result<(), anyhow::Error> {
+    let input = r#"
+    servers:
+      - bind_address: 0.0.0.0:3000
+        routes:
+          - path: /
+            html: home
+            cache: 'default'
+    "#;
+    let state = from_yaml(input)?;
+    let (parts, ..) = uri_to_res_parts(state, "/").await;
+    assert_eq!(parts.headers.get(CACHE_CONTROL), None);
+    Ok(())
+}

crates/bsnext_input/src/input_test/snapshots/bsnext_input__input_test__deserialize_3_headers.snap

@@ -32,6 +32,7 @@ Config {
                         "a": "b",
                     },
                 ),
+                cache: Prevent,
                 compression: None,
             },
             fallback: None,

crates/bsnext_input/src/input_test/snapshots/bsnext_input__input_test__deserialize_3_headers_control.snap

@@ -28,6 +28,7 @@ Config {
                     true,
                 ),
                 headers: None,
+                cache: Prevent,
                 compression: None,
             },
             fallback: None,

crates/bsnext_input/src/playground.rs

@@ -37,6 +37,7 @@ impl Playground {
                 inject: playground_wrap(),
                 headers: None,
                 compression: None,
+                ..Default::default()
             },
             fallback: Some(FallbackRoute {
                 kind: RouteKind::new_html(FALLBACK_HTML),

crates/bsnext_input/src/route.rs

@@ -1,5 +1,6 @@
 use crate::path_def::PathDef;
 use crate::watch_opts::WatchOpts;
+use bsnext_resp::cache_opts::CacheOpts;
 use bsnext_resp::inject_opts::InjectOpts;
 use matchit::InsertError;
 use std::collections::BTreeMap;
@@ -49,6 +50,8 @@ pub struct Opts {
     #[serde(default)]
     pub inject: InjectOpts,
     pub headers: Option<BTreeMap<String, String>>,
+    #[serde(default)]
+    pub cache: CacheOpts,
     pub compression: Option<CompressionOpts>,
 }
 
@@ -58,12 +61,7 @@ impl Default for Route {
             path: PathDef::from_str("/").unwrap(),
             kind: RouteKind::new_html("default"),
             opts: Opts {
-                headers: None,
-                cors: None,
-                delay: None,
-                watch: Default::default(),
-                inject: Default::default(),
-                compression: Default::default(),
+                ..Default::default()
             },
             fallback: Default::default(),
         }

crates/bsnext_md/tests/snapshots/md_playground__md_playground.snap

@@ -69,6 +69,7 @@ expression: routes
                 ],
             ),
             headers: None,
+            cache: Prevent,
             compression: None,
         },
         fallback: Some(
@@ -88,6 +89,7 @@ expression: routes
                         true,
                     ),
                     headers: None,
+                    cache: Prevent,
                     compression: None,
                 },
             },
@@ -112,6 +114,7 @@ expression: routes
                 true,
             ),
             headers: None,
+            cache: Prevent,
             compression: None,
         },
         fallback: None,
@@ -135,6 +138,7 @@ expression: routes
                 true,
             ),
             headers: None,
+            cache: Prevent,
             compression: None,
         },
         fallback: None,
@@ -158,6 +162,7 @@ expression: routes
                 true,
             ),
             headers: None,
+            cache: Prevent,
             compression: None,
         },
         fallback: None,

crates/bsnext_resp/src/cache_opts.rs

@@ -0,0 +1,10 @@
+#[derive(Debug, Default, PartialEq, Hash, Clone, serde::Deserialize, serde::Serialize)]
+pub enum CacheOpts {
+    /// Try to prevent browsers from caching the responses. This is the default behaviour
+    #[serde(rename = "prevent")]
+    #[default]
+    Prevent,
+    /// Do not try to prevent browsers from caching the responses.
+    #[serde(rename = "default")]
+    Default,
+}

crates/bsnext_resp/src/lib.rs

@@ -1,4 +1,5 @@
 pub mod builtin_strings;
+pub mod cache_opts;
 pub mod connector;
 pub mod debug;
 pub mod inject_addition;

crates/bsnext_system/src/start_kind/snapshots/bsnext_system__start_kind__start_from_paths__test__test-2.snap

@@ -11,6 +11,7 @@ servers:
         watch: true
         inject: true
         headers: ~
+        cache: prevent
         compression: ~
         fallback: ~
     watchers: []

crates/bsnext_system/src/start_kind/snapshots/bsnext_system__start_kind__start_from_paths__test__test.snap

@@ -29,6 +29,7 @@ Input {
                             true,
                         ),
                         headers: None,
+                        cache: Prevent,
                         compression: None,
                     },
                     fallback: None,

crates/bsnext_system/tests/override_input.rs

@@ -13,7 +13,8 @@ use tokio::sync::{mpsc, oneshot};
 use tokio_stream::wrappers::ReceiverStream;
 use tokio_stream::StreamExt;
 
-async fn test() -> anyhow::Result<()> {
+#[actix_rt::test]
+pub async fn main() -> Result<(), anyhow::Error> {
     let input = r#"
 servers:
     - name: api
@@ -83,8 +84,3 @@ servers:
     };
     Ok(())
 }
-
-#[actix_rt::test]
-pub async fn main() -> Result<(), anyhow::Error> {
-    test().await
-}