add snapshot statistics route

Author: ghubertpalo

mithril-aggregator/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "git.ignoreLimitWarning": true
+}

mithril-aggregator/src/http_server/routes/mod.rs

@@ -6,3 +6,4 @@ mod reply;
 pub mod router;
 mod signatures_routes;
 mod signer_routes;
+mod statistics;

mithril-aggregator/src/http_server/routes/router.rs

@@ -14,6 +14,8 @@ use warp::http::Method;
 use warp::reject::Reject;
 use warp::{Filter, Rejection, Reply};
 
+use super::statistics;
+
 #[derive(Debug)]
 pub struct VersionMismatchError;
 
@@ -49,6 +51,7 @@ pub fn routes(
                 .or(signer_routes::routes(dependency_manager.clone()))
                 .or(signatures_routes::routes(dependency_manager.clone()))
                 .or(epoch_routes::routes(dependency_manager.clone()))
+                .or(statistics::routes(dependency_manager.clone()))
                 .with(cors),
         )
         .recover(handle_custom)

mithril-aggregator/src/http_server/routes/statistics.rs

@@ -0,0 +1,115 @@
+use mithril_common::MITHRIL_SIGNER_VERSION_HEADER;
+use std::sync::Arc;
+use warp::Filter;
+
+use crate::http_server::routes::middlewares;
+use crate::DependencyContainer;
+
+pub fn routes(
+    dependency_manager: Arc<DependencyContainer>,
+) -> impl Filter<Extract = (impl warp::Reply,), Error = warp::Rejection> + Clone {
+    post_statistics(dependency_manager)
+}
+
+/// POST /statistics/snapshot
+fn post_statistics(
+    dependency_manager: Arc<DependencyContainer>,
+) -> impl Filter<Extract = (impl warp::Reply,), Error = warp::Rejection> + Clone {
+    warp::path!("statistics" / "snapshot")
+        .and(warp::post())
+        .and(warp::header::optional::<String>(
+            MITHRIL_SIGNER_VERSION_HEADER,
+        ))
+        .and(warp::body::json())
+        .and(middlewares::with_event_transmitter(
+            dependency_manager.clone(),
+        ))
+        .and_then(handlers::post_snapshot_statistics)
+}
+
+mod handlers {
+    use std::{convert::Infallible, sync::Arc};
+
+    use mithril_common::messages::SnapshotMessage;
+    use reqwest::StatusCode;
+
+    use crate::event_store::{EventMessage, TransmitterService};
+    use crate::http_server::routes::reply;
+
+    pub async fn post_snapshot_statistics(
+        signer_node_version: Option<String>,
+        snapshot_message: SnapshotMessage,
+        event_transmitter: Arc<TransmitterService<EventMessage>>,
+    ) -> Result<impl warp::Reply, Infallible> {
+        let headers: Vec<(&str, &str)> = signer_node_version
+            .as_ref()
+            .map(|v| ("signer-node-version", v.as_str()))
+            .into_iter()
+            .collect();
+        let _ = event_transmitter.send_event_message(
+            "HTTP::statistics",
+            "snapshot_downloaded",
+            &snapshot_message,
+            headers,
+        );
+
+        Ok(reply::empty(StatusCode::CREATED))
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    use mithril_common::messages::SnapshotMessage;
+    use mithril_common::test_utils::apispec::APISpec;
+
+    use warp::{http::Method, test::request};
+
+    use crate::{
+        dependency_injection::DependenciesBuilder, http_server::SERVER_BASE_PATH, Configuration,
+    };
+
+    fn setup_router(
+        dependency_manager: Arc<DependencyContainer>,
+    ) -> impl Filter<Extract = (impl warp::Reply,), Error = warp::Rejection> + Clone {
+        let cors = warp::cors()
+            .allow_any_origin()
+            .allow_headers(vec!["content-type"])
+            .allow_methods(vec![Method::GET, Method::POST, Method::OPTIONS]);
+
+        warp::any()
+            .and(warp::path(SERVER_BASE_PATH))
+            .and(routes(dependency_manager).with(cors))
+    }
+
+    #[tokio::test]
+    async fn post_statistics_ok() {
+        let config = Configuration::new_sample();
+        let mut builder = DependenciesBuilder::new(config);
+        let mut rx = builder.get_event_transmitter_receiver().await.unwrap();
+        let dependency_manager = builder.build_dependency_container().await.unwrap();
+        let snapshot_message = SnapshotMessage::dummy();
+
+        let method = Method::POST.as_str();
+        let path = "/statistics/snapshot";
+
+        let response = request()
+            .method(method)
+            .json(&snapshot_message)
+            .path(&format!("/{SERVER_BASE_PATH}{path}"))
+            .reply(&setup_router(Arc::new(dependency_manager)))
+            .await;
+
+        APISpec::verify_conformity(
+            APISpec::get_all_spec_files(),
+            method,
+            path,
+            "application/json",
+            &snapshot_message,
+            &response,
+        );
+
+        let _ = rx.try_recv().unwrap();
+    }
+}

openapi.yaml

@@ -360,6 +360,34 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Error"
+  /statistics/snapshot:
+    post:
+      summary: Increments download statistics
+      description: Increments snapshot download statistics
+      requestBody:
+        description: Downloaded snapshot
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SnapshotMessage"
+      responses:
+        "201":
+          description: Statistic succesfully posted
+        "400":
+          description: Increments download statistics bad request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "412":
+          description: API version mismatch
+        default:
+          description: Snapshot download statistics error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
 
 components:
   schemas: