feat: Allow configuring the status code of the timeout middleware (#947)

Author: spencewenski

.github/workflows/ci.yml

@@ -198,7 +198,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
-      - uses: EmbarkStudios/cargo-deny-action@34899fc7ba81ca6268d5947a7a16b4649013fea1
+      - uses: EmbarkStudios/cargo-deny-action@76cd80eb775d7bbbd2d80292136d74d39e1b4918
         with:
           command: check
           arguments: "--all-features --locked"

Cargo.lock

@@ -16,7 +16,7 @@ rust-version = "1.88"
 [features]
 default = ["open-api", "jwt-ietf", "cli", "otel"]
 
-http = ["dep:axum", "dep:axum-extra", "dep:tower", "dep:tower-http", "dep:http-body-util", "dep:mime"]
+http = ["dep:axum", "dep:axum-extra", "dep:tower", "dep:tower-http", "dep:http-body-util", "dep:mime", "dep:http-serde"]
 open-api = ["http", "dep:aide", "dep:schemars"]
 
 worker = ["dep:rand", "dep:num_cpus", "dep:cron", "uuid/v7"]
@@ -90,6 +90,7 @@ aide = { workspace = true, features = ["axum", "axum-json", "axum-query", "redoc
 schemars = { workspace = true, optional = true }
 http-body-util = { workspace = true, optional = true }
 mime = { workspace = true, optional = true }
+http-serde = { workspace = true, optional = true }
 
 # DB - SeaORM
 sea-orm = { workspace = true, features = ["debug-print", "runtime-tokio-rustls", "sqlx-postgres", "macros"], optional = true }
@@ -204,11 +205,12 @@ aide = { version = "0.16.0-alpha.1", features = ["axum"] }
 axum-core = "0.5.2"
 axum = "0.8.4"
 axum-extra = "0.12.1"
-tower-http = "0.6.2"
+tower-http = "0.6.7"
 tower = "0.5.2"
 schemars = "1.0.4"
 mime = "0.3.17"
 http-body-util = { version = "0.1.2" }
+http-serde = "2.0.0"
 
 # DB - SeaORM
 sea-orm = { version = "1.1.15" }

Cargo.toml

@@ -45,6 +45,7 @@ priority = -9960
 [service.http.middleware.timeout]
 priority = 0
 timeout = 10000
+status-code = 408
 
 [service.http.middleware.size-limit]
 priority = -9970

src/config/service/http/config/default.toml

@@ -1,6 +1,7 @@
 use crate::app::context::AppContext;
 use crate::service::http::middleware::Middleware;
 use axum::Router;
+use axum::http::StatusCode;
 use axum_core::extract::FromRef;
 use serde_derive::{Deserialize, Serialize};
 use serde_with::serde_as;
@@ -10,19 +11,13 @@ use validator::Validate;
 
 #[serde_as]
 #[derive(Debug, Clone, Validate, Serialize, Deserialize)]
-#[serde(rename_all = "kebab-case", default)]
+#[serde(rename_all = "kebab-case")]
 #[non_exhaustive]
 pub struct TimeoutConfig {
     #[serde_as(as = "serde_with::DurationMilliSeconds")]
     pub timeout: Duration,
-}
-
-impl Default for TimeoutConfig {
-    fn default() -> Self {
-        Self {
-            timeout: Duration::from_secs(10),
-        }
-    }
+    #[serde(with = "http_serde::status_code")]
+    pub status_code: StatusCode,
 }
 
 pub struct TimeoutMiddleware;
@@ -63,17 +58,19 @@ where
 
     fn install(&self, state: &S, router: Router) -> Result<Router, Self::Error> {
         let context = AppContext::from_ref(state);
-        let timeout = &context
+        let config = &context
             .config()
             .service
             .http
             .custom
             .middleware
             .timeout
-            .custom
-            .timeout;
+            .custom;
+
+        let status_code = config.status_code;
+        let timeout = config.timeout;
 
-        let router = router.layer(TimeoutLayer::new(*timeout));
+        let router = router.layer(TimeoutLayer::with_status_code(status_code, timeout));
 
         Ok(router)
     }