mirror of
https://github.com/GothenburgBitFactory/taskwarrior.git
synced 2025-07-07 20:06:36 +02:00
Remove KvStorage
This commit is contained in:
parent
98f2ab51cb
commit
baa6b59e39
6 changed files with 4 additions and 316 deletions
|
@ -14,7 +14,6 @@ thiserror = "1.0"
|
|||
futures = "^0.3.8"
|
||||
serde = "^1.0.125"
|
||||
serde_json = "^1.0"
|
||||
kv = {version = "^0.10.0", features = ["msgpack-value"]}
|
||||
clap = "^2.33.0"
|
||||
log = "^0.4.14"
|
||||
env_logger = "^0.8.3"
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
#![deny(clippy::all)]
|
||||
|
||||
use crate::storage::{KvStorage, Storage};
|
||||
use crate::storage::{SqliteStorage, Storage};
|
||||
use actix_web::{get, middleware::Logger, web, App, HttpServer, Responder, Scope};
|
||||
use api::{api_scope, ServerState};
|
||||
use clap::Arg;
|
||||
|
@ -56,7 +56,7 @@ async fn main() -> anyhow::Result<()> {
|
|||
let data_dir = matches.value_of("data-dir").unwrap();
|
||||
let port = matches.value_of("port").unwrap();
|
||||
|
||||
let server_box: Box<dyn Storage> = Box::new(KvStorage::new(data_dir)?);
|
||||
let server_box: Box<dyn Storage> = Box::new(SqliteStorage::new(data_dir)?);
|
||||
let server_state = ServerState::new(server_box);
|
||||
|
||||
log::warn!("Serving on port {}", port);
|
||||
|
|
|
@ -1,241 +0,0 @@
|
|||
use super::{Client, Storage, StorageTxn, Uuid, Version};
|
||||
use kv::msgpack::Msgpack;
|
||||
use kv::{Bucket, Config, Error, Serde, Store, ValueBuf};
|
||||
use std::path::Path;
|
||||
|
||||
/// DB Key for versions: concatenation of client_key and parent_version_id
|
||||
type VersionDbKey = [u8; 32];
|
||||
|
||||
fn version_db_key(client_key: Uuid, parent_version_id: Uuid) -> VersionDbKey {
|
||||
let mut key = [0u8; 32];
|
||||
key[..16].clone_from_slice(client_key.as_bytes());
|
||||
key[16..].clone_from_slice(parent_version_id.as_bytes());
|
||||
key
|
||||
}
|
||||
|
||||
/// Key for clients: just the client_key
|
||||
type ClientDbKey = [u8; 16];
|
||||
|
||||
fn client_db_key(client_key: Uuid) -> ClientDbKey {
|
||||
*client_key.as_bytes()
|
||||
}
|
||||
|
||||
/// KvStorage is an on-disk storage backend which uses LMDB via the `kv` crate.
|
||||
pub(crate) struct KvStorage<'t> {
|
||||
store: Store,
|
||||
clients_bucket: Bucket<'t, ClientDbKey, ValueBuf<Msgpack<Client>>>,
|
||||
versions_bucket: Bucket<'t, VersionDbKey, ValueBuf<Msgpack<Version>>>,
|
||||
}
|
||||
|
||||
impl<'t> KvStorage<'t> {
|
||||
pub fn new<P: AsRef<Path>>(directory: P) -> anyhow::Result<KvStorage<'t>> {
|
||||
let mut config = Config::default(directory);
|
||||
config.bucket("clients", None);
|
||||
config.bucket("versions", None);
|
||||
|
||||
let store = Store::new(config)?;
|
||||
|
||||
let clients_bucket =
|
||||
store.bucket::<ClientDbKey, ValueBuf<Msgpack<Client>>>(Some("clients"))?;
|
||||
let versions_bucket =
|
||||
store.bucket::<VersionDbKey, ValueBuf<Msgpack<Version>>>(Some("versions"))?;
|
||||
|
||||
Ok(KvStorage {
|
||||
store,
|
||||
clients_bucket,
|
||||
versions_bucket,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl<'t> Storage for KvStorage<'t> {
|
||||
fn txn<'a>(&'a self) -> anyhow::Result<Box<dyn StorageTxn + 'a>> {
|
||||
Ok(Box::new(Txn {
|
||||
storage: self,
|
||||
txn: Some(self.store.write_txn()?),
|
||||
}))
|
||||
}
|
||||
}
|
||||
|
||||
struct Txn<'t> {
|
||||
storage: &'t KvStorage<'t>,
|
||||
txn: Option<kv::Txn<'t>>,
|
||||
}
|
||||
|
||||
impl<'t> Txn<'t> {
|
||||
// get the underlying kv Txn
|
||||
fn kvtxn(&mut self) -> &mut kv::Txn<'t> {
|
||||
if let Some(ref mut txn) = self.txn {
|
||||
txn
|
||||
} else {
|
||||
panic!("cannot use transaction after commit");
|
||||
}
|
||||
}
|
||||
|
||||
fn clients_bucket(&self) -> &'t Bucket<'t, ClientDbKey, ValueBuf<Msgpack<Client>>> {
|
||||
&self.storage.clients_bucket
|
||||
}
|
||||
fn versions_bucket(&self) -> &'t Bucket<'t, VersionDbKey, ValueBuf<Msgpack<Version>>> {
|
||||
&self.storage.versions_bucket
|
||||
}
|
||||
}
|
||||
|
||||
impl<'t> StorageTxn for Txn<'t> {
|
||||
fn get_client(&mut self, client_key: Uuid) -> anyhow::Result<Option<Client>> {
|
||||
let key = client_db_key(client_key);
|
||||
let bucket = self.clients_bucket();
|
||||
let kvtxn = self.kvtxn();
|
||||
|
||||
let client = match kvtxn.get(&bucket, key) {
|
||||
Ok(buf) => buf,
|
||||
Err(Error::NotFound) => return Ok(None),
|
||||
Err(e) => return Err(e.into()),
|
||||
}
|
||||
.inner()?
|
||||
.to_serde();
|
||||
Ok(Some(client))
|
||||
}
|
||||
|
||||
fn new_client(&mut self, client_key: Uuid, latest_version_id: Uuid) -> anyhow::Result<()> {
|
||||
let key = client_db_key(client_key);
|
||||
let bucket = self.clients_bucket();
|
||||
let kvtxn = self.kvtxn();
|
||||
let client = Client { latest_version_id };
|
||||
kvtxn.set(&bucket, key, Msgpack::to_value_buf(client)?)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn set_client_latest_version_id(
|
||||
&mut self,
|
||||
client_key: Uuid,
|
||||
latest_version_id: Uuid,
|
||||
) -> anyhow::Result<()> {
|
||||
// implementation is the same as new_client..
|
||||
self.new_client(client_key, latest_version_id)
|
||||
}
|
||||
|
||||
fn get_version_by_parent(
|
||||
&mut self,
|
||||
client_key: Uuid,
|
||||
parent_version_id: Uuid,
|
||||
) -> anyhow::Result<Option<Version>> {
|
||||
let key = version_db_key(client_key, parent_version_id);
|
||||
let bucket = self.versions_bucket();
|
||||
let kvtxn = self.kvtxn();
|
||||
let version = match kvtxn.get(&bucket, key) {
|
||||
Ok(buf) => buf,
|
||||
Err(Error::NotFound) => return Ok(None),
|
||||
Err(e) => return Err(e.into()),
|
||||
}
|
||||
.inner()?
|
||||
.to_serde();
|
||||
Ok(Some(version))
|
||||
}
|
||||
|
||||
fn add_version(
|
||||
&mut self,
|
||||
client_key: Uuid,
|
||||
version_id: Uuid,
|
||||
parent_version_id: Uuid,
|
||||
history_segment: Vec<u8>,
|
||||
) -> anyhow::Result<()> {
|
||||
let key = version_db_key(client_key, parent_version_id);
|
||||
let bucket = self.versions_bucket();
|
||||
let kvtxn = self.kvtxn();
|
||||
let version = Version {
|
||||
version_id,
|
||||
parent_version_id,
|
||||
history_segment,
|
||||
};
|
||||
kvtxn.set(&bucket, key, Msgpack::to_value_buf(version)?)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn commit(&mut self) -> anyhow::Result<()> {
|
||||
if let Some(kvtxn) = self.txn.take() {
|
||||
kvtxn.commit()?;
|
||||
} else {
|
||||
panic!("transaction already committed");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use super::*;
|
||||
use tempfile::TempDir;
|
||||
|
||||
#[test]
|
||||
fn test_get_client_empty() -> anyhow::Result<()> {
|
||||
let tmp_dir = TempDir::new()?;
|
||||
let storage = KvStorage::new(&tmp_dir.path())?;
|
||||
let mut txn = storage.txn()?;
|
||||
let maybe_client = txn.get_client(Uuid::new_v4())?;
|
||||
assert!(maybe_client.is_none());
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_client_storage() -> anyhow::Result<()> {
|
||||
let tmp_dir = TempDir::new()?;
|
||||
let storage = KvStorage::new(&tmp_dir.path())?;
|
||||
let mut txn = storage.txn()?;
|
||||
|
||||
let client_key = Uuid::new_v4();
|
||||
let latest_version_id = Uuid::new_v4();
|
||||
txn.new_client(client_key, latest_version_id)?;
|
||||
|
||||
let client = txn.get_client(client_key)?.unwrap();
|
||||
assert_eq!(client.latest_version_id, latest_version_id);
|
||||
|
||||
let latest_version_id = Uuid::new_v4();
|
||||
txn.set_client_latest_version_id(client_key, latest_version_id)?;
|
||||
|
||||
let client = txn.get_client(client_key)?.unwrap();
|
||||
assert_eq!(client.latest_version_id, latest_version_id);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_gvbp_empty() -> anyhow::Result<()> {
|
||||
let tmp_dir = TempDir::new()?;
|
||||
let storage = KvStorage::new(&tmp_dir.path())?;
|
||||
let mut txn = storage.txn()?;
|
||||
let maybe_version = txn.get_version_by_parent(Uuid::new_v4(), Uuid::new_v4())?;
|
||||
assert!(maybe_version.is_none());
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_add_version_and_gvbp() -> anyhow::Result<()> {
|
||||
let tmp_dir = TempDir::new()?;
|
||||
let storage = KvStorage::new(&tmp_dir.path())?;
|
||||
let mut txn = storage.txn()?;
|
||||
|
||||
let client_key = Uuid::new_v4();
|
||||
let version_id = Uuid::new_v4();
|
||||
let parent_version_id = Uuid::new_v4();
|
||||
let history_segment = b"abc".to_vec();
|
||||
txn.add_version(
|
||||
client_key,
|
||||
version_id,
|
||||
parent_version_id,
|
||||
history_segment.clone(),
|
||||
)?;
|
||||
let version = txn
|
||||
.get_version_by_parent(client_key, parent_version_id)?
|
||||
.unwrap();
|
||||
|
||||
assert_eq!(
|
||||
version,
|
||||
Version {
|
||||
version_id,
|
||||
parent_version_id,
|
||||
history_segment,
|
||||
}
|
||||
);
|
||||
Ok(())
|
||||
}
|
||||
}
|
|
@ -9,9 +9,6 @@ pub(crate) use inmemory::InMemoryStorage;
|
|||
mod sqlite;
|
||||
pub(crate) use self::sqlite::SqliteStorage;
|
||||
|
||||
mod kv;
|
||||
pub(crate) use self::kv::KvStorage;
|
||||
|
||||
#[derive(Clone, PartialEq, Debug, Serialize, Deserialize)]
|
||||
pub(crate) struct Client {
|
||||
pub(crate) latest_version_id: Uuid,
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue