rws_server/middleware/

mod.rs

//! Composable middleware pipeline.
//!
//! [`Middleware`] is a single layer that wraps request dispatch. Implement it
//! to add cross-cutting behaviour — logging, authentication, rate limiting,
//! header injection — without editing the inner application.
//!
//! [`WithMiddleware`] stacks one or more middleware layers around any
//! [`Application`]. Layers run in registration order on the way in and in
//! reverse order on the way out.
//!
//! # Example
//!
//! ```rust,no_run
//! # extern crate rws_server as rust_web_server;
//! use rust_web_server::middleware::{Middleware, WithMiddleware};
//! use rust_web_server::application::Application;
//! use rust_web_server::request::Request;
//! use rust_web_server::response::Response;
//! use rust_web_server::server::ConnectionInfo;
//! use rust_web_server::app::App;
//! use rust_web_server::core::New;
//!
//! pub struct LoggingMiddleware;
//!
//! impl Middleware for LoggingMiddleware {
//!     fn handle(
//!         &self,
//!         request: &Request,
//!         connection: &ConnectionInfo,
//!         next: &dyn Application,
//!     ) -> Result<Response, String> {
//!         println!("{} {}", request.method, request.request_uri);
//!         let response = next.execute(request, connection)?;
//!         println!("  → {}", response.status_code);
//!         Ok(response)
//!     }
//! }
//!
//! let app = WithMiddleware::new(App::new())
//!     .wrap(LoggingMiddleware);
//! ```

#[cfg(test)]
mod tests;

use std::sync::Arc;

use crate::application::Application;
use crate::request::Request;
use crate::response::Response;
use crate::header::Header;
use crate::server::ConnectionInfo;

/// Built-in middleware that enforces the process-wide rate limit
/// (configured via `RWS_CONFIG_RATE_LIMIT_MAX_REQUESTS` and
/// `RWS_CONFIG_RATE_LIMIT_WINDOW_SECS`).
///
/// Returns `429 Too Many Requests` when the sliding-window budget for the
/// client IP is exhausted; otherwise passes the request to the next layer.
///
/// # Example
///
/// ```rust,no_run
/// # extern crate rws_server as rust_web_server;
/// use rust_web_server::app::App;
/// use rust_web_server::middleware::{WithMiddleware, RateLimitLayer};
/// use rust_web_server::core::New;
///
/// let app = App::new().wrap(RateLimitLayer);
/// ```
pub struct RateLimitLayer;

impl Middleware for RateLimitLayer {
    /// Headers only: a streamed body passes through untouched.
    fn accepts_streamed_body(&self, _request: &Request, _connection: &ConnectionInfo) -> bool {
        true
    }


    fn handle(
        &self,
        request: &Request,
        connection: &ConnectionInfo,
        next: &dyn Application,
    ) -> Result<Response, String> {
        use crate::error::{AppError, IntoResponse};
        let ip = crate::ip_filter::client_ip(request, &connection.client.ip);
        if crate::rate_limit::global().check(&ip) {
            next.execute(request, connection)
        } else {
            let mut response = AppError::TooManyRequests.into_response();
            let retry_after = crate::rate_limit::global().retry_after(&ip);
            response.headers.push(Header {
                name: Header::_RETRY_AFTER.into(),
                value: retry_after.to_string().into(),
            });
            Ok(response)
        }
    }

    /// In-memory only: safe on the event loop.
    fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool {
        true
    }
}

/// A single middleware layer.
///
/// Receive the request, call `next.execute(request, connection)` to pass
/// control to the next layer (or the inner application), and optionally
/// inspect or transform the resulting response.
///
/// Short-circuit by returning a `Response` (or `Err`) without calling `next`.
pub trait Middleware: Send + Sync {
    fn handle(
        &self,
        request: &Request,
        connection: &ConnectionInfo,
        next: &dyn Application,
    ) -> Result<Response, String>;

    /// `true` when this layer's own work for `request` never blocks (in-memory
    /// state, atomics, short mutexes) — see [`Application::runs_inline`]. A
    /// [`WithMiddleware`] stack runs inline only if every layer and the inner
    /// application agree. Default `false`.
    fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool {
        false
    }

    /// `true` when `handle` would do nothing for `request` but call `next`
    /// (e.g. a rate limit that isn't configured). A [`WithMiddleware`] stack
    /// offers the inner application's `execute_async` only if every layer
    /// passes the request through. Default `false`.
    fn is_passthrough(&self, _request: &Request, _connection: &ConnectionInfo) -> bool {
        false
    }

    /// `true` when this layer never reads `request.body`, so the inner
    /// application may receive it as a stream ([`Application::streams_body`]).
    /// A layer that inspects the body (CSRF tokens in a form, request
    /// signatures, rewriting) must keep the default `false`: it would see an
    /// empty body.
    fn accepts_streamed_body(&self, _request: &Request, _connection: &ConnectionInfo) -> bool {
        false
    }

    /// `true` when this layer answers `request` itself — it doesn't call
    /// `next` — and reads its body as a stream (a proxy forwarding it as it
    /// arrives). The body is then streamed whatever the layers after it and
    /// the application would say. Requires `accepts_streamed_body`. Since
    /// 18.3.0.
    fn answers_streamed_body(&self, _request: &Request, _connection: &ConnectionInfo) -> bool {
        false
    }
}

/// An [`Application`] that applies a stack of [`Middleware`] layers before
/// dispatching to an inner application.
///
/// Layers are applied in registration order: the first `.wrap()`ed middleware
/// runs first on the request path and last on the response path.
pub struct WithMiddleware<A> {
    inner: A,
    /// Built once; shared by every clone (the servers clone the app per
    /// request, so a `Vec` here was an allocation per request).
    layers: Arc<[Arc<dyn Middleware>]>,
}

impl<A: Application> WithMiddleware<A> {
    /// Wrap `app` with no initial middleware.
    pub fn new(app: A) -> Self {
        WithMiddleware { inner: app, layers: Arc::new([]) }
    }

    /// Add a middleware layer. Layers run in registration order.
    pub fn wrap(mut self, layer: impl Middleware + 'static) -> Self {
        let mut layers = self.layers.to_vec();
        layers.push(Arc::new(layer));
        self.layers = layers.into();
        self
    }
}

impl<A: Application + Send + Sync + Clone + 'static> WithMiddleware<A> {
    /// Attach an MCP server that handles `POST /mcp`; all other requests fall
    /// through to this middleware stack.
    pub fn mcp(self, name: impl Into<String>, version: impl Into<String>) -> crate::mcp::McpServer {
        crate::mcp::McpServer::new(name, version).wrap(self)
    }
}

impl<A: Clone> Clone for WithMiddleware<A> {
    fn clone(&self) -> Self {
        WithMiddleware { inner: self.inner.clone(), layers: Arc::clone(&self.layers) }
    }
}

impl<A: Application> Application for WithMiddleware<A> {
    fn execute(&self, request: &Request, connection: &ConnectionInfo) -> Result<Response, String> {
        Chain { app: &self.inner, layers: &self.layers, index: 0 }.execute(request, connection)
    }

    fn runs_inline(&self, request: &Request, connection: &ConnectionInfo) -> bool {
        self.layers.iter().all(|l| l.runs_inline(request, connection)) && self.inner.runs_inline(request, connection)
    }

    #[cfg(feature = "http2")]
    fn execute_async<'a>(&'a self, request: &'a Request, connection: &'a ConnectionInfo) -> Option<crate::application::AsyncResponse<'a>> {
        if self.layers.iter().all(|l| l.is_passthrough(request, connection)) {
            self.inner.execute_async(request, connection)
        } else {
            None
        }
    }
    fn streams_body(&self, request: &Request, connection: &ConnectionInfo) -> bool {
        for layer in self.layers.iter() {
            if !layer.accepts_streamed_body(request, connection) {
                return false;
            }
            if layer.answers_streamed_body(request, connection) {
                return true;
            }
        }
        self.inner.streams_body(request, connection)
    }
}

// Internal chain that carries the remaining layers and the final app.
struct Chain<'a> {
    app: &'a dyn Application,
    layers: &'a [Arc<dyn Middleware>],
    index: usize,
}

impl<'a> Application for Chain<'a> {
    fn execute(&self, request: &Request, connection: &ConnectionInfo) -> Result<Response, String> {
        if self.index < self.layers.len() {
            let next = Chain { app: self.app, layers: self.layers, index: self.index + 1 };
            self.layers[self.index].handle(request, connection, &next)
        } else {
            self.app.execute(request, connection)
        }
    }
}