#[cfg(feature = "inmemory_db")]
mod inmemory;
#[cfg(feature = "inmemory_db")]
pub use inmemory::InmemoryDatabase;
#[cfg(feature = "sled_db")]
mod sled_db;
#[cfg(feature = "sled_db")]
pub use sled_db::SledDatabase;
use crate::{
database::{Database, DatabaseResult},
Ent, Filter, Id, Predicate, Primitive, Query, Value,
};
use std::collections::HashSet;
type EntIdSet = HashSet<Id>;
pub trait KeyValueDatabase: Database {
fn ids(&self) -> EntIdSet;
fn has_id(&self, id: Id) -> bool;
fn ids_for_type(&self, r#type: &str) -> EntIdSet;
}
pub struct KeyValueDatabaseExecutor<'a, T: KeyValueDatabase>(&'a T);
impl<'a, T: KeyValueDatabase> From<&'a T> for KeyValueDatabaseExecutor<'a, T> {
fn from(db: &'a T) -> Self {
Self(db)
}
}
impl<'a, T: KeyValueDatabase> KeyValueDatabaseExecutor<'a, T> {
pub fn get_all(&self, ids: Vec<Id>) -> DatabaseResult<Vec<Box<dyn Ent>>> {
ids.into_iter()
.filter_map(|id| self.0.get(id).transpose())
.collect()
}
pub fn find_all(&self, query: Query) -> DatabaseResult<Vec<Box<dyn Ent>>> {
let mut pipeline: Option<EntIdSet> = None;
for filter in query {
let mut_pipeline = pipeline.get_or_insert_with(|| prefill_ids(self.0, &filter));
match filter {
Filter::IntoEdge(name) => {
pipeline = Some(
mut_pipeline
.iter()
.flat_map(|id| {
self.0
.get(*id)
.map(|maybe_ent| {
maybe_ent
.and_then(|ent| {
ent.edge(&name).map(|edge| edge.to_ids())
})
.unwrap_or_default()
})
.unwrap_or_default()
})
.collect(),
)
}
f => {
mut_pipeline.retain(|id| filter_id(self.0, id, &f));
}
}
}
pipeline
.unwrap_or_default()
.into_iter()
.filter_map(|id| self.0.get(id).transpose())
.collect()
}
}
fn prefill_ids<D: KeyValueDatabase>(db: &D, filter: &Filter) -> EntIdSet {
fn from_id_predicate<D: KeyValueDatabase>(
db: &D,
p: &Predicate,
mut ids: EntIdSet,
) -> Option<EntIdSet> {
match p {
Predicate::Equals(Value::Primitive(Primitive::Number(id))) => Some({
ids.insert(id.to_usize());
ids
}),
Predicate::Or(list) => list.iter().fold(Some(ids), |ids, p| match ids {
Some(ids) => from_id_predicate(db, p, ids),
None => None,
}),
_ => None,
}
}
fn from_type_predicate<D: KeyValueDatabase>(
db: &D,
p: &Predicate,
mut ids: EntIdSet,
) -> Option<EntIdSet> {
match p {
Predicate::Equals(Value::Text(t)) => Some({
ids.extend(db.ids_for_type(t));
ids
}),
Predicate::Or(list) => list.iter().fold(Some(ids), |ids, p| match ids {
Some(ids) => from_type_predicate(db, p, ids),
None => None,
}),
_ => None,
}
}
match filter {
Filter::Id(p) => {
from_id_predicate(db, p.as_untyped(), EntIdSet::new()).unwrap_or_else(|| db.ids())
}
Filter::Type(p) => {
from_type_predicate(db, p.as_untyped(), EntIdSet::new()).unwrap_or_else(|| db.ids())
}
_ => db.ids(),
}
}
fn filter_id<D: KeyValueDatabase>(db: &D, id: &Id, filter: &Filter) -> bool {
match filter {
Filter::Id(p) => p.check(*id),
Filter::Type(p) => with_ent(db, id, |ent| p.check(ent.r#type().to_string())),
Filter::Created(p) => with_ent(db, id, |ent| p.check(ent.created())),
Filter::LastUpdated(p) => with_ent(db, id, |ent| p.check(ent.last_updated())),
Filter::Field(name, p) => with_ent(db, id, |ent| match ent.field(name) {
Some(value) => p.check(&value),
None => false,
}),
Filter::Edge(name, f) => with_ent(db, id, |ent| match ent.edge(name) {
Some(edge) => edge.to_ids().iter().any(|id| filter_id(db, id, f)),
None => false,
}),
Filter::IntoEdge(_) => unreachable!("Bug: Transformation in filter"),
}
}
fn with_ent<D: KeyValueDatabase, F: Fn(Box<dyn Ent>) -> bool>(db: &D, id: &Id, f: F) -> bool {
db.get(*id)
.map(|maybe_ent| maybe_ent.map(f).unwrap_or_default())
.unwrap_or_default()
}
#[cfg(test)]
mod tests {
#![cfg_attr(
not(any(feature = "inmemory_db", feature = "sled_db")),
allow(dead_code, unused_imports, unused_macros)
)]
use super::*;
use crate::*;
use std::collections::HashMap;
use {Predicate as P, TypedPredicate as TP};
macro_rules! impl_tests {
($db_type:ty, $new_db:expr) => {
fn new_test_database() -> $db_type {
let db = $new_db;
let _ = db
.insert(Box::from(UntypedEnt::from_collections(1, vec![], vec![])))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(2, vec![], vec![])))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(3, vec![], vec![])))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(
4,
vec![Field::new("a", 1), Field::new("b", 2)],
vec![],
)))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(
5,
vec![Field::new("a", 3), Field::new("b", 4)],
vec![],
)))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(
6,
vec![Field::new("a", 5), Field::new("b", 6)],
vec![],
)))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(
7,
vec![Field::new(
"f",
Value::from(
vec![(String::from("a"), 3), (String::from("b"), 5)]
.into_iter()
.collect::<HashMap<String, u8>>(),
),
)],
vec![],
)))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(
8,
vec![Field::new("f", vec![1, 2])],
vec![],
)))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(
9,
vec![Field::new(
"f",
Value::from(
vec![
(String::from("a"), Value::from(vec![1, 2])),
(String::from("b"), Value::from(vec![3, 4])),
]
.into_iter()
.collect::<HashMap<String, Value>>(),
),
)],
vec![],
)))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(
10,
vec![],
vec![
Edge::new("a", 1),
Edge::new("b", vec![3, 4, 5]),
Edge::new("c", None),
],
)))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(
11,
vec![],
vec![Edge::new("a", 2), Edge::new("b", vec![1, 2, 3, 4, 5, 6])],
)))
.unwrap();
let _ = db
.insert(Box::from(UntypedEnt::from_collections(
12,
vec![],
vec![
Edge::new("a", 3),
Edge::new("b", vec![]),
Edge::new("c", Some(8)),
],
)))
.unwrap();
db
}
fn query_and_assert<Q: Into<Query>, T: KeyValueDatabase>(
db: &T,
query: Q,
expected: &[Id],
) {
let query = query.into();
let results = db
.find_all(query.clone())
.expect("Failed to retrieve ents")
.iter()
.map(|ent| ent.id())
.collect::<HashSet<Id>>();
assert_eq!(
results,
expected.into_iter().copied().collect(),
"{:?}\nExpected: {:?}, Actual: {:?}",
query,
expected,
results
);
}
#[test]
fn get_all_should_return_all_ents_with_associated_ids() {
let db = $new_db;
let _ = db.insert(Box::from(UntypedEnt::empty_with_id(1))).unwrap();
let _ = db.insert(Box::from(UntypedEnt::empty_with_id(2))).unwrap();
let _ = db.insert(Box::from(UntypedEnt::empty_with_id(3))).unwrap();
let results = db
.get_all(vec![1, 2, 3])
.expect("Failed to retrieve ents")
.iter()
.map(|ent| ent.id())
.collect::<HashSet<Id>>();
assert_eq!(results, [1, 2, 3].iter().copied().collect());
let results = db
.get_all(vec![1, 3])
.expect("Failed to retrieve ents")
.iter()
.map(|ent| ent.id())
.collect::<HashSet<Id>>();
assert_eq!(results, [1, 3].iter().copied().collect());
let results = db
.get_all(vec![2, 3, 4, 5, 6, 7, 8])
.expect("Failed to retrieve ents")
.iter()
.map(|ent| ent.id())
.collect::<HashSet<Id>>();
assert_eq!(results, [2, 3].iter().copied().collect());
}
#[test]
fn find_all_should_return_no_ents_by_default() {
let db = new_test_database();
let q = Query::default();
query_and_assert(&db, q, &[]);
}
#[test]
fn find_all_should_support_filtering_by_id() {
let db = new_test_database();
let q = Query::default().where_id(TP::equals(1));
query_and_assert(&db, q, &[1]);
let q = Query::default().where_id(TP::equals(1) | TP::equals(2));
query_and_assert(&db, q, &[1, 2]);
let q = Query::default().where_id(TP::equals(999));
query_and_assert(&db, q, &[]);
let q = Query::default()
.where_id(TP::equals(1) | TP::equals(2))
.where_id(TP::equals(1) | TP::equals(3));
query_and_assert(&db, q, &[1]);
}
#[test]
fn find_all_should_support_filtering_by_type() {
let db = new_test_database();
let _ = db.insert(Box::from(TestEnt::new(20))).unwrap();
let _ = db.insert(Box::from(TestEnt::new(21))).unwrap();
let _ = db.insert(Box::from(TestEnt::new(22))).unwrap();
let ts = <UntypedEnt as EntType>::type_str();
let q = Query::default().where_type(TP::equals(ts.to_string()));
query_and_assert(&db, q, &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]);
let q = Query::default().where_type(TP::or(vec![
TP::equals(<UntypedEnt as EntType>::type_str().to_string()),
TP::equals(<TestEnt as EntType>::type_str().to_string()),
]));
query_and_assert(&db, q, &[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 20, 21, 22]);
let q = Query::default().where_type(TP::equals(String::from("unknown")));
query_and_assert(&db, q, &[]);
let q = Query::default()
.where_id(TP::equals(1) | TP::equals(2) | TP::equals(4))
.where_type(TP::equals(ts.to_string()));
query_and_assert(&db, q, &[1, 2, 4]);
}
#[test]
fn find_all_should_support_filtering_by_created_timestamp() {
let db = new_test_database();
for i in 1..=12 {
let ent = UntypedEnt::empty_with_id(i);
db.insert(Box::from(ent))
.expect(&format!("Failed to replace ent {}", i));
std::thread::sleep(std::time::Duration::from_millis(1));
}
let time = db.get(3).unwrap().expect("Missing ent 3").created();
let q = Query::default().where_created(TP::greater_than(time));
query_and_assert(&db, q, &[4, 5, 6, 7, 8, 9, 10, 11, 12]);
let time = db.get(3).unwrap().expect("Missing ent 3").created();
let q = Query::default()
.where_id(TP::less_than(8))
.where_created(TP::greater_than(time));
query_and_assert(&db, q, &[4, 5, 6, 7]);
}
#[test]
fn find_all_should_support_filtering_by_last_updated_timestamp() {
let db = new_test_database();
for i in (1..=12).rev() {
use crate::DatabaseExt;
let mut ent = db
.get_typed::<UntypedEnt>(i)
.unwrap()
.expect(&format!("Missing ent {}", i));
ent.mark_updated().unwrap();
db.insert(Box::from(ent))
.expect(&format!("Failed to update ent {}", i));
std::thread::sleep(std::time::Duration::from_millis(1));
}
let time = db.get(3).unwrap().expect("Missing ent 3").last_updated();
let q = Query::default().where_last_updated(TP::greater_than(time));
query_and_assert(&db, q, &[1, 2]);
let time = db.get(3).unwrap().expect("Missing ent 3").created();
let q = Query::default()
.where_id(TP::equals(2))
.where_last_updated(TP::greater_than(time));
query_and_assert(&db, q, &[2]);
}
#[test]
fn find_all_should_support_filtering_by_field() {
let db = new_test_database();
let q = Query::default().where_field("a", P::equals(3));
query_and_assert(&db, q, &[5]);
let q = Query::default()
.where_id(TP::equals(4) | TP::equals(6))
.where_field("a", P::greater_than(1));
query_and_assert(&db, q, &[6]);
}
#[test]
fn find_all_should_support_filtering_by_edge() {
let db = new_test_database();
let q = Query::default().where_edge("a", Filter::Id(TP::equals(3)));
query_and_assert(&db, q, &[12]);
let q = Query::default()
.where_id(TP::equals(10) | TP::equals(12))
.where_edge("a", Filter::Id(TP::always()));
query_and_assert(&db, q, &[10, 12]);
}
#[test]
fn find_all_should_support_transforming_into_edge() {
let db = new_test_database();
let q = Query::default().where_into_edge("b");
query_and_assert(&db, q, &[1, 2, 3, 4, 5, 6]);
let q = Query::default()
.where_id(TP::equals(10) | TP::equals(12))
.where_into_edge("b");
query_and_assert(&db, q, &[3, 4, 5]);
}
};
}
#[cfg(feature = "inmemory_db")]
mod inmemory {
use super::*;
impl_tests!(InmemoryDatabase, InmemoryDatabase::default());
}
#[cfg(feature = "sled_db")]
mod sled_db {
use super::*;
impl_tests!(
SledDatabase,
SledDatabase::new(sled::Config::new().temporary(true).open().unwrap())
);
}
#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde-1", derive(serde::Serialize, serde::Deserialize))]
struct TestEnt(Id);
impl TestEnt {
pub fn new(id: Id) -> Self {
Self(id)
}
}
impl EntType for TestEnt {
fn type_str() -> &'static str {
concat!(module_path!(), "::TestEnt")
}
}
#[cfg_attr(feature = "serde-1", typetag::serde)]
impl Ent for TestEnt {
fn id(&self) -> Id {
self.0
}
fn set_id(&mut self, id: Id) {
self.0 = id;
}
fn r#type(&self) -> &str {
Self::type_str()
}
fn created(&self) -> u64 {
0
}
fn last_updated(&self) -> u64 {
0
}
fn mark_updated(&mut self) -> Result<(), EntMutationError> {
Ok(())
}
fn field_definitions(&self) -> Vec<FieldDefinition> {
Vec::new()
}
fn field_names(&self) -> Vec<String> {
Vec::new()
}
fn field(&self, _name: &str) -> Option<Value> {
None
}
fn update_field(&mut self, name: &str, _value: Value) -> Result<Value, EntMutationError> {
Err(EntMutationError::NoField {
name: name.to_string(),
})
}
fn edge_definitions(&self) -> Vec<EdgeDefinition> {
Vec::new()
}
fn edge_names(&self) -> Vec<String> {
Vec::new()
}
fn edge(&self, _name: &str) -> Option<EdgeValue> {
None
}
fn update_edge(
&mut self,
name: &str,
_value: EdgeValue,
) -> Result<EdgeValue, EntMutationError> {
Err(EntMutationError::NoEdge {
name: name.to_string(),
})
}
fn connect(&mut self, _database: WeakDatabaseRc) {}
fn disconnect(&mut self) {}
fn is_connected(&self) -> bool {
false
}
fn load_edge(&self, _name: &str) -> DatabaseResult<Vec<Box<dyn Ent>>> {
Err(DatabaseError::Disconnected)
}
fn refresh(&mut self) -> DatabaseResult<()> {
Err(DatabaseError::Disconnected)
}
fn commit(&mut self) -> DatabaseResult<()> {
Err(DatabaseError::Disconnected)
}
fn remove(&self) -> DatabaseResult<bool> {
Err(DatabaseError::Disconnected)
}
}
}