use humantime to parse patience duration

Author: ThatsNoMoon

Cargo.lock

@@ -44,6 +44,7 @@ tinyvec = { version = "1.5", features = ["alloc"] }
 tracing = "0.1"
 tracing-opentelemetry = { version = "0.18", optional = true }
 tracing-subscriber = { version = "0.3", features = ["json"] }
+humantime-serde = "1.1.1"
 
 [dependencies.config]
 version = "0.13"

Cargo.toml

@@ -12,8 +12,10 @@ private = false
 [behavior]
 # Maximum amount of keywords users can subscribe to
 max_keywords = 100
-# Amount of seconds to wait for activity before sending a notification
-patience_seconds = 120
+# Amount of time to wait for activity before sending a notification
+# Other examples: "1m 30sec", "5minutes"
+# See https://docs.rs/humantime/latest/humantime/fn.parse_duration.html for complete list
+patience = "2m"
 
 [logging]
 # Discord webhook to send errors and panics to

example_config.toml

@@ -1,4 +1,4 @@
-// Copyright 2022 ThatsNoMoon
+// Copyright 2023 ThatsNoMoon
 // Licensed under the Open Software License version 3.0
 
 //! Highlights is a simple but flexible keyword highlighting bot for Discord.
@@ -9,6 +9,9 @@
 #![allow(clippy::tabs_in_doc_comments)]
 
 use anyhow::Result;
+use tracing::warn;
+
+use crate::settings::settings;
 
 pub(crate) mod db;
 
@@ -29,6 +32,14 @@ async fn main() -> Result<()> {
 
 	logging::init()?;
 
+	if settings().behavior.patience_seconds.is_some() {
+		warn!(
+			"Your configuration includes behavior.patience_seconds. \
+			This setting is deprecated; please use behavior.patience instead. \
+			For example, patience = \"2m\"."
+		);
+	}
+
 	db::init().await?;
 
 	#[cfg(feature = "bot")]

src/main.rs

@@ -1,4 +1,4 @@
-// Copyright 2022 joshyrobot, ThatsNoMoon
+// Copyright 2023 joshyrobot, ThatsNoMoon
 // Licensed under the Open Software License version 3.0
 
 //! Handling of bot configuration for hosters.
@@ -48,11 +48,11 @@ mod duration_de {
 	}
 	pub(super) fn deserialize_duration<'de, D>(
 		d: D,
-	) -> Result<Duration, D::Error>
+	) -> Result<Option<Duration>, D::Error>
 	where
 		D: Deserializer<'de>,
 	{
-		d.deserialize_u64(DurationVisitor)
+		d.deserialize_u64(DurationVisitor).map(Some)
 	}
 }
 
@@ -254,12 +254,18 @@ pub(crate) struct BehaviorSettings {
 	pub(crate) max_keywords: u32,
 
 	/// Duration to wait for activity before sending a notification.
+	#[serde(with = "humantime_serde")]
+	#[cfg(feature = "bot")]
+	pub(crate) patience: Duration,
+
+	/// Deprecated method to specify patience.
 	#[serde(
-		rename = "patience_seconds",
-		deserialize_with = "deserialize_duration"
+		deserialize_with = "deserialize_duration",
+		alias = "patienceseconds",
+		default
 	)]
 	#[cfg(feature = "bot")]
-	pub(crate) patience: Duration,
+	pub(crate) patience_seconds: Option<Duration>,
 }
 
 /// Settings for the account of the bot.
@@ -344,7 +350,7 @@ impl Settings {
 
 		#[cfg(feature = "bot")]
 		let b = b.set_default("behavior.max_keywords", 100i64)?
-			.set_default("behavior.patience_seconds", 60i64 * 2)?
+			.set_default("behavior.patience", "2m")?
 			.set_default("bot.private", false)?;
 
 		#[cfg(feature = "monitoring")]
@@ -371,6 +377,12 @@ impl Settings {
 		b.add_source(Environment::with_prefix("HIGHLIGHTS").separator("_"))
 			.build()?
 			.try_deserialize()
+			.map(|mut settings: Settings| {
+				if let Some(old) = settings.behavior.patience_seconds {
+					settings.behavior.patience = old;
+				}
+				settings
+			})
 	}
 }