Merge pull request #1972 from input-output-hk/djo/1925/deprecate_cert…

…ificate_pending Deprecate certificate pending
input-output-hk · Oct 3, 2024 · a80a413 · a80a413
2 parents 7e0b764 + 5cef73c
commit a80a413
Show file tree

Hide file tree

Showing 17 changed files with 64 additions and 357 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,8 @@ As a minor extension, we have adopted a slightly different versioning convention
 
 - Signer compute what to sign independently of the aggregator.
 
+- Deprecate aggregator `/certificate-pending` route as the signer does not need it anymore.
+
 - Crates versions:
 
 | Crate | Version |

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/mithril-aggregator/Cargo.toml b/mithril-aggregator/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.5.72"
+version = "0.5.73"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

diff --git a/mithril-aggregator/src/message_adapters/to_certificate_pending_message.rs b/mithril-aggregator/src/message_adapters/to_certificate_pending_message.rs
@@ -1,3 +1,4 @@
+#![allow(deprecated)]
 use mithril_common::entities::CardanoDbBeacon;
 use mithril_common::{
     entities::{CertificatePending, SignedEntityType},

diff --git a/mithril-common/Cargo.toml b/mithril-common/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.4.62"
+version = "0.4.63"
 description = "Common types, interfaces, and utilities for Mithril nodes."
 authors = { workspace = true }
 edition = { workspace = true }

diff --git a/mithril-common/src/messages/certificate_pending.rs b/mithril-common/src/messages/certificate_pending.rs
@@ -1,10 +1,15 @@
+#![allow(deprecated)]
 use serde::{Deserialize, Serialize};
 
 use crate::entities::{CardanoDbBeacon, Epoch, ProtocolParameters, SignedEntityType};
 use crate::messages::SignerMessagePart;
 
 /// Structure to transport [crate::entities::CertificatePending] data.
 #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[deprecated(
+    since = "0.4.63",
+    note = "Exists only for backward-compatibility, will be removed in the future"
+)]
 pub struct CertificatePendingMessage {
     /// Current Epoch
     pub epoch: Epoch,

diff --git a/mithril-common/src/messages/mod.rs b/mithril-common/src/messages/mod.rs
@@ -39,6 +39,7 @@ pub use certificate::CertificateMessage;
 pub use certificate_list::{
     CertificateListItemMessage, CertificateListItemMessageMetadata, CertificateListMessage,
 };
+#[allow(deprecated)]
 pub use certificate_pending::CertificatePendingMessage;
 pub use epoch_settings::EpochSettingsMessage;
 pub use interface::*;

diff --git a/mithril-common/src/test_utils/apispec.rs b/mithril-common/src/test_utils/apispec.rs
@@ -333,7 +333,7 @@ mod tests {
 
     use super::*;
     use crate::entities;
-    use crate::messages::{CertificatePendingMessage, SignerMessagePart};
+    use crate::messages::{AggregatorFeaturesMessage, SignerMessagePart};
     use crate::test_utils::{fake_data, TempDir};
 
     fn build_empty_response(status_code: u16) -> Response<Bytes> {
@@ -420,9 +420,19 @@ components:
 
     #[test]
     fn test_validate_a_response_without_body() {
-        APISpec::from_file(&APISpec::get_default_spec_file())
+        let file = get_temp_openapi_filename("validate_a_response_without_body", line!());
+        let paths = r#"
+        /empty-route:
+            get:
+                responses:
+                    "204":
+                        description: no pending certificate available
+        "#;
+        write_minimal_open_api_file("1.0.0", &file, paths, "");
+
+        APISpec::from_file(file.to_str().unwrap())
             .method(Method::GET.as_str())
-            .path("/certificate-pending")
+            .path("/empty-route")
             .validate_request(&Null)
             .unwrap()
             .validate_response(&build_empty_response(204))
@@ -433,12 +443,12 @@ components:
     fn test_validate_ok_when_request_without_body_and_expects_response() {
         APISpec::from_file(&APISpec::get_default_spec_file())
             .method(Method::GET.as_str())
-            .path("/certificate-pending")
+            .path("/")
             .validate_request(&Null)
             .unwrap()
             .validate_response(&build_json_response(
                 200,
-                CertificatePendingMessage::dummy(),
+                AggregatorFeaturesMessage::dummy(),
             ))
             .unwrap();
     }
@@ -480,7 +490,7 @@ components:
         let mut api_spec = APISpec::from_file(&APISpec::get_default_spec_file());
         let result = api_spec
             .method(Method::GET.as_str())
-            .path("/certificate-pending")
+            .path("/")
             .validate_request(&Null)
             .unwrap()
             .validate_status(&response, &StatusCode::OK);
@@ -505,7 +515,7 @@ components:
 
         APISpec::from_file(&APISpec::get_default_spec_file())
             .method(Method::GET.as_str())
-            .path("/certificate-pending")
+            .path("/")
             .validate_request(&Null)
             .unwrap()
             .validate_status(&response, &StatusCode::INTERNAL_SERVER_ERROR)
@@ -532,21 +542,21 @@ components:
         let mut api_spec = APISpec::from_file(&APISpec::get_default_spec_file());
         let result = api_spec
             .method(Method::OPTIONS.as_str())
-            .path("/certificate-pending")
+            .path("/certificates")
             .validate_response(&build_response(200, b"abcdefgh"));
 
         assert!(result.is_err());
         assert_eq!(
             result.err(),
-            Some("Unmatched path and method: /certificate-pending OPTIONS".to_string())
+            Some("Unmatched path and method: /certificates OPTIONS".to_string())
         );
     }
     #[test]
     fn test_validate_returns_error_when_route_exists_but_expects_non_empty_response() {
         let mut api_spec = APISpec::from_file(&APISpec::get_default_spec_file());
         let result = api_spec
             .method(Method::GET.as_str())
-            .path("/certificate-pending")
+            .path("/certificates")
             .validate_response(&build_empty_response(200));
 
         assert!(result.is_err());
@@ -588,7 +598,7 @@ components:
         let mut api_spec = APISpec::from_file(&APISpec::get_default_spec_file());
         let result = api_spec
             .method(Method::GET.as_str())
-            .path("/certificate-pending")
+            .path("/certificates")
             .validate_request(&Null)
             .unwrap()
             .validate_response(&build_response(200, b"not a json"));
@@ -602,7 +612,7 @@ components:
     fn test_validate_returns_errors_when_route_exists_but_does_not_expect_request_body() {
         assert!(APISpec::from_file(&APISpec::get_default_spec_file())
             .method(Method::GET.as_str())
-            .path("/certificate-pending")
+            .path("/certificates")
             .validate_request(&fake_data::beacon())
             .is_err());
     }
@@ -620,7 +630,7 @@ components:
         let mut api_spec = APISpec::from_file(&APISpec::get_default_spec_file());
         let result = api_spec
             .method(Method::GET.as_str())
-            .path("/certificate-pending")
+            .path("/certificates")
             .content_type("whatever")
             .validate_request(&Null)
             .unwrap()
@@ -629,7 +639,7 @@ components:
         assert!(result.is_err());
         assert_eq!(
             result.err().unwrap().to_string(),
-            "Expected content type 'whatever' but spec is '{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CertificatePendingMessage\"}}}'",
+            "Expected content type 'whatever' but spec is '{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/CertificateListMessage\"}}}'",
         );
     }
 
@@ -707,24 +717,24 @@ components:
         APISpec::verify_conformity(
             APISpec::get_all_spec_files(),
             Method::GET.as_str(),
-            "/certificate-pending",
+            "/",
             "application/json",
             &Null,
-            &build_json_response(200, CertificatePendingMessage::dummy()),
+            &build_json_response(200, AggregatorFeaturesMessage::dummy()),
             &StatusCode::OK,
         )
         .unwrap()
     }
 
     #[test]
     fn test_verify_conformity_with_non_expected_status_returns_error() {
-        let response = build_json_response(200, CertificatePendingMessage::dummy());
+        let response = build_json_response(200, AggregatorFeaturesMessage::dummy());
 
         let spec_file = APISpec::get_default_spec_file();
         let result = APISpec::verify_conformity(
             vec![spec_file.clone()],
             Method::GET.as_str(),
-            "/certificate-pending",
+            "/",
             "application/json",
             &Null,
             &response,
@@ -737,7 +747,7 @@ components:
             StatusCode::OK.as_u16()
         );
         let error_message = format!(
-            "OpenAPI invalid response in {spec_file} on route /certificate-pending, reason: {error_reason}\nresponse: {response:#?}"
+            "OpenAPI invalid response in {spec_file} on route /, reason: {error_reason}\nresponse: {response:#?}"
         );
         assert!(result.is_err());
         assert_eq!(result.err().unwrap().to_string(), error_message);
@@ -748,10 +758,10 @@ components:
         let result = APISpec::verify_conformity(
             vec![],
             Method::GET.as_str(),
-            "/certificate-pending",
+            "/",
             "application/json",
             &Null,
-            &build_json_response(200, CertificatePendingMessage::dummy()),
+            &build_json_response(200, AggregatorFeaturesMessage::dummy()),
             &StatusCode::OK,
         );
 

diff --git a/mithril-signer/Cargo.toml b/mithril-signer/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mithril-signer"
-version = "0.2.190"
+version = "0.2.191"
 description = "A Mithril Signer"
 authors = { workspace = true }
 edition = { workspace = true }

diff --git a/mithril-signer/src/lib.rs b/mithril-signer/src/lib.rs
@@ -18,9 +18,7 @@ pub mod store;
 
 pub use configuration::{Configuration, DefaultConfiguration};
 pub use entities::SignerEpochSettings;
-pub use message_adapters::{
-    FromEpochSettingsAdapter, FromPendingCertificateMessageAdapter, ToRegisterSignerMessageAdapter,
-};
+pub use message_adapters::{FromEpochSettingsAdapter, ToRegisterSignerMessageAdapter};
 pub use metrics::*;
 pub use runtime::*;
 

diff --git a/mithril-signer/src/message_adapters/from_pending_certificate_message.rs b/mithril-signer/src/message_adapters/from_pending_certificate_message.rs
diff --git a/mithril-signer/src/message_adapters/mod.rs b/mithril-signer/src/message_adapters/mod.rs
@@ -1,9 +1,7 @@
 mod from_epoch_settings;
-mod from_pending_certificate_message;
 mod to_register_signature_message;
 mod to_register_signer_message;
 
 pub use from_epoch_settings::FromEpochSettingsAdapter;
-pub use from_pending_certificate_message::FromPendingCertificateMessageAdapter;
 pub use to_register_signature_message::ToRegisterSignatureMessageAdapter;
 pub use to_register_signer_message::ToRegisterSignerMessageAdapter;