mod local_index_controller; mod updates; pub use local_index_controller::LocalIndexController; use std::collections::HashMap; use std::num::NonZeroUsize; use std::sync::Arc; use anyhow::Result; use chrono::{DateTime, Utc}; use milli::Index; use milli::update::{IndexDocumentsMethod, UpdateFormat, DocumentAdditionResult}; use serde::{Serialize, Deserialize, de::Deserializer}; use uuid::Uuid; pub use updates::{Processed, Processing, Failed}; pub type UpdateStatus = updates::UpdateStatus; #[derive(Debug, Serialize, Deserialize, Clone)] #[serde(rename_all = "camelCase")] pub struct IndexMetadata { pub uid: String, uuid: Uuid, created_at: DateTime, updated_at: DateTime, primary_key: Option, } #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(tag = "type")] pub enum UpdateMeta { DocumentsAddition { method: IndexDocumentsMethod, format: UpdateFormat, primary_key: Option, }, ClearDocuments, DeleteDocuments, Settings(Settings), Facets(Facets), } #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(deny_unknown_fields)] #[serde(rename_all = "camelCase")] pub struct Facets { pub level_group_size: Option, pub min_level_size: Option, } fn deserialize_some<'de, T, D>(deserializer: D) -> Result, D::Error> where T: Deserialize<'de>, D: Deserializer<'de> { Deserialize::deserialize(deserializer).map(Some) } #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(deny_unknown_fields)] #[serde(rename_all = "camelCase")] pub struct Settings { #[serde( default, deserialize_with = "deserialize_some", skip_serializing_if = "Option::is_none", )] pub displayed_attributes: Option>>, #[serde( default, deserialize_with = "deserialize_some", skip_serializing_if = "Option::is_none", )] pub searchable_attributes: Option>>, #[serde(default)] pub faceted_attributes: Option>>, #[serde( default, deserialize_with = "deserialize_some", skip_serializing_if = "Option::is_none", )] pub criteria: Option>>, } impl Settings { pub fn cleared() -> Self { Self { displayed_attributes: Some(None), searchable_attributes: Some(None), faceted_attributes: Some(None), criteria: Some(None), } } } #[derive(Debug, Clone, Serialize, Deserialize)] pub enum UpdateResult { DocumentsAddition(DocumentAdditionResult), DocumentDeletion { deleted: usize }, Other, } #[derive(Clone, Debug)] pub struct IndexSettings { pub name: Option, pub primary_key: Option, } /// The `IndexController` is in charge of the access to the underlying indices. It splits the logic /// for read access which is provided thanks to an handle to the index, and write access which must /// be provided. This allows the implementer to define the behaviour of write accesses to the /// indices, and abstract the scheduling of the updates. The implementer must be able to provide an /// instance of `IndexStore` pub trait IndexController { /* * Write operations * * Logic for the write operation need to be provided by the implementer, since they can be made * asynchronous thanks to an update_store for example. * * */ /// Perform document addition on the database. If the provided index does not exist, it will be /// created when the addition is applied to the index. fn add_documents>( &self, index: S, method: IndexDocumentsMethod, format: UpdateFormat, data: &[u8], primary_key: Option, ) -> anyhow::Result; /// Clear all documents in the given index. fn clear_documents(&self, index: impl AsRef) -> anyhow::Result; /// Delete all documents in `document_ids`. fn delete_documents(&self, index: impl AsRef, document_ids: Vec) -> anyhow::Result; /// Updates an index settings. If the index does not exist, it will be created when the update /// is applied to the index. fn update_settings>(&self, index_uid: S, settings: Settings) -> anyhow::Result; /// Create an index with the given `index_uid`. fn create_index(&self, index_settings: IndexSettings) -> Result; /// Delete index with the given `index_uid`, attempting to close it beforehand. fn delete_index>(&self, index_uid: S) -> Result<()>; /// Swap two indexes, concretely, it simply swaps the index the names point to. fn swap_indices, S2: AsRef>(&self, index1_uid: S1, index2_uid: S2) -> Result<()>; /// Apply an update to the given index. This method can be called when an update is ready to be /// processed fn handle_update>( &self, _index: S, _update_id: u64, _meta: Processing, _content: &[u8] ) -> Result, Failed> { todo!() } /// Returns, if it exists, the `Index` with the povided name. fn index(&self, name: impl AsRef) -> anyhow::Result>>; /// Returns the udpate status an update fn update_status(&self, index: impl AsRef, id: u64) -> anyhow::Result>; /// Returns all the udpate status for an index fn all_update_status(&self, index: impl AsRef) -> anyhow::Result>; /// List all the indexes fn list_indexes(&self) -> anyhow::Result>; fn update_index(&self, name: impl AsRef, index_settings: IndexSettings) -> anyhow::Result; } #[cfg(test)] #[macro_use] pub(crate) mod test { use super::*; #[macro_export] macro_rules! make_index_controller_tests { ($controller_buider:block) => { #[test] fn test_create_and_list_indexes() { crate::index_controller::test::create_and_list_indexes($controller_buider); } #[test] fn test_create_index_with_no_name_is_error() { crate::index_controller::test::create_index_with_no_name_is_error($controller_buider); } #[test] fn test_update_index() { crate::index_controller::test::update_index($controller_buider); } }; } pub(crate) fn create_and_list_indexes(controller: impl IndexController) { let settings1 = IndexSettings { name: Some(String::from("test_index")), primary_key: None, }; let settings2 = IndexSettings { name: Some(String::from("test_index2")), primary_key: Some(String::from("foo")), }; controller.create_index(settings1).unwrap(); controller.create_index(settings2).unwrap(); let indexes = controller.list_indexes().unwrap(); assert_eq!(indexes.len(), 2); assert_eq!(indexes[0].uid, "test_index"); assert_eq!(indexes[1].uid, "test_index2"); assert_eq!(indexes[1].primary_key.clone().unwrap(), "foo"); } pub(crate) fn create_index_with_no_name_is_error(controller: impl IndexController) { let settings = IndexSettings { name: None, primary_key: None, }; assert!(controller.create_index(settings).is_err()); } pub(crate) fn update_index(controller: impl IndexController) { let settings = IndexSettings { name: Some(String::from("test")), primary_key: None, }; assert!(controller.create_index(settings).is_ok()); // perform empty update returns index meta unchanged let settings = IndexSettings { name: None, primary_key: None, }; let result = controller.update_index("test", settings).unwrap(); assert_eq!(result.uid, "test"); assert_eq!(result.created_at, result.updated_at); assert!(result.primary_key.is_none()); // Changing the name trigger an error let settings = IndexSettings { name: Some(String::from("bar")), primary_key: None, }; assert!(controller.update_index("test", settings).is_err()); // Update primary key let settings = IndexSettings { name: None, primary_key: Some(String::from("foo")), }; let result = controller.update_index("test", settings.clone()).unwrap(); assert_eq!(result.uid, "test"); assert!(result.created_at < result.updated_at); assert_eq!(result.primary_key.unwrap(), "foo"); // setting the primary key again is an error assert!(controller.update_index("test", settings).is_err()); } }