library_usage/
library_usage.rs

1use axum::Router;
2use phantom_frame::{
3    cache::CacheHandle, create_proxy, CacheStrategy, CompressStrategy, CreateProxyConfig, ProxyMode,
4};
5use std::path::PathBuf;
6
7#[tokio::main]
8async fn main() {
9    // Initialize tracing (optional but recommended)
10    // tracing_subscriber::fmt::init();
11
12    // Create proxy configuration
13    // You can specify method prefixes to filter by HTTP method
14    let proxy_config = CreateProxyConfig::new("http://localhost:8080".to_string())
15        .with_include_paths(vec![
16            "/api/*".to_string(),
17            "/public/*".to_string(),
18            "GET /admin/stats".to_string(), // Only cache GET requests to this endpoint
19        ])
20        .with_exclude_paths(vec![
21            "/api/admin/*".to_string(),
22            "POST *".to_string(),   // Don't cache any POST requests
23            "PUT *".to_string(),    // Don't cache any PUT requests
24            "DELETE *".to_string(), // Don't cache any DELETE requests
25        ])
26        .caching_strategy(CacheStrategy::None)
27        .compression_strategy(CompressStrategy::Brotli)
28        .with_cache_storage_mode(phantom_frame::CacheStorageMode::Filesystem)
29        .with_cache_directory(PathBuf::from("./.phantom-frame-cache"))
30        .with_websocket_enabled(true); // Enable WebSocket support (default: true)
31
32    // Create proxy - proxy_url is the backend server to proxy requests to
33    let (proxy_app, handle): (Router, CacheHandle) = create_proxy(proxy_config);
34
35    // You can clone and use the handle in your code
36    let handle_clone = handle.clone();
37
38    // Example: Trigger cache invalidation from another part of your application
39    tokio::spawn(async move {
40        tokio::time::sleep(tokio::time::Duration::from_secs(60)).await;
41
42        // Invalidate all cache entries
43        handle_clone.invalidate_all();
44        println!("All cache invalidated!");
45
46        tokio::time::sleep(tokio::time::Duration::from_secs(30)).await;
47
48        // Invalidate only cache entries matching a pattern (supports wildcards)
49        handle_clone.invalidate("GET:/api/*");
50        println!("Cache invalidated for GET:/api/* pattern!");
51    });
52
53    // Example: PreGenerate (SSG) mode with snapshot management
54    // let ssg_config = CreateProxyConfig::new("http://localhost:8080".to_string())
55    //     .with_proxy_mode(ProxyMode::PreGenerate {
56    //         paths: vec!["/".to_string(), "/about".to_string(), "/book/1".to_string()],
57    //         fallthrough: false, // return 404 on cache miss (default)
58    //     });
59    // let (ssg_app, ssg_handle) = create_proxy(ssg_config);
60    // // At runtime, manage snapshots:
61    // ssg_handle.add_snapshot("/book/2").await.unwrap();
62    // ssg_handle.refresh_snapshot("/book/1").await.unwrap();
63    // ssg_handle.remove_snapshot("/about").await.unwrap();
64    // ssg_handle.refresh_all_snapshots().await.unwrap();
65    let _ = ProxyMode::Dynamic; // suppress unused import warning
66
67    // Start the proxy server
68    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
69
70    println!("Proxy server listening on http://0.0.0.0:3000");
71    println!("Caching paths: /api/*, /public/*, GET /admin/stats");
72    println!("Excluding: /api/admin/*, POST *, PUT *, DELETE *");
73    println!("Cache strategy: none (proxy-only mode)");
74    println!("Compression strategy: brotli (applies only to cached responses)");
75    println!("Cache storage mode: filesystem (custom cache directory)");
76    println!("Note: Cache reads and writes are disabled in this example");
77    println!("WebSocket support: enabled");
78
79    axum::serve(listener, proxy_app).await.unwrap();
80}
library_usage/library_usage.rs

library_usage/
library_usage.rs
