objectstore_server/web/
app.rs

1use std::net::SocketAddr;
2
3use anyhow::Result;
4use axum::ServiceExt;
5use axum::extract::Request;
6use sentry::integrations::tower::{NewSentryLayer, SentryHttpLayer};
7use tokio::net::TcpListener;
8use tower::ServiceBuilder;
9use tower_http::catch_panic::CatchPanicLayer;
10use tower_http::trace::{DefaultOnFailure, TraceLayer};
11use tracing::Level;
12
13use crate::endpoints;
14use crate::state::ServiceState;
15use crate::web::middleware as m;
16
17/// The objectstore web server application.
18#[derive(Debug)]
19pub struct App {
20    router: axum::Router,
21    graceful_shutdown: bool,
22}
23
24impl App {
25    /// Creates a new application router for the given service state.
26    ///
27    /// The applications sets up middlewares and routes for the objectstore web API. Use
28    /// [`serve`](Self::serve) to run the server future.
29    pub fn new(state: ServiceState) -> Self {
30        // Build the router middleware into a single service which runs _after_ routing. Service
31        // builder order defines layers added first will be called first. This means:
32        //  - Requests go from top to bottom
33        //  - Responses go from bottom to top
34        let middleware = ServiceBuilder::new()
35            .layer(axum::middleware::from_fn(m::emit_request_metrics))
36            .layer(axum::middleware::from_fn_with_state(
37                state.request_counter.clone(),
38                m::limit_web_concurrency,
39            ))
40            .layer(state.request_counter.layer())
41            .layer(CatchPanicLayer::custom(m::handle_panic))
42            .layer(m::set_server_header())
43            .layer(NewSentryLayer::new_from_top())
44            .layer(SentryHttpLayer::new().enable_transaction())
45            .layer(
46                TraceLayer::new_for_http()
47                    .make_span_with(m::make_http_span)
48                    .on_failure(DefaultOnFailure::new().level(Level::DEBUG)),
49            );
50
51        let router = endpoints::routes()
52            .layer(middleware)
53            .with_state(state.clone());
54
55        App {
56            router,
57            graceful_shutdown: false,
58        }
59    }
60
61    /// Enables or disables graceful shutdown for the server.
62    ///
63    /// By default, graceful shutdown is disabled.
64    pub fn graceful_shutdown(mut self, enable: bool) -> Self {
65        self.graceful_shutdown = enable;
66        self
67    }
68
69    /// Runs the web server until graceful shutdown is triggered.
70    ///
71    /// This function creates a future that runs the server. The future must be spawned or awaited for
72    /// the server to continue running.
73    pub async fn serve(self, listener: TcpListener) -> Result<()> {
74        let Self {
75            router,
76            graceful_shutdown,
77        } = self;
78
79        let service =
80            ServiceExt::<Request>::into_make_service_with_connect_info::<SocketAddr>(router);
81
82        if graceful_shutdown {
83            let guard = elegant_departure::get_shutdown_guard();
84            axum::serve(listener, service)
85                .with_graceful_shutdown(guard.wait_owned())
86                .await?;
87        } else {
88            axum::serve(listener, service).await?;
89        }
90
91        Ok(())
92    }
93}
objectstore_server/web/app.rs

objectstore_server/web/
app.rs
