conduit/src/database/abstraction.rs

use super::Config;
use crate::Result;

use std::{future::Future, pin::Pin, sync::Arc};

#[cfg(any(feature = "persy"))]
use std::{collections::BTreeMap, sync::RwLock};

#[cfg(feature = "persy")]
use std::{
    cmp::Ordering,
    collections::BTreeSet,
    iter::Peekable,
    time::{Duration, Instant},
};

#[cfg(feature = "sled")]
pub mod sled;

#[cfg(feature = "sqlite")]
pub mod sqlite;

#[cfg(feature = "heed")]
pub mod heed;

pub trait DatabaseEngine: Sized {
    fn open(config: &Config) -> Result<Arc<Self>>;
    fn open_tree(self: &Arc<Self>, name: &'static str) -> Result<Arc<dyn Tree>>;
    fn flush(self: &Arc<Self>) -> Result<()>;
}

pub trait Tree: Send + Sync {
    fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>>;

    fn insert(&self, key: &[u8], value: &[u8]) -> Result<()>;
    fn insert_batch<'a>(&self, iter: &mut dyn Iterator<Item = (Vec<u8>, Vec<u8>)>) -> Result<()>;

    fn remove(&self, key: &[u8]) -> Result<()>;

    fn iter<'a>(&'a self) -> Box<dyn Iterator<Item = (Vec<u8>, Vec<u8>)> + 'a>;

    fn iter_from<'a>(
        &'a self,
        from: &[u8],
        backwards: bool,
    ) -> Box<dyn Iterator<Item = (Vec<u8>, Vec<u8>)> + 'a>;

    fn increment(&self, key: &[u8]) -> Result<Vec<u8>>;
    fn increment_batch<'a>(&self, iter: &mut dyn Iterator<Item = Vec<u8>>) -> Result<()>;

    fn scan_prefix<'a>(
        &'a self,
        prefix: Vec<u8>,
    ) -> Box<dyn Iterator<Item = (Vec<u8>, Vec<u8>)> + 'a>;

    fn watch_prefix<'a>(&'a self, prefix: &[u8]) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>>;

    fn clear(&self) -> Result<()> {
        for (key, _) in self.iter() {
            self.remove(&key)?;
        }

        Ok(())
    }
}

// This is a functional integration at the state of the art of the current
// implementations, it should work and provide the base for stability and performance
// testing, Persy should be pretty resilient to crash and pretty lightweight in memory usage
// the speed in single thread will be pretty low because each transaction commit will wait for data
// to be flushed on disk, multi-thread should guarantee better performances even though I expect
// speed of a few thousand transactions per second.
//
// The current design of the engine right now do not allow to do transactions with multiple keys
// that would allow to reduce the latency quite a lot, anyway support transaction in the engine
// require a massive refactor.

#[cfg(feature = "persy")]
pub struct PersyEngine(persy::Persy, Arc<RwLock<WriteCache>>);

#[cfg(feature = "persy")]
impl DatabaseEngine for PersyEngine {
    fn open(config: &Config) -> Result<Arc<Self>> {
        let cfg = persy::Config::new();
        // This is for tweak the in memory cache size
        //config.change_cache_size(32 * 1024 * 1024 /*32Mb*/)

        let persy = persy::OpenOptions::new()
            .create(true)
            .config(cfg)
            .open(&format!("{}/db.persy", config.database_path))?;

        let write_cache = Arc::new(RwLock::new(WriteCache {
            add_cache: Default::default(),
            remove_cache: Default::default(),
            changes_count: Default::default(),
            last_flush: Instant::now(),
            db: persy.clone(),
        }));
        Ok(Arc::new(PersyEngine(persy, write_cache)))
    }

    fn open_tree(self: &Arc<Self>, name: &'static str) -> Result<Arc<dyn Tree>> {
        // Create if it doesn't exist
        if !self.0.exists_index(name)? {
            let mut tx = self.0.begin()?;
            tx.create_index::<persy::ByteVec, persy::ByteVec>(name, persy::ValueMode::REPLACE)?;
            tx.prepare()?.commit()?;
        }

        Ok(Arc::new(PersyTree {
            db: self.0.clone(),
            name: name.to_owned(),
            watchers: RwLock::new(BTreeMap::new()),
            write_cache: self.1.clone(),
        }))
    }
}

#[cfg(feature = "persy")]
pub struct PersyTree {
    db: persy::Persy,
    name: String,
    watchers: RwLock<BTreeMap<Vec<u8>, Vec<tokio::sync::oneshot::Sender<()>>>>,
    write_cache: Arc<RwLock<WriteCache>>,
}

#[cfg(feature = "persy")]
pub struct WriteCache {
    add_cache: BTreeMap<String, BTreeMap<Vec<u8>, Vec<u8>>>,
    remove_cache: BTreeMap<String, BTreeSet<Vec<u8>>>,
    changes_count: i32,
    last_flush: Instant,
    db: persy::Persy,
}

#[cfg(feature = "persy")]
impl WriteCache {
    pub fn insert(&mut self, index: String, key: &[u8], value: &[u8]) -> Result<()> {
        use std::collections::btree_map::Entry;
        match self.add_cache.entry(index.clone()) {
            Entry::Vacant(s) => {
                let mut map = BTreeMap::new();
                map.insert(key.to_owned(), value.to_owned());
                s.insert(map);
            }
            Entry::Occupied(mut o) => {
                o.get_mut().insert(key.to_owned(), value.to_owned());
            }
        }
        self.remove_remove(index, key)?;
        self.check_and_flush()?;
        Ok(())
    }

    pub fn remove_remove(&mut self, index: String, key: &[u8]) -> Result<()> {
        use std::collections::btree_map::Entry;
        match self.remove_cache.entry(index) {
            Entry::Vacant(_) => {}
            Entry::Occupied(mut o) => {
                o.get_mut().remove(key);
            }
        }
        Ok(())
    }

    pub fn remove_insert(&mut self, index: String, key: &[u8]) -> Result<()> {
        use std::collections::btree_map::Entry;
        match self.add_cache.entry(index) {
            Entry::Vacant(_) => {}
            Entry::Occupied(mut o) => {
                o.get_mut().remove(key);
            }
        }
        Ok(())
    }

    pub fn remove(&mut self, index: String, key: &[u8]) -> Result<()> {
        use std::collections::btree_map::Entry;
        match self.remove_cache.entry(index.clone()) {
            Entry::Vacant(s) => {
                let mut map = BTreeSet::new();
                map.insert(key.to_owned());
                s.insert(map);
            }
            Entry::Occupied(mut o) => {
                o.get_mut().insert(key.to_owned());
            }
        }
        self.remove_insert(index, key)?;
        self.check_and_flush()?;
        Ok(())
    }
    pub fn check_and_flush(&mut self) -> Result<()> {
        self.changes_count += 1;
        if self.changes_count > 1000 {
            self.flush_changes()?;
            self.changes_count = 0;
        }
        Ok(())
    }

    pub fn get(&self, index: &str, key: &[u8], value: Option<Vec<u8>>) -> Result<Option<Vec<u8>>> {
        Ok(if let Some(changes) = self.add_cache.get(index) {
            changes.get(key).map(|v| v.to_owned()).or(value)
        } else if let Some(remove) = self.remove_cache.get(index) {
            if remove.contains(key) {
                None
            } else {
                value
            }
        } else {
            value
        })
    }

    fn flush_changes(&mut self) -> Result<()> {
        use persy::ByteVec;
        let mut tx = self.db.begin()?;

        for (index, changes) in &self.add_cache {
            for (key, value) in changes {
                tx.put::<ByteVec, ByteVec>(
                    &index,
                    ByteVec(key.to_owned()),
                    ByteVec(value.to_owned()),
                )?;
            }
        }
        self.add_cache.clear();
        for (index, changes) in &self.remove_cache {
            for key in changes {
                tx.remove::<ByteVec, ByteVec>(&index, ByteVec(key.to_owned()), None)?;
            }
        }
        self.remove_cache.clear();
        tx.prepare()?.commit()?;
        self.last_flush = Instant::now();
        Ok(())
    }

    pub fn iter<'a>(
        &self,
        index: &str,
        mut iter: Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + Send + Sync + 'a>,
    ) -> Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + Send + Sync + 'a> {
        if let Some(adds) = self.add_cache.get(index) {
            let added = adds.clone().into_iter().map(|(k, v)| (k.into(), v.into()));
            iter = Box::new(UnionIter::new(iter, added, false))
        }

        if let Some(removes) = self.remove_cache.get(index) {
            let to_filter = removes.clone();
            iter = Box::new(iter.filter(move |x| to_filter.contains(&(*x.0).to_owned())))
        }

        iter
    }

    fn iter_from<'a>(
        &self,
        index: &str,
        from: &[u8],
        backwards: bool,
        mut iter: Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + 'a>,
    ) -> Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + 'a> {
        if let Some(adds) = self.add_cache.get(index) {
            let range = if backwards {
                adds.range(..from.to_owned())
            } else {
                adds.range(from.to_owned()..)
            };
            let added = range
                .map(|(k, v)| (k.to_owned().into(), v.to_owned().into()))
                .collect::<Vec<(Box<[u8]>, Box<[u8]>)>>();
            let add_iter: Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)>> = if backwards {
                Box::new(added.into_iter().rev())
            } else {
                Box::new(added.into_iter())
            };
            iter = Box::new(UnionIter::new(iter, add_iter, backwards))
        }

        if let Some(removes) = self.remove_cache.get(index) {
            let owned_from = from.to_owned();
            let to_filter = removes.iter();
            let to_filter = if backwards {
                to_filter
                    .filter(|x| (..&owned_from).contains(x))
                    .cloned()
                    .collect::<Vec<Vec<u8>>>()
            } else {
                to_filter
                    .filter(|x| (&owned_from..).contains(x))
                    .cloned()
                    .collect::<Vec<Vec<u8>>>()
            };
            iter = Box::new(iter.filter(move |x| !to_filter.contains(&(*x.0).to_owned())))
        }
        iter
    }

    fn scan_prefix<'a>(
        &self,
        index: &str,
        prefix: Vec<u8>,
        mut iter: Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + Send + 'a>,
    ) -> Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + Send + 'a> {
        if let Some(adds) = self.add_cache.get(index) {
            let owned_prefix = prefix.to_owned();
            let added = adds
                .range(prefix.to_owned()..)
                .take_while(move |(k, _)| k.starts_with(&owned_prefix))
                .map(|(k, v)| (k.to_owned().into(), v.to_owned().into()))
                .collect::<Vec<(Box<[u8]>, Box<[u8]>)>>();
            iter = Box::new(UnionIter::new(iter, added.into_iter(), false))
        }

        if let Some(removes) = self.remove_cache.get(index) {
            let to_filter = removes
                .iter()
                .filter(move |k| k.starts_with(&prefix))
                .cloned()
                .collect::<Vec<Vec<u8>>>();
            iter = Box::new(iter.filter(move |x| !to_filter.contains(&(*x.0).to_owned())))
        }
        iter
    }

    #[allow(unused)]
    pub fn flush_timed(&mut self) -> Result<()> {
        if self.changes_count > 0 {
            if Instant::now() - self.last_flush > Duration::from_secs(2) {
                self.flush_changes()?;
            }
        }
        Ok(())
    }
}

#[cfg(feature = "persy")]
impl Drop for WriteCache {
    fn drop(&mut self) {
        if self.changes_count > 0 {
            self.flush_changes().unwrap();
        }
    }
}

#[cfg(feature = "persy")]
struct UnionIter<T: Iterator<Item = I>, T1: Iterator<Item = I>, I> {
    first: Peekable<T>,
    second: Peekable<T1>,
    backwards: bool,
}

#[cfg(feature = "persy")]
impl<T: Iterator<Item = I>, T1: Iterator<Item = I>, I> UnionIter<T, T1, I> {
    fn new(first: T, second: T1, backwards: bool) -> Self {
        UnionIter {
            first: first.peekable(),
            second: second.peekable(),
            backwards,
        }
    }
}

#[cfg(feature = "persy")]
impl<K: Ord, V, T, T1> Iterator for UnionIter<T, T1, (K, V)>
where
    T: Iterator<Item = (K, V)>,
    T1: Iterator<Item = (K, V)>,
{
    type Item = (K, V);
    fn next(&mut self) -> Option<Self::Item> {
        if let (Some(f), Some(s)) = (self.first.peek(), self.second.peek()) {
            if self.backwards {
                match f.0.cmp(&s.0) {
                    Ordering::Less => self.second.next(),
                    Ordering::Greater => self.first.next(),
                    Ordering::Equal => {
                        self.first.next();
                        self.second.next()
                    }
                }
            } else {
                match f.0.cmp(&s.0) {
                    Ordering::Less => self.first.next(),
                    Ordering::Greater => self.second.next(),
                    Ordering::Equal => {
                        self.first.next();
                        self.second.next()
                    }
                }
            }
        } else {
            self.first.next().or_else(|| self.second.next())
        }
    }
}

#[cfg(feature = "persy")]
impl Tree for PersyTree {
    fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>> {
        use persy::ByteVec;
        let result = self
            .db
            .get::<ByteVec, ByteVec>(&self.name, &ByteVec(key.to_vec()))?
            .map(|v| v.into_iter().map(|bv| bv.0).next())
            .flatten();
        let result = self
            .write_cache
            .read()
            .unwrap()
            .get(&self.name, key, result)?;
        Ok(result)
    }

    fn insert(&self, key: &[u8], value: &[u8]) -> Result<()> {
        let watchers = self.watchers.read().unwrap();
        let mut triggered = Vec::new();

        for length in 0..=key.len() {
            if watchers.contains_key(&key[..length]) {
                triggered.push(&key[..length]);
            }
        }

        drop(watchers);

        if !triggered.is_empty() {
            let mut watchers = self.watchers.write().unwrap();
            for prefix in triggered {
                if let Some(txs) = watchers.remove(prefix) {
                    for tx in txs {
                        let _ = tx.send(());
                    }
                }
            }
        }
        self.write_cache
            .write()
            .unwrap()
            .insert(self.name.clone(), key, value)?;
        Ok(())
    }

    fn remove(&self, key: &[u8]) -> Result<()> {
        self.write_cache
            .write()
            .unwrap()
            .remove(self.name.clone(), key)?;
        Ok(())
    }

    fn iter<'a>(&'a self) -> Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + Send + Sync + 'a> {
        use persy::ByteVec;
        let result = Box::new(
            self.db
                .range::<ByteVec, ByteVec, _>(&self.name, ..)
                .unwrap()
                .filter_map(|(k, v)| {
                    v.into_iter()
                        .map(|val| (k.0.to_owned().into(), val.0.to_owned().into()))
                        .next()
                }),
        );

        self.write_cache.read().unwrap().iter(&self.name, result)
    }

    fn iter_from<'a>(
        &'a self,
        from: &[u8],
        backwards: bool,
    ) -> Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + 'a> {
        use persy::ByteVec;
        let iter = if backwards {
            self.db
                .range::<ByteVec, ByteVec, _>(&self.name, ..ByteVec(from.to_owned()))
                .unwrap()
        } else {
            self.db
                .range::<ByteVec, ByteVec, _>(&self.name, ByteVec(from.to_owned())..)
                .unwrap()
        };
        let map = iter.filter_map(|(k, v)| {
            v.into_iter()
                .map(|val| (k.0.to_owned().into(), val.0.to_owned().into()))
                .next()
        });
        let result: Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)>> = if backwards {
            Box::new(map.rev())
        } else {
            Box::new(map)
        };

        self.write_cache
            .read()
            .unwrap()
            .iter_from(&self.name, from, backwards, result)
    }

    fn increment(&self, key: &[u8]) -> Result<Vec<u8>> {
        let old = self.get(key)?;
        let new = utils::increment(old.as_deref()).unwrap();
        self.insert(key, &new)?;
        Ok(new)
    }

    fn scan_prefix<'a>(
        &'a self,
        prefix: Vec<u8>,
    ) -> Box<dyn Iterator<Item = (Box<[u8]>, Box<[u8]>)> + Send + 'a> {
        use persy::ByteVec;

        let range_prefix = ByteVec(prefix.to_owned());
        let owned_prefix = prefix.clone();
        let result = Box::new(
            self.db
                .range::<ByteVec, ByteVec, _>(&self.name, range_prefix..)
                .unwrap()
                .take_while(move |(k, _)| k.0.starts_with(&owned_prefix))
                .filter_map(|(k, v)| {
                    v.into_iter()
                        .map(|val| (k.0.to_owned().into(), val.0.to_owned().into()))
                        .next()
                }),
        );

        self.write_cache
            .read()
            .unwrap()
            .scan_prefix(&self.name, prefix, result)
    }

    fn watch_prefix<'a>(&'a self, prefix: &[u8]) -> Pin<Box<dyn Future<Output = ()> + Send + 'a>> {
        let (tx, rx) = tokio::sync::oneshot::channel();

        self.watchers
            .write()
            .unwrap()
            .entry(prefix.to_vec())
            .or_default()
            .push(tx);

        Box::pin(async move {
            // Tx is never destroyed
            rx.await.unwrap();
        })
    }
}