Merge pull request #528 from AmbireTech/general-improvements

General improvements & sentry graceful shutdown

Author: elpiel

Cargo.lock

@@ -40,7 +40,7 @@ serde_json = "1.0"
 serde-hex = "0.1"
 serde_millis = "0.1"
 # Used prefixes on field for targeting::Input, and `campaign::Active`
-serde_with = "1"
+serde_with = "2"
 # Configuration
 toml = "0.5"
 # Logging
@@ -83,4 +83,4 @@ once_cell = "1"
 [dev-dependencies]
 pretty_assertions = "1"
 tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
-serde_qs = "0.9"
+serde_qs = "0.10"

primitives/Cargo.toml

@@ -309,3 +309,16 @@ pub fn configuration(
         },
     }
 }
+
+#[cfg(test)]
+mod test {
+    use super::{GANACHE_CONFIG, PRODUCTION_CONFIG};
+
+    /// Makes sure that both config files are correct and won't be left in a
+    /// broken state.
+    #[test]
+    fn correct_config_files() {
+        let _ganache = GANACHE_CONFIG.clone();
+        let _production = PRODUCTION_CONFIG.clone();
+    }
+}

primitives/src/config.rs

@@ -46,7 +46,7 @@ pub mod sentry;
 pub mod spender;
 pub mod supermarket;
 pub mod targeting;
-#[cfg(feature = "test-util")]
+#[cfg(any(test, feature = "test-util"))]
 #[cfg_attr(docsrs, doc(cfg(feature = "test-util")))]
 pub mod test_util;
 pub mod unified_num;

primitives/src/lib.rs

@@ -1129,15 +1129,55 @@ mod postgres {
             }
         }
     }
+
+    #[cfg(test)]
+    mod test {
+        use chrono::{TimeZone, Utc};
+
+        use crate::{postgres::POSTGRES_POOL, sentry::DateHour};
+
+        #[tokio::test]
+        pub async fn datehour_from_to_sql() {
+            let client = POSTGRES_POOL.get().await.unwrap();
+            let sql_type = "TIMESTAMPTZ";
+
+            let example_datehour = DateHour::<Utc>::from_ymdh(2021, 1, 1, 1);
+            let expected_datehour = DateHour::try_from(Utc.ymd(2021, 1, 1).and_hms(1, 0, 0))
+                .expect("Should get DateHour");
+            assert_eq!(
+                example_datehour, expected_datehour,
+                "Example and expected datehour must be the same"
+            );
+
+            // from SQL
+            let actual_datehour: DateHour<Utc> = client
+                .query_one(
+                    &*format!("SELECT '{}'::{}", example_datehour.to_datetime(), sql_type),
+                    &[],
+                )
+                .await
+                .unwrap()
+                .get(0);
+
+            assert_eq!(&expected_datehour, &actual_datehour);
+
+            // to SQL
+            let actual_datehour: DateHour<Utc> = client
+                .query_one(&*format!("SELECT $1::{}", sql_type), &[&example_datehour])
+                .await
+                .unwrap()
+                .get(0);
+
+            assert_eq!(&expected_datehour, &actual_datehour);
+        }
+    }
 }
 
 #[cfg(test)]
 mod test {
     use super::*;
-    use crate::{
-        postgres::POSTGRES_POOL,
-        test_util::{DUMMY_IPFS, PUBLISHER},
-    };
+    use crate::test_util::{DUMMY_IPFS, PUBLISHER};
+
     use serde_json::{json, Value};
 
     #[test]
@@ -1243,39 +1283,4 @@ mod test {
             "UTC+0 value should be equal to UTC+2"
         );
     }
-
-    #[tokio::test]
-    pub async fn datehour_from_to_sql() {
-        let client = POSTGRES_POOL.get().await.unwrap();
-        let sql_type = "TIMESTAMPTZ";
-
-        let example_datehour = DateHour::<Utc>::from_ymdh(2021, 1, 1, 1);
-        let expected_datehour =
-            DateHour::try_from(Utc.ymd(2021, 1, 1).and_hms(1, 0, 0)).expect("Should get DateHour");
-        assert_eq!(
-            example_datehour, expected_datehour,
-            "Example and expected datehour must be the same"
-        );
-
-        // from SQL
-        let actual_datehour: DateHour<Utc> = client
-            .query_one(
-                &*format!("SELECT '{}'::{}", example_datehour.to_datetime(), sql_type),
-                &[],
-            )
-            .await
-            .unwrap()
-            .get(0);
-
-        assert_eq!(&expected_datehour, &actual_datehour);
-
-        // to SQL
-        let actual_datehour: DateHour<Utc> = client
-            .query_one(&*format!("SELECT $1::{}", sql_type), &[&example_datehour])
-            .await
-            .unwrap()
-            .get(0);
-
-        assert_eq!(&expected_datehour, &actual_datehour);
-    }
 }

primitives/src/sentry.rs

@@ -11,6 +11,10 @@ edition = "2021"
 
 default-run = "sentry"
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [[bin]]
 name = "seed"
 test = false # Is tested by default.
@@ -37,7 +41,7 @@ hex = "0.4"
 # CLI
 clap = { version = "3", features = ["cargo"] }
 # Server
-tokio = { version = "1", features = ["macros", "time", "rt-multi-thread"] }
+tokio = { version = "1", features = ["macros", "time", "rt-multi-thread", "signal"] }
 hyper = { version = "0.14", features = ["stream", "runtime", "http1", "http2", "server"] }
 simple-hyper-server-tls = { version = "0.3", features = ["tls-rustls"] }
 regex = "1"
@@ -63,7 +67,7 @@ envy = "0.4"
 # Serde
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
-serde_qs = "0.9"
+serde_qs = "0.10"
 # Other
 thiserror = "1"
 once_cell = "1"
@@ -77,7 +81,3 @@ pretty_assertions = "1"
 
 primitives = { path = "../primitives", features = ["postgres", "test-util"] }
 adapter = { version = "0.2", path = "../adapter", features = ["test-util"] }
-
-[package.metadata.docs.rs]
-all-features = true
-rustdoc-args = ["--cfg", "docsrs"]

sentry/Cargo.toml

@@ -183,7 +183,9 @@ impl<C: Locked + 'static> Application<C> {
                     }
                 });
 
-                let server = Server::bind(&socket_addr).serve(make_service);
+                let server = Server::bind(&socket_addr)
+                    .serve(make_service)
+                    .with_graceful_shutdown(shutdown_signal(logger.clone()));
 
                 if let Err(e) = server.await {
                     error!(&logger, "server error: {}", e; "main" => "run");
@@ -201,7 +203,10 @@ impl<C: Locked + 'static> Application<C> {
                 });
 
                 // TODO: Find a way to redirect to HTTPS
-                let mut server = Server::builder(listener).serve(make_service);
+                let server = Server::builder(listener)
+                    .serve(make_service)
+                    .with_graceful_shutdown(shutdown_signal(logger.clone()));
+                tokio::pin!(server);
 
                 while let Err(e) = (&mut server).await {
                     // This is usually caused by trying to connect on HTTP instead of HTTPS
@@ -273,6 +278,16 @@ pub struct Auth {
     pub chain: primitives::Chain,
 }
 
+/// A Ctrl+C signal to gracefully shutdown the server
+async fn shutdown_signal(logger: Logger) {
+    // Wait for the Ctrl+C signal
+    tokio::signal::ctrl_c()
+        .await
+        .expect("failed to install CTRL+C signal handler");
+
+    info!(&logger, "Received Ctrl+C signal. Shutting down..")
+}
+
 #[cfg(test)]
 mod test {
     use serde_json::json;