LCOV - code coverage report
Current view: top level - safekeeper/src/http - routes.rs (source / functions) Coverage Total Hit
Test: 050dd70dd490b28fffe527eae9fb8a1222b5c59c.info Lines: 3.5 % 426 15
Test Date: 2024-06-25 21:28:46 Functions: 1.1 % 89 1

            Line data    Source code
       1              : use hyper::{Body, Request, Response, StatusCode, Uri};
       2              : use once_cell::sync::Lazy;
       3              : use serde::{Deserialize, Serialize};
       4              : use std::collections::{HashMap, HashSet};
       5              : use std::fmt;
       6              : use std::io::Write as _;
       7              : use std::str::FromStr;
       8              : use std::sync::Arc;
       9              : use storage_broker::proto::SafekeeperTimelineInfo;
      10              : use storage_broker::proto::TenantTimelineId as ProtoTenantTimelineId;
      11              : use tokio::sync::mpsc;
      12              : use tokio::task;
      13              : use tokio_stream::wrappers::ReceiverStream;
      14              : use tokio_util::sync::CancellationToken;
      15              : use tracing::{info_span, Instrument};
      16              : use utils::failpoint_support::failpoints_handler;
      17              : use utils::http::endpoint::{prometheus_metrics_handler, request_span, ChannelWriter};
      18              : use utils::http::request::parse_query_param;
      19              : 
      20              : use postgres_ffi::WAL_SEGMENT_SIZE;
      21              : use safekeeper_api::models::TimelineCreateRequest;
      22              : use safekeeper_api::models::{SkTimelineInfo, TimelineCopyRequest};
      23              : use utils::{
      24              :     auth::SwappableJwtAuth,
      25              :     http::{
      26              :         endpoint::{self, auth_middleware, check_permission_with},
      27              :         error::ApiError,
      28              :         json::{json_request, json_response},
      29              :         request::{ensure_no_body, parse_request_param},
      30              :         RequestExt, RouterBuilder,
      31              :     },
      32              :     id::{NodeId, TenantId, TenantTimelineId, TimelineId},
      33              :     lsn::Lsn,
      34              : };
      35              : 
      36              : use crate::debug_dump::TimelineDigestRequest;
      37              : use crate::receive_wal::WalReceiverState;
      38              : use crate::safekeeper::Term;
      39              : use crate::safekeeper::{ServerInfo, TermLsn};
      40              : use crate::send_wal::WalSenderState;
      41              : use crate::timeline::PeerInfo;
      42              : use crate::timelines_global_map::TimelineDeleteForceResult;
      43              : use crate::GlobalTimelines;
      44              : use crate::SafeKeeperConf;
      45              : use crate::{copy_timeline, debug_dump, patch_control_file, pull_timeline};
      46              : 
      47              : #[derive(Debug, Serialize)]
      48              : struct SafekeeperStatus {
      49              :     id: NodeId,
      50              : }
      51              : 
      52              : /// Healthcheck handler.
      53            0 : async fn status_handler(request: Request<Body>) -> Result<Response<Body>, ApiError> {
      54            0 :     check_permission(&request, None)?;
      55            0 :     let conf = get_conf(&request);
      56            0 :     let status = SafekeeperStatus { id: conf.my_id };
      57            0 :     json_response(StatusCode::OK, status)
      58            0 : }
      59              : 
      60            0 : fn get_conf(request: &Request<Body>) -> &SafeKeeperConf {
      61            0 :     request
      62            0 :         .data::<Arc<SafeKeeperConf>>()
      63            0 :         .expect("unknown state type")
      64            0 :         .as_ref()
      65            0 : }
      66              : 
      67              : /// Same as TermLsn, but serializes LSN using display serializer
      68              : /// in Postgres format, i.e. 0/FFFFFFFF. Used only for the API response.
      69            0 : #[derive(Debug, Clone, Copy, Serialize, Deserialize)]
      70              : pub struct TermSwitchApiEntry {
      71              :     pub term: Term,
      72              :     pub lsn: Lsn,
      73              : }
      74              : 
      75              : impl From<TermSwitchApiEntry> for TermLsn {
      76            0 :     fn from(api_val: TermSwitchApiEntry) -> Self {
      77            0 :         TermLsn {
      78            0 :             term: api_val.term,
      79            0 :             lsn: api_val.lsn,
      80            0 :         }
      81            0 :     }
      82              : }
      83              : 
      84              : /// Augment AcceptorState with last_log_term for convenience
      85            0 : #[derive(Debug, Serialize, Deserialize)]
      86              : pub struct AcceptorStateStatus {
      87              :     pub term: Term,
      88              :     pub epoch: Term, // aka last_log_term
      89              :     pub term_history: Vec<TermSwitchApiEntry>,
      90              : }
      91              : 
      92              : /// Info about timeline on safekeeper ready for reporting.
      93            0 : #[derive(Debug, Serialize, Deserialize)]
      94              : pub struct TimelineStatus {
      95              :     pub tenant_id: TenantId,
      96              :     pub timeline_id: TimelineId,
      97              :     pub acceptor_state: AcceptorStateStatus,
      98              :     pub pg_info: ServerInfo,
      99              :     pub flush_lsn: Lsn,
     100              :     pub timeline_start_lsn: Lsn,
     101              :     pub local_start_lsn: Lsn,
     102              :     pub commit_lsn: Lsn,
     103              :     pub backup_lsn: Lsn,
     104              :     pub peer_horizon_lsn: Lsn,
     105              :     pub remote_consistent_lsn: Lsn,
     106              :     pub peers: Vec<PeerInfo>,
     107              :     pub walsenders: Vec<WalSenderState>,
     108              :     pub walreceivers: Vec<WalReceiverState>,
     109              : }
     110              : 
     111            0 : fn check_permission(request: &Request<Body>, tenant_id: Option<TenantId>) -> Result<(), ApiError> {
     112            0 :     check_permission_with(request, |claims| {
     113            0 :         crate::auth::check_permission(claims, tenant_id)
     114            0 :     })
     115            0 : }
     116              : 
     117              : /// Report info about timeline.
     118            0 : async fn timeline_status_handler(request: Request<Body>) -> Result<Response<Body>, ApiError> {
     119            0 :     let ttid = TenantTimelineId::new(
     120            0 :         parse_request_param(&request, "tenant_id")?,
     121            0 :         parse_request_param(&request, "timeline_id")?,
     122              :     );
     123            0 :     check_permission(&request, Some(ttid.tenant_id))?;
     124              : 
     125            0 :     let tli = GlobalTimelines::get(ttid).map_err(ApiError::from)?;
     126            0 :     let (inmem, state) = tli.get_state().await;
     127            0 :     let flush_lsn = tli.get_flush_lsn().await;
     128              : 
     129            0 :     let last_log_term = state.acceptor_state.get_last_log_term(flush_lsn);
     130            0 :     let term_history = state
     131            0 :         .acceptor_state
     132            0 :         .term_history
     133            0 :         .0
     134            0 :         .into_iter()
     135            0 :         .map(|ts| TermSwitchApiEntry {
     136            0 :             term: ts.term,
     137            0 :             lsn: ts.lsn,
     138            0 :         })
     139            0 :         .collect();
     140            0 :     let acc_state = AcceptorStateStatus {
     141            0 :         term: state.acceptor_state.term,
     142            0 :         epoch: last_log_term,
     143            0 :         term_history,
     144            0 :     };
     145            0 : 
     146            0 :     let conf = get_conf(&request);
     147              :     // Note: we report in memory values which can be lost.
     148            0 :     let status = TimelineStatus {
     149            0 :         tenant_id: ttid.tenant_id,
     150            0 :         timeline_id: ttid.timeline_id,
     151            0 :         acceptor_state: acc_state,
     152            0 :         pg_info: state.server,
     153            0 :         flush_lsn,
     154            0 :         timeline_start_lsn: state.timeline_start_lsn,
     155            0 :         local_start_lsn: state.local_start_lsn,
     156            0 :         commit_lsn: inmem.commit_lsn,
     157            0 :         backup_lsn: inmem.backup_lsn,
     158            0 :         peer_horizon_lsn: inmem.peer_horizon_lsn,
     159            0 :         remote_consistent_lsn: inmem.remote_consistent_lsn,
     160            0 :         peers: tli.get_peers(conf).await,
     161            0 :         walsenders: tli.get_walsenders().get_all(),
     162            0 :         walreceivers: tli.get_walreceivers().get_all(),
     163            0 :     };
     164            0 :     json_response(StatusCode::OK, status)
     165            0 : }
     166              : 
     167            0 : async fn timeline_create_handler(mut request: Request<Body>) -> Result<Response<Body>, ApiError> {
     168            0 :     let request_data: TimelineCreateRequest = json_request(&mut request).await?;
     169              : 
     170            0 :     let ttid = TenantTimelineId {
     171            0 :         tenant_id: request_data.tenant_id,
     172            0 :         timeline_id: request_data.timeline_id,
     173            0 :     };
     174            0 :     check_permission(&request, Some(ttid.tenant_id))?;
     175              : 
     176            0 :     let server_info = ServerInfo {
     177            0 :         pg_version: request_data.pg_version,
     178            0 :         system_id: request_data.system_id.unwrap_or(0),
     179            0 :         wal_seg_size: request_data.wal_seg_size.unwrap_or(WAL_SEGMENT_SIZE as u32),
     180            0 :     };
     181            0 :     let local_start_lsn = request_data.local_start_lsn.unwrap_or_else(|| {
     182            0 :         request_data
     183            0 :             .commit_lsn
     184            0 :             .segment_lsn(server_info.wal_seg_size as usize)
     185            0 :     });
     186            0 :     GlobalTimelines::create(ttid, server_info, request_data.commit_lsn, local_start_lsn)
     187            0 :         .await
     188            0 :         .map_err(ApiError::InternalServerError)?;
     189              : 
     190            0 :     json_response(StatusCode::OK, ())
     191            0 : }
     192              : 
     193              : /// Pull timeline from peer safekeeper instances.
     194            0 : async fn timeline_pull_handler(mut request: Request<Body>) -> Result<Response<Body>, ApiError> {
     195            0 :     check_permission(&request, None)?;
     196              : 
     197            0 :     let data: pull_timeline::Request = json_request(&mut request).await?;
     198            0 :     let conf = get_conf(&request);
     199              : 
     200            0 :     let resp = pull_timeline::handle_request(data, conf.sk_auth_token.clone())
     201            0 :         .await
     202            0 :         .map_err(ApiError::InternalServerError)?;
     203            0 :     json_response(StatusCode::OK, resp)
     204            0 : }
     205              : 
     206              : /// Stream tar archive with all timeline data.
     207            0 : async fn timeline_snapshot_handler(request: Request<Body>) -> Result<Response<Body>, ApiError> {
     208            0 :     let ttid = TenantTimelineId::new(
     209            0 :         parse_request_param(&request, "tenant_id")?,
     210            0 :         parse_request_param(&request, "timeline_id")?,
     211              :     );
     212            0 :     check_permission(&request, Some(ttid.tenant_id))?;
     213              : 
     214            0 :     let tli = GlobalTimelines::get(ttid).map_err(ApiError::from)?;
     215              :     // Note: with evicted timelines it should work better then de-evict them and
     216              :     // stream; probably start_snapshot would copy partial s3 file to dest path
     217              :     // and stream control file, or return FullAccessTimeline if timeline is not
     218              :     // evicted.
     219            0 :     let tli = tli
     220            0 :         .full_access_guard()
     221            0 :         .await
     222            0 :         .map_err(ApiError::InternalServerError)?;
     223              : 
     224              :     // To stream the body use wrap_stream which wants Stream of Result<Bytes>,
     225              :     // so create the chan and write to it in another task.
     226            0 :     let (tx, rx) = mpsc::channel(1);
     227            0 : 
     228            0 :     task::spawn(pull_timeline::stream_snapshot(tli, tx));
     229            0 : 
     230            0 :     let rx_stream = ReceiverStream::new(rx);
     231            0 :     let body = Body::wrap_stream(rx_stream);
     232            0 : 
     233            0 :     let response = Response::builder()
     234            0 :         .status(200)
     235            0 :         .header(hyper::header::CONTENT_TYPE, "application/octet-stream")
     236            0 :         .body(body)
     237            0 :         .unwrap();
     238            0 : 
     239            0 :     Ok(response)
     240            0 : }
     241              : 
     242            0 : async fn timeline_copy_handler(mut request: Request<Body>) -> Result<Response<Body>, ApiError> {
     243            0 :     check_permission(&request, None)?;
     244              : 
     245            0 :     let request_data: TimelineCopyRequest = json_request(&mut request).await?;
     246            0 :     let ttid = TenantTimelineId::new(
     247            0 :         parse_request_param(&request, "tenant_id")?,
     248            0 :         parse_request_param(&request, "source_timeline_id")?,
     249              :     );
     250              : 
     251            0 :     let source = GlobalTimelines::get(ttid)?;
     252              : 
     253            0 :     copy_timeline::handle_request(copy_timeline::Request{
     254            0 :         source,
     255            0 :         until_lsn: request_data.until_lsn,
     256            0 :         destination_ttid: TenantTimelineId::new(ttid.tenant_id, request_data.target_timeline_id),
     257            0 :     })
     258            0 :         .instrument(info_span!("copy_timeline", from=%ttid, to=%request_data.target_timeline_id, until_lsn=%request_data.until_lsn))
     259            0 :         .await
     260            0 :         .map_err(ApiError::InternalServerError)?;
     261              : 
     262            0 :     json_response(StatusCode::OK, ())
     263            0 : }
     264              : 
     265            0 : async fn timeline_digest_handler(request: Request<Body>) -> Result<Response<Body>, ApiError> {
     266            0 :     let ttid = TenantTimelineId::new(
     267            0 :         parse_request_param(&request, "tenant_id")?,
     268            0 :         parse_request_param(&request, "timeline_id")?,
     269              :     );
     270            0 :     check_permission(&request, Some(ttid.tenant_id))?;
     271              : 
     272            0 :     let from_lsn: Option<Lsn> = parse_query_param(&request, "from_lsn")?;
     273            0 :     let until_lsn: Option<Lsn> = parse_query_param(&request, "until_lsn")?;
     274              : 
     275            0 :     let request = TimelineDigestRequest {
     276            0 :         from_lsn: from_lsn.ok_or(ApiError::BadRequest(anyhow::anyhow!(
     277            0 :             "from_lsn is required"
     278            0 :         )))?,
     279            0 :         until_lsn: until_lsn.ok_or(ApiError::BadRequest(anyhow::anyhow!(
     280            0 :             "until_lsn is required"
     281            0 :         )))?,
     282              :     };
     283              : 
     284            0 :     let tli = GlobalTimelines::get(ttid).map_err(ApiError::from)?;
     285            0 :     let tli = tli
     286            0 :         .full_access_guard()
     287            0 :         .await
     288            0 :         .map_err(ApiError::InternalServerError)?;
     289              : 
     290            0 :     let response = debug_dump::calculate_digest(&tli, request)
     291            0 :         .await
     292            0 :         .map_err(ApiError::InternalServerError)?;
     293            0 :     json_response(StatusCode::OK, response)
     294            0 : }
     295              : 
     296              : /// Force persist control file.
     297            0 : async fn timeline_checkpoint_handler(request: Request<Body>) -> Result<Response<Body>, ApiError> {
     298            0 :     check_permission(&request, None)?;
     299              : 
     300            0 :     let ttid = TenantTimelineId::new(
     301            0 :         parse_request_param(&request, "tenant_id")?,
     302            0 :         parse_request_param(&request, "timeline_id")?,
     303              :     );
     304              : 
     305            0 :     let tli = GlobalTimelines::get(ttid)?;
     306            0 :     tli.write_shared_state()
     307            0 :         .await
     308              :         .sk
     309              :         .state
     310            0 :         .flush()
     311            0 :         .await
     312            0 :         .map_err(ApiError::InternalServerError)?;
     313            0 :     json_response(StatusCode::OK, ())
     314            0 : }
     315              : 
     316              : /// Deactivates the timeline and removes its data directory.
     317            0 : async fn timeline_delete_handler(mut request: Request<Body>) -> Result<Response<Body>, ApiError> {
     318            0 :     let ttid = TenantTimelineId::new(
     319            0 :         parse_request_param(&request, "tenant_id")?,
     320            0 :         parse_request_param(&request, "timeline_id")?,
     321              :     );
     322            0 :     let only_local = parse_query_param(&request, "only_local")?.unwrap_or(false);
     323            0 :     check_permission(&request, Some(ttid.tenant_id))?;
     324            0 :     ensure_no_body(&mut request).await?;
     325              :     // FIXME: `delete_force` can fail from both internal errors and bad requests. Add better
     326              :     // error handling here when we're able to.
     327            0 :     let resp = GlobalTimelines::delete(&ttid, only_local)
     328            0 :         .await
     329            0 :         .map_err(ApiError::InternalServerError)?;
     330            0 :     json_response(StatusCode::OK, resp)
     331            0 : }
     332              : 
     333              : /// Deactivates all timelines for the tenant and removes its data directory.
     334              : /// See `timeline_delete_handler`.
     335            0 : async fn tenant_delete_handler(mut request: Request<Body>) -> Result<Response<Body>, ApiError> {
     336            0 :     let tenant_id = parse_request_param(&request, "tenant_id")?;
     337            0 :     let only_local = parse_query_param(&request, "only_local")?.unwrap_or(false);
     338            0 :     check_permission(&request, Some(tenant_id))?;
     339            0 :     ensure_no_body(&mut request).await?;
     340              :     // FIXME: `delete_force_all_for_tenant` can return an error for multiple different reasons;
     341              :     // Using an `InternalServerError` should be fixed when the types support it
     342            0 :     let delete_info = GlobalTimelines::delete_force_all_for_tenant(&tenant_id, only_local)
     343            0 :         .await
     344            0 :         .map_err(ApiError::InternalServerError)?;
     345            0 :     json_response(
     346            0 :         StatusCode::OK,
     347            0 :         delete_info
     348            0 :             .iter()
     349            0 :             .map(|(ttid, resp)| (format!("{}", ttid.timeline_id), *resp))
     350            0 :             .collect::<HashMap<String, TimelineDeleteForceResult>>(),
     351            0 :     )
     352            0 : }
     353              : 
     354              : /// Used only in tests to hand craft required data.
     355            0 : async fn record_safekeeper_info(mut request: Request<Body>) -> Result<Response<Body>, ApiError> {
     356            0 :     let ttid = TenantTimelineId::new(
     357            0 :         parse_request_param(&request, "tenant_id")?,
     358            0 :         parse_request_param(&request, "timeline_id")?,
     359              :     );
     360            0 :     check_permission(&request, Some(ttid.tenant_id))?;
     361            0 :     let sk_info: SkTimelineInfo = json_request(&mut request).await?;
     362            0 :     let proto_sk_info = SafekeeperTimelineInfo {
     363            0 :         safekeeper_id: 0,
     364            0 :         tenant_timeline_id: Some(ProtoTenantTimelineId {
     365            0 :             tenant_id: ttid.tenant_id.as_ref().to_owned(),
     366            0 :             timeline_id: ttid.timeline_id.as_ref().to_owned(),
     367            0 :         }),
     368            0 :         term: sk_info.term.unwrap_or(0),
     369            0 :         last_log_term: sk_info.last_log_term.unwrap_or(0),
     370            0 :         flush_lsn: sk_info.flush_lsn.0,
     371            0 :         commit_lsn: sk_info.commit_lsn.0,
     372            0 :         remote_consistent_lsn: sk_info.remote_consistent_lsn.0,
     373            0 :         peer_horizon_lsn: sk_info.peer_horizon_lsn.0,
     374            0 :         safekeeper_connstr: sk_info.safekeeper_connstr.unwrap_or_else(|| "".to_owned()),
     375            0 :         http_connstr: sk_info.http_connstr.unwrap_or_else(|| "".to_owned()),
     376            0 :         backup_lsn: sk_info.backup_lsn.0,
     377            0 :         local_start_lsn: sk_info.local_start_lsn.0,
     378            0 :         availability_zone: None,
     379            0 :         standby_horizon: sk_info.standby_horizon.0,
     380            0 :     };
     381              : 
     382            0 :     let tli = GlobalTimelines::get(ttid).map_err(ApiError::from)?;
     383            0 :     tli.record_safekeeper_info(proto_sk_info)
     384            0 :         .await
     385            0 :         .map_err(ApiError::InternalServerError)?;
     386              : 
     387            0 :     json_response(StatusCode::OK, ())
     388            0 : }
     389              : 
     390            0 : fn parse_kv_str<E: fmt::Display, T: FromStr<Err = E>>(k: &str, v: &str) -> Result<T, ApiError> {
     391            0 :     v.parse()
     392            0 :         .map_err(|e| ApiError::BadRequest(anyhow::anyhow!("cannot parse {k}: {e}")))
     393            0 : }
     394              : 
     395              : /// Dump debug info about all available safekeeper state.
     396            0 : async fn dump_debug_handler(mut request: Request<Body>) -> Result<Response<Body>, ApiError> {
     397            0 :     check_permission(&request, None)?;
     398            0 :     ensure_no_body(&mut request).await?;
     399              : 
     400            0 :     let mut dump_all: Option<bool> = None;
     401            0 :     let mut dump_control_file: Option<bool> = None;
     402            0 :     let mut dump_memory: Option<bool> = None;
     403            0 :     let mut dump_disk_content: Option<bool> = None;
     404            0 :     let mut dump_term_history: Option<bool> = None;
     405            0 :     let mut tenant_id: Option<TenantId> = None;
     406            0 :     let mut timeline_id: Option<TimelineId> = None;
     407            0 : 
     408            0 :     let query = request.uri().query().unwrap_or("");
     409            0 :     let mut values = url::form_urlencoded::parse(query.as_bytes());
     410              : 
     411            0 :     for (k, v) in &mut values {
     412            0 :         match k.as_ref() {
     413            0 :             "dump_all" => dump_all = Some(parse_kv_str(&k, &v)?),
     414            0 :             "dump_control_file" => dump_control_file = Some(parse_kv_str(&k, &v)?),
     415            0 :             "dump_memory" => dump_memory = Some(parse_kv_str(&k, &v)?),
     416            0 :             "dump_disk_content" => dump_disk_content = Some(parse_kv_str(&k, &v)?),
     417            0 :             "dump_term_history" => dump_term_history = Some(parse_kv_str(&k, &v)?),
     418            0 :             "tenant_id" => tenant_id = Some(parse_kv_str(&k, &v)?),
     419            0 :             "timeline_id" => timeline_id = Some(parse_kv_str(&k, &v)?),
     420            0 :             _ => Err(ApiError::BadRequest(anyhow::anyhow!(
     421            0 :                 "Unknown query parameter: {}",
     422            0 :                 k
     423            0 :             )))?,
     424              :         }
     425              :     }
     426              : 
     427            0 :     let dump_all = dump_all.unwrap_or(false);
     428            0 :     let dump_control_file = dump_control_file.unwrap_or(dump_all);
     429            0 :     let dump_memory = dump_memory.unwrap_or(dump_all);
     430            0 :     let dump_disk_content = dump_disk_content.unwrap_or(dump_all);
     431            0 :     let dump_term_history = dump_term_history.unwrap_or(true);
     432            0 : 
     433            0 :     let args = debug_dump::Args {
     434            0 :         dump_all,
     435            0 :         dump_control_file,
     436            0 :         dump_memory,
     437            0 :         dump_disk_content,
     438            0 :         dump_term_history,
     439            0 :         tenant_id,
     440            0 :         timeline_id,
     441            0 :     };
     442              : 
     443            0 :     let resp = debug_dump::build(args)
     444            0 :         .await
     445            0 :         .map_err(ApiError::InternalServerError)?;
     446              : 
     447            0 :     let started_at = std::time::Instant::now();
     448            0 : 
     449            0 :     let (tx, rx) = mpsc::channel(1);
     450            0 : 
     451            0 :     let body = Body::wrap_stream(ReceiverStream::new(rx));
     452            0 : 
     453            0 :     let mut writer = ChannelWriter::new(128 * 1024, tx);
     454            0 : 
     455            0 :     let response = Response::builder()
     456            0 :         .status(200)
     457            0 :         .header(hyper::header::CONTENT_TYPE, "application/octet-stream")
     458            0 :         .body(body)
     459            0 :         .unwrap();
     460              : 
     461            0 :     let span = info_span!("blocking");
     462            0 :     tokio::task::spawn_blocking(move || {
     463            0 :         let _span = span.entered();
     464            0 : 
     465            0 :         let res = serde_json::to_writer(&mut writer, &resp)
     466            0 :             .map_err(std::io::Error::from)
     467            0 :             .and_then(|_| writer.flush());
     468            0 : 
     469            0 :         match res {
     470              :             Ok(()) => {
     471            0 :                 tracing::info!(
     472            0 :                     bytes = writer.flushed_bytes(),
     473            0 :                     elapsed_ms = started_at.elapsed().as_millis(),
     474            0 :                     "responded /v1/debug_dump"
     475              :                 );
     476              :             }
     477            0 :             Err(e) => {
     478            0 :                 tracing::warn!("failed to write out /v1/debug_dump response: {e:#}");
     479              :                 // semantics of this error are quite... unclear. we want to error the stream out to
     480              :                 // abort the response to somehow notify the client that we failed.
     481              :                 //
     482              :                 // though, most likely the reason for failure is that the receiver is already gone.
     483            0 :                 drop(
     484            0 :                     writer
     485            0 :                         .tx
     486            0 :                         .blocking_send(Err(std::io::ErrorKind::BrokenPipe.into())),
     487            0 :                 );
     488              :             }
     489              :         }
     490            0 :     });
     491            0 : 
     492            0 :     Ok(response)
     493            0 : }
     494              : 
     495            0 : async fn patch_control_file_handler(
     496            0 :     mut request: Request<Body>,
     497            0 : ) -> Result<Response<Body>, ApiError> {
     498            0 :     check_permission(&request, None)?;
     499              : 
     500            0 :     let ttid = TenantTimelineId::new(
     501            0 :         parse_request_param(&request, "tenant_id")?,
     502            0 :         parse_request_param(&request, "timeline_id")?,
     503              :     );
     504              : 
     505            0 :     let tli = GlobalTimelines::get(ttid).map_err(ApiError::from)?;
     506              : 
     507            0 :     let patch_request: patch_control_file::Request = json_request(&mut request).await?;
     508            0 :     let response = patch_control_file::handle_request(tli, patch_request)
     509            0 :         .await
     510            0 :         .map_err(ApiError::InternalServerError)?;
     511              : 
     512            0 :     json_response(StatusCode::OK, response)
     513            0 : }
     514              : 
     515              : /// Safekeeper http router.
     516            0 : pub fn make_router(conf: SafeKeeperConf) -> RouterBuilder<hyper::Body, ApiError> {
     517            0 :     let mut router = endpoint::make_router();
     518            0 :     if conf.http_auth.is_some() {
     519            0 :         router = router.middleware(auth_middleware(|request| {
     520            0 :             #[allow(clippy::mutable_key_type)]
     521            0 :             static ALLOWLIST_ROUTES: Lazy<HashSet<Uri>> = Lazy::new(|| {
     522            0 :                 ["/v1/status", "/metrics"]
     523            0 :                     .iter()
     524            0 :                     .map(|v| v.parse().unwrap())
     525            0 :                     .collect()
     526            0 :             });
     527            0 :             if ALLOWLIST_ROUTES.contains(request.uri()) {
     528            0 :                 None
     529              :             } else {
     530              :                 // Option<Arc<SwappableJwtAuth>> is always provided as data below, hence unwrap().
     531            0 :                 request
     532            0 :                     .data::<Option<Arc<SwappableJwtAuth>>>()
     533            0 :                     .unwrap()
     534            0 :                     .as_deref()
     535              :             }
     536            0 :         }))
     537            0 :     }
     538              : 
     539              :     // NB: on any changes do not forget to update the OpenAPI spec
     540              :     // located nearby (/safekeeper/src/http/openapi_spec.yaml).
     541            0 :     let auth = conf.http_auth.clone();
     542            0 :     router
     543            0 :         .data(Arc::new(conf))
     544            0 :         .data(auth)
     545            0 :         .get("/metrics", |r| request_span(r, prometheus_metrics_handler))
     546            0 :         .get("/v1/status", |r| request_span(r, status_handler))
     547            0 :         .put("/v1/failpoints", |r| {
     548            0 :             request_span(r, move |r| async {
     549            0 :                 check_permission(&r, None)?;
     550            0 :                 let cancel = CancellationToken::new();
     551            0 :                 failpoints_handler(r, cancel).await
     552            0 :             })
     553            0 :         })
     554            0 :         // Will be used in the future instead of implicit timeline creation
     555            0 :         .post("/v1/tenant/timeline", |r| {
     556            0 :             request_span(r, timeline_create_handler)
     557            0 :         })
     558            0 :         .get("/v1/tenant/:tenant_id/timeline/:timeline_id", |r| {
     559            0 :             request_span(r, timeline_status_handler)
     560            0 :         })
     561            0 :         .delete("/v1/tenant/:tenant_id/timeline/:timeline_id", |r| {
     562            0 :             request_span(r, timeline_delete_handler)
     563            0 :         })
     564            0 :         .delete("/v1/tenant/:tenant_id", |r| {
     565            0 :             request_span(r, tenant_delete_handler)
     566            0 :         })
     567            0 :         .get(
     568            0 :             "/v1/tenant/:tenant_id/timeline/:timeline_id/snapshot",
     569            0 :             |r| request_span(r, timeline_snapshot_handler),
     570            0 :         )
     571            0 :         .post("/v1/pull_timeline", |r| {
     572            0 :             request_span(r, timeline_pull_handler)
     573            0 :         })
     574            0 :         .post(
     575            0 :             "/v1/tenant/:tenant_id/timeline/:source_timeline_id/copy",
     576            0 :             |r| request_span(r, timeline_copy_handler),
     577            0 :         )
     578            0 :         .patch(
     579            0 :             "/v1/tenant/:tenant_id/timeline/:timeline_id/control_file",
     580            0 :             |r| request_span(r, patch_control_file_handler),
     581            0 :         )
     582            0 :         .post(
     583            0 :             "/v1/tenant/:tenant_id/timeline/:timeline_id/checkpoint",
     584            0 :             |r| request_span(r, timeline_checkpoint_handler),
     585            0 :         )
     586            0 :         // for tests
     587            0 :         .post("/v1/record_safekeeper_info/:tenant_id/:timeline_id", |r| {
     588            0 :             request_span(r, record_safekeeper_info)
     589            0 :         })
     590            0 :         .get("/v1/debug_dump", |r| request_span(r, dump_debug_handler))
     591            0 :         .get("/v1/tenant/:tenant_id/timeline/:timeline_id/digest", |r| {
     592            0 :             request_span(r, timeline_digest_handler)
     593            0 :         })
     594            0 : }
     595              : 
     596              : #[cfg(test)]
     597              : mod tests {
     598              :     use super::*;
     599              : 
     600              :     #[test]
     601            2 :     fn test_term_switch_entry_api_serialize() {
     602            2 :         let state = AcceptorStateStatus {
     603            2 :             term: 1,
     604            2 :             epoch: 1,
     605            2 :             term_history: vec![TermSwitchApiEntry {
     606            2 :                 term: 1,
     607            2 :                 lsn: Lsn(0x16FFDDDD),
     608            2 :             }],
     609            2 :         };
     610            2 :         let json = serde_json::to_string(&state).unwrap();
     611            2 :         assert_eq!(
     612            2 :             json,
     613            2 :             "{\"term\":1,\"epoch\":1,\"term_history\":[{\"term\":1,\"lsn\":\"0/16FFDDDD\"}]}"
     614            2 :         );
     615            2 :     }
     616              : }
        

Generated by: LCOV version 2.1-beta