fix(rust/signed-doc): parameters linked referenced document validation (#486)

* move parameters link validation under the parameters rule, added missing checks

* fix spelling

Author: Mr-Leshiy

rust/signed_doc/src/validator/mod.rs

@@ -12,8 +12,8 @@ use std::{
 use anyhow::Context;
 use catalyst_types::{catalyst_id::role_index::RoleId, problem_report::ProblemReport};
 use rules::{
-    ContentEncodingRule, ContentRule, ContentSchema, ContentTypeRule, LinkField,
-    ParameterLinkRefRule, ParametersRule, RefRule, ReplyRule, Rules, SectionRule, SignatureKidRule,
+    ContentEncodingRule, ContentRule, ContentSchema, ContentTypeRule, ParametersRule, RefRule,
+    ReplyRule, Rules, SectionRule, SignatureKidRule,
 };
 
 use crate::{
@@ -61,9 +61,6 @@ fn proposal_rule() -> Rules {
         kid: SignatureKidRule {
             exp: &[RoleId::Proposer],
         },
-        param_link_ref: ParameterLinkRefRule::Specified {
-            field: LinkField::Template,
-        },
     }
 }
 
@@ -89,7 +86,7 @@ fn proposal_comment_rule() -> Rules {
             exp_template_type: PROPOSAL_COMMENT_FORM_TEMPLATE.clone(),
         },
         doc_ref: RefRule::Specified {
-            exp_ref_type: PROPOSAL.clone(),
+            exp_ref_types: vec![PROPOSAL.clone()],
             optional: false,
         },
         reply: ReplyRule::Specified {
@@ -104,10 +101,6 @@ fn proposal_comment_rule() -> Rules {
         kid: SignatureKidRule {
             exp: &[RoleId::Role0],
         },
-        // Link field can be either template or ref
-        param_link_ref: ParameterLinkRefRule::Specified {
-            field: LinkField::Template,
-        },
     }
 }
 
@@ -146,17 +139,14 @@ fn proposal_submission_action_rule() -> Rules {
             optional: false,
         },
         doc_ref: RefRule::Specified {
-            exp_ref_type: PROPOSAL.clone(),
+            exp_ref_types: vec![PROPOSAL.clone()],
             optional: false,
         },
         reply: ReplyRule::NotSpecified,
         section: SectionRule::NotSpecified,
         kid: SignatureKidRule {
             exp: &[RoleId::Proposer],
         },
-        param_link_ref: ParameterLinkRefRule::Specified {
-            field: LinkField::Ref,
-        },
     }
 }
 

rust/signed_doc/src/validator/rules/doc_ref.rs

@@ -13,7 +13,7 @@ pub(crate) enum RefRule {
     /// Is 'ref' specified
     Specified {
         /// expected `type` field of the referenced doc
-        exp_ref_type: DocType,
+        exp_ref_types: Vec<DocType>,
         /// optional flag for the `ref` field
         optional: bool,
     },
@@ -32,13 +32,13 @@ impl RefRule {
     {
         let context: &str = "Ref rule check";
         if let Self::Specified {
-            exp_ref_type,
+            exp_ref_types,
             optional,
         } = self
         {
             if let Some(doc_ref) = doc.doc_meta().doc_ref() {
                 let ref_validator = |ref_doc: CatalystSignedDocument| {
-                    referenced_doc_check(&ref_doc, exp_ref_type, "ref", doc.report())
+                    referenced_doc_check(&ref_doc, exp_ref_types, "ref", doc.report())
                 };
                 return validate_doc_refs(doc_ref, provider, doc.report(), ref_validator).await;
             } else if !optional {
@@ -65,7 +65,7 @@ impl RefRule {
 /// A generic implementation of the referenced document validation.
 pub(crate) fn referenced_doc_check(
     ref_doc: &CatalystSignedDocument,
-    exp_ref_type: &DocType,
+    exp_ref_types: &[DocType],
     field_name: &str,
     report: &ProblemReport,
 ) -> bool {
@@ -74,12 +74,18 @@ pub(crate) fn referenced_doc_check(
         return false;
     };
 
-    if ref_doc_type != exp_ref_type {
+    // Check that the type matches one of the expected ones
+    if exp_ref_types
+        .iter()
+        .all(|exp_type| ref_doc_type != exp_type)
+    {
         report.invalid_value(
             field_name,
             &ref_doc_type.to_string(),
-            &exp_ref_type.to_string(),
-            "Invalid referenced document type",
+            &exp_ref_types
+                .iter()
+                .fold(String::new(), |s, v| format!("{s}, {v}")),
+            &format!("Invalid referenced document type, during validation of {field_name} field"),
         );
         return false;
     }
@@ -150,7 +156,7 @@ mod tests {
         // Create a document where `ref` field is required and referencing a valid document in
         // provider. Using doc ref of new implementation.
         let rule = RefRule::Specified {
-            exp_ref_type: exp_ref_type.into(),
+            exp_ref_types: vec![exp_ref_type.into()],
             optional: false,
         };
         let doc = Builder::new()
@@ -201,15 +207,15 @@ mod tests {
 
         // All correct, `ref` field is missing, but its optional
         let rule = RefRule::Specified {
-            exp_ref_type: exp_ref_type.into(),
+            exp_ref_types: vec![exp_ref_type.into()],
             optional: true,
         };
         let doc = Builder::new().build();
         assert!(rule.check(&doc, &provider).await.unwrap());
 
         // Missing `ref` field, but its required
         let rule = RefRule::Specified {
-            exp_ref_type: exp_ref_type.into(),
+            exp_ref_types: vec![exp_ref_type.into()],
             optional: false,
         };
         let doc = Builder::new().build();

rust/signed_doc/src/validator/rules/mod.rs

@@ -8,7 +8,6 @@ use crate::{providers::CatalystSignedDocumentProvider, CatalystSignedDocument};
 mod content_encoding;
 mod content_type;
 mod doc_ref;
-mod param_link_ref;
 mod parameters;
 mod reply;
 mod section;
@@ -18,7 +17,6 @@ mod template;
 pub(crate) use content_encoding::ContentEncodingRule;
 pub(crate) use content_type::ContentTypeRule;
 pub(crate) use doc_ref::RefRule;
-pub(crate) use param_link_ref::{LinkField, ParameterLinkRefRule};
 pub(crate) use parameters::ParametersRule;
 pub(crate) use reply::ReplyRule;
 pub(crate) use section::SectionRule;
@@ -43,8 +41,6 @@ pub(crate) struct Rules {
     pub(crate) parameters: ParametersRule,
     /// `kid` field validation rule
     pub(crate) kid: SignatureKidRule,
-    /// Link reference rule
-    pub(crate) param_link_ref: ParameterLinkRefRule,
 }
 
 impl Rules {
@@ -66,7 +62,6 @@ impl Rules {
             self.section.check(doc).boxed(),
             self.parameters.check(doc, provider).boxed(),
             self.kid.check(doc).boxed(),
-            self.param_link_ref.check(doc, provider).boxed(),
         ];
 
         let res = futures::future::join_all(rules)