p2panda-rs 0.7.0

// SPDX-License-Identifier: AGPL-3.0-or-later

use std::cmp::Ordering;
use std::collections::btree_map::Iter;
use std::collections::BTreeMap;
use std::fmt;

use serde::de::Visitor;
use serde::{Deserialize, Serialize};

use crate::operation::error::FieldsError;
use crate::operation::plain::PlainValue;
use crate::operation::{OperationFields, OperationValue};
use crate::schema::FieldName;

/// Operation fields which have not been checked against a schema yet.
#[derive(Clone, Serialize, Default, Debug, PartialEq)]
pub struct PlainFields(BTreeMap<FieldName, PlainValue>);

impl PlainFields {
    /// Returns a new instance of plain fields.
    pub(crate) fn new() -> Self {
        Self(BTreeMap::new())
    }

    /// Returns true when no field is given.
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Returns the number of fields.
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Gets a field from the list by name, returns `None` if it couldn't be found.
    pub fn get(&self, name: &str) -> Option<&PlainValue> {
        self.0.get(name)
    }

    /// Inserts a new field into the list.
    ///
    /// Returns an error when a duplicate field name was detected.
    pub fn insert(&mut self, name: &str, value: PlainValue) -> Result<(), FieldsError> {
        if self.0.contains_key(name) {
            Err(FieldsError::FieldDuplicate(name.to_owned()))
        } else {
            self.0.insert(name.to_owned(), value);
            Ok(())
        }
    }

    /// Iterates over the list of fields.
    pub fn iter(&self) -> Iter<FieldName, PlainValue> {
        self.0.iter()
    }
}

impl<'de> Deserialize<'de> for PlainFields {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        struct RawFieldsVisitor;

        impl<'de> Visitor<'de> for RawFieldsVisitor {
            type Value = PlainFields;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("p2panda operation fields")
            }

            fn visit_map<A>(self, mut map: A) -> Result<Self::Value, A::Error>
            where
                A: serde::de::MapAccess<'de>,
            {
                let mut fields = PlainFields::new();
                let mut last_field_name: String = String::new();

                while let Some(field_name) = map.next_key::<String>()? {
                    // Check that field names are sorted lexicographically to ensure canonic
                    // encoding
                    if last_field_name.cmp(&field_name) == Ordering::Greater {
                        return Err(serde::de::Error::custom(format!(
                            "encountered unsorted field name: '{}' should be before '{}'",
                            field_name, last_field_name,
                        )));
                    }

                    let field_value: PlainValue = map.next_value()?;
                    fields.insert(&field_name, field_value).map_err(|_| {
                        // Fail if field names are duplicate to ensure canonic encoding
                        serde::de::Error::custom(format!(
                            "encountered duplicate field key '{}'",
                            field_name
                        ))
                    })?;

                    last_field_name = field_name;
                }

                Ok(fields)
            }
        }

        deserializer.deserialize_map(RawFieldsVisitor)
    }
}

impl From<Vec<(&str, PlainValue)>> for PlainFields {
    fn from(spec: Vec<(&str, PlainValue)>) -> Self {
        let mut fields = PlainFields::new();

        for field in spec {
            if fields.insert(field.0, field.1).is_err() {
                // Silently ignore duplicates errors .. the underlying data type takes care of that
                // for us!
            }
        }

        fields
    }
}

impl From<&OperationFields> for PlainFields {
    fn from(fields: &OperationFields) -> Self {
        let mut raw = PlainFields::new();

        for (name, value) in fields.iter() {
            let raw_value = match value {
                OperationValue::Boolean(bool) => PlainValue::Boolean(*bool),
                OperationValue::Integer(int) => PlainValue::Integer(*int),
                OperationValue::Float(float) => PlainValue::Float(*float),
                OperationValue::String(str) => PlainValue::StringOrRelation(str.to_owned()),
                OperationValue::Relation(relation) => relation.document_id().to_owned().into(),
                OperationValue::RelationList(list) => list.document_ids().to_vec().into(),
                OperationValue::PinnedRelation(relation) => relation.view_id().to_owned().into(),
                OperationValue::PinnedRelationList(list) => {
                    list.document_view_ids().to_vec().into()
                }
            };

            // Unwrap here because we already know that there are no duplicates in
            // `OperationFields`
            raw.insert(name, raw_value).unwrap();
        }

        raw
    }
}

#[cfg(test)]
mod tests {
    use ciborium::cbor;
    use rstest::rstest;

    use crate::operation::plain::PlainValue;
    use crate::operation::OperationFields;
    use crate::serde::{deserialize_into, serialize_from, serialize_value};
    use crate::test_utils::fixtures::operation_fields;

    use super::PlainFields;

    #[test]
    fn insert_and_get_fields() {
        let mut fields = PlainFields::new();
        assert!(fields.is_empty());
        assert_eq!(fields.len(), 0);

        fields.insert("test", PlainValue::Boolean(true)).unwrap();
        assert!(!fields.is_empty());
        assert_eq!(fields.len(), 1);
        assert_eq!(fields.get("test"), Some(&PlainValue::Boolean(true)));
    }

    #[test]
    fn try_getting_inexistant_field() {
        let fields = PlainFields::new();
        assert!(fields.get("test").is_none());
    }

    #[rstest]
    fn from_operation_fields(operation_fields: OperationFields) {
        let fields = PlainFields::from(&operation_fields);
        assert_eq!(fields.len(), 8);
    }

    #[test]
    fn from_vec() {
        let fields = PlainFields::from(vec![
            ("it_works", PlainValue::Boolean(true)),
            (
                "it_works",
                PlainValue::StringOrRelation("... and ignores duplicates".into()),
            ),
        ]);
        assert_eq!(fields.len(), 1);
        assert_eq!(fields.get("it_works"), Some(&PlainValue::Boolean(true)));
    }

    #[test]
    fn serialize() {
        let mut fields = PlainFields::new();

        fields
            .insert("it_works", PlainValue::Boolean(true))
            .unwrap();
        fields
            .insert("message", PlainValue::StringOrRelation("mjau".into()))
            .unwrap();

        // This field was inserted last but will be ordered first
        fields
            .insert("a_first_field", PlainValue::Integer(5))
            .unwrap();

        let bytes = serialize_from(fields);

        assert_eq!(
            bytes,
            serialize_value(cbor!({
                "a_first_field" => 5,
                "it_works" => true,
                "message" => "mjau",
            }))
        );
    }

    #[test]
    fn deserialize() {
        let fields: PlainFields = deserialize_into(&serialize_value(cbor!({
            "a_first_field" => 5,
            "it_works" => true,
        })))
        .unwrap();
        assert_eq!(fields.len(), 2);
        assert_eq!(fields.get("it_works"), Some(&PlainValue::Boolean(true)));
    }

    #[test]
    fn fail_on_unordered_keys() {
        assert!(deserialize_into::<PlainValue>(&serialize_value(cbor!({
            "it_works" => true,
            "a_first_field" => 5,
        })))
        .is_err());
    }

    #[test]
    fn fail_on_duplicate_fields() {
        assert!(deserialize_into::<PlainValue>(&serialize_value(cbor!({
            "it_works" => false,
            "it_works" => "false",
        })))
        .is_err());
    }
}