diff --git a/rust/signed_doc/src/doc_types/mod.rs b/rust/signed_doc/src/doc_types/mod.rs index 2a2c22735e..79939755b3 100644 --- a/rust/signed_doc/src/doc_types/mod.rs +++ b/rust/signed_doc/src/doc_types/mod.rs @@ -4,16 +4,41 @@ use std::sync::LazyLock; use catalyst_types::uuid::Uuid; -use deprecated::{ - COMMENT_DOCUMENT_UUID_TYPE, PROPOSAL_ACTION_DOCUMENT_UUID_TYPE, PROPOSAL_DOCUMENT_UUID_TYPE, -}; use crate::DocType; +/// -------------- Document Types -------------- +/// Brand document type. +#[allow(clippy::expect_used)] +pub static BRAND_PARAMETERS: LazyLock = LazyLock::new(|| { + let ids = &[BRAND_BASE_TYPE]; + ids.to_vec() + .try_into() + .expect("Failed to convert brand base types Uuid to DocType") +}); + +/// Campaign Parameters document type. +#[allow(clippy::expect_used)] +pub static CAMPAIGN_PARAMETERS: LazyLock = LazyLock::new(|| { + let ids = &[CAMPAIGN_BASE_TYPE]; + ids.to_vec() + .try_into() + .expect("Failed to convert campaign base types Uuid to DocType") +}); + +/// Category Parameters document type. +#[allow(clippy::expect_used)] +pub static CATEGORY_PARAMETERS: LazyLock = LazyLock::new(|| { + let ids = &[CATEGORY_BASE_TYPE]; + ids.to_vec() + .try_into() + .expect("Failed to convert category base types Uuid to DocType") +}); + /// Proposal document type. #[allow(clippy::expect_used)] -pub static PROPOSAL_DOC_TYPE: LazyLock = LazyLock::new(|| { - let ids = &[PROPOSAL_UUID_TYPE]; +pub static PROPOSAL: LazyLock = LazyLock::new(|| { + let ids = &[PROPOSAL_BASE_TYPE]; ids.to_vec() .try_into() .expect("Failed to convert proposal document Uuid to DocType") @@ -21,8 +46,8 @@ pub static PROPOSAL_DOC_TYPE: LazyLock = LazyLock::new(|| { /// Proposal comment document type. #[allow(clippy::expect_used)] -pub static PROPOSAL_COMMENT_DOC: LazyLock = LazyLock::new(|| { - let ids = &[COMMENT_UUID_TYPE, PROPOSAL_UUID_TYPE]; +pub static PROPOSAL_COMMENT: LazyLock = LazyLock::new(|| { + let ids = &[COMMENT_BASE_TYPE, PROPOSAL_BASE_TYPE]; ids.to_vec() .try_into() .expect("Failed to convert proposal comment document Uuid to DocType") @@ -30,26 +55,72 @@ pub static PROPOSAL_COMMENT_DOC: LazyLock = LazyLock::new(|| { /// Proposal action document type. #[allow(clippy::expect_used)] -pub static PROPOSAL_ACTION_DOC: LazyLock = LazyLock::new(|| { +pub static PROPOSAL_SUBMISSION_ACTION: LazyLock = LazyLock::new(|| { let ids = &[ - ACTION_UUID_TYPE, - PROPOSAL_UUID_TYPE, - SUBMISSION_ACTION_UUID_TYPE, + ACTION_BASE_TYPE, + PROPOSAL_BASE_TYPE, + SUBMISSION_ACTION_BASE_TYPE, ]; ids.to_vec() .try_into() .expect("Failed to convert proposal action document Uuid to DocType") }); -/// Submission Action UUID type. -pub const SUBMISSION_ACTION_UUID_TYPE: Uuid = +/// Proposal Comment Meta Template document type. +#[allow(clippy::expect_used)] +pub static PROPOSAL_COMMENT_META_TEMPLATE: LazyLock = LazyLock::new(|| { + let ids = &[ + TEMPLATE_BASE_TYPE, + TEMPLATE_BASE_TYPE, + COMMENT_BASE_TYPE, + PROPOSAL_BASE_TYPE, + ]; + ids.to_vec() + .try_into() + .expect("Failed to convert proposal comment meta template document Uuid to DocType") +}); + +/// Proposal Comment Template document type. +#[allow(clippy::expect_used)] +pub static PROPOSAL_COMMENT_TEMPLATE: LazyLock = LazyLock::new(|| { + let ids = &[TEMPLATE_BASE_TYPE, COMMENT_BASE_TYPE, PROPOSAL_BASE_TYPE]; + ids.to_vec() + .try_into() + .expect("Failed to convert proposal comment template document Uuid to DocType") +}); + +/// Proposal Template document type. +#[allow(clippy::expect_used)] +pub static PROPOSAL_TEMPLATE: LazyLock = LazyLock::new(|| { + let ids = &[TEMPLATE_BASE_TYPE, PROPOSAL_BASE_TYPE]; + ids.to_vec() + .try_into() + .expect("Failed to convert proposal template document Uuid to DocType") +}); + +/// -------------- Base Types -------------- +/// Action UUID base type. +pub const ACTION_BASE_TYPE: Uuid = Uuid::from_u128(0x5E60_E623_AD02_4A1B_A1AC_406D_B978_EE48); +/// Brand UUID base type. +pub const BRAND_BASE_TYPE: Uuid = Uuid::from_u128(0xEBCA_BEEB_5BC5_4F95_91E8_CAB8_CA72_4172); +/// Campaign UUID base type. +pub const CAMPAIGN_BASE_TYPE: Uuid = Uuid::from_u128(0x5EF3_2D5D_F240_462C_A7A4_BA4A_F221_FA23); +/// Category UUID base type. +pub const CATEGORY_BASE_TYPE: Uuid = Uuid::from_u128(0x8189_38C3_3139_4DAA_AFE6_974C_7848_8E95); +/// Comment UUID base type. +pub const COMMENT_BASE_TYPE: Uuid = Uuid::from_u128(0xB679_DED3_0E7C_41BA_89F8_DA62_A178_98EA); +/// Decision UUID base type. +pub const DECISION_BASE_TYPE: Uuid = Uuid::from_u128(0x788F_F4C6_D65A_451F_BB33_575F_E056_B411); +/// Moderation Action UUID base type. +pub const MODERATION_ACTION_BASE_TYPE: Uuid = + Uuid::from_u128(0xA5D2_32B8_5E03_4117_9AFD_BE32_B878_FCDD); +/// Proposal UUID base type. +pub const PROPOSAL_BASE_TYPE: Uuid = Uuid::from_u128(0x7808_D2BA_D511_40AF_84E8_C0D1_625F_DFDC); +/// Submission Action UUID base type. +pub const SUBMISSION_ACTION_BASE_TYPE: Uuid = Uuid::from_u128(0x7892_7329_CFD9_4EA1_9C71_0E01_9B12_6A65); -/// Proposal UUID type. -pub const PROPOSAL_UUID_TYPE: Uuid = PROPOSAL_DOCUMENT_UUID_TYPE; -/// Comment UUID type. -pub const COMMENT_UUID_TYPE: Uuid = COMMENT_DOCUMENT_UUID_TYPE; -/// Action UUID type. -pub const ACTION_UUID_TYPE: Uuid = PROPOSAL_ACTION_DOCUMENT_UUID_TYPE; +/// Template UUID base type. +pub const TEMPLATE_BASE_TYPE: Uuid = Uuid::from_u128(0x0CE8_AB38_9258_4FBC_A62E_7FAA_6E58_318F); /// Document type which will be deprecated. pub mod deprecated { diff --git a/rust/signed_doc/src/metadata/doc_type.rs b/rust/signed_doc/src/metadata/doc_type.rs index a7b0886420..c55a45be5e 100644 --- a/rust/signed_doc/src/metadata/doc_type.rs +++ b/rust/signed_doc/src/metadata/doc_type.rs @@ -5,17 +5,15 @@ use std::{ hash::{Hash, Hasher}, }; -use catalyst_types::uuid::{CborContext, Uuid, UuidV4}; +use catalyst_types::uuid::{CborContext, Uuid, UuidV4, UUID_CBOR_TAG}; +use coset::cbor::Value; use minicbor::{Decode, Decoder, Encode}; use serde::{Deserialize, Deserializer}; use tracing::warn; use crate::{ decode_context::{CompatibilityPolicy, DecodeContext}, - doc_types::{ - ACTION_UUID_TYPE, COMMENT_UUID_TYPE, PROPOSAL_ACTION_DOC, PROPOSAL_COMMENT_DOC, - PROPOSAL_DOC_TYPE, PROPOSAL_UUID_TYPE, - }, + doc_types::{deprecated, PROPOSAL, PROPOSAL_COMMENT, PROPOSAL_SUBMISSION_ACTION}, }; /// List of `UUIDv4` document type. @@ -87,6 +85,18 @@ impl TryFrom> for DocType { } } +impl From for Vec { + fn from(value: DocType) -> Vec { + value.0.into_iter().map(Uuid::from).collect() + } +} + +impl From for Vec { + fn from(val: DocType) -> Self { + val.0.into_iter().map(|uuid| uuid.to_string()).collect() + } +} + impl TryFrom> for DocType { type Error = DocTypeError; @@ -231,9 +241,11 @@ impl Decode<'_, DecodeContext<'_>> for DocType { /// fn map_doc_type(uuid: UuidV4) -> DocType { match uuid { - id if Uuid::from(id) == PROPOSAL_UUID_TYPE => PROPOSAL_DOC_TYPE.clone(), - id if Uuid::from(id) == COMMENT_UUID_TYPE => PROPOSAL_COMMENT_DOC.clone(), - id if Uuid::from(id) == ACTION_UUID_TYPE => PROPOSAL_ACTION_DOC.clone(), + id if Uuid::from(id) == deprecated::PROPOSAL_DOCUMENT_UUID_TYPE => PROPOSAL.clone(), + id if Uuid::from(id) == deprecated::COMMENT_DOCUMENT_UUID_TYPE => PROPOSAL_COMMENT.clone(), + id if Uuid::from(id) == deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE => { + PROPOSAL_SUBMISSION_ACTION.clone() + }, id => DocType(vec![id]), } } @@ -284,15 +296,35 @@ impl<'de> Deserialize<'de> for DocType { } } +impl From for Value { + fn from(value: DocType) -> Self { + Value::Array( + value + .0 + .iter() + .map(|uuidv4| { + Value::Tag( + UUID_CBOR_TAG, + Box::new(Value::Bytes(uuidv4.uuid().as_bytes().to_vec())), + ) + }) + .collect(), + ) + } +} + // This is needed to preserve backward compatibility with the old solution. impl PartialEq for DocType { fn eq(&self, other: &Self) -> bool { // List of special-case (single UUID) -> new DocType // The old one should equal to the new one let special_cases = [ - (PROPOSAL_UUID_TYPE, &*PROPOSAL_DOC_TYPE), - (COMMENT_UUID_TYPE, &*PROPOSAL_COMMENT_DOC), - (ACTION_UUID_TYPE, &*PROPOSAL_ACTION_DOC), + (deprecated::PROPOSAL_DOCUMENT_UUID_TYPE, &*PROPOSAL), + (deprecated::COMMENT_DOCUMENT_UUID_TYPE, &*PROPOSAL_COMMENT), + ( + deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE, + &*PROPOSAL_SUBMISSION_ACTION, + ), ]; for (uuid, expected) in special_cases { match DocType::try_from(uuid) { @@ -416,21 +448,33 @@ mod tests { assert!(matches!(result, Err(DocTypeError::StringConversion(s)) if s == "not-a-uuid")); } + #[test] + fn test_doc_type_to_value() { + let uuid = uuid::Uuid::new_v4(); + let doc_type: Value = DocType(vec![UuidV4::try_from(uuid).unwrap()]).into(); + + for d in &doc_type.into_array().unwrap() { + let t = d.clone().into_tag().unwrap(); + assert_eq!(t.0, UUID_CBOR_TAG); + assert_eq!(t.1.as_bytes().unwrap().len(), 16); + } + } + #[test] fn test_doctype_equal_special_cases() { // Direct equal - let uuid: UuidV4 = PROPOSAL_UUID_TYPE.try_into().unwrap(); + let uuid = deprecated::PROPOSAL_DOCUMENT_UUID_TYPE; let dt1 = DocType::try_from(vec![uuid]).unwrap(); let dt2 = DocType::try_from(vec![uuid]).unwrap(); assert_eq!(dt1, dt2); // single -> special mapped type - let single = DocType::try_from(PROPOSAL_UUID_TYPE).unwrap(); - assert_eq!(single, *PROPOSAL_DOC_TYPE); - let single = DocType::try_from(COMMENT_UUID_TYPE).unwrap(); - assert_eq!(single, *PROPOSAL_COMMENT_DOC); - let single = DocType::try_from(ACTION_UUID_TYPE).unwrap(); - assert_eq!(single, *PROPOSAL_ACTION_DOC); + let single = DocType::try_from(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap(); + assert_eq!(single, *PROPOSAL); + let single = DocType::try_from(deprecated::COMMENT_DOCUMENT_UUID_TYPE).unwrap(); + assert_eq!(single, *PROPOSAL_COMMENT); + let single = DocType::try_from(deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE).unwrap(); + assert_eq!(single, *PROPOSAL_SUBMISSION_ACTION); } #[test] @@ -459,10 +503,10 @@ mod tests { #[test] fn test_deserialize_special_case() { - let uuid = PROPOSAL_UUID_TYPE.to_string(); + let uuid = deprecated::PROPOSAL_DOCUMENT_UUID_TYPE.to_string(); let json = json!(uuid); let dt: DocType = serde_json::from_value(json).unwrap(); - assert_eq!(dt, *PROPOSAL_DOC_TYPE); + assert_eq!(dt, *PROPOSAL); } } diff --git a/rust/signed_doc/src/validator/mod.rs b/rust/signed_doc/src/validator/mod.rs index c5acfb3a9e..de498d61e4 100644 --- a/rust/signed_doc/src/validator/mod.rs +++ b/rust/signed_doc/src/validator/mod.rs @@ -5,7 +5,7 @@ pub(crate) mod utils; use std::{ collections::HashMap, - sync::LazyLock, + sync::{Arc, LazyLock}, time::{Duration, SystemTime}, }; @@ -18,11 +18,8 @@ use rules::{ use crate::{ doc_types::{ - deprecated::{ - CATEGORY_DOCUMENT_UUID_TYPE, COMMENT_TEMPLATE_UUID_TYPE, PROPOSAL_TEMPLATE_UUID_TYPE, - }, - COMMENT_UUID_TYPE, PROPOSAL_ACTION_DOC, PROPOSAL_COMMENT_DOC, PROPOSAL_DOC_TYPE, - PROPOSAL_UUID_TYPE, + deprecated::{self}, + PROPOSAL, PROPOSAL_COMMENT, PROPOSAL_SUBMISSION_ACTION, }, metadata::DocType, providers::{CatalystSignedDocumentProvider, VerifyingKeyProvider}, @@ -31,7 +28,7 @@ use crate::{ }; /// A table representing a full set or validation rules per document id. -static DOCUMENT_RULES: LazyLock> = LazyLock::new(document_rules_init); +static DOCUMENT_RULES: LazyLock>> = LazyLock::new(document_rules_init); /// Returns an `DocType` from the provided argument. /// Reduce redundant conversion. @@ -47,7 +44,7 @@ where /// `DOCUMENT_RULES` initialization function #[allow(clippy::expect_used)] -fn document_rules_init() -> HashMap { +fn document_rules_init() -> HashMap> { let mut document_rules_map = HashMap::new(); let proposal_document_rules = Rules { @@ -59,10 +56,10 @@ fn document_rules_init() -> HashMap { optional: false, }, content: ContentRule::Templated { - exp_template_type: expect_doc_type(PROPOSAL_TEMPLATE_UUID_TYPE), + exp_template_type: expect_doc_type(deprecated::PROPOSAL_TEMPLATE_UUID_TYPE), }, parameters: ParametersRule::Specified { - exp_parameters_type: expect_doc_type(CATEGORY_DOCUMENT_UUID_TYPE), + exp_parameters_type: expect_doc_type(deprecated::CATEGORY_DOCUMENT_UUID_TYPE), optional: true, }, doc_ref: RefRule::NotSpecified, @@ -73,8 +70,6 @@ fn document_rules_init() -> HashMap { }, }; - document_rules_map.insert(PROPOSAL_DOC_TYPE.clone(), proposal_document_rules); - let comment_document_rules = Rules { content_type: ContentTypeRule { exp: ContentType::Json, @@ -84,14 +79,14 @@ fn document_rules_init() -> HashMap { optional: false, }, content: ContentRule::Templated { - exp_template_type: expect_doc_type(COMMENT_TEMPLATE_UUID_TYPE), + exp_template_type: expect_doc_type(deprecated::COMMENT_TEMPLATE_UUID_TYPE), }, doc_ref: RefRule::Specified { - exp_ref_type: expect_doc_type(PROPOSAL_UUID_TYPE), + exp_ref_type: expect_doc_type(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE), optional: false, }, reply: ReplyRule::Specified { - exp_reply_type: expect_doc_type(COMMENT_UUID_TYPE), + exp_reply_type: expect_doc_type(deprecated::COMMENT_DOCUMENT_UUID_TYPE), optional: true, }, section: SectionRule::Specified { optional: true }, @@ -100,7 +95,6 @@ fn document_rules_init() -> HashMap { exp: &[RoleId::Role0], }, }; - document_rules_map.insert(PROPOSAL_COMMENT_DOC.clone(), comment_document_rules); let proposal_action_json_schema = jsonschema::options() .with_draft(jsonschema::Draft::Draft7) @@ -121,11 +115,11 @@ fn document_rules_init() -> HashMap { }, content: ContentRule::Static(ContentSchema::Json(proposal_action_json_schema)), parameters: ParametersRule::Specified { - exp_parameters_type: expect_doc_type(CATEGORY_DOCUMENT_UUID_TYPE), + exp_parameters_type: expect_doc_type(deprecated::CATEGORY_DOCUMENT_UUID_TYPE), optional: true, }, doc_ref: RefRule::Specified { - exp_ref_type: expect_doc_type(PROPOSAL_UUID_TYPE), + exp_ref_type: expect_doc_type(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE), optional: false, }, reply: ReplyRule::NotSpecified, @@ -135,9 +129,25 @@ fn document_rules_init() -> HashMap { }, }; + let proposal_rules = Arc::new(proposal_document_rules); + let comment_rules = Arc::new(comment_document_rules); + let action_rules = Arc::new(proposal_submission_action_rules); + + document_rules_map.insert(PROPOSAL.clone(), Arc::clone(&proposal_rules)); + document_rules_map.insert(PROPOSAL_COMMENT.clone(), Arc::clone(&comment_rules)); + document_rules_map.insert( + PROPOSAL_SUBMISSION_ACTION.clone(), + Arc::clone(&action_rules), + ); + + // Insert old rules (for backward compatibility) + document_rules_map.insert( + expect_doc_type(deprecated::COMMENT_DOCUMENT_UUID_TYPE), + Arc::clone(&comment_rules), + ); document_rules_map.insert( - PROPOSAL_ACTION_DOC.clone(), - proposal_submission_action_rules, + expect_doc_type(deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE), + Arc::clone(&action_rules), ); document_rules_map diff --git a/rust/signed_doc/tests/comment.rs b/rust/signed_doc/tests/comment.rs index 5725e3080c..9c03630b79 100644 --- a/rust/signed_doc/tests/comment.rs +++ b/rust/signed_doc/tests/comment.rs @@ -1,6 +1,8 @@ //! Integration test for comment document validation part. -use catalyst_signed_doc::{providers::tests::TestCatalystSignedDocumentProvider, *}; +use catalyst_signed_doc::{ + doc_types::deprecated, providers::tests::TestCatalystSignedDocumentProvider, *, +}; use catalyst_types::catalyst_id::role_index::RoleId; mod common; @@ -8,16 +10,16 @@ mod common; #[tokio::test] async fn test_valid_comment_doc() { let (proposal_doc, proposal_doc_id, proposal_doc_ver) = - common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap(); let (template_doc, template_doc_id, template_doc_ver) = - common::create_dummy_doc(doc_types::deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap(); let uuid_v7 = UuidV7::new(); let (doc, ..) = common::create_dummy_signed_doc( serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_COMMENT_DOC.clone(), + "type": doc_types::PROPOSAL_COMMENT.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "template": { @@ -46,9 +48,9 @@ async fn test_valid_comment_doc() { #[tokio::test] async fn test_valid_comment_doc_old_type() { let (proposal_doc, proposal_doc_id, proposal_doc_ver) = - common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap(); let (template_doc, template_doc_id, template_doc_ver) = - common::create_dummy_doc(doc_types::deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap(); let uuid_v7 = UuidV7::new(); let (doc, ..) = common::create_dummy_signed_doc( @@ -56,7 +58,7 @@ async fn test_valid_comment_doc_old_type() { "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), // Using old (single uuid) - "type": doc_types::deprecated::COMMENT_DOCUMENT_UUID_TYPE, + "type": deprecated::COMMENT_DOCUMENT_UUID_TYPE, "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "template": { @@ -87,9 +89,9 @@ async fn test_valid_comment_doc_with_reply() { let empty_json = serde_json::to_vec(&serde_json::json!({})).unwrap(); let (proposal_doc, proposal_doc_id, proposal_doc_ver) = - common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap(); let (template_doc, template_doc_id, template_doc_ver) = - common::create_dummy_doc(doc_types::deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap(); let comment_doc_id = UuidV7::new(); let comment_doc_ver = UuidV7::new(); @@ -97,7 +99,7 @@ async fn test_valid_comment_doc_with_reply() { .with_json_metadata(serde_json::json!({ "id": comment_doc_id, "ver": comment_doc_ver, - "type": doc_types::PROPOSAL_COMMENT_DOC.clone(), + "type": doc_types::PROPOSAL_COMMENT.clone(), "content-type": ContentType::Json.to_string(), "template": { "id": template_doc_id.to_string(), "ver": template_doc_ver.to_string() }, "ref": { @@ -114,7 +116,7 @@ async fn test_valid_comment_doc_with_reply() { serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_COMMENT_DOC.clone(), + "type": doc_types::PROPOSAL_COMMENT.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "template": { @@ -147,16 +149,17 @@ async fn test_valid_comment_doc_with_reply() { #[tokio::test] async fn test_invalid_comment_doc() { - let (proposal_doc, ..) = common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap(); + let (proposal_doc, ..) = + common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap(); let (template_doc, template_doc_id, template_doc_ver) = - common::create_dummy_doc(doc_types::deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::COMMENT_TEMPLATE_UUID_TYPE).unwrap(); let uuid_v7 = UuidV7::new(); let (doc, ..) = common::create_dummy_signed_doc( serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_COMMENT_DOC.clone(), + "type": doc_types::PROPOSAL_COMMENT.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "template": { diff --git a/rust/signed_doc/tests/decoding.rs b/rust/signed_doc/tests/decoding.rs index 1d8b4354ea..a8b8220523 100644 --- a/rust/signed_doc/tests/decoding.rs +++ b/rust/signed_doc/tests/decoding.rs @@ -1,6 +1,6 @@ //! Integration test for COSE decoding part. -use catalyst_signed_doc::{providers::tests::TestVerifyingKeyProvider, *}; +use catalyst_signed_doc::{doc_types::deprecated, providers::tests::TestVerifyingKeyProvider, *}; use catalyst_types::catalyst_id::role_index::RoleId; use common::create_dummy_key_pair; use coset::{CborSerializable, TaggedCborSerializable}; @@ -13,7 +13,7 @@ mod common; async fn catalyst_signed_doc_parameters_aliases_test() { catalyst_signed_doc_parameters_aliases(common::test_metadata()).await; catalyst_signed_doc_parameters_aliases(common::test_metadata_specific_type( - Some(doc_types::PROPOSAL_UUID_TYPE.try_into().unwrap()), + Some(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE.try_into().unwrap()), None, )) .await; diff --git a/rust/signed_doc/tests/proposal.rs b/rust/signed_doc/tests/proposal.rs index 7e6f4f21d7..5cc071fd01 100644 --- a/rust/signed_doc/tests/proposal.rs +++ b/rust/signed_doc/tests/proposal.rs @@ -15,7 +15,7 @@ async fn test_valid_proposal_doc() { serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_DOC_TYPE.clone(), + "type": doc_types::PROPOSAL.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "template": { @@ -79,7 +79,7 @@ async fn test_valid_proposal_doc_with_empty_provider() { serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_DOC_TYPE.clone(), + "type": doc_types::PROPOSAL.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "template": { @@ -106,7 +106,7 @@ async fn test_invalid_proposal_doc() { serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_DOC_TYPE.clone(), + "type": doc_types::PROPOSAL.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), // without specifying template id diff --git a/rust/signed_doc/tests/submission.rs b/rust/signed_doc/tests/submission.rs index dc2ea5d56a..5601f51c75 100644 --- a/rust/signed_doc/tests/submission.rs +++ b/rust/signed_doc/tests/submission.rs @@ -1,6 +1,8 @@ //! Test for proposal submission action. -use catalyst_signed_doc::{providers::tests::TestCatalystSignedDocumentProvider, *}; +use catalyst_signed_doc::{ + doc_types::deprecated, providers::tests::TestCatalystSignedDocumentProvider, *, +}; use catalyst_types::catalyst_id::role_index::RoleId; mod common; @@ -8,14 +10,14 @@ mod common; #[tokio::test] async fn test_valid_submission_action() { let (proposal_doc, proposal_doc_id, proposal_doc_ver) = - common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap(); let uuid_v7 = UuidV7::new(); let (doc, ..) = common::create_dummy_signed_doc( serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_ACTION_DOC.clone(), + "type": doc_types::PROPOSAL_SUBMISSION_ACTION.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "ref": { @@ -40,7 +42,7 @@ async fn test_valid_submission_action() { #[tokio::test] async fn test_valid_submission_action_old_type() { let (proposal_doc, proposal_doc_id, proposal_doc_ver) = - common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap(); let uuid_v7 = UuidV7::new(); let (doc, ..) = common::create_dummy_signed_doc( @@ -48,7 +50,7 @@ async fn test_valid_submission_action_old_type() { "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), // Using old (single uuid) - "type": doc_types::deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE, + "type": deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE, "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "ref": { @@ -80,7 +82,7 @@ async fn test_valid_submission_action_with_empty_provider() { serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_ACTION_DOC.clone(), + "type": doc_types::PROPOSAL_SUBMISSION_ACTION.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "ref": { @@ -111,7 +113,7 @@ async fn test_invalid_submission_action() { serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_ACTION_DOC.clone(), + "type": doc_types::PROPOSAL_SUBMISSION_ACTION.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), // without specifying ref @@ -131,13 +133,13 @@ async fn test_invalid_submission_action() { // corrupted JSON let (proposal_doc, proposal_doc_id, proposal_doc_ver) = - common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap(); let uuid_v7 = UuidV7::new(); let (doc, ..) = common::create_dummy_signed_doc( serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::ACTION_UUID_TYPE, + "type": deprecated::PROPOSAL_ACTION_DOCUMENT_UUID_TYPE, "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "ref": { @@ -157,13 +159,13 @@ async fn test_invalid_submission_action() { // empty content let (proposal_doc, proposal_doc_id, proposal_doc_ver) = - common::create_dummy_doc(doc_types::PROPOSAL_UUID_TYPE).unwrap(); + common::create_dummy_doc(deprecated::PROPOSAL_DOCUMENT_UUID_TYPE).unwrap(); let uuid_v7 = UuidV7::new(); let (doc, ..) = common::create_dummy_signed_doc( serde_json::json!({ "content-type": ContentType::Json.to_string(), "content-encoding": ContentEncoding::Brotli.to_string(), - "type": doc_types::PROPOSAL_ACTION_DOC.clone(), + "type": doc_types::PROPOSAL_SUBMISSION_ACTION.clone(), "id": uuid_v7.to_string(), "ver": uuid_v7.to_string(), "ref": {