//! ISR (Incremental Static Regeneration) cache implementation //! //! Provides in-memory caching for SSR pages with: //! - TTL-based expiration //! - Stale-while-revalidate pattern //! - Singleflight (via moka's built-in coalescing) //! - On-demand invalidation use axum::http::{HeaderMap, StatusCode}; use dashmap::DashSet; use moka::future::Cache; use std::{ sync::Arc, time::{Duration, Instant}, }; /// Cached response data #[derive(Clone)] pub struct CachedResponse { pub status: StatusCode, pub headers: HeaderMap, pub body: axum::body::Bytes, pub cached_at: Instant, } impl CachedResponse { pub fn new(status: StatusCode, headers: HeaderMap, body: axum::body::Bytes) -> Self { Self { status, headers, body, cached_at: Instant::now(), } } /// Check if this response is still fresh (within fresh_duration) pub fn is_fresh(&self, fresh_duration: Duration) -> bool { self.cached_at.elapsed() < fresh_duration } /// Check if this response is stale but still usable (within stale_duration) pub fn is_stale_but_usable(&self, fresh_duration: Duration, stale_duration: Duration) -> bool { let age = self.cached_at.elapsed(); age >= fresh_duration && age < stale_duration } /// Get the age of this cached response pub fn age(&self) -> Duration { self.cached_at.elapsed() } } /// Configuration for the ISR cache #[derive(Debug, Clone)] pub struct IsrCacheConfig { /// Maximum number of cached entries pub max_entries: u64, /// Duration a response is considered fresh (served without refresh) pub fresh_duration: Duration, /// Total duration before entry is evicted (stale responses served during refresh) pub stale_duration: Duration, /// Whether caching is enabled pub enabled: bool, } impl Default for IsrCacheConfig { fn default() -> Self { Self { max_entries: 1000, fresh_duration: Duration::from_secs(60), stale_duration: Duration::from_secs(300), enabled: true, } } } impl IsrCacheConfig { /// Load configuration from environment variables pub fn from_env() -> Self { let max_entries = std::env::var("ISR_CACHE_MAX_ENTRIES") .ok() .and_then(|v| v.parse().ok()) .unwrap_or(1000); let fresh_sec = std::env::var("ISR_CACHE_FRESH_SEC") .ok() .and_then(|v| v.parse().ok()) .unwrap_or(60); let stale_sec = std::env::var("ISR_CACHE_STALE_SEC") .ok() .and_then(|v| v.parse().ok()) .unwrap_or(300); let enabled = std::env::var("ISR_CACHE_ENABLED") .map(|v| v != "false" && v != "0") .unwrap_or(true); Self { max_entries, fresh_duration: Duration::from_secs(fresh_sec), stale_duration: Duration::from_secs(stale_sec), enabled, } } } /// ISR cache for SSR page responses pub struct IsrCache { cache: Cache>, /// Tracks paths currently being refreshed in background refreshing: DashSet, pub config: IsrCacheConfig, } impl IsrCache { /// Create a new ISR cache with the given configuration pub fn new(config: IsrCacheConfig) -> Self { let cache = Cache::builder() .max_capacity(config.max_entries) // Use stale_duration as TTL - we handle fresh/stale logic ourselves .time_to_live(config.stale_duration) .name("isr_cache") .build(); Self { cache, refreshing: DashSet::new(), config, } } /// Get a cached response if it exists pub async fn get(&self, path: &str) -> Option> { if !self.config.enabled { return None; } self.cache.get(path).await } /// Insert a response into the cache pub async fn insert(&self, path: String, response: CachedResponse) { if !self.config.enabled { return; } self.cache.insert(path, Arc::new(response)).await; } /// Check if a path is currently being refreshed pub fn is_refreshing(&self, path: &str) -> bool { self.refreshing.contains(path) } /// Mark a path as being refreshed. Returns true if it wasn't already refreshing. pub fn start_refresh(&self, path: &str) -> bool { self.refreshing.insert(path.to_string()) } /// Mark a path refresh as complete pub fn end_refresh(&self, path: &str) { self.refreshing.remove(path); } /// Invalidate a single cached path pub async fn invalidate(&self, path: &str) { self.cache.invalidate(path).await; tracing::debug!(path = %path, "Cache entry invalidated"); } /// Invalidate multiple cached paths pub async fn invalidate_many(&self, paths: &[&str]) { for path in paths { self.cache.invalidate(*path).await; } tracing::info!(paths = ?paths, "Cache entries invalidated"); } /// Invalidate all entries matching a prefix pub async fn invalidate_prefix(&self, prefix: &str) { // moka doesn't have prefix invalidation, so we need to iterate // This is O(n) but invalidation should be infrequent let prefix_owned = prefix.to_string(); self.cache .invalidate_entries_if(move |key, _| key.starts_with(&prefix_owned)) .ok(); tracing::info!(prefix = %prefix, "Cache entries with prefix invalidated"); } /// Invalidate all cached entries pub async fn invalidate_all(&self) { let previous_count = self.cache.entry_count(); self.cache.invalidate_all(); tracing::info!(previous_count, "All cache entries invalidated"); } /// Get cache statistics pub fn stats(&self) -> CacheStats { CacheStats { entry_count: self.cache.entry_count(), weighted_size: self.cache.weighted_size(), refreshing_count: self.refreshing.len(), } } } /// Cache statistics for observability #[derive(Debug, Clone, serde::Serialize)] pub struct CacheStats { pub entry_count: u64, pub weighted_size: u64, pub refreshing_count: usize, } /// Determines if a path should be cached /// /// Excludes: /// - Admin pages (session-specific) /// - API routes (handled separately) /// - Internal routes /// - Static assets (served directly from embedded files) pub fn is_cacheable_path(path: &str) -> bool { // Never cache admin pages - they're session-specific if path.starts_with("/admin") { return false; } // Never cache API routes if path.starts_with("/api/") { return false; } // Never cache internal routes if path.starts_with("/internal/") { return false; } // Don't cache static assets (they're served from embedded files anyway) if path.starts_with("/_app/") || path.starts_with("/.") { return false; } true } /// Normalize a path into a cache key /// /// For now, keeps query strings as part of the key since SSR pages /// may render differently based on query params (e.g., ?tag=rust) pub fn cache_key(path: &str, query: Option<&str>) -> String { match query { Some(q) if !q.is_empty() => format!("{path}?{q}"), _ => path.to_string(), } } #[cfg(test)] mod tests { use super::*; #[test] fn test_is_cacheable_path() { // Should cache assert!(is_cacheable_path("/")); assert!(is_cacheable_path("/projects")); assert!(is_cacheable_path("/projects/my-project")); // Should not cache assert!(!is_cacheable_path("/admin")); assert!(!is_cacheable_path("/admin/projects")); assert!(!is_cacheable_path("/api/projects")); assert!(!is_cacheable_path("/internal/health")); assert!(!is_cacheable_path("/_app/immutable/foo.js")); } #[test] fn test_cache_key() { assert_eq!(cache_key("/projects", None), "/projects"); assert_eq!(cache_key("/projects", Some("")), "/projects"); assert_eq!( cache_key("/projects", Some("tag=rust")), "/projects?tag=rust" ); } #[tokio::test] async fn test_cached_response_freshness() { let response = CachedResponse::new( StatusCode::OK, HeaderMap::new(), axum::body::Bytes::from_static(b"test"), ); let fresh = Duration::from_millis(100); let stale = Duration::from_millis(200); // Should be fresh immediately assert!(response.is_fresh(fresh)); assert!(!response.is_stale_but_usable(fresh, stale)); // Wait a bit tokio::time::sleep(Duration::from_millis(110)).await; // Should be stale but usable assert!(!response.is_fresh(fresh)); assert!(response.is_stale_but_usable(fresh, stale)); // Wait more tokio::time::sleep(Duration::from_millis(100)).await; // Should be neither fresh nor usable assert!(!response.is_fresh(fresh)); assert!(!response.is_stale_but_usable(fresh, stale)); } }