Merge pull request #223 from dandi/timeout-resp

Add a response body to timeout errors

Cargo.toml

@@ -47,8 +47,8 @@ tera = { version = "1.20.0", default-features = false }
 thiserror = "2.0.11"
 time = { version = "0.3.37", features = ["formatting", "macros", "parsing", "serde"] }
 tokio = { version = "1.43.0", features = ["macros", "net", "rt-multi-thread", "time"] }
-tower = { version = "0.5.2", features = ["util"] }
-tower-http = { version = "0.6.2", features = ["set-header", "timeout", "trace"] }
+tower = { version = "0.5.2", features = ["timeout", "util"] }
+tower-http = { version = "0.6.2", features = ["set-header", "trace"] }
 tower_governor = { version = "0.6.0", features = ["tracing"] }
 tracing = "0.1.41"
 tracing-subscriber = { version = "0.3.19", features = ["json", "local-time", "time"] }

src/main.rs

@@ -17,14 +17,15 @@ use crate::zarrman::{ManifestFetcher, ZarrManClient};
 use anyhow::Context;
 use axum::{
     body::Body,
+    error_handling::HandleErrorLayer,
     extract::Request,
     http::{
         header::{
             HeaderValue, ACCESS_CONTROL_ALLOW_ORIGIN, CONTENT_LENGTH, CONTENT_TYPE, SERVER,
             USER_AGENT,
         },
         response::Response,
-        Method,
+        Method, StatusCode,
     },
     middleware::{self, Next},
     routing::get,
@@ -35,13 +36,11 @@ use http_body::Body as _;
 use std::fmt;
 use std::net::IpAddr;
 use std::sync::Arc;
-use tower::service_fn;
+use tower::{service_fn, ServiceBuilder};
 use tower_governor::{
     governor::GovernorConfigBuilder, key_extractor::SmartIpKeyExtractor, GovernorLayer,
 };
-use tower_http::{
-    set_header::response::SetResponseHeaderLayer, timeout::TimeoutLayer, trace::TraceLayer,
-};
+use tower_http::{set_header::response::SetResponseHeaderLayer, trace::TraceLayer};
 use tracing::Level;
 use tracing_subscriber::{filter::Targets, fmt::time::OffsetTime, prelude::*};
 
@@ -51,6 +50,9 @@ static STYLESHEET: &str = include_str!("dav/static/styles.css");
 /// The content of the `robots.txt` file to serve at `/robots.txt`
 static ROBOTS_TXT: &str = "User-agent: *\nDisallow: /\n";
 
+/// The body to return with 408 Request Timeout responses
+static REQUEST_TIMEOUT_BODY: &str = "Request could not be completed in time\n";
+
 /// WebDAV view to DANDI Archive
 ///
 /// See <https://github.com/dandi/dandidav> for more information.
@@ -186,7 +188,11 @@ fn get_app(cfg: Config) -> anyhow::Result<Router> {
             ACCESS_CONTROL_ALLOW_ORIGIN,
             HeaderValue::from_static("*"),
         ))
-        .layer(TimeoutLayer::new(std::time::Duration::from_secs(25)))
+        .layer(
+            ServiceBuilder::new()
+                .layer(HandleErrorLayer::new(|_| async { (StatusCode::REQUEST_TIMEOUT, REQUEST_TIMEOUT_BODY) }))
+                .timeout(std::time::Duration::from_secs(25))
+        )
         .layer(GovernorLayer {
             config: Arc::new(
                 GovernorConfigBuilder::default()
@@ -287,7 +293,6 @@ impl fmt::Display for UsizeDiff {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use axum::http::StatusCode;
     use http_body_util::BodyExt;
     use tower::ServiceExt; // for `collect`