feature(aggregator, openapi): handle 404 result for protocol-configuration route

Author: turmelclem

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

@@ -26,6 +26,7 @@ fn protocol_configuration(
 mod handlers {
     use slog::{Logger, warn};
     use std::{collections::BTreeSet, convert::Infallible, sync::Arc};
+    use warp::http::StatusCode;
 
     use mithril_common::entities::{Epoch, SignedEntityTypeDiscriminants};
 
@@ -54,7 +55,11 @@ mod handlers {
             .await;
 
         match protocol_configuration_message {
-            Ok(message) => Ok(reply::json(&message, warp::http::StatusCode::OK)),
+            Ok(Some(message)) => Ok(reply::json(&message, warp::http::StatusCode::OK)),
+            Ok(None) => {
+                warn!(logger, "protocol_configuration::not_found");
+                Ok(reply::empty(StatusCode::NOT_FOUND))
+            }
             Err(err) => {
                 slog::warn!(logger, "protocol_configuration::error"; "error" => ?err);
                 Ok(reply::server_error(err))
@@ -100,7 +105,7 @@ mod tests {
         let mut mock_http_message_service = MockMessageService::new();
         mock_http_message_service
             .expect_get_protocol_configuration_message()
-            .return_once(|_, _| Ok(ProtocolConfigurationMessage::dummy()))
+            .return_once(|_, _| Ok(Some(ProtocolConfigurationMessage::dummy())))
             .once();
         dependency_manager.message_service = Arc::new(mock_http_message_service);
 
@@ -124,6 +129,38 @@ mod tests {
         .unwrap();
     }
 
+    #[tokio::test]
+    async fn test_protocol_configuration_return_404_when_no_configuration_found() {
+        let method = Method::GET.as_str();
+        let base_path = "/protocol-configuration";
+        let mut dependency_manager = initialize_dependencies!().await;
+        let mut mock_http_message_service = MockMessageService::new();
+        mock_http_message_service
+            .expect_get_protocol_configuration_message()
+            .return_once(|_, _| Ok(None))
+            .once();
+        dependency_manager.message_service = Arc::new(mock_http_message_service);
+
+        let response = request()
+            .method(method)
+            .path(&format!("{base_path}/42"))
+            .reply(&setup_router(RouterState::new_with_dummy_config(Arc::new(
+                dependency_manager,
+            ))))
+            .await;
+
+        APISpec::verify_conformity(
+            APISpec::get_default_spec_file_from(crate::http_server::API_SPEC_LOCATION),
+            method,
+            &format!("{base_path}/{{epoch}}"),
+            "application/json",
+            &Null,
+            &response,
+            &StatusCode::NOT_FOUND,
+        )
+        .unwrap();
+    }
+
     #[tokio::test]
     async fn test_protocol_configuration_get_ko_500() {
         let method = Method::GET.as_str();

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

@@ -1,8 +1,8 @@
 use crate::ServeCommandDependenciesContainer;
 use crate::http_server::SERVER_BASE_PATH;
 use crate::http_server::routes::{
-    artifact_routes, certificate_routes, epoch_routes, root_routes, signatures_routes,
-    signer_routes, statistics_routes, status,
+    artifact_routes, certificate_routes, epoch_routes, protocol_configuration_routes, root_routes,
+    signatures_routes, signer_routes, statistics_routes, status,
 };
 use crate::tools::url_sanitizer::SanitizedUrlWithTrailingSlash;
 
@@ -140,6 +140,7 @@ pub fn routes(
                 .or(signer_routes::routes(&state))
                 .or(signatures_routes::routes(&state))
                 .or(epoch_routes::routes(&state))
+                .or(protocol_configuration_routes::routes(&state))
                 .or(statistics_routes::routes(&state))
                 .or(root_routes::routes(&state))
                 .or(status::routes(&state)),

mithril-aggregator/src/services/message.rs

@@ -40,7 +40,7 @@ pub trait MessageService: Sync + Send {
         &self,
         epoch: Epoch,
         allowed_discriminants: BTreeSet<SignedEntityTypeDiscriminants>,
-    ) -> StdResult<ProtocolConfigurationMessage>;
+    ) -> StdResult<Option<ProtocolConfigurationMessage>>;
 
     /// Return the message representation of a certificate if it exists.
     async fn get_certificate_message(
@@ -198,8 +198,11 @@ impl MessageService for MithrilMessageService {
         &self,
         epoch: Epoch,
         enabled_discriminants: BTreeSet<SignedEntityTypeDiscriminants>,
-    ) -> StdResult<ProtocolConfigurationMessage> {
-        let epoch_settings = self.epoch_settings_storer.get_epoch_settings(epoch).await?.unwrap();
+    ) -> StdResult<Option<ProtocolConfigurationMessage>> {
+        let epoch_settings = match self.epoch_settings_storer.get_epoch_settings(epoch).await? {
+            Some(settings) => settings,
+            None => return Ok(None),
+        };
 
         let cardano_transactions_discriminant =
             enabled_discriminants.get(&SignedEntityTypeDiscriminants::CardanoTransactions);
@@ -212,7 +215,7 @@ impl MessageService for MithrilMessageService {
             cardano_transactions_signing_config,
             available_signed_entity_types: enabled_discriminants,
         };
-        Ok(protocol_configuration_message)
+        Ok(Some(protocol_configuration_message))
     }
 
     async fn get_certificate_message(

openapi.yaml

@@ -129,6 +129,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ProtocolConfigurationMessage"
+        "404":
+          description: protocol configuration not found
         default:
           description: protocol configuration error
           content:
@@ -1062,17 +1064,17 @@ components:
         cardano_transactions_signing_config:
           $ref: "#/components/schemas/CardanoTransactionsSigningConfig"
         available_signed_entity_types:
-            description: Available signed entity types that are signed by the aggregator
-            type: array
-            minItems: 1
-            items:
-              description: Signed entity types that can be signed
-              type: string
-              enum:
-                - MithrilStakeDistribution
-                - CardanoStakeDistribution
-                - CardanoImmutableFilesFull
-                - CardanoTransactions
+          description: Available signed entity types that are signed by the aggregator
+          type: array
+          minItems: 1
+          items:
+            description: Signed entity types that can be signed
+            type: string
+            enum:
+              - MithrilStakeDistribution
+              - CardanoStakeDistribution
+              - CardanoImmutableFilesFull
+              - CardanoTransactions
       examples:
         - {
             "protocol_parameters": { "k": 9, "m": 77, "phi_f": 0.5 },