meilisearch/meilisearch-schema/src/schema.rs

use std::borrow::Cow;
use std::collections::{BTreeSet, HashSet};

use serde::{Deserialize, Serialize};

use crate::position_map::PositionMap;
use crate::{Error, FieldId, FieldsMap, IndexedPos, SResult};

#[derive(Clone, Debug, Serialize, Deserialize, Default)]
pub struct Schema {
    fields_map: FieldsMap,

    primary_key: Option<FieldId>,
    ranked: HashSet<FieldId>,
    displayed: Option<BTreeSet<FieldId>>,

    searchable: Option<Vec<FieldId>>,
    pub indexed_position: PositionMap,
}

impl Schema {
    pub fn with_primary_key(name: &str) -> Schema {
        let mut fields_map = FieldsMap::default();
        let field_id = fields_map.insert(name).unwrap();
        let mut indexed_position = PositionMap::default();
        indexed_position.push(field_id);

        Schema {
            fields_map,
            primary_key: Some(field_id),
            ranked: HashSet::new(),
            displayed: None,
            searchable: None,
            indexed_position,
        }
    }

    pub fn primary_key(&self) -> Option<&str> {
        self.primary_key.map(|id| self.fields_map.name(id).unwrap())
    }

    pub fn set_primary_key(&mut self, name: &str) -> SResult<FieldId> {
        if self.primary_key.is_some() {
            return Err(Error::PrimaryKeyAlreadyPresent);
        }

        let id = self.insert(name)?;
        self.primary_key = Some(id);

        Ok(id)
    }

    pub fn id(&self, name: &str) -> Option<FieldId> {
        self.fields_map.id(name)
    }

    pub fn name<I: Into<FieldId>>(&self, id: I) -> Option<&str> {
        self.fields_map.name(id)
    }

    pub fn names(&self) -> impl Iterator<Item = &str> {
        self.fields_map.iter().map(|(k, _)| k.as_ref())
    }

    /// add `name` to the list of known fields
    pub fn insert(&mut self, name: &str) -> SResult<FieldId> {
        self.fields_map.insert(name)
    }

    /// Adds `name` to the list of known fields, and in the last position of the indexed_position map. This
    /// field is taken into acccount when `searchableAttribute` or `displayedAttributes` is set to `"*"`
    pub fn insert_with_position(&mut self, name: &str) -> SResult<(FieldId, IndexedPos)> {
        let field_id = self.fields_map.insert(name)?;
        let position = self
            .is_searchable(field_id)
            .unwrap_or_else(|| self.indexed_position.push(field_id));
        Ok((field_id, position))
    }

    pub fn ranked(&self) -> &HashSet<FieldId> {
        &self.ranked
    }

    fn displayed(&self) -> Cow<BTreeSet<FieldId>> {
        match &self.displayed {
            Some(displayed) => Cow::Borrowed(displayed),
            None => Cow::Owned(self.indexed_position.field_pos().map(|(f, _)| f).collect()),
        }
    }

    pub fn is_displayed_all(&self) -> bool {
        self.displayed.is_none()
    }

    pub fn displayed_names(&self) -> BTreeSet<&str> {
        self.displayed()
            .iter()
            .filter_map(|&f| self.name(f))
            .collect()
    }

    fn searchable(&self) -> Cow<[FieldId]> {
        match &self.searchable {
            Some(searchable) => Cow::Borrowed(&searchable),
            None => Cow::Owned(self.indexed_position.field_pos().map(|(f, _)| f).collect()),
        }
    }

    pub fn searchable_names(&self) -> Vec<&str> {
        self.searchable()
            .iter()
            .filter_map(|a| self.name(*a))
            .collect()
    }

    pub(crate) fn set_ranked(&mut self, name: &str) -> SResult<FieldId> {
        let id = self.fields_map.insert(name)?;
        self.ranked.insert(id);
        Ok(id)
    }

    pub fn clear_ranked(&mut self) {
        self.ranked.clear();
    }

    pub fn is_ranked(&self, id: FieldId) -> bool {
        self.ranked.get(&id).is_some()
    }

    pub fn is_displayed(&self, id: FieldId) -> bool {
        match &self.displayed {
            Some(displayed) => displayed.contains(&id),
            None => true,
        }
    }

    pub fn is_searchable(&self, id: FieldId) -> Option<IndexedPos> {
        match &self.searchable {
            Some(searchable) if searchable.contains(&id) => self.indexed_position.field_to_pos(id),
            None => self.indexed_position.field_to_pos(id),
            _ => None,
        }
    }

    pub fn is_searchable_all(&self) -> bool {
        self.searchable.is_none()
    }

    pub fn indexed_pos_to_field_id<I: Into<IndexedPos>>(&self, pos: I) -> Option<FieldId> {
        self.indexed_position.pos_to_field(pos.into())
    }

    pub fn update_ranked<S: AsRef<str>>(
        &mut self,
        data: impl IntoIterator<Item = S>,
    ) -> SResult<()> {
        self.ranked.clear();
        for name in data {
            self.set_ranked(name.as_ref())?;
        }
        Ok(())
    }

    pub fn update_displayed<S: AsRef<str>>(
        &mut self,
        data: impl IntoIterator<Item = S>,
    ) -> SResult<()> {
        let mut displayed = BTreeSet::new();
        for name in data {
            let id = self.fields_map.insert(name.as_ref())?;
            displayed.insert(id);
        }
        self.displayed.replace(displayed);
        Ok(())
    }

    pub fn update_searchable<S: AsRef<str>>(&mut self, data: Vec<S>) -> SResult<()> {
        let mut searchable = Vec::with_capacity(data.len());
        for (pos, name) in data.iter().enumerate() {
            let id = self.insert(name.as_ref())?;
            self.indexed_position.insert(id, IndexedPos(pos as u16));
            searchable.push(id);
        }
        self.searchable.replace(searchable);
        Ok(())
    }

    pub fn set_all_searchable(&mut self) {
        self.searchable.take();
    }

    pub fn set_all_displayed(&mut self) {
        self.displayed.take();
    }
}

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

    #[test]
    fn test_with_primary_key() {
        let schema = Schema::with_primary_key("test");
        assert_eq!(
            format!("{:?}", schema),
            r##"Schema { fields_map: FieldsMap { name_map: {"test": FieldId(0)}, id_map: {FieldId(0): "test"}, next_id: FieldId(1) }, primary_key: Some(FieldId(0)), ranked: {}, displayed: None, searchable: None, indexed_position: PositionMap { pos_to_field: [FieldId(0)], field_to_pos: {FieldId(0): IndexedPos(0)} } }"##
        );
    }

    #[test]
    fn primary_key() {
        let schema = Schema::with_primary_key("test");
        assert_eq!(schema.primary_key(), Some("test"));
    }

    #[test]
    fn test_insert_with_position_base() {
        let mut schema = Schema::default();
        let (id, position) = schema.insert_with_position("foo").unwrap();
        assert!(schema.searchable.is_none());
        assert!(schema.displayed.is_none());
        assert_eq!(id, 0.into());
        assert_eq!(position, 0.into());
        let (id, position) = schema.insert_with_position("bar").unwrap();
        assert_eq!(id, 1.into());
        assert_eq!(position, 1.into());
    }

    #[test]
    fn test_insert_with_position_primary_key() {
        let mut schema = Schema::with_primary_key("test");
        let (id, position) = schema.insert_with_position("foo").unwrap();
        assert!(schema.searchable.is_none());
        assert!(schema.displayed.is_none());
        assert_eq!(id, 1.into());
        assert_eq!(position, 1.into());
        let (id, position) = schema.insert_with_position("test").unwrap();
        assert_eq!(id, 0.into());
        assert_eq!(position, 0.into());
    }

    #[test]
    fn test_insert() {
        let mut schema = Schema::default();
        let field_id = schema.insert("foo").unwrap();
        assert!(schema.fields_map.name(field_id).is_some());
        assert!(schema.searchable.is_none());
        assert!(schema.displayed.is_none());
    }

    #[test]
    fn test_update_searchable() {
        let mut schema = Schema::default();

        schema.update_searchable(vec!["foo", "bar"]).unwrap();
        assert_eq!(
            format!("{:?}", schema.indexed_position),
            r##"PositionMap { pos_to_field: [FieldId(0), FieldId(1)], field_to_pos: {FieldId(0): IndexedPos(0), FieldId(1): IndexedPos(1)} }"##
        );
        assert_eq!(
            format!("{:?}", schema.searchable),
            r##"Some([FieldId(0), FieldId(1)])"##
        );
        schema.update_searchable(vec!["bar"]).unwrap();
        assert_eq!(
            format!("{:?}", schema.searchable),
            r##"Some([FieldId(1)])"##
        );
        assert_eq!(
            format!("{:?}", schema.indexed_position),
            r##"PositionMap { pos_to_field: [FieldId(1), FieldId(0)], field_to_pos: {FieldId(0): IndexedPos(1), FieldId(1): IndexedPos(0)} }"##
        );
    }

    #[test]
    fn test_update_displayed() {
        let mut schema = Schema::default();
        schema.update_displayed(vec!["foobar"]).unwrap();
        assert_eq!(
            format!("{:?}", schema.displayed),
            r##"Some({FieldId(0)})"##
        );
        assert_eq!(
            format!("{:?}", schema.indexed_position),
            r##"PositionMap { pos_to_field: [], field_to_pos: {} }"##
        );
    }

    #[test]
    fn test_is_searchable_all() {
        let mut schema = Schema::default();
        assert!(schema.is_searchable_all());
        schema.update_searchable(vec!["foo"]).unwrap();
        assert!(!schema.is_searchable_all());
    }

    #[test]
    fn test_is_displayed_all() {
        let mut schema = Schema::default();
        assert!(schema.is_displayed_all());
        schema.update_displayed(vec!["foo"]).unwrap();
        assert!(!schema.is_displayed_all());
    }

    #[test]
    fn test_searchable_names() {
        let mut schema = Schema::default();
        assert_eq!(format!("{:?}", schema.searchable_names()), r##"[]"##);
        schema.insert_with_position("foo").unwrap();
        schema.insert_with_position("bar").unwrap();
        assert_eq!(
            format!("{:?}", schema.searchable_names()),
            r##"["foo", "bar"]"##
        );
        schema.update_searchable(vec!["hello", "world"]).unwrap();
        assert_eq!(
            format!("{:?}", schema.searchable_names()),
            r##"["hello", "world"]"##
        );
        schema.set_all_searchable();
        assert_eq!(
            format!("{:?}", schema.searchable_names()),
            r##"["hello", "world", "foo", "bar"]"##
        );
    }

    #[test]
    fn test_displayed_names() {
        let mut schema = Schema::default();
        assert_eq!(format!("{:?}", schema.displayed_names()), r##"{}"##);
        schema.insert_with_position("foo").unwrap();
        schema.insert_with_position("bar").unwrap();
        assert_eq!(
            format!("{:?}", schema.displayed_names()),
            r##"{"bar", "foo"}"##
        );
        schema.update_displayed(vec!["hello", "world"]).unwrap();
        assert_eq!(
            format!("{:?}", schema.displayed_names()),
            r##"{"hello", "world"}"##
        );
        schema.set_all_displayed();
        assert_eq!(
            format!("{:?}", schema.displayed_names()),
            r##"{"bar", "foo"}"##
        );
    }

    #[test]
    fn test_set_all_searchable() {
        let mut schema = Schema::default();
        assert!(schema.is_searchable_all());
        schema.update_searchable(vec!["foobar"]).unwrap();
        assert!(!schema.is_searchable_all());
        schema.set_all_searchable();
        assert!(schema.is_searchable_all());
    }

    #[test]
    fn test_set_all_displayed() {
        let mut schema = Schema::default();
        assert!(schema.is_displayed_all());
        schema.update_displayed(vec!["foobar"]).unwrap();
        assert!(!schema.is_displayed_all());
        schema.set_all_displayed();
        assert!(schema.is_displayed_all());
    }
}