Merge pull request #20 from msalinas92/feature/cachebolt-ui

Feature/cachebolt UI

Author: msalinas92

.github/workflows/release.yml

@@ -67,6 +67,18 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Build Astro UI
+        run: |
+          cd ui
+          npm ci
+          npm run build
+          cd ..
+
       - name: Install cross-compilers and dependencies
         if: runner.os == 'Linux'
         run: |

Cargo.lock

@@ -58,7 +58,9 @@ metrics-exporter-prometheus = "0.17.0"
 futures = "0.3"
 rand = "0.8"
 tower = "0.5.2"
-
+tower-http = { version = "0.4", features = ["cors"] }
+rust-embed = "8.2.0"
+mime_guess = "2.0"
 
 [dev-dependencies]
 tokio = { version = "1", features = ["macros", "rt-multi-thread", "test-util"] }

Cargo.toml

@@ -60,6 +60,29 @@ docker run --rm -p 3000:3000 \
 - ⏱️ Latency-based failover policies (regex route rules)
 - 🧠 Smart fallback if upstreams are slow or unavailable
 
+
+## 🖥️ Web UI (Built-in Admin Interface)
+
+CacheBolt comes with a built-in **graphical admin interface** accessible via your browser.  
+This lightweight UI is bundled directly into the binary—no additional server or frontend hosting is required.
+
+### 🔗 Accessing the UI
+
+Once CacheBolt is running, open:
+
+http://localhost:3000/cb-admin
+
+### 🧰 Available Features
+
+- 🧠 **View memory cache entries** in real time
+- 🧹 **Clear in-memory or persistent cache** with a single click
+- 📊 **Inspect memory usage, TTL, and sizes**
+- 🛠️ Fully static and bundled – served directly from the binary
+
+This interface is useful for both **debugging** and **administrative operations** in production environments.
+
+![CacheBolt Web UI](https://raw.githubusercontent.com/msalinas92/CacheBolt/refs/heads/master/docs/screenshot-1.png)
+
 ---
 ## 🔁 Request Flow
 

README.md

@@ -13,4 +13,5 @@
 // limitations under the License.
 
 pub mod clean;
-pub mod status_memory;
+pub mod status_memory;
+pub mod ui;

docs/screenshot-1.png

@@ -0,0 +1,79 @@
+use axum::{
+    extract::Path,
+    http::{header, Response, StatusCode},
+    response::IntoResponse,
+};
+use mime_guess::from_path;
+use rust_embed::RustEmbed;
+
+#[derive(RustEmbed)]
+#[folder = "ui/dist/cb-admin/"] // Ruta relativa al Cargo.toml
+pub struct EmbeddedAssets;
+
+/// Servidor de archivos embebidos para `/cb-admin/*path`
+/// Soporta rutas como:
+/// - `/cb-admin`
+/// - `/cb-admin/`
+/// - `/cb-admin/index.html`
+/// - `/cb-admin/cache` -> `cache/index.html`
+/// - `/cb-admin/cache/` -> `cache/index.html`
+pub async fn embedded_ui_handler(Path(path): Path<String>) -> impl IntoResponse {
+    tracing::info!("📦 UI embedded request for: {}", path);
+
+    // Elimina "/" inicial para estandarizar
+    let clean_path = path.trim_start_matches('/');
+
+    // Lógica para resolver correctamente rutas tipo `/cb-admin/cache`
+    let resolved_path = if clean_path.is_empty() {
+        "index.html".to_string()
+    } else if EmbeddedAssets::get(clean_path).is_some() {
+        clean_path.to_string()
+    } else {
+        let with_index = format!("{}/index.html", clean_path);
+        if EmbeddedAssets::get(&with_index).is_some() {
+            with_index
+        } else {
+            clean_path.to_string() // Intento final (puede fallar)
+        }
+    };
+
+    // Buscar el archivo embebido
+    match EmbeddedAssets::get(&resolved_path) {
+        Some(content) => {
+            let mime = from_path(&resolved_path).first_or_octet_stream();
+            Response::builder()
+                .header(header::CONTENT_TYPE, mime.as_ref())
+                .body(axum::body::Body::from(content.data.into_owned()))
+                .unwrap()
+        }
+        None => {
+            // Fallback a index.html para SPA si existe
+            if let Some(index) = EmbeddedAssets::get("index.html") {
+                return Response::builder()
+                    .header(header::CONTENT_TYPE, "text/html")
+                    .body(axum::body::Body::from(index.data.into_owned()))
+                    .unwrap();
+            }
+
+            // Si ni siquiera hay index, error 404
+            Response::builder()
+                .status(StatusCode::NOT_FOUND)
+                .body(axum::body::Body::from("404 Not Found"))
+                .unwrap()
+        }
+    }
+}
+
+/// Sirve el archivo `index.html` directamente para rutas `/cb-admin` o `/cb-admin/`
+pub async fn embedded_ui_index() -> impl IntoResponse {
+    match EmbeddedAssets::get("index.html") {
+        Some(content) => Response::builder()
+            .header(header::CONTENT_TYPE, "text/html")
+            .body(axum::body::Body::from(content.data.into_owned()))
+            .unwrap(),
+        None => Response::builder()
+            .status(StatusCode::NOT_FOUND)
+            .body("404 Not Found".into())
+            .unwrap(),
+    }
+}

src/admin/mod.rs

@@ -17,18 +17,18 @@
 // ----------------------
 // These are internal modules for handling the proxy logic, caching layers,
 // configuration loading, and in-memory eviction based on memory pressure.
+mod admin;
 mod config;
 mod eviction;
 mod memory;
 mod proxy;
 mod rules;
 mod storage;
-mod admin;
 
 // ----------------------
 // External dependencies
 // ----------------------
-use axum::{Router, routing::get, routing::delete}; // Axum: Web framework for routing and request handling
+use axum::{Router, routing::delete, routing::get}; // Axum: Web framework for routing and request handling
 use hyper::Server; // Hyper: High-performance HTTP server
 use std::{net::SocketAddr, process::exit}; // Network + system utilities
 
@@ -38,6 +38,7 @@ use tracing_subscriber::EnvFilter; // Log filtering via LOG_LEVEL
 
 use crate::admin::clean::invalidate_handler;
 use crate::admin::status_memory::get_memory_cache_status;
+use crate::admin::ui::{embedded_ui_handler, embedded_ui_index};
 // ----------------------
 // Internal dependencies
 // ----------------------
@@ -46,6 +47,9 @@ use crate::eviction::start_background_eviction_task; // Memory pressure eviction
 use crate::storage::{azure, gcs, s3}; // Persistent storage backends
 use metrics_exporter_prometheus::PrometheusBuilder;
 
+use hyper::http::{HeaderValue, Method, header};
+use tower_http::cors::CorsLayer;
+
 /// ----------------------------
 /// CLI ARGUMENT STRUCTURE
 /// ----------------------------
@@ -191,12 +195,21 @@ async fn main() {
     // 7. Define Axum router with a single wildcard route
     //    All incoming GET requests will be handled by the proxy logic.
     // ------------------------------------------------------
+    let cors = CorsLayer::new()
+        .allow_origin("http://localhost:4321".parse::<HeaderValue>().unwrap()) // o use HeaderValue::from_static(...)
+        .allow_methods([Method::GET, Method::POST, Method::DELETE])
+        .allow_headers([header::CONTENT_TYPE]);
+
     let app = Router::new()
+        .route("/cb-admin/api/cache", delete(invalidate_handler))
+        .route("/cb-admin/api/status", get(get_memory_cache_status))
+        .route("/cb-admin", get(embedded_ui_index))
+        .route("/cb-admin/", get(embedded_ui_index))
+        .route("/cb-admin/*path", get(embedded_ui_handler))
         .route("/metrics", get(move || async move { handle.render() }))
-        .route("/", get(proxy::proxy_handler)) 
+        .route("/", get(proxy::proxy_handler))
         .route("/*path", get(proxy::proxy_handler))
-        .route("/admin/cache", delete(invalidate_handler))
-        .route("/admin/status-memory", get(get_memory_cache_status));
+        .layer(cors);
 
     // ------------------------------------------------------
     // 8. Bind the server to all interfaces on port 3000

src/admin/ui.rs

@@ -0,0 +1,24 @@
+# build output
+dist/
+
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/