Merge pull request #37 from unikmhz/config-maint-mode

unikmhz · web-flow · commit 2520d1b19277 · 2025-08-22T06:02:01.000+03:00
feat: Configurable maintenance mode
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "uxum"
-version = "0.6.1"
+version = "0.7.0"
 authors = ["Alex Unigovsky <unik@devrandom.ru>"]
 license = "MIT OR Apache-2.0"
 edition = "2021"
@@ -37,7 +37,7 @@ sign-tag = false
 tag-message = "uxum {{version}}"
 
 [dependencies]
-uxum-macros = { path = "uxum-macros", version = "0.4" }
+uxum-macros = { path = "uxum-macros", version = "=0.4.1" }
 
 argon2 = "0.5"
 askama = "0.13"
diff --git a/examples/advanced_server/src/main.rs b/examples/advanced_server/src/main.rs
@@ -380,14 +380,14 @@ mod hello {
     #[handler]
     async fn name_from_text_body(state: State<HelloState>, body: String) -> String {
         state.log_name(&body);
-        format!("Hello {}!", body)
+        format!("Hello {body}!")
     }
 
     /// Greet someone using a name from a binary body.
     #[handler]
     async fn name_from_binary_body(state: State<HelloState>, body: Bytes) -> String {
         state.log_name(std::str::from_utf8(&body).unwrap_or(""));
-        format!("Hello {:?}!", body)
+        format!("Hello {body:?}!")
     }
 
     /// Greet someone using a name from a URL path element.
diff --git a/src/auth/config.rs b/src/auth/config.rs
@@ -152,7 +152,7 @@ mod serde_impls {
         {
             PasswordHashString::new(v)
                 .map(Into::into)
-                .map_err(|err| E::custom(format!("unable to parse PHC format: {}", err)))
+                .map_err(|err| E::custom(format!("unable to parse PHC format: {err}")))
         }
     }
 }
diff --git a/src/auth/extractor.rs b/src/auth/extractor.rs
@@ -64,7 +64,6 @@ impl AuthExtractor for NoOpAuthExtractor {
         Ok(((), ()))
     }
 
-    #[must_use]
     fn error_response(&self, err: AuthError) -> Response<Body> {
         // This shuld never get executed for a NoOp extractor
         error!("tried to generate auth error response for NoOpAuthExtractor");
@@ -106,7 +105,6 @@ impl AuthExtractor for BasicAuthExtractor {
         }
     }
 
-    #[must_use]
     fn error_response(&self, err: AuthError) -> Response<Body> {
         let status = match err {
             AuthError::NoAuthProvided | AuthError::UserNotFound | AuthError::AuthFailed => {
@@ -135,7 +133,6 @@ impl AuthExtractor for BasicAuthExtractor {
         resp
     }
 
-    #[must_use]
     fn security_schemes(&self) -> BTreeMap<String, openapi3::SecurityScheme> {
         maplit::btreemap! {
             "basic".into() => openapi3::SecurityScheme {
@@ -240,7 +237,6 @@ impl AuthExtractor for HeaderAuthExtractor {
         Ok((user, tokens))
     }
 
-    #[must_use]
     fn error_response(&self, err: AuthError) -> Response<Body> {
         let status = match err {
             AuthError::NoAuthProvided
@@ -255,7 +251,6 @@ impl AuthExtractor for HeaderAuthExtractor {
             .into_response()
     }
 
-    #[must_use]
     fn security_schemes(&self) -> BTreeMap<String, openapi3::SecurityScheme> {
         maplit::btreemap! {
             "api-name".into() => openapi3::SecurityScheme {
diff --git a/src/layers/cors.rs b/src/layers/cors.rs
@@ -142,8 +142,7 @@ mod serde_impls {
             match v.to_ascii_lowercase().as_str() {
                 "any" => Ok(AnyOr::Any),
                 other => Err(E::custom(format_args!(
-                    "expecting string 'any', got '{}'",
-                    other
+                    "expecting string 'any', got '{other}'"
                 ))),
             }
         }
diff --git a/src/layers/request_id.rs b/src/layers/request_id.rs
@@ -30,7 +30,6 @@ where
 {
     type Service = RecordRequestIdService<S>;
 
-    #[must_use]
     fn layer(&self, inner: S) -> Self::Service {
         RecordRequestIdService::new(inner)
     }
diff --git a/src/logging/json.rs b/src/logging/json.rs
@@ -162,7 +162,6 @@ pub(crate) struct ExtensibleJsonFormat<T = SystemTime> {
 }
 
 impl Default for ExtensibleJsonFormat {
-    #[must_use]
     fn default() -> Self {
         Self {
             timer: SystemTime,
@@ -507,7 +506,7 @@ where
             // If we *aren't* in debug mode, it's probably best not
             // crash the program, but let's at least make sure it's clear
             // that the fields are not supposed to be missing.
-            Err(e) => serializer.serialize_entry("field_error", &format!("{}", e))?,
+            Err(e) => serializer.serialize_entry("field_error", &format!("{e}"))?,
         };
         serializer.serialize_entry("name", self.0.metadata().name())?;
         serializer.end()
diff --git a/src/probes.rs b/src/probes.rs
@@ -45,6 +45,8 @@ pub struct ProbeConfig {
     /// Runtime watchdog configuration.
     #[serde(default, skip_serializing_if = "Option::is_none")]
     watchdog: Option<WatchdogConfig>,
+    #[serde(default)]
+    start_in_maintenance: bool,
 }
 
 impl Default for ProbeConfig {
@@ -55,6 +57,7 @@ impl Default for ProbeConfig {
             maintenance_on_path: Self::default_maintenance_on_path(),
             maintenance_off_path: Self::default_maintenance_off_path(),
             watchdog: Some(WatchdogConfig::default()),
+            start_in_maintenance: false,
         }
     }
 }
@@ -102,7 +105,7 @@ impl ProbeConfig {
     {
         // TODO: add toggle for probes, and possibly for maintenance mode.
         let _span = debug_span!("build_probes").entered();
-        let state = ProbeState::new(self.watchdog.as_ref());
+        let state = ProbeState::new(self.start_in_maintenance, self.watchdog.as_ref());
         Router::new()
             .route(&self.readiness_path, routing::get(readiness_probe))
             .route(&self.liveness_path, routing::get(liveness_probe))
@@ -148,9 +151,9 @@ impl Default for ProbeState {
 impl ProbeState {
     /// Create new [`ProbeState`] with optional [`WatchdogConfig`].
     #[must_use]
-    pub fn new(watchdog: Option<&WatchdogConfig>) -> Self {
+    pub fn new(in_maint: bool, watchdog: Option<&WatchdogConfig>) -> Self {
         Self(Arc::new(ProbeStateInner {
-            in_maintenance: AtomicBool::new(true),
+            in_maintenance: AtomicBool::new(in_maint),
             watchdog: watchdog.map(|wc| {
                 let mut watchdog: Watchdog = wc.clone().into();
                 watchdog.start();
diff --git a/src/response.rs b/src/response.rs
@@ -49,7 +49,6 @@ mod impls {
     impl GetResponseSchemas for String {
         type ResponseIter = [ResponseSchema; 1];
 
-        #[must_use]
         fn get_response_schemas(gen: &mut SchemaGenerator) -> Self::ResponseIter {
             [ResponseSchema {
                 status: StatusCode::OK,
@@ -70,7 +69,6 @@ mod impls {
     impl GetResponseSchemas for str {
         type ResponseIter = [ResponseSchema; 1];
 
-        #[must_use]
         fn get_response_schemas(gen: &mut SchemaGenerator) -> Self::ResponseIter {
             <String as GetResponseSchemas>::get_response_schemas(gen)
         }
@@ -79,7 +77,6 @@ mod impls {
     impl GetResponseSchemas for () {
         type ResponseIter = [ResponseSchema; 1];
 
-        #[must_use]
         fn get_response_schemas(_gen: &mut SchemaGenerator) -> Self::ResponseIter {
             [ResponseSchema {
                 status: StatusCode::OK,
@@ -107,7 +104,6 @@ mod impls {
     {
         type ResponseIter = T::ResponseIter;
 
-        #[must_use]
         fn get_response_schemas(gen: &mut schemars::gen::SchemaGenerator) -> Self::ResponseIter {
             T::get_response_schemas(gen)
         }
@@ -119,7 +115,6 @@ mod impls {
     {
         type ResponseIter = [ResponseSchema; 1];
 
-        #[must_use]
         fn get_response_schemas(gen: &mut SchemaGenerator) -> Self::ResponseIter {
             [ResponseSchema {
                 status: StatusCode::OK,
@@ -144,7 +139,6 @@ mod impls {
     {
         type ResponseIter = Vec<ResponseSchema>;
 
-        #[must_use]
         fn get_response_schemas(gen: &mut SchemaGenerator) -> Self::ResponseIter {
             T::get_response_schemas(gen)
                 .into_iter()
diff --git a/uxum-macros/Cargo.toml b/uxum-macros/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "uxum-macros"
-version = "0.4.0"
+version = "0.4.1"
 authors = ["Alex Unigovsky <unik@devrandom.ru>"]
 license = "MIT OR Apache-2.0"
 edition = "2021"
diff --git a/uxum-macros/src/handler/server.rs b/uxum-macros/src/handler/server.rs
@@ -6,6 +6,7 @@ use crate::util::quote_option;
 
 /// Available service endpoint.
 #[derive(Debug, FromMeta)]
+#[allow(dead_code)]
 pub(crate) struct OpenApiServer {
     /// Server URL.
     url: String,
diff --git a/uxum-pools/Cargo.toml b/uxum-pools/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "uxum-pools"
-version = "0.3.0"
+version = "0.3.1"
 authors = ["Alex Unigovsky <unik@devrandom.ru>"]
 license = "MIT OR Apache-2.0"
 edition = "2021"
diff --git a/uxum-pools/src/async/impls/bb8.rs b/uxum-pools/src/async/impls/bb8.rs
@@ -34,13 +34,7 @@ where
             max_size: None,
             size: Some(inner.connections as usize),
             idle: Some(inner.idle_connections as usize),
-            in_use: Some({
-                if inner.connections > inner.idle_connections {
-                    (inner.connections - inner.idle_connections) as usize
-                } else {
-                    0
-                }
-            }),
+            in_use: Some(inner.connections.saturating_sub(inner.idle_connections) as usize),
             min_idle: None,
             max_idle: None,
         })
diff --git a/uxum-pools/src/async/impls/deadpool.rs b/uxum-pools/src/async/impls/deadpool.rs
@@ -48,13 +48,7 @@ where
             max_size: Some(inner.max_size),
             size: Some(inner.size),
             idle: Some(inner.available),
-            in_use: Some({
-                if inner.size > inner.available {
-                    inner.size - inner.available
-                } else {
-                    0
-                }
-            }),
+            in_use: Some(inner.size.saturating_sub(inner.available)),
             min_idle: None,
             max_idle: None,
         })
diff --git a/uxum-pools/src/sync/impls/r2d2.rs b/uxum-pools/src/sync/impls/r2d2.rs
@@ -28,13 +28,7 @@ impl<'p, M: ManageConnection> InstrumentablePool<'p> for Pool<M> {
             max_size: Some(Pool::max_size(self) as usize),
             size: Some(inner.connections as usize),
             idle: Some(inner.idle_connections as usize),
-            in_use: Some({
-                if inner.connections > inner.idle_connections {
-                    (inner.connections - inner.idle_connections) as usize
-                } else {
-                    0
-                }
-            }),
+            in_use: Some(inner.connections.saturating_sub(inner.idle_connections) as usize),
             min_idle: Pool::min_idle(self).map(|i| i as usize),
             max_idle: None,
         })

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ mod serde_impls {`
`152`	`152`	`{`
`153`	`153`	`PasswordHashString::new(v)`
`154`	`154`	`.map(Into::into)`
`155`		`- .map_err(\|err\| E::custom(format!("unable to parse PHC format: {}", err)))`
	`155`	`+ .map_err(\|err\| E::custom(format!("unable to parse PHC format: {err}")))`
`156`	`156`	`}`
`157`	`157`	`}`
`158`	`158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,6 @@ impl AuthExtractor for NoOpAuthExtractor {`
`64`	`64`	`Ok(((), ()))`
`65`	`65`	`}`
`66`	`66`
`67`		`- #[must_use]`
`68`	`67`	`fn error_response(&self, err: AuthError) -> Response<Body> {`
`69`	`68`	`// This shuld never get executed for a NoOp extractor`
`70`	`69`	`error!("tried to generate auth error response for NoOpAuthExtractor");`
`@@ -106,7 +105,6 @@ impl AuthExtractor for BasicAuthExtractor {`
`106`	`105`	`}`
`107`	`106`	`}`
`108`	`107`
`109`		`- #[must_use]`
`110`	`108`	`fn error_response(&self, err: AuthError) -> Response<Body> {`
`111`	`109`	`let status = match err {`
`112`	`110`	`AuthError::NoAuthProvided \| AuthError::UserNotFound \| AuthError::AuthFailed => {`
`@@ -135,7 +133,6 @@ impl AuthExtractor for BasicAuthExtractor {`
`135`	`133`	`resp`
`136`	`134`	`}`
`137`	`135`
`138`		`- #[must_use]`
`139`	`136`	`fn security_schemes(&self) -> BTreeMap<String, openapi3::SecurityScheme> {`
`140`	`137`	`maplit::btreemap! {`
`141`	`138`	`"basic".into() => openapi3::SecurityScheme {`
`@@ -240,7 +237,6 @@ impl AuthExtractor for HeaderAuthExtractor {`
`240`	`237`	`Ok((user, tokens))`
`241`	`238`	`}`
`242`	`239`
`243`		`- #[must_use]`
`244`	`240`	`fn error_response(&self, err: AuthError) -> Response<Body> {`
`245`	`241`	`let status = match err {`
`246`	`242`	`AuthError::NoAuthProvided`
`@@ -255,7 +251,6 @@ impl AuthExtractor for HeaderAuthExtractor {`
`255`	`251`	`.into_response()`
`256`	`252`	`}`
`257`	`253`
`258`		`- #[must_use]`
`259`	`254`	`fn security_schemes(&self) -> BTreeMap<String, openapi3::SecurityScheme> {`
`260`	`255`	`maplit::btreemap! {`
`261`	`256`	`"api-name".into() => openapi3::SecurityScheme {`
Original file line number	Diff line number	Diff line change
`@@ -142,8 +142,7 @@ mod serde_impls {`
`142`	`142`	`match v.to_ascii_lowercase().as_str() {`
`143`	`143`	`"any" => Ok(AnyOr::Any),`
`144`	`144`	`other => Err(E::custom(format_args!(`
`145`		`- "expecting string 'any', got '{}'",`
`146`		`- other`
	`145`	`+ "expecting string 'any', got '{other}'"`
`147`	`146`	`))),`
`148`	`147`	`}`
`149`	`148`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,6 @@ where`
`30`	`30`	`{`
`31`	`31`	`type Service = RecordRequestIdService<S>;`
`32`	`32`
`33`		`- #[must_use]`
`34`	`33`	`fn layer(&self, inner: S) -> Self::Service {`
`35`	`34`	`RecordRequestIdService::new(inner)`
`36`	`35`	`}`