GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-07-07 20:06:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Remove KvStorage

Browse source
This commit is contained in:
dbr 2021-05-28 12:10:18 +10:00
parent 98f2ab51cb
commit baa6b59e39
6 changed files with 4 additions and 316 deletions
Download patch file Download diff file Expand all files Collapse all files

70
Cargo.lock generated
View file

@ -1,5 +1,7 @@
# This file is automatically @generated by Cargo. # This file is automatically @generated by Cargo.
# It is not intended for manual editing. # It is not intended for manual editing.
version = 3
[[package]] [[package]]
name = "actix-codec" name = "actix-codec"
version = "0.3.0" version = "0.3.0"
@ -1161,19 +1163,6 @@ dependencies = [
"winapi-build", "winapi-build",
] ]
[[package]]
name = "kv"
version = "0.10.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "cb79e59d356a5ae85b13990bbb3649a293d64df1ca6e7890822076186527a9f7"
dependencies = [
"lmdb-rkv",
"rmp-serde",
"serde",
"thiserror",
"toml",
]
[[package]] [[package]]
name = "language-tags" name = "language-tags"
version = "0.2.2" version = "0.2.2"
@ -1222,29 +1211,6 @@ version = "0.5.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7fb9b38af92608140b86b693604b9ffcc5824240a484d1ecd4795bacb2fe88f3" checksum = "7fb9b38af92608140b86b693604b9ffcc5824240a484d1ecd4795bacb2fe88f3"
[[package]]
name = "lmdb-rkv"
version = "0.12.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "605061e5465304475be2041f19967a900175ea1b6d8f47fbab84a84fb8c48452"
dependencies = [
"bitflags",
"byteorder",
"libc",
"lmdb-rkv-sys",
]
[[package]]
name = "lmdb-rkv-sys"
version = "0.9.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7982ba0460e939e26a52ee12c8075deab0ebd44ed21881f656841b70e021b7c8"
dependencies = [
"cc",
"libc",
"pkg-config",
]
[[package]] [[package]]
name = "lock_api" name = "lock_api"
version = "0.4.3" version = "0.4.3"
@ -1865,27 +1831,6 @@ dependencies = [
"winapi 0.3.9", "winapi 0.3.9",
] ]
[[package]]
name = "rmp"
version = "0.8.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4f55e5fa1446c4d5dd1f5daeed2a4fe193071771a2636274d0d7a3b082aa7ad6"
dependencies = [
"byteorder",
"num-traits",
]
[[package]]
name = "rmp-serde"
version = "0.14.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4ce7d70c926fe472aed493b902010bccc17fa9f7284145cb8772fd22fdb052d8"
dependencies = [
"byteorder",
"rmp",
"serde",
]
[[package]] [[package]]
name = "rusqlite" name = "rusqlite"
version = "0.25.1" version = "0.25.1"
@ -2183,7 +2128,6 @@ version = "0.3.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"chrono", "chrono",
"kv",
"log", "log",
"proptest", "proptest",
"rusqlite", "rusqlite",
@ -2226,7 +2170,6 @@ dependencies = [
"clap", "clap",
"env_logger", "env_logger",
"futures", "futures",
"kv",
"log", "log",
"rusqlite", "rusqlite",
"serde", "serde",
@ -2454,15 +2397,6 @@ dependencies = [
"tokio 0.2.25", "tokio 0.2.25",
] ]
[[package]]
name = "toml"
version = "0.5.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a31142970826733df8241ef35dc040ef98c679ab14d7c3e54d827099b3acecaa"
dependencies = [
"serde",
]
[[package]] [[package]]
name = "tracing" name = "tracing"
version = "0.1.25" version = "0.1.25"

1
sync-server/Cargo.toml
View file

@ -14,7 +14,6 @@ thiserror = "1.0"
futures = "^0.3.8" futures = "^0.3.8"
serde = "^1.0.125" serde = "^1.0.125"
serde_json = "^1.0" serde_json = "^1.0"
kv = {version = "^0.10.0", features = ["msgpack-value"]}
clap = "^2.33.0" clap = "^2.33.0"
log = "^0.4.14" log = "^0.4.14"
env_logger = "^0.8.3" env_logger = "^0.8.3"

4
sync-server/src/main.rs
View file

@ -1,6 +1,6 @@
#![deny(clippy::all)] #![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 actix_web::{get, middleware::Logger, web, App, HttpServer, Responder, Scope};
use api::{api_scope, ServerState}; use api::{api_scope, ServerState};
use clap::Arg; use clap::Arg;
@ -56,7 +56,7 @@ async fn main() -> anyhow::Result<()> {
let data_dir = matches.value_of("data-dir").unwrap(); let data_dir = matches.value_of("data-dir").unwrap();
let port = matches.value_of("port").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); let server_state = ServerState::new(server_box);
log::warn!("Serving on port {}", port); log::warn!("Serving on port {}", port);

241
sync-server/src/storage/kv.rs
View file

@ -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(())
}
}

3
sync-server/src/storage/mod.rs
View file

@ -9,9 +9,6 @@ pub(crate) use inmemory::InMemoryStorage;
mod sqlite; mod sqlite;
pub(crate) use self::sqlite::SqliteStorage; pub(crate) use self::sqlite::SqliteStorage;
mod kv;
pub(crate) use self::kv::KvStorage;
#[derive(Clone, PartialEq, Debug, Serialize, Deserialize)] #[derive(Clone, PartialEq, Debug, Serialize, Deserialize)]
pub(crate) struct Client { pub(crate) struct Client {
pub(crate) latest_version_id: Uuid, pub(crate) latest_version_id: Uuid,

1
taskchampion/Cargo.toml
View file

@ -17,7 +17,6 @@ serde_json = "^1.0"
chrono = { version = "^0.4.10", features = ["serde"] } chrono = { version = "^0.4.10", features = ["serde"] }
anyhow = "1.0" anyhow = "1.0"
thiserror = "1.0" thiserror = "1.0"
kv = {version = "^0.10.0", features = ["msgpack-value"]}
ureq = "^2.1.0" ureq = "^2.1.0"
log = "^0.4.14" log = "^0.4.14"
tindercrypt = { version = "^0.2.2", default-features = false } tindercrypt = { version = "^0.2.2", default-features = false }