LCOV - code coverage report
Current view: top level - compute_tools/src/http - server.rs (source / functions) Coverage Total Hit
Test: 6df3fc19ec669bcfbbf9aba41d1338898d24eaa0.info Lines: 0.0 % 135 0
Test Date: 2025-03-12 18:28:53 Functions: 0.0 % 16 0

            Line data    Source code
       1              : use std::fmt::Display;
       2              : use std::net::{IpAddr, Ipv6Addr, SocketAddr};
       3              : use std::sync::Arc;
       4              : use std::time::Duration;
       5              : 
       6              : use anyhow::Result;
       7              : use axum::Router;
       8              : use axum::middleware::{self};
       9              : use axum::response::IntoResponse;
      10              : use axum::routing::{get, post};
      11              : use http::StatusCode;
      12              : use jsonwebtoken::jwk::JwkSet;
      13              : use tokio::net::TcpListener;
      14              : use tower::ServiceBuilder;
      15              : use tower_http::{
      16              :     auth::AsyncRequireAuthorizationLayer, request_id::PropagateRequestIdLayer, trace::TraceLayer,
      17              : };
      18              : use tracing::{Span, error, info};
      19              : 
      20              : use super::middleware::request_id::maybe_add_request_id_header;
      21              : use super::{
      22              :     headers::X_REQUEST_ID,
      23              :     middleware::authorize::Authorize,
      24              :     routes::{
      25              :         check_writability, configure, database_schema, dbs_and_roles, extension_server, extensions,
      26              :         grants, insights, metrics, metrics_json, status, terminate,
      27              :     },
      28              : };
      29              : use crate::compute::ComputeNode;
      30              : 
      31              : /// `compute_ctl` has two servers: internal and external. The internal server
      32              : /// binds to the loopback interface and handles communication from clients on
      33              : /// the compute. The external server is what receives communication from the
      34              : /// control plane, the metrics scraper, etc. We make the distinction because
      35              : /// certain routes in `compute_ctl` only need to be exposed to local processes
      36              : /// like Postgres via the neon extension and local_proxy.
      37              : #[derive(Clone, Debug)]
      38              : pub enum Server {
      39              :     Internal {
      40              :         port: u16,
      41              :     },
      42              :     External {
      43              :         port: u16,
      44              :         jwks: JwkSet,
      45              :         compute_id: String,
      46              :     },
      47              : }
      48              : 
      49              : impl Display for Server {
      50            0 :     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
      51            0 :         match self {
      52            0 :             Server::Internal { .. } => f.write_str("internal"),
      53            0 :             Server::External { .. } => f.write_str("external"),
      54              :         }
      55            0 :     }
      56              : }
      57              : 
      58              : impl From<&Server> for Router<Arc<ComputeNode>> {
      59            0 :     fn from(server: &Server) -> Self {
      60            0 :         let mut router = Router::<Arc<ComputeNode>>::new();
      61              : 
      62            0 :         router = match server {
      63              :             Server::Internal { .. } => {
      64            0 :                 router = router
      65            0 :                     .route(
      66            0 :                         "/extension_server/{*filename}",
      67            0 :                         post(extension_server::download_extension),
      68            0 :                     )
      69            0 :                     .route("/extensions", post(extensions::install_extension))
      70            0 :                     .route("/grants", post(grants::add_grant));
      71            0 : 
      72            0 :                 // Add in any testing support
      73            0 :                 if cfg!(feature = "testing") {
      74            0 :                     use super::routes::failpoints;
      75            0 : 
      76            0 :                     router = router.route("/failpoints", post(failpoints::configure_failpoints));
      77            0 :                 }
      78              : 
      79            0 :                 router
      80              :             }
      81              :             Server::External {
      82            0 :                 jwks, compute_id, ..
      83            0 :             } => {
      84            0 :                 let unauthenticated_router =
      85            0 :                     Router::<Arc<ComputeNode>>::new().route("/metrics", get(metrics::get_metrics));
      86            0 : 
      87            0 :                 let authenticated_router = Router::<Arc<ComputeNode>>::new()
      88            0 :                     .route("/check_writability", post(check_writability::is_writable))
      89            0 :                     .route("/configure", post(configure::configure))
      90            0 :                     .route("/database_schema", get(database_schema::get_schema_dump))
      91            0 :                     .route("/dbs_and_roles", get(dbs_and_roles::get_catalog_objects))
      92            0 :                     .route("/insights", get(insights::get_insights))
      93            0 :                     .route("/metrics.json", get(metrics_json::get_metrics))
      94            0 :                     .route("/status", get(status::get_status))
      95            0 :                     .route("/terminate", post(terminate::terminate))
      96            0 :                     .layer(AsyncRequireAuthorizationLayer::new(Authorize::new(
      97            0 :                         compute_id.clone(),
      98            0 :                         jwks.clone(),
      99            0 :                     )));
     100            0 : 
     101            0 :                 router
     102            0 :                     .merge(unauthenticated_router)
     103            0 :                     .merge(authenticated_router)
     104              :             }
     105              :         };
     106              : 
     107            0 :         router
     108            0 :             .fallback(Server::handle_404)
     109            0 :             .method_not_allowed_fallback(Server::handle_405)
     110            0 :             .layer(
     111            0 :                 ServiceBuilder::new()
     112            0 :                     .layer(tower_otel::trace::HttpLayer::server(tracing::Level::INFO))
     113            0 :                     // Add this middleware since we assume the request ID exists
     114            0 :                     .layer(middleware::from_fn(maybe_add_request_id_header))
     115            0 :                     .layer(
     116            0 :                         TraceLayer::new_for_http()
     117            0 :                             .on_request(|request: &http::Request<_>, _span: &Span| {
     118            0 :                                 let request_id = request
     119            0 :                                     .headers()
     120            0 :                                     .get(X_REQUEST_ID)
     121            0 :                                     .unwrap()
     122            0 :                                     .to_str()
     123            0 :                                     .unwrap();
     124            0 : 
     125            0 :                                 info!(%request_id, "{} {}", request.method(), request.uri());
     126            0 :                             })
     127            0 :                             .on_response(
     128            0 :                                 |response: &http::Response<_>, latency: Duration, _span: &Span| {
     129            0 :                                     let request_id = response
     130            0 :                                         .headers()
     131            0 :                                         .get(X_REQUEST_ID)
     132            0 :                                         .unwrap()
     133            0 :                                         .to_str()
     134            0 :                                         .unwrap();
     135            0 : 
     136            0 :                                     info!(
     137              :                                         %request_id,
     138            0 :                                         code = response.status().as_u16(),
     139            0 :                                         latency = latency.as_millis()
     140              :                                     );
     141            0 :                                 },
     142            0 :                             ),
     143            0 :                     )
     144            0 :                     .layer(PropagateRequestIdLayer::x_request_id()),
     145            0 :             )
     146            0 :     }
     147              : }
     148              : 
     149              : impl Server {
     150            0 :     async fn handle_404() -> impl IntoResponse {
     151            0 :         StatusCode::NOT_FOUND
     152            0 :     }
     153              : 
     154            0 :     async fn handle_405() -> impl IntoResponse {
     155            0 :         StatusCode::METHOD_NOT_ALLOWED
     156            0 :     }
     157              : 
     158            0 :     async fn listener(&self) -> Result<TcpListener> {
     159            0 :         let addr = SocketAddr::new(self.ip(), self.port());
     160            0 :         let listener = TcpListener::bind(&addr).await?;
     161              : 
     162            0 :         Ok(listener)
     163            0 :     }
     164              : 
     165            0 :     fn ip(&self) -> IpAddr {
     166            0 :         match self {
     167              :             // TODO: Change this to Ipv6Addr::LOCALHOST when the GitHub runners
     168              :             // allow binding to localhost
     169            0 :             Server::Internal { .. } => IpAddr::from(Ipv6Addr::UNSPECIFIED),
     170            0 :             Server::External { .. } => IpAddr::from(Ipv6Addr::UNSPECIFIED),
     171              :         }
     172            0 :     }
     173              : 
     174            0 :     fn port(&self) -> u16 {
     175            0 :         match self {
     176            0 :             Server::Internal { port, .. } => *port,
     177            0 :             Server::External { port, .. } => *port,
     178              :         }
     179            0 :     }
     180              : 
     181            0 :     async fn serve(self, compute: Arc<ComputeNode>) {
     182            0 :         let listener = self.listener().await.unwrap_or_else(|e| {
     183            0 :             // If we can't bind, the compute cannot operate correctly
     184            0 :             panic!(
     185            0 :                 "failed to bind the compute_ctl {} HTTP server to {}: {}",
     186            0 :                 self,
     187            0 :                 SocketAddr::new(self.ip(), self.port()),
     188            0 :                 e
     189            0 :             );
     190            0 :         });
     191            0 : 
     192            0 :         if tracing::enabled!(tracing::Level::INFO) {
     193            0 :             let local_addr = match listener.local_addr() {
     194            0 :                 Ok(local_addr) => local_addr,
     195            0 :                 Err(_) => SocketAddr::new(self.ip(), self.port()),
     196              :             };
     197              : 
     198            0 :             info!(
     199            0 :                 "compute_ctl {} HTTP server listening at {}",
     200              :                 self, local_addr
     201              :             );
     202            0 :         }
     203              : 
     204            0 :         let router = Router::from(&self)
     205            0 :             .with_state(compute)
     206            0 :             .into_make_service_with_connect_info::<SocketAddr>();
     207              : 
     208            0 :         if let Err(e) = axum::serve(listener, router).await {
     209            0 :             error!("compute_ctl {} HTTP server error: {}", self, e);
     210            0 :         }
     211            0 :     }
     212              : 
     213            0 :     pub fn launch(self, compute: &Arc<ComputeNode>) {
     214            0 :         let state = Arc::clone(compute);
     215            0 : 
     216            0 :         info!("Launching the {} server", self);
     217              : 
     218            0 :         tokio::spawn(self.serve(state));
     219            0 :     }
     220              : }
        

Generated by: LCOV version 2.1-beta