uqa-core 0.4.0

Document sets, finite-support relations, posting storage, and value types for UQA
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! PUBLIC and a named ACL recipient have distinct durable representations.

use serde::{Deserialize, Deserializer, Serialize};

/// A named recipient can have any valid role spelling, including the quoted name `PUBLIC`.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Serialize)]
#[serde(tag = "kind", content = "name", rename_all = "snake_case")]
pub enum AclGrantee {
    Public,
    Role(String),
}

impl AclGrantee {
    #[must_use]
    pub fn role_name(&self) -> Option<&str> {
        match self {
            Self::Public => None,
            Self::Role(name) => Some(name),
        }
    }

    #[must_use]
    pub const fn is_public(&self) -> bool {
        matches!(self, Self::Public)
    }
}

impl From<String> for AclGrantee {
    fn from(name: String) -> Self {
        Self::Role(name)
    }
}

impl From<&str> for AclGrantee {
    fn from(name: &str) -> Self {
        Self::Role(name.into())
    }
}

impl std::fmt::Display for AclGrantee {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter.write_str(self.role_name().unwrap_or("PUBLIC"))
    }
}

impl<'de> Deserialize<'de> for AclGrantee {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        #[derive(Deserialize)]
        #[serde(
            tag = "kind",
            content = "name",
            rename_all = "snake_case",
            deny_unknown_fields
        )]
        enum Tagged {
            Public,
            Role(String),
        }
        #[derive(Deserialize)]
        #[serde(untagged)]
        enum Stored {
            Tagged(Tagged),
            Legacy(String),
        }
        Ok(match Stored::deserialize(deserializer)? {
            Stored::Tagged(Tagged::Public) => Self::Public,
            // Legacy ACLs encoded the PUBLIC recipient as this exact string. No role-catalog lookup can recover a different original intent from those bytes.
            Stored::Legacy(name) if name == "PUBLIC" => Self::Public,
            Stored::Tagged(Tagged::Role(name)) | Stored::Legacy(name) => Self::Role(name),
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn public_and_keyword_spelled_named_recipients_round_trip_separately() {
        let grantees = [
            AclGrantee::Public,
            AclGrantee::Role("PUBLIC".into()),
            AclGrantee::Role("CURRENT_USER".into()),
            AclGrantee::Role("SESSION_USER".into()),
            AclGrantee::Role("reader".into()),
        ];
        let mut encoded = std::collections::BTreeSet::new();
        for grantee in grantees {
            let json = serde_json::to_string(&grantee).unwrap();
            assert!(encoded.insert(json.clone()));
            assert_eq!(serde_json::from_str::<AclGrantee>(&json).unwrap(), grantee);
        }
        assert!(!AclGrantee::from("PUBLIC").is_public());
        assert_eq!(AclGrantee::Public.role_name(), None);
    }

    #[test]
    fn legacy_acl_strings_preserve_their_stored_grantee_meaning() {
        for (name, expected) in [
            ("PUBLIC", AclGrantee::Public),
            ("CURRENT_USER", AclGrantee::Role("CURRENT_USER".into())),
            ("SESSION_USER", AclGrantee::Role("SESSION_USER".into())),
            ("reader", AclGrantee::Role("reader".into())),
        ] {
            let json = serde_json::to_string(name).unwrap();
            assert_eq!(serde_json::from_str::<AclGrantee>(&json).unwrap(), expected);
        }
    }

    #[test]
    fn malformed_current_grantees_never_become_public_or_legacy_names() {
        for json in [
            r#"{"kind":"unknown","name":"PUBLIC"}"#,
            r#"{"kind":"role"}"#,
            r#"{"kind":"role","name":null}"#,
            r#"{"kind":null,"name":"PUBLIC"}"#,
            r#"{"name":"PUBLIC"}"#,
            r#"{"kind":"public","name":"reader"}"#,
            "null",
            "42",
        ] {
            assert!(serde_json::from_str::<AclGrantee>(json).is_err(), "{json}");
        }
    }
}