From a614cbbea92cff285033a726efa7eca23ac1ff86 Mon Sep 17 00:00:00 2001
From: ClementTsang <34804052+ClementTsang@users.noreply.github.com>
Date: Sun, 13 Apr 2025 04:30:12 -0400
Subject: [PATCH] update loggers

---
 src/utils/logging.rs | 72 ++++++++++++++++++++++++++++++++++++++------
 1 file changed, 63 insertions(+), 9 deletions(-)

diff --git a/src/utils/logging.rs b/src/utils/logging.rs
index cb610984..1af08aad 100644
--- a/src/utils/logging.rs
+++ b/src/utils/logging.rs
@@ -49,7 +49,7 @@ macro_rules! error {
     ($($x:tt)*) => {
         #[cfg(feature = "logging")]
         {
-            log::error!($($x)*)
+            log::error!($($x)*);
         }
     };
 }
@@ -59,7 +59,7 @@ macro_rules! warn {
     ($($x:tt)*) => {
         #[cfg(feature = "logging")]
         {
-            log::warn!($($x)*)
+            log::warn!($($x)*);
         }
     };
 }
@@ -69,7 +69,7 @@ macro_rules! info {
     ($($x:tt)*) => {
         #[cfg(feature = "logging")]
         {
-            log::info!($($x)*)
+            log::info!($($x)*);
         }
     };
 }
@@ -79,7 +79,7 @@ macro_rules! debug {
     ($($x:tt)*) => {
         #[cfg(feature = "logging")]
         {
-            log::debug!($($x)*)
+            log::debug!($($x)*);
         }
     };
 }
@@ -89,7 +89,7 @@ macro_rules! trace {
     ($($x:tt)*) => {
         #[cfg(feature = "logging")]
         {
-            log::trace!($($x)*)
+            log::trace!($($x)*);
         }
     };
 }
@@ -99,25 +99,71 @@ macro_rules! log {
     ($($x:tt)*) => {
         #[cfg(feature = "logging")]
         {
-            log::log!(log::Level::Trace, $($x)*)
+            log::log!(log::Level::Trace, $($x)*);
         }
     };
     ($level:expr, $($x:tt)*) => {
         #[cfg(feature = "logging")]
         {
-            log::log!($level, $($x)*)
+            log::log!($level, $($x)*);
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! info_every_n_secs {
+    ($n:expr, $($x:tt)*) => {
+        #[cfg(feature = "logging")]
+        {
+            crate::log_every_n_secs!(log::Level::Info, $n, $($x)*);
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! log_every_n_secs {
+    ($level:expr, $n:expr, $($x:tt)*) => {
+        #[cfg(feature = "logging")]
+        {
+            static LAST_LOG: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(0);
+            let since_last_log = LAST_LOG.load(std::sync::atomic::Ordering::Relaxed);
+            let now = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).expect("should be valid").as_secs();
+
+            if now - since_last_log > $n {
+                LAST_LOG.store(now, std::sync::atomic::Ordering::Relaxed);
+                log::log!($level, $($x)*);
+            }
         }
     };
 }
 
 #[cfg(test)]
 mod test {
+    #[cfg(feature = "logging")]
+    /// We do this to ensure that the test logger is only initialized _once_ for
+    /// things like the default test runner that run tests in the same process.
+    ///
+    /// This doesn't do anything if you use something like nextest, which runs
+    /// a test-per-process, but that's fine.
+    fn init_test_logger() {
+        use std::sync::atomic::AtomicBool;
+        use std::sync::atomic::Ordering;
+
+        static LOG_INIT: AtomicBool = AtomicBool::new(false);
+
+        if LOG_INIT.load(Ordering::SeqCst) {
+            return;
+        }
+
+        LOG_INIT.store(true, Ordering::SeqCst);
+        super::init_logger(log::LevelFilter::Trace, None)
+            .expect("initializing the logger should succeed");
+    }
 
     #[cfg(feature = "logging")]
     #[test]
     fn test_logging_macros() {
-        super::init_logger(log::LevelFilter::Trace, None)
-            .expect("initializing the logger should succeed");
+        init_test_logger();
 
         error!("This is an error.");
         warn!("This is a warning.");
@@ -125,4 +171,12 @@ mod test {
         debug!("This is a debug.");
         info!("This is a trace.");
     }
+
+    #[cfg(feature = "logging")]
+    #[test]
+    fn test_log_every_macros() {
+        init_test_logger();
+
+        info_every_n_secs!(10, "This is an info every 10 seconds.");
+    }
 }