feature: adding timeout http layer + db connection timeout

Cargo.toml

@@ -69,7 +69,11 @@ tracing-subscriber = { version = "0.3.16", features = ["env-filter"] }
 duct = "0.13.6"
 
 config = "0.13.3"
-tower-http = { version = "0.5.0", features = ["trace", "catch-panic"] }
+tower-http = { version = "0.5.0", features = [
+  "trace",
+  "catch-panic",
+  "timeout",
+] }
 byte-unit = "4.0.19"
 
 jsonwebtoken = { version = "9.1.0", optional = true }

examples/demo/config/development.yaml

@@ -14,6 +14,11 @@ server:
       enable: true
     catch_panic:
       enable: true
+    catch_panic:
+      enable: true
+    timeout_request:
+      enable: true
+      timeout: 5000
 workers:
   mode: BackgroundQueue
 mailer:
@@ -29,6 +34,8 @@ database:
   uri: postgres://loco:loco@localhost:5432/loco_app
   # uri: sqlite://db.sqlite?mode=rwc
   enable_logging: false
+  connect_timeout: 500
+  idle_timeout: 500
   min_connections: 1
   max_connections: 1
   auto_migrate: true

examples/demo/config/test.yaml

@@ -13,8 +13,11 @@ server:
       enable: true
     catch_panic:
       enable: true
+    timeout_request:
+      enable: true
+      timeout: 5000
 workers:
-  mode: ForegroundBlocking
+  mode: ForegroundBlockingc
 mailer:
   smtp:
     enable: true
@@ -27,6 +30,8 @@ mailer:
 database:
   uri: postgres://loco:loco@localhost:5432/loco_app
   enable_logging: false
+  connect_timeout: 500
+  idle_timeout: 1000
   min_connections: 1
   max_connections: 1
   auto_migrate: true

src/config.rs

@@ -69,6 +69,10 @@ pub struct Database {
     pub min_connections: u32,
     /// Maximum number of connections for a pool
     pub max_connections: u32,
+    /// Set the timeout duration when acquiring a connection
+    pub connect_timeout: u64,
+    /// Set the idle duration before closing a connection
+    pub idle_timeout: u64,
     #[serde(default)]
     /// Run migration up when application loaded
     pub auto_migrate: bool,
@@ -129,6 +133,15 @@ pub struct Middlewares {
     pub logger: Option<EnableMiddleware>,
     /// catch any code panic and log the error.
     pub catch_panic: Option<EnableMiddleware>,
+    /// Setting a global timeout for the requests
+    pub timeout_request: Option<TimeoutRequestMiddleware>,
+}
+
+#[derive(Debug, Clone, Deserialize, Serialize)]
+pub struct TimeoutRequestMiddleware {
+    pub enable: bool,
+    // Timeout request in milliseconds
+    pub timeout: u64,
 }
 
 #[derive(Debug, Clone, Deserialize, Serialize)]

src/controller/app_routes.rs

@@ -5,7 +5,8 @@
 use axum::{http::Request, Router as AXRouter};
 use lazy_static::lazy_static;
 use regex::Regex;
-use tower_http::{catch_panic::CatchPanicLayer, trace::TraceLayer};
+use std::time::Duration;
+use tower_http::{catch_panic::CatchPanicLayer, timeout::TimeoutLayer, trace::TraceLayer};
 
 use super::routes::Routes;
 use crate::{app::AppContext, config, Result};
@@ -173,6 +174,16 @@ impl AppRoutes {
                 app = Self::add_logger_middleware(app);
             }
         }
+        if let Some(logger) = &ctx.config.server.middlewares.logger {
+            if logger.enable {
+                app = Self::add_logger_middleware(app);
+            }
+        }
+        if let Some(timeout_request) = &ctx.config.server.middlewares.timeout_request {
+            if timeout_request.enable {
+                app = Self::add_timeout_middleware(app, timeout_request);
+            }
+        }
         Ok(app.with_state(ctx))
     }
 
@@ -212,4 +223,13 @@ impl AppRoutes {
         tracing::info!("[Middleware] Adding log trace id",);
         app
     }
+    fn add_timeout_middleware(
+        app: AXRouter<AppContext>,
+        config: &config::TimeoutRequestMiddleware,
+    ) -> AXRouter<AppContext> {
+        let app = app.layer(TimeoutLayer::new(Duration::from_millis(config.timeout)));
+
+        tracing::info!("[Middleware] Adding timeout layer");
+        app
+    }
 }

src/db.rs

@@ -19,6 +19,7 @@ use crate::{
     app::{AppContext, Hooks},
     config,
 };
+use std::time::Duration;
 
 /// converge database logic
 ///
@@ -60,6 +61,8 @@ pub async fn connect(config: &config::Database) -> Result<DbConn, sea_orm::DbErr
     let mut opt = ConnectOptions::new(&config.uri);
     opt.max_connections(config.max_connections)
         .min_connections(config.min_connections)
+        .connect_timeout(Duration::from_millis(config.connect_timeout))
+        .idle_timeout(Duration::from_millis(config.idle_timeout))
         .sqlx_logging(config.enable_logging);
 
     Database::connect(opt).await

starters/saas/config/development.yaml

@@ -14,6 +14,9 @@ server:
       enable: true
     catch_panic:
       enable: true
+    timeout_request:
+      enable: false
+      timeout: 5000
 workers:
   mode: BackgroundQueue
 mailer:
@@ -29,6 +32,8 @@ database:
   uri: postgres://loco:loco@localhost:5432/loco_app
   # uri: sqlite://db.sqlite?mode=rwc
   enable_logging: false
+  connect_timeout: 500
+  idle_timeout: 1000
   min_connections: 1
   max_connections: 1
   auto_migrate: true

starters/saas/config/test.yaml

@@ -14,6 +14,9 @@ server:
       enable: true
     catch_panic:
       enable: true
+    timeout_request:
+      enable: true
+      timeout: 5000
 workers:
   mode: ForegroundBlocking
 mailer:
@@ -28,6 +31,8 @@ mailer:
 database:
   uri: postgres://loco:loco@localhost:5432/loco_app
   enable_logging: false
+  connect_timeout: 500
+  idle_timeout: 1000
   min_connections: 1
   max_connections: 1
   auto_migrate: true

starters/stateless/config/development.yaml

@@ -14,6 +14,9 @@ server:
       enable: true
     catch_panic:
       enable: true
+    timeout_request:
+      enable: false
+      timeout: 5000
 workers:
   mode: BackgroundQueue
 mailer:

starters/stateless/config/test.yaml

@@ -14,6 +14,9 @@ server:
       enable: true
     catch_panic:
       enable: true
+    timeout_request:
+      enable: true
+      timeout: 5000
 workers:
   mode: ForegroundBlocking
 mailer: