feat: Allow configuring the max duration of health checks (#264)

Closes #263

src/api/cli/roadster/health.rs

@@ -31,7 +31,13 @@ where
         _cli: &RoadsterCli,
         #[allow(unused_variables)] state: &S,
     ) -> RoadsterResult<bool> {
-        let duration = Duration::from_millis(self.max_duration.unwrap_or(10000));
+        let duration = self
+            .max_duration
+            .map(Duration::from_millis)
+            .unwrap_or_else(|| {
+                let context = AppContext::from_ref(state);
+                context.config().health_check.max_duration.startup
+            });
         let health = health_check(state, Some(duration)).await?;
         let health = serde_json::to_string_pretty(&health)?;
         info!("\n{health}");

src/api/http/health.rs

@@ -96,7 +96,13 @@ where
     S: Clone + Send + Sync + 'static,
     AppContext: FromRef<S>,
 {
-    let duration = Duration::from_millis(query.max_duration.unwrap_or(1000));
+    let duration = query
+        .max_duration
+        .map(Duration::from_millis)
+        .unwrap_or_else(|| {
+            let context = AppContext::from_ref(&state);
+            context.config().health_check.max_duration.startup
+        });
     Ok(Json(health_check(&state, Some(duration)).await?))
 }
 

src/config/health_check/default.toml

@@ -1,3 +1,8 @@
+[health-check.max-duration]
+startup = 60000
+api = 1000
+cli = 10000
+
 [health-check.database]
 
 [health-check.sidekiq]

src/config/health_check/mod.rs

@@ -4,7 +4,9 @@ use crate::util::serde_util::default_true;
 use axum::extract::FromRef;
 use config::{FileFormat, FileSourceString};
 use serde_derive::{Deserialize, Serialize};
+use serde_with::serde_as;
 use std::collections::BTreeMap;
+use std::time::Duration;
 use validator::Validate;
 
 pub fn default_config() -> config::File<FileSourceString, FileFormat> {
@@ -17,6 +19,7 @@ pub fn default_config() -> config::File<FileSourceString, FileFormat> {
 pub struct HealthCheck {
     #[serde(default = "default_true")]
     pub default_enable: bool,
+    pub max_duration: MaxDuration,
     #[cfg(feature = "db-sql")]
     pub database: HealthCheckConfig<()>,
     #[cfg(feature = "sidekiq")]
@@ -50,7 +53,7 @@ pub struct HealthCheck {
     pub custom: BTreeMap<String, HealthCheckConfig<CustomConfig>>,
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Validate, Serialize, Deserialize)]
 #[serde(rename_all = "kebab-case")]
 #[non_exhaustive]
 pub struct CommonConfig {
@@ -77,7 +80,7 @@ impl CommonConfig {
     }
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize)]
+#[derive(Debug, Clone, Validate, Serialize, Deserialize)]
 #[serde(rename_all = "kebab-case")]
 #[non_exhaustive]
 pub struct HealthCheckConfig<T> {
@@ -87,6 +90,27 @@ pub struct HealthCheckConfig<T> {
     pub custom: T,
 }
 
+/// The maximum duration to wait for health checks to succeed before timing out and assuming
+/// the checks failed.
+#[serde_as]
+#[derive(Debug, Clone, Validate, Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+#[non_exhaustive]
+pub struct MaxDuration {
+    /// The maximum time (in milliseconds) to wait  when running checks on app startup.
+    #[serde_as(as = "serde_with::DurationMilliSeconds")]
+    pub startup: Duration,
+    /// The maximum time (in milliseconds) to wait when running checks via a web API (HTTP, gRPC, etc).
+    /// In the default `_health` HTTP endpoint, this can be overridden via the `maxDuration`
+    /// query parameter.
+    #[serde_as(as = "serde_with::DurationMilliSeconds")]
+    pub api: Duration,
+    /// The maximum time (in milliseconds) to wait when running checks via the CLI. This can be
+    /// overridden via the `-d/--max-duration` CLI arg.
+    #[serde_as(as = "serde_with::DurationMilliSeconds")]
+    pub cli: Duration,
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

src/config/snapshots/roadster__config__app_config__tests__test.snap

@@ -11,6 +11,11 @@ shutdown-on-error = true
 [health-check]
 default-enable = true
 
+[health-check.max-duration]
+startup = 60000
+api = 1000
+cli = 10000
+
 [health-check.database]
 
 [health-check.sidekiq]