Line data Source code
1 : use crate::auth::{AuthError, Claims, SwappableJwtAuth};
2 : use crate::http::error::{api_error_handler, route_error_handler, ApiError};
3 : use crate::http::request::{get_query_param, parse_query_param};
4 : use crate::pprof;
5 : use ::pprof::protos::Message as _;
6 : use ::pprof::ProfilerGuardBuilder;
7 : use anyhow::{anyhow, Context};
8 : use bytes::{Bytes, BytesMut};
9 : use hyper::header::{HeaderName, AUTHORIZATION, CONTENT_DISPOSITION};
10 : use hyper::http::HeaderValue;
11 : use hyper::Method;
12 : use hyper::{header::CONTENT_TYPE, Body, Request, Response};
13 : use metrics::{register_int_counter, Encoder, IntCounter, TextEncoder};
14 : use once_cell::sync::Lazy;
15 : use regex::Regex;
16 : use routerify::ext::RequestExt;
17 : use routerify::{Middleware, RequestInfo, Router, RouterBuilder};
18 : use tokio::sync::{mpsc, Mutex};
19 : use tokio_stream::wrappers::ReceiverStream;
20 : use tokio_util::io::ReaderStream;
21 : use tracing::{debug, info, info_span, warn, Instrument};
22 :
23 : use std::future::Future;
24 : use std::io::Write as _;
25 : use std::str::FromStr;
26 : use std::time::Duration;
27 :
28 0 : static SERVE_METRICS_COUNT: Lazy<IntCounter> = Lazy::new(|| {
29 0 : register_int_counter!(
30 0 : "libmetrics_metric_handler_requests_total",
31 0 : "Number of metric requests made"
32 0 : )
33 0 : .expect("failed to define a metric")
34 0 : });
35 :
36 : static X_REQUEST_ID_HEADER_STR: &str = "x-request-id";
37 :
38 : static X_REQUEST_ID_HEADER: HeaderName = HeaderName::from_static(X_REQUEST_ID_HEADER_STR);
39 : #[derive(Debug, Default, Clone)]
40 : struct RequestId(String);
41 :
42 : /// Adds a tracing info_span! instrumentation around the handler events,
43 : /// logs the request start and end events for non-GET requests and non-200 responses.
44 : ///
45 : /// Usage: Replace `my_handler` with `|r| request_span(r, my_handler)`
46 : ///
47 : /// Use this to distinguish between logs of different HTTP requests: every request handler wrapped
48 : /// with this will get request info logged in the wrapping span, including the unique request ID.
49 : ///
50 : /// This also handles errors, logging them and converting them to an HTTP error response.
51 : ///
52 : /// NB: If the client disconnects, Hyper will drop the Future, without polling it to
53 : /// completion. In other words, the handler must be async cancellation safe! request_span
54 : /// prints a warning to the log when that happens, so that you have some trace of it in
55 : /// the log.
56 : ///
57 : ///
58 : /// There could be other ways to implement similar functionality:
59 : ///
60 : /// * procmacros placed on top of all handler methods
61 : /// With all the drawbacks of procmacros, brings no difference implementation-wise,
62 : /// and little code reduction compared to the existing approach.
63 : ///
64 : /// * Another `TraitExt` with e.g. the `get_with_span`, `post_with_span` methods to do similar logic,
65 : /// implemented for [`RouterBuilder`].
66 : /// Could be simpler, but we don't want to depend on [`routerify`] more, targeting to use other library later.
67 : ///
68 : /// * In theory, a span guard could've been created in a pre-request middleware and placed into a global collection, to be dropped
69 : /// later, in a post-response middleware.
70 : /// Due to suspendable nature of the futures, would give contradictive results which is exactly the opposite of what `tracing-futures`
71 : /// tries to achive with its `.instrument` used in the current approach.
72 : ///
73 : /// If needed, a declarative macro to substitute the |r| ... closure boilerplate could be introduced.
74 0 : pub async fn request_span<R, H>(request: Request<Body>, handler: H) -> R::Output
75 0 : where
76 0 : R: Future<Output = Result<Response<Body>, ApiError>> + Send + 'static,
77 0 : H: FnOnce(Request<Body>) -> R + Send + Sync + 'static,
78 0 : {
79 0 : let request_id = request.context::<RequestId>().unwrap_or_default().0;
80 0 : let method = request.method();
81 0 : let path = request.uri().path();
82 0 : let request_span = info_span!("request", %method, %path, %request_id);
83 :
84 0 : let log_quietly = method == Method::GET;
85 0 : async move {
86 0 : let cancellation_guard = RequestCancelled::warn_when_dropped_without_responding();
87 0 : if log_quietly {
88 0 : debug!("Handling request");
89 : } else {
90 0 : info!("Handling request");
91 : }
92 :
93 : // No special handling for panics here. There's a `tracing_panic_hook` from another
94 : // module to do that globally.
95 0 : let res = handler(request).await;
96 :
97 0 : cancellation_guard.disarm();
98 0 :
99 0 : // Log the result if needed.
100 0 : //
101 0 : // We also convert any errors into an Ok response with HTTP error code here.
102 0 : // `make_router` sets a last-resort error handler that would do the same, but
103 0 : // we prefer to do it here, before we exit the request span, so that the error
104 0 : // is still logged with the span.
105 0 : //
106 0 : // (Because we convert errors to Ok response, we never actually return an error,
107 0 : // and we could declare the function to return the never type (`!`). However,
108 0 : // using `routerify::RouterBuilder` requires a proper error type.)
109 0 : match res {
110 0 : Ok(response) => {
111 0 : let response_status = response.status();
112 0 : if log_quietly && response_status.is_success() {
113 0 : debug!("Request handled, status: {response_status}");
114 : } else {
115 0 : info!("Request handled, status: {response_status}");
116 : }
117 0 : Ok(response)
118 : }
119 0 : Err(err) => Ok(api_error_handler(err)),
120 : }
121 0 : }
122 0 : .instrument(request_span)
123 0 : .await
124 0 : }
125 :
126 : /// Drop guard to WARN in case the request was dropped before completion.
127 : struct RequestCancelled {
128 : warn: Option<tracing::Span>,
129 : }
130 :
131 : impl RequestCancelled {
132 : /// Create the drop guard using the [`tracing::Span::current`] as the span.
133 0 : fn warn_when_dropped_without_responding() -> Self {
134 0 : RequestCancelled {
135 0 : warn: Some(tracing::Span::current()),
136 0 : }
137 0 : }
138 :
139 : /// Consume the drop guard without logging anything.
140 0 : fn disarm(mut self) {
141 0 : self.warn = None;
142 0 : }
143 : }
144 :
145 : impl Drop for RequestCancelled {
146 0 : fn drop(&mut self) {
147 0 : if std::thread::panicking() {
148 0 : // we are unwinding due to panicking, assume we are not dropped for cancellation
149 0 : } else if let Some(span) = self.warn.take() {
150 : // the span has all of the info already, but the outer `.instrument(span)` has already
151 : // been dropped, so we need to manually re-enter it for this message.
152 : //
153 : // this is what the instrument would do before polling so it is fine.
154 0 : let _g = span.entered();
155 0 : warn!("request was dropped before completing");
156 0 : }
157 0 : }
158 : }
159 :
160 : /// An [`std::io::Write`] implementation on top of a channel sending [`bytes::Bytes`] chunks.
161 : pub struct ChannelWriter {
162 : buffer: BytesMut,
163 : pub tx: mpsc::Sender<std::io::Result<Bytes>>,
164 : written: usize,
165 : /// Time spent waiting for the channel to make progress. It is not the same as time to upload a
166 : /// buffer because we cannot know anything about that, but this should allow us to understand
167 : /// the actual time taken without the time spent `std::thread::park`ed.
168 : wait_time: std::time::Duration,
169 : }
170 :
171 : impl ChannelWriter {
172 0 : pub fn new(buf_len: usize, tx: mpsc::Sender<std::io::Result<Bytes>>) -> Self {
173 0 : assert_ne!(buf_len, 0);
174 0 : ChannelWriter {
175 0 : // split about half off the buffer from the start, because we flush depending on
176 0 : // capacity. first flush will come sooner than without this, but now resizes will
177 0 : // have better chance of picking up the "other" half. not guaranteed of course.
178 0 : buffer: BytesMut::with_capacity(buf_len).split_off(buf_len / 2),
179 0 : tx,
180 0 : written: 0,
181 0 : wait_time: std::time::Duration::ZERO,
182 0 : }
183 0 : }
184 :
185 0 : pub fn flush0(&mut self) -> std::io::Result<usize> {
186 0 : let n = self.buffer.len();
187 0 : if n == 0 {
188 0 : return Ok(0);
189 0 : }
190 0 :
191 0 : tracing::trace!(n, "flushing");
192 0 : let ready = self.buffer.split().freeze();
193 0 :
194 0 : let wait_started_at = std::time::Instant::now();
195 0 :
196 0 : // not ideal to call from blocking code to block_on, but we are sure that this
197 0 : // operation does not spawn_blocking other tasks
198 0 : let res: Result<(), ()> = tokio::runtime::Handle::current().block_on(async {
199 0 : self.tx.send(Ok(ready)).await.map_err(|_| ())?;
200 :
201 : // throttle sending to allow reuse of our buffer in `write`.
202 0 : self.tx.reserve().await.map_err(|_| ())?;
203 :
204 : // now the response task has picked up the buffer and hopefully started
205 : // sending it to the client.
206 0 : Ok(())
207 0 : });
208 0 :
209 0 : self.wait_time += wait_started_at.elapsed();
210 0 :
211 0 : if res.is_err() {
212 0 : return Err(std::io::ErrorKind::BrokenPipe.into());
213 0 : }
214 0 : self.written += n;
215 0 : Ok(n)
216 0 : }
217 :
218 0 : pub fn flushed_bytes(&self) -> usize {
219 0 : self.written
220 0 : }
221 :
222 0 : pub fn wait_time(&self) -> std::time::Duration {
223 0 : self.wait_time
224 0 : }
225 : }
226 :
227 : impl std::io::Write for ChannelWriter {
228 0 : fn write(&mut self, mut buf: &[u8]) -> std::io::Result<usize> {
229 0 : let remaining = self.buffer.capacity() - self.buffer.len();
230 0 :
231 0 : let out_of_space = remaining < buf.len();
232 0 :
233 0 : let original_len = buf.len();
234 0 :
235 0 : if out_of_space {
236 0 : let can_still_fit = buf.len() - remaining;
237 0 : self.buffer.extend_from_slice(&buf[..can_still_fit]);
238 0 : buf = &buf[can_still_fit..];
239 0 : self.flush0()?;
240 0 : }
241 :
242 : // assume that this will often under normal operation just move the pointer back to the
243 : // beginning of allocation, because previous split off parts are already sent and
244 : // dropped.
245 0 : self.buffer.extend_from_slice(buf);
246 0 : Ok(original_len)
247 0 : }
248 :
249 0 : fn flush(&mut self) -> std::io::Result<()> {
250 0 : self.flush0().map(|_| ())
251 0 : }
252 : }
253 :
254 0 : pub async fn prometheus_metrics_handler(_req: Request<Body>) -> Result<Response<Body>, ApiError> {
255 0 : SERVE_METRICS_COUNT.inc();
256 0 :
257 0 : let started_at = std::time::Instant::now();
258 0 :
259 0 : let (tx, rx) = mpsc::channel(1);
260 0 :
261 0 : let body = Body::wrap_stream(ReceiverStream::new(rx));
262 0 :
263 0 : let mut writer = ChannelWriter::new(128 * 1024, tx);
264 0 :
265 0 : let encoder = TextEncoder::new();
266 0 :
267 0 : let response = Response::builder()
268 0 : .status(200)
269 0 : .header(CONTENT_TYPE, encoder.format_type())
270 0 : .body(body)
271 0 : .unwrap();
272 :
273 0 : let span = info_span!("blocking");
274 0 : tokio::task::spawn_blocking(move || {
275 0 : // there are situations where we lose scraped metrics under load, try to gather some clues
276 0 : // since all nodes are queried this, keep the message count low.
277 0 : let spawned_at = std::time::Instant::now();
278 0 :
279 0 : let _span = span.entered();
280 0 :
281 0 : let metrics = metrics::gather();
282 0 :
283 0 : let gathered_at = std::time::Instant::now();
284 0 :
285 0 : let res = encoder
286 0 : .encode(&metrics, &mut writer)
287 0 : .and_then(|_| writer.flush().map_err(|e| e.into()));
288 0 :
289 0 : // this instant is not when we finally got the full response sent, sending is done by hyper
290 0 : // in another task.
291 0 : let encoded_at = std::time::Instant::now();
292 0 :
293 0 : let spawned_in = spawned_at - started_at;
294 0 : let collected_in = gathered_at - spawned_at;
295 0 : // remove the wait time here in case the tcp connection was clogged
296 0 : let encoded_in = encoded_at - gathered_at - writer.wait_time();
297 0 : let total = encoded_at - started_at;
298 0 :
299 0 : match res {
300 : Ok(()) => {
301 0 : tracing::info!(
302 0 : bytes = writer.flushed_bytes(),
303 0 : total_ms = total.as_millis(),
304 0 : spawning_ms = spawned_in.as_millis(),
305 0 : collection_ms = collected_in.as_millis(),
306 0 : encoding_ms = encoded_in.as_millis(),
307 0 : "responded /metrics"
308 : );
309 : }
310 0 : Err(e) => {
311 0 : // there is a chance that this error is not the BrokenPipe we generate in the writer
312 0 : // for "closed connection", but it is highly unlikely.
313 0 : tracing::warn!(
314 0 : after_bytes = writer.flushed_bytes(),
315 0 : total_ms = total.as_millis(),
316 0 : spawning_ms = spawned_in.as_millis(),
317 0 : collection_ms = collected_in.as_millis(),
318 0 : encoding_ms = encoded_in.as_millis(),
319 0 : "failed to write out /metrics response: {e:?}"
320 : );
321 : // semantics of this error are quite... unclear. we want to error the stream out to
322 : // abort the response to somehow notify the client that we failed.
323 : //
324 : // though, most likely the reason for failure is that the receiver is already gone.
325 0 : drop(
326 0 : writer
327 0 : .tx
328 0 : .blocking_send(Err(std::io::ErrorKind::BrokenPipe.into())),
329 0 : );
330 : }
331 : }
332 0 : });
333 0 :
334 0 : Ok(response)
335 0 : }
336 :
337 : /// Generates CPU profiles.
338 0 : pub async fn profile_cpu_handler(req: Request<Body>) -> Result<Response<Body>, ApiError> {
339 : enum Format {
340 : Pprof,
341 : Svg,
342 : }
343 :
344 : // Parameters.
345 0 : let format = match get_query_param(&req, "format")?.as_deref() {
346 0 : None => Format::Pprof,
347 0 : Some("pprof") => Format::Pprof,
348 0 : Some("svg") => Format::Svg,
349 0 : Some(format) => return Err(ApiError::BadRequest(anyhow!("invalid format {format}"))),
350 : };
351 0 : let seconds = match parse_query_param(&req, "seconds")? {
352 0 : None => 5,
353 0 : Some(seconds @ 1..=30) => seconds,
354 0 : Some(_) => return Err(ApiError::BadRequest(anyhow!("duration must be 1-30 secs"))),
355 : };
356 0 : let frequency_hz = match parse_query_param(&req, "frequency")? {
357 0 : None => 99,
358 0 : Some(1001..) => return Err(ApiError::BadRequest(anyhow!("frequency must be <=1000 Hz"))),
359 0 : Some(frequency) => frequency,
360 : };
361 :
362 : // Only allow one profiler at a time.
363 0 : static PROFILE_LOCK: Lazy<Mutex<()>> = Lazy::new(|| Mutex::new(()));
364 0 : let _lock = PROFILE_LOCK
365 0 : .try_lock()
366 0 : .map_err(|_| ApiError::Conflict("profiler already running".into()))?;
367 :
368 : // Take the profile.
369 0 : let report = tokio::task::spawn_blocking(move || {
370 0 : let guard = ProfilerGuardBuilder::default()
371 0 : .frequency(frequency_hz)
372 0 : .blocklist(&["libc", "libgcc", "pthread", "vdso"])
373 0 : .build()?;
374 0 : std::thread::sleep(Duration::from_secs(seconds));
375 0 : guard.report().build()
376 0 : })
377 0 : .await
378 0 : .map_err(|join_err| ApiError::InternalServerError(join_err.into()))?
379 0 : .map_err(|pprof_err| ApiError::InternalServerError(pprof_err.into()))?;
380 :
381 : // Return the report in the requested format.
382 0 : match format {
383 : Format::Pprof => {
384 0 : let mut body = Vec::new();
385 0 : report
386 0 : .pprof()
387 0 : .map_err(|err| ApiError::InternalServerError(err.into()))?
388 0 : .write_to_vec(&mut body)
389 0 : .map_err(|err| ApiError::InternalServerError(err.into()))?;
390 :
391 0 : Response::builder()
392 0 : .status(200)
393 0 : .header(CONTENT_TYPE, "application/octet-stream")
394 0 : .header(CONTENT_DISPOSITION, "attachment; filename=\"profile.pb\"")
395 0 : .body(Body::from(body))
396 0 : .map_err(|err| ApiError::InternalServerError(err.into()))
397 : }
398 :
399 : Format::Svg => {
400 0 : let mut body = Vec::new();
401 0 : report
402 0 : .flamegraph(&mut body)
403 0 : .map_err(|err| ApiError::InternalServerError(err.into()))?;
404 0 : Response::builder()
405 0 : .status(200)
406 0 : .header(CONTENT_TYPE, "image/svg+xml")
407 0 : .body(Body::from(body))
408 0 : .map_err(|err| ApiError::InternalServerError(err.into()))
409 : }
410 : }
411 0 : }
412 :
413 : /// Generates heap profiles.
414 : ///
415 : /// This only works with jemalloc on Linux.
416 0 : pub async fn profile_heap_handler(req: Request<Body>) -> Result<Response<Body>, ApiError> {
417 : enum Format {
418 : Jemalloc,
419 : Pprof,
420 : }
421 :
422 : // Parameters.
423 0 : let format = match get_query_param(&req, "format")?.as_deref() {
424 0 : None => Format::Pprof,
425 0 : Some("jemalloc") => Format::Jemalloc,
426 0 : Some("pprof") => Format::Pprof,
427 0 : Some(format) => return Err(ApiError::BadRequest(anyhow!("invalid format {format}"))),
428 : };
429 :
430 : // Obtain profiler handle.
431 0 : let mut prof_ctl = jemalloc_pprof::PROF_CTL
432 0 : .as_ref()
433 0 : .ok_or(ApiError::InternalServerError(anyhow!(
434 0 : "heap profiling not enabled"
435 0 : )))?
436 0 : .lock()
437 0 : .await;
438 0 : if !prof_ctl.activated() {
439 0 : return Err(ApiError::InternalServerError(anyhow!(
440 0 : "heap profiling not enabled"
441 0 : )));
442 0 : }
443 0 :
444 0 : // Take and return the profile.
445 0 : match format {
446 : Format::Jemalloc => {
447 : // NB: file is an open handle to a tempfile that's already deleted.
448 0 : let file = tokio::task::spawn_blocking(move || prof_ctl.dump())
449 0 : .await
450 0 : .map_err(|join_err| ApiError::InternalServerError(join_err.into()))?
451 0 : .map_err(ApiError::InternalServerError)?;
452 0 : let stream = ReaderStream::new(tokio::fs::File::from_std(file));
453 0 : Response::builder()
454 0 : .status(200)
455 0 : .header(CONTENT_TYPE, "application/octet-stream")
456 0 : .header(CONTENT_DISPOSITION, "attachment; filename=\"heap.dump\"")
457 0 : .body(Body::wrap_stream(stream))
458 0 : .map_err(|err| ApiError::InternalServerError(err.into()))
459 : }
460 :
461 : Format::Pprof => {
462 0 : let data = tokio::task::spawn_blocking(move || {
463 0 : let bytes = prof_ctl.dump_pprof()?;
464 : // Symbolize the profile.
465 : // TODO: consider moving this upstream to jemalloc_pprof and avoiding the
466 : // serialization roundtrip.
467 0 : static STRIP_FUNCTIONS: Lazy<Vec<(Regex, bool)>> = Lazy::new(|| {
468 0 : // Functions to strip from profiles. If true, also remove child frames.
469 0 : vec![
470 0 : (Regex::new("^__rust").unwrap(), false),
471 0 : (Regex::new("^_start$").unwrap(), false),
472 0 : (Regex::new("^irallocx_prof").unwrap(), true),
473 0 : (Regex::new("^prof_alloc_prep").unwrap(), true),
474 0 : (Regex::new("^std::rt::lang_start").unwrap(), false),
475 0 : (Regex::new("^std::sys::backtrace::__rust").unwrap(), false),
476 0 : ]
477 0 : });
478 0 : let profile = pprof::decode(&bytes)?;
479 0 : let profile = pprof::symbolize(profile)?;
480 0 : let profile = pprof::strip_locations(
481 0 : profile,
482 0 : &["libc", "libgcc", "pthread", "vdso"],
483 0 : &STRIP_FUNCTIONS,
484 0 : );
485 0 : pprof::encode(&profile)
486 0 : })
487 0 : .await
488 0 : .map_err(|join_err| ApiError::InternalServerError(join_err.into()))?
489 0 : .map_err(ApiError::InternalServerError)?;
490 0 : Response::builder()
491 0 : .status(200)
492 0 : .header(CONTENT_TYPE, "application/octet-stream")
493 0 : .header(CONTENT_DISPOSITION, "attachment; filename=\"heap.pb\"")
494 0 : .body(Body::from(data))
495 0 : .map_err(|err| ApiError::InternalServerError(err.into()))
496 : }
497 : }
498 0 : }
499 :
500 2 : pub fn add_request_id_middleware<B: hyper::body::HttpBody + Send + Sync + 'static>(
501 2 : ) -> Middleware<B, ApiError> {
502 2 : Middleware::pre(move |req| async move {
503 2 : let request_id = match req.headers().get(&X_REQUEST_ID_HEADER) {
504 1 : Some(request_id) => request_id
505 1 : .to_str()
506 1 : .expect("extract request id value")
507 1 : .to_owned(),
508 : None => {
509 1 : let request_id = uuid::Uuid::new_v4();
510 1 : request_id.to_string()
511 : }
512 : };
513 2 : req.set_context(RequestId(request_id));
514 2 :
515 2 : Ok(req)
516 2 : })
517 2 : }
518 :
519 2 : async fn add_request_id_header_to_response(
520 2 : mut res: Response<Body>,
521 2 : req_info: RequestInfo,
522 2 : ) -> Result<Response<Body>, ApiError> {
523 2 : if let Some(request_id) = req_info.context::<RequestId>() {
524 2 : if let Ok(request_header_value) = HeaderValue::from_str(&request_id.0) {
525 2 : res.headers_mut()
526 2 : .insert(&X_REQUEST_ID_HEADER, request_header_value);
527 2 : };
528 0 : };
529 :
530 2 : Ok(res)
531 2 : }
532 :
533 2 : pub fn make_router() -> RouterBuilder<hyper::Body, ApiError> {
534 2 : Router::builder()
535 2 : .middleware(add_request_id_middleware())
536 2 : .middleware(Middleware::post_with_info(
537 2 : add_request_id_header_to_response,
538 2 : ))
539 2 : .err_handler(route_error_handler)
540 2 : }
541 :
542 0 : pub fn attach_openapi_ui(
543 0 : router_builder: RouterBuilder<hyper::Body, ApiError>,
544 0 : spec: &'static [u8],
545 0 : spec_mount_path: &'static str,
546 0 : ui_mount_path: &'static str,
547 0 : ) -> RouterBuilder<hyper::Body, ApiError> {
548 0 : router_builder
549 0 : .get(spec_mount_path,
550 0 : move |r| request_span(r, move |_| async move {
551 0 : Ok(Response::builder().body(Body::from(spec)).unwrap())
552 0 : })
553 0 : )
554 0 : .get(ui_mount_path,
555 0 : move |r| request_span(r, move |_| async move {
556 0 : Ok(Response::builder().body(Body::from(format!(r#"
557 0 : <!DOCTYPE html>
558 0 : <html lang="en">
559 0 : <head>
560 0 : <title>rweb</title>
561 0 : <link href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@3/swagger-ui.css" rel="stylesheet">
562 0 : </head>
563 0 : <body>
564 0 : <div id="swagger-ui"></div>
565 0 : <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@3/swagger-ui-bundle.js" charset="UTF-8"> </script>
566 0 : <script>
567 0 : window.onload = function() {{
568 0 : const ui = SwaggerUIBundle({{
569 0 : "dom_id": "\#swagger-ui",
570 0 : presets: [
571 0 : SwaggerUIBundle.presets.apis,
572 0 : SwaggerUIBundle.SwaggerUIStandalonePreset
573 0 : ],
574 0 : layout: "BaseLayout",
575 0 : deepLinking: true,
576 0 : showExtensions: true,
577 0 : showCommonExtensions: true,
578 0 : url: "{}",
579 0 : }})
580 0 : window.ui = ui;
581 0 : }};
582 0 : </script>
583 0 : </body>
584 0 : </html>
585 0 : "#, spec_mount_path))).unwrap())
586 0 : })
587 0 : )
588 0 : }
589 :
590 0 : fn parse_token(header_value: &str) -> Result<&str, ApiError> {
591 : // header must be in form Bearer <token>
592 0 : let (prefix, token) = header_value
593 0 : .split_once(' ')
594 0 : .ok_or_else(|| ApiError::Unauthorized("malformed authorization header".to_string()))?;
595 0 : if prefix != "Bearer" {
596 0 : return Err(ApiError::Unauthorized(
597 0 : "malformed authorization header".to_string(),
598 0 : ));
599 0 : }
600 0 : Ok(token)
601 0 : }
602 :
603 0 : pub fn auth_middleware<B: hyper::body::HttpBody + Send + Sync + 'static>(
604 0 : provide_auth: fn(&Request<Body>) -> Option<&SwappableJwtAuth>,
605 0 : ) -> Middleware<B, ApiError> {
606 0 : Middleware::pre(move |req| async move {
607 0 : if let Some(auth) = provide_auth(&req) {
608 0 : match req.headers().get(AUTHORIZATION) {
609 0 : Some(value) => {
610 0 : let header_value = value.to_str().map_err(|_| {
611 0 : ApiError::Unauthorized("malformed authorization header".to_string())
612 0 : })?;
613 0 : let token = parse_token(header_value)?;
614 :
615 0 : let data = auth.decode(token).map_err(|err| {
616 0 : warn!("Authentication error: {err}");
617 : // Rely on From<AuthError> for ApiError impl
618 0 : err
619 0 : })?;
620 0 : req.set_context(data.claims);
621 : }
622 : None => {
623 0 : return Err(ApiError::Unauthorized(
624 0 : "missing authorization header".to_string(),
625 0 : ))
626 : }
627 : }
628 0 : }
629 0 : Ok(req)
630 0 : })
631 0 : }
632 :
633 0 : pub fn add_response_header_middleware<B>(
634 0 : header: &str,
635 0 : value: &str,
636 0 : ) -> anyhow::Result<Middleware<B, ApiError>>
637 0 : where
638 0 : B: hyper::body::HttpBody + Send + Sync + 'static,
639 0 : {
640 0 : let name =
641 0 : HeaderName::from_str(header).with_context(|| format!("invalid header name: {header}"))?;
642 0 : let value =
643 0 : HeaderValue::from_str(value).with_context(|| format!("invalid header value: {value}"))?;
644 0 : Ok(Middleware::post_with_info(
645 0 : move |mut response, request_info| {
646 0 : let name = name.clone();
647 0 : let value = value.clone();
648 0 : async move {
649 0 : let headers = response.headers_mut();
650 0 : if headers.contains_key(&name) {
651 0 : warn!(
652 0 : "{} response already contains header {:?}",
653 0 : request_info.uri(),
654 0 : &name,
655 : );
656 0 : } else {
657 0 : headers.insert(name, value);
658 0 : }
659 0 : Ok(response)
660 0 : }
661 0 : },
662 0 : ))
663 0 : }
664 :
665 0 : pub fn check_permission_with(
666 0 : req: &Request<Body>,
667 0 : check_permission: impl Fn(&Claims) -> Result<(), AuthError>,
668 0 : ) -> Result<(), ApiError> {
669 0 : match req.context::<Claims>() {
670 0 : Some(claims) => Ok(check_permission(&claims)
671 0 : .map_err(|_err| ApiError::Forbidden("JWT authentication error".to_string()))?),
672 0 : None => Ok(()), // claims is None because auth is disabled
673 : }
674 0 : }
675 :
676 : #[cfg(test)]
677 : mod tests {
678 : use super::*;
679 : use futures::future::poll_fn;
680 : use hyper::service::Service;
681 : use routerify::RequestServiceBuilder;
682 : use std::net::{IpAddr, SocketAddr};
683 :
684 : #[tokio::test]
685 1 : async fn test_request_id_returned() {
686 1 : let builder = RequestServiceBuilder::new(make_router().build().unwrap()).unwrap();
687 1 : let remote_addr = SocketAddr::new(IpAddr::from_str("127.0.0.1").unwrap(), 80);
688 1 : let mut service = builder.build(remote_addr);
689 1 : if let Err(e) = poll_fn(|ctx| service.poll_ready(ctx)).await {
690 1 : panic!("request service is not ready: {:?}", e);
691 1 : }
692 1 :
693 1 : let mut req: Request<Body> = Request::default();
694 1 : req.headers_mut()
695 1 : .append(&X_REQUEST_ID_HEADER, HeaderValue::from_str("42").unwrap());
696 1 :
697 1 : let resp: Response<hyper::body::Body> = service.call(req).await.unwrap();
698 1 :
699 1 : let header_val = resp.headers().get(&X_REQUEST_ID_HEADER).unwrap();
700 1 :
701 1 : assert!(header_val == "42", "response header mismatch");
702 1 : }
703 :
704 : #[tokio::test]
705 1 : async fn test_request_id_empty() {
706 1 : let builder = RequestServiceBuilder::new(make_router().build().unwrap()).unwrap();
707 1 : let remote_addr = SocketAddr::new(IpAddr::from_str("127.0.0.1").unwrap(), 80);
708 1 : let mut service = builder.build(remote_addr);
709 1 : if let Err(e) = poll_fn(|ctx| service.poll_ready(ctx)).await {
710 1 : panic!("request service is not ready: {:?}", e);
711 1 : }
712 1 :
713 1 : let req: Request<Body> = Request::default();
714 1 : let resp: Response<hyper::body::Body> = service.call(req).await.unwrap();
715 1 :
716 1 : let header_val = resp.headers().get(&X_REQUEST_ID_HEADER);
717 1 :
718 1 : assert_ne!(header_val, None, "response header should NOT be empty");
719 1 : }
720 : }
|
