p2panda-rs 0.9.0

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

use once_cell::sync::Lazy;
use regex::Regex;

use crate::hash::Hash;
use crate::operation::plain::{PlainFields, PlainValue};
use crate::schema::validate::error::SchemaDefinitionError;

/// Checks "name" field of operations with "schema_definition_v1" schema id.
///
/// 1. It must be at most 64 characters long
/// 2. It begins with a letter
/// 3. It uses only alphanumeric characters, digits and the underscore character
/// 4. It doesn't end with an underscore
pub fn validate_name(value: &str) -> bool {
    static NAME_REGEX: Lazy<Regex> = Lazy::new(|| {
        // Unwrap as we checked the regular expression for correctness
        Regex::new("^[A-Za-z]{1}[A-Za-z0-9_]{0,62}[A-Za-z0-9]{1}$").unwrap()
    });

    NAME_REGEX.is_match(value)
}

/// Checks "description" field of operations with "schema_definition_v1" schema id.
///
/// 1. It consists of unicode characters
/// 2. ... and must be at most 256 characters long
pub fn validate_description(value: &str) -> bool {
    value.chars().count() <= 256
}

/// Checks "fields" field of operations with "schema_definition_v1" schema id.
///
/// 1. A schema must have at most 1024 fields
fn validate_fields(value: &[Vec<Hash>]) -> bool {
    value.len() <= 1024
}

/// Validate formatting for operations following `schema_definition_v1` system schemas.
///
/// These operations contain a "name", "description" and "fields" field with each have special
/// limitations defined by the p2panda specification.
///
/// Please note that this does not check type field type or the operation fields in general, as
/// this should be handled by other validation methods. This method is only checking the special
/// requirements of this particular system schema.
pub fn validate_schema_definition_v1_fields(
    fields: &PlainFields,
) -> Result<(), SchemaDefinitionError> {
    // Check "name" field
    let schema_name = fields.get("name");

    match schema_name {
        Some(PlainValue::String(value)) => {
            if validate_name(value) {
                Ok(())
            } else {
                Err(SchemaDefinitionError::NameInvalid)
            }
        }
        _ => Ok(()),
    }?;

    // Check "description" field
    let schema_description = fields.get("description");

    match schema_description {
        Some(PlainValue::String(value)) => {
            if validate_description(value) {
                Ok(())
            } else {
                Err(SchemaDefinitionError::DescriptionInvalid)
            }
        }
        _ => Ok(()),
    }?;

    // Check "fields" field
    let schema_fields = fields.get("fields");

    match schema_fields {
        Some(PlainValue::PinnedRelationList(value)) => {
            if validate_fields(value) {
                Ok(())
            } else {
                Err(SchemaDefinitionError::FieldsInvalid)
            }
        }
        _ => Ok(()),
    }?;

    Ok(())
}

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

    use crate::operation::plain::{PlainFields, PlainValue};
    use crate::test_utils::fixtures::{random_document_view_id, random_hash};

    use super::{
        validate_description, validate_fields, validate_name, validate_schema_definition_v1_fields,
    };

    #[rstest]
    #[case(vec![
       ("name", "venues".into()),
       ("description", "This is a test description".into()),
       ("fields", vec![random_document_view_id(), random_document_view_id()].into()),
    ].into())]
    #[case::no_fields(vec![
       ("name", "venues".into()),
       ("description", "This is a test description".into()),
       ("fields", PlainValue::PinnedRelationList(Vec::new())),
    ].into())]
    #[case::no_name(vec![
       ("description", "This is a test description".into()),
       ("fields", vec![random_document_view_id()].into()),
    ].into())]
    #[case::no_description(vec![
       ("name", "venues".into()),
       ("fields", vec![random_document_view_id()].into()),
    ].into())]
    fn check_fields(#[case] fields: PlainFields) {
        assert!(validate_schema_definition_v1_fields(&fields).is_ok());
    }

    #[test]
    fn check_schema_fields() {
        let mut many_fields = Vec::new();
        let hash = random_hash();

        for _ in 0..1200 {
            many_fields.push(vec![hash.clone()]);
        }

        assert!(!validate_fields(&many_fields));
        assert!(validate_fields(&vec![vec![hash]]));
    }

    #[rstest]
    #[case(
        "The kangaroo is a marsupial from the family Macropodidae
           (macropods, meaning large foot)"
    )]
    #[case("%*&______@@@@@[[}}}{}}}}}}}&}{&{&{&{&{&}}}}}]]")]
    #[should_panic]
    #[case(
        "In common use the term is used to describe the largest species from this
           family, the red kangaroo, as well as the antilopine kangaroo, eastern grey
           kangaroo, and western grey kangaroo! Kangaroos have large, powerful hind legs,
           large feet adapted for leaping, a long muscular tail for balance, and a small
           head. Like most marsupials, female kangaroos have a pouch called a marsupium
           in which joeys complete postnatal development."
    )]
    fn check_description(#[case] description_str: &str) {
        assert!(validate_description(description_str));
    }

    #[rstest]
    #[case("venues_with_garden")]
    #[case("animals_in_zoo_with_many_friends")]
    #[case("robot_3000_building_specification")]
    #[case("mushrooms_in_2054")]
    #[case("ILikeCamels")]
    #[case("AndDromedars")]
    #[case("And_Their_Special_Variants")]
    #[should_panic]
    #[case("where_did_we_end_up_again_")]
    #[should_panic]
    #[case("c0_1_2_1_a_b_4_____")]
    #[should_panic]
    #[case("")]
    #[should_panic]
    #[case("icecrüëmm")]
    #[should_panic]
    #[case("サービス！サービス！")]
    #[should_panic]
    #[case("schema_names_for_people_who_cant_decide_which_schema_name_to_pick")]
    #[should_panic]
    #[case("25_kangaroos")]
    #[should_panic]
    #[case("_and_how_did_it_all_began")]
    #[should_panic]
    #[case("???????")]
    #[should_panic]
    #[case("specification-says-no")]
    fn check_name_field(#[case] name_str: &str) {
        assert!(validate_name(name_str));
    }
}