refractium 1.1.4

Extensible low-level reverse proxy for port multiplexing and protocol-based routing
Documentation
/// Balancer module for load balancing logic.
pub mod balancer;
/// Health module for backend monitoring.
pub mod health;
/// Proxy module for TCP tunneling.
pub mod proxy;
/// Router module for protocol-based routing.
pub mod router;
/// TCP server implementation.
pub mod tcp;
/// UDP server implementation.
pub mod udp;

/// Types used across the core module.
pub mod types;

use crate::errors::Result;
use crate::protocols::ProtocolRegistry;
use balancer::LoadBalancer;
use health::HealthMonitor;
use router::Router;
use std::collections::HashMap;
use std::net::SocketAddr;
use std::sync::Arc;
use tcp::TcpServer;
use tokio::sync::RwLock;
use tokio_util::sync::CancellationToken;
use udp::UdpServer;

/// Main Refractium engine that manages TCP and UDP servers.
pub struct Refractium {
    router_tcp: Arc<Router>,
    router_udp: Arc<Router>,
    health: Arc<HealthMonitor>,
    peek_buffer_size: usize,
    peek_timeout_ms: u64,
    max_connections: usize,
    max_connections_per_ip: usize,
    cancel_token: CancellationToken,
}

impl Refractium {
    /// Returns a new `RefractiumBuilder` instance.
    #[must_use]
    pub fn builder() -> RefractiumBuilder {
        RefractiumBuilder::new()
    }

    /// Reloads the routing table for both TCP and UDP.
    pub async fn reload_routes(
        &self,
        tcp: HashMap<String, Vec<String>>,
        udp: HashMap<String, Vec<String>>,
    ) {
        let mut targets = tcp.values().flatten().cloned().collect::<Vec<_>>();
        targets.extend(udp.values().flatten().cloned());

        self.router_tcp
            .update_balancer(tcp, Arc::clone(&self.health))
            .await;
        self.router_udp
            .update_balancer(udp, Arc::clone(&self.health))
            .await;

        self.health.start_monitoring(targets);
    }

    /// Returns a clone of the cancellation token.
    #[must_use]
    pub fn cancel_token(&self) -> CancellationToken {
        self.cancel_token.clone()
    }

    /// Runs the TCP server on the specified address.
    ///
    /// # Errors
    ///
    /// Returns a `RefractiumError` if the server fails to start or encounters a fatal error.
    pub async fn run_tcp(&self, addr: SocketAddr) -> Result<()> {
        TcpServer::new(
            addr,
            Arc::clone(&self.router_tcp),
            Arc::clone(&self.health),
            self.peek_buffer_size,
            self.peek_timeout_ms,
            self.max_connections,
            self.max_connections_per_ip,
            self.cancel_token.clone(),
        )
        .start()
        .await
    }

    /// Runs the UDP server on the specified address.
    ///
    /// # Errors
    ///
    /// Returns a `RefractiumError` if the server fails to start or encounters a fatal error.
    pub async fn run_udp(&self, addr: SocketAddr) -> Result<()> {
        UdpServer::new(
            addr,
            Arc::clone(&self.router_udp),
            Arc::clone(&self.health),
            self.cancel_token.clone(),
        )
        .start()
        .await
    }

    /// Runs both TCP and UDP servers on the specified address.
    ///
    /// # Errors
    ///
    /// Returns a `RefractiumError` if either server fails to start.
    pub async fn run_both(&self, addr: SocketAddr) -> Result<()> {
        tokio::try_join!(self.run_tcp(addr), self.run_udp(addr))?;
        Ok(())
    }

    /// Prints a health report of all configured backends.
    pub async fn report_health(&self) {
        let tcp_status = self.router_tcp.get_health_status().await;
        let udp_status = self.router_udp.get_health_status().await;

        if !tcp_status.is_empty() {
            println!("\n[TCP Backends]");
            Self::print_status_map(tcp_status);
        }
        if !udp_status.is_empty() {
            println!("\n[UDP Backends]");
            Self::print_status_map(udp_status);
        }
        println!();
    }

    fn print_status_map(status: HashMap<String, Vec<(String, bool)>>) {
        for (proto, backends) in status {
            print!("  {proto} -> ");
            for (idx, (addr, alive)) in backends.iter().enumerate() {
                if idx > 0 {
                    print!(", ");
                }
                let status_str = if *alive {
                    "\x1b[32mUP\x1b[0m" // Green
                } else {
                    "\x1b[31mDOWN\x1b[0m" // Red
                };
                print!("{addr} [{status_str}]");
            }
            println!();
        }
    }
}

/// Builder for the `Refractium` engine.
pub struct RefractiumBuilder {
    registry_tcp: Option<Arc<ProtocolRegistry>>,
    registry_udp: Option<Arc<ProtocolRegistry>>,
    routes_tcp: HashMap<String, Vec<String>>,
    routes_udp: HashMap<String, Vec<String>>,
    peek_size: usize,
    peek_timeout: u64,
    max_connections: usize,
    max_connections_per_ip: usize,
    cancel_token: Option<CancellationToken>,
}

impl RefractiumBuilder {
    /// Creates a new `RefractiumBuilder` with default values.
    #[must_use]
    pub fn new() -> Self {
        Self {
            registry_tcp: None,
            registry_udp: None,
            routes_tcp: HashMap::new(),
            routes_udp: HashMap::new(),
            peek_size: 1024,
            peek_timeout: 3000,
            max_connections: 10000,
            max_connections_per_ip: 50,
            cancel_token: None,
        }
    }

    /// Sets the protocol registries for TCP and UDP.
    #[must_use]
    pub fn registries(mut self, tcp: Arc<ProtocolRegistry>, udp: Arc<ProtocolRegistry>) -> Self {
        self.registry_tcp = Some(tcp);
        self.registry_udp = Some(udp);
        self
    }

    /// Sets the routing tables for TCP and UDP.
    #[must_use]
    pub fn routes(
        mut self,
        tcp: HashMap<String, Vec<String>>,
        udp: HashMap<String, Vec<String>>,
    ) -> Self {
        self.routes_tcp = tcp;
        self.routes_udp = udp;
        self
    }

    /// Sets the peek configuration for protocol identification.
    #[must_use]
    pub const fn peek_config(mut self, size: usize, timeout_ms: u64) -> Self {
        self.peek_size = size;
        self.peek_timeout = timeout_ms;
        self
    }

    /// Sets the maximum number of concurrent connections.
    #[must_use]
    pub const fn max_connections(mut self, max: usize) -> Self {
        self.max_connections = max;
        self
    }

    /// Sets the maximum number of concurrent connections per IP.
    #[must_use]
    pub const fn max_connections_per_ip(mut self, max: usize) -> Self {
        self.max_connections_per_ip = max;
        self
    }

    /// Sets the cancellation token for the engine.
    #[must_use]
    pub fn cancel_token(mut self, token: CancellationToken) -> Self {
        self.cancel_token = Some(token);
        self
    }

    /// Builds the `Refractium` engine.
    #[must_use]
    pub fn build(self) -> Refractium {
        let health = Arc::new(HealthMonitor::new());
        self.init_health(&health);

        let router_tcp = Self::do_build_router(self.routes_tcp, self.registry_tcp, &health);
        let router_udp = Self::do_build_router(self.routes_udp, self.registry_udp, &health);

        Refractium {
            router_tcp,
            router_udp,
            health,
            peek_buffer_size: self.peek_size,
            peek_timeout_ms: self.peek_timeout,
            max_connections: self.max_connections,
            max_connections_per_ip: self.max_connections_per_ip,
            cancel_token: self.cancel_token.unwrap_or_default(),
        }
    }

    fn init_health(&self, health: &Arc<HealthMonitor>) {
        let mut targets = self
            .routes_tcp
            .values()
            .flatten()
            .cloned()
            .collect::<Vec<_>>();
        targets.extend(self.routes_udp.values().flatten().cloned());
        health.start_monitoring(targets);
    }

    fn do_build_router(
        routes: HashMap<String, Vec<String>>,
        registry: Option<Arc<ProtocolRegistry>>,
        health: &Arc<HealthMonitor>,
    ) -> Arc<Router> {
        let balancer = Arc::new(RwLock::new(LoadBalancer::new(routes, Arc::clone(health))));
        let registry = registry.unwrap_or_else(|| Arc::new(ProtocolRegistry::new()));
        Arc::new(Router::new(registry, balancer))
    }
}

impl Default for RefractiumBuilder {
    fn default() -> Self {
        Self::new()
    }
}