prost-protovalidate 0.3.0

Runtime validation for Protocol Buffer messages using buf.validate rules
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use std::collections::HashSet;

use prost_reflect::ReflectMessage;

use crate::config::ValidationConfig;
use crate::error::{Error, ValidationError};
use crate::violation::Violation;

pub(crate) struct FieldMaskRuleEval {
    r#const: Option<Vec<String>>,
    r#in: HashSet<String>,
    not_in: HashSet<String>,
}

impl FieldMaskRuleEval {
    pub fn new(rules: &prost_protovalidate_types::FieldMaskRules) -> Self {
        Self {
            r#const: rules.r#const.as_ref().map(|m| m.paths.clone()),
            r#in: rules.r#in.iter().cloned().collect(),
            not_in: rules.not_in.iter().cloned().collect(),
        }
    }

    pub fn tautology(&self) -> bool {
        self.r#const.is_none() && self.r#in.is_empty() && self.not_in.is_empty()
    }

    pub fn evaluate(
        &self,
        val: &prost_reflect::Value,
        _cfg: &ValidationConfig,
    ) -> Result<(), Error> {
        let msg = match val.as_message() {
            Some(m) if m.descriptor().full_name() == "google.protobuf.FieldMask" => m,
            _ => return Ok(()),
        };

        let paths = msg
            .get_field_by_name("paths")
            .map(|value| {
                value
                    .as_list()
                    .map(|list| {
                        list.iter()
                            .filter_map(|v| v.as_str().map(str::to_string))
                            .collect::<Vec<_>>()
                    })
                    .unwrap_or_default()
            })
            .unwrap_or_default();

        let mut violations = Vec::new();

        if let Some(expected) = &self.r#const {
            if &paths != expected {
                violations.push(Violation::new("", "field_mask.const", "must equal paths"));
            }
        }

        if !self.r#in.is_empty()
            && !paths
                .iter()
                .all(|path| self.r#in.iter().any(|allowed| path_matches(path, allowed)))
        {
            violations.push(Violation::new(
                "",
                "field_mask.in",
                "must only contain allowed paths",
            ));
        }

        if !self.not_in.is_empty()
            && paths.iter().any(|path| {
                self.not_in
                    .iter()
                    .any(|blocked| path_matches(path, blocked))
            })
        {
            violations.push(Violation::new(
                "",
                "field_mask.not_in",
                "must not contain forbidden paths",
            ));
        }

        if violations.is_empty() {
            Ok(())
        } else {
            Err(ValidationError::new(violations).into())
        }
    }
}

fn path_matches(path: &str, prefix: &str) -> bool {
    path == prefix || path.starts_with(&format!("{prefix}."))
}