|
| 1 | +use io::Error; |
| 2 | +use std::io; |
| 3 | +use std::io::ErrorKind; |
| 4 | +#[cfg(test)] |
| 5 | +use std::panic::RefUnwindSafe; |
| 6 | + |
| 7 | +use crate::io::utils::check_namespace_key_validity; |
| 8 | +use lightning::util::persist::KVStore; |
| 9 | +use tokio::runtime::Runtime; |
| 10 | +use vss_client::client::VssClient; |
| 11 | +use vss_client::error::VssError; |
| 12 | +use vss_client::types::{ |
| 13 | + DeleteObjectRequest, GetObjectRequest, KeyValue, ListKeyVersionsRequest, PutObjectRequest, |
| 14 | +}; |
| 15 | + |
| 16 | +/// A [`KVStore`] implementation that writes to and reads from a [VSS](https://github.com/lightningdevkit/vss-server/blob/main/README.md) backend. |
| 17 | +pub struct VssStore { |
| 18 | + client: VssClient, |
| 19 | + store_id: String, |
| 20 | + runtime: Runtime, |
| 21 | +} |
| 22 | + |
| 23 | +impl VssStore { |
| 24 | + #[cfg(feature = "vss")] |
| 25 | + pub(crate) fn new(base_url: &str, store_id: String) -> Self { |
| 26 | + let client = VssClient::new(base_url); |
| 27 | + let runtime = tokio::runtime::Builder::new_multi_thread().enable_all().build().unwrap(); |
| 28 | + Self { client, store_id, runtime } |
| 29 | + } |
| 30 | + |
| 31 | + fn build_key(&self, namespace: &str, sub_namespace: &str, key: &str) -> io::Result<String> { |
| 32 | + if key.is_empty() { |
| 33 | + return Err(Error::new(ErrorKind::Other, "Empty key is not allowed")); |
| 34 | + } |
| 35 | + // But namespace and sub_namespace can be empty |
| 36 | + if namespace.is_empty() { |
| 37 | + Ok(key.to_string()) |
| 38 | + } else { |
| 39 | + Ok(format!("{}#{}#{}", namespace, sub_namespace, key)) |
| 40 | + } |
| 41 | + } |
| 42 | + |
| 43 | + fn split_key(&self, key: &str) -> io::Result<(String, String, String)> { |
| 44 | + let parts: Vec<&str> = key.split('#').collect(); |
| 45 | + match parts.as_slice() { |
| 46 | + [namespace, sub_namespace, actual_key] => { |
| 47 | + Ok((namespace.to_string(), sub_namespace.to_string(), actual_key.to_string())) |
| 48 | + } |
| 49 | + _ => Err(Error::new(ErrorKind::InvalidData, "Invalid key format")), |
| 50 | + } |
| 51 | + } |
| 52 | + |
| 53 | + async fn list_all_keys(&self, namespace: &str, sub_namespace: &str) -> io::Result<Vec<String>> { |
| 54 | + let mut page_token = None; |
| 55 | + let mut keys = vec![]; |
| 56 | + let key_prefix = format!("{}#{}", namespace, sub_namespace); |
| 57 | + while page_token != Some("".to_string()) { |
| 58 | + let request = ListKeyVersionsRequest { |
| 59 | + store_id: self.store_id.to_string(), |
| 60 | + key_prefix: Some(key_prefix.to_string()), |
| 61 | + page_token, |
| 62 | + page_size: None, |
| 63 | + }; |
| 64 | + |
| 65 | + let response = self.client.list_key_versions(&request).await.map_err(|e| { |
| 66 | + let msg = format!("Failed to list keys in {}/{}: {}", namespace, sub_namespace, e); |
| 67 | + Error::new(ErrorKind::Other, msg) |
| 68 | + })?; |
| 69 | + |
| 70 | + for kv in response.key_versions { |
| 71 | + keys.push(self.split_key(&kv.key)?.2); |
| 72 | + } |
| 73 | + page_token = response.next_page_token; |
| 74 | + } |
| 75 | + Ok(keys) |
| 76 | + } |
| 77 | +} |
| 78 | + |
| 79 | +impl KVStore for VssStore { |
| 80 | + fn read(&self, namespace: &str, sub_namespace: &str, key: &str) -> io::Result<Vec<u8>> { |
| 81 | + check_namespace_key_validity(namespace, sub_namespace, Some(key), "read")?; |
| 82 | + let request = GetObjectRequest { |
| 83 | + store_id: self.store_id.to_string(), |
| 84 | + key: self.build_key(namespace, sub_namespace, key)?, |
| 85 | + }; |
| 86 | + // self.runtime.spawn() |
| 87 | + let resp = |
| 88 | + tokio::task::block_in_place(|| self.runtime.block_on(self.client.get_object(&request))) |
| 89 | + .map_err(|e| match e { |
| 90 | + VssError::NoSuchKeyError(..) => { |
| 91 | + let msg = format!( |
| 92 | + "Failed to read as key could not be found: {}/{}. Details: {}", |
| 93 | + namespace, key, e |
| 94 | + ); |
| 95 | + Error::new(ErrorKind::NotFound, msg) |
| 96 | + } |
| 97 | + _ => { |
| 98 | + let msg = format!("Failed to read from key {}/{}: {}", namespace, key, e); |
| 99 | + Error::new(ErrorKind::Other, msg) |
| 100 | + } |
| 101 | + })?; |
| 102 | + Ok(resp.value.unwrap().value) |
| 103 | + } |
| 104 | + |
| 105 | + fn write(&self, namespace: &str, sub_namespace: &str, key: &str, buf: &[u8]) -> io::Result<()> { |
| 106 | + check_namespace_key_validity(namespace, sub_namespace, Some(key), "write")?; |
| 107 | + let request = PutObjectRequest { |
| 108 | + store_id: self.store_id.to_string(), |
| 109 | + global_version: None, |
| 110 | + transaction_items: vec![KeyValue { |
| 111 | + key: self.build_key(namespace, sub_namespace, key)?, |
| 112 | + version: -1, |
| 113 | + value: buf.to_vec(), |
| 114 | + }], |
| 115 | + delete_items: vec![], |
| 116 | + }; |
| 117 | + |
| 118 | + tokio::task::block_in_place(|| self.runtime.block_on(self.client.put_object(&request))) |
| 119 | + .map_err(|e| { |
| 120 | + let msg = format!("Failed to write to key {}/{}: {}", namespace, key, e); |
| 121 | + Error::new(ErrorKind::Other, msg) |
| 122 | + })?; |
| 123 | + |
| 124 | + Ok(()) |
| 125 | + } |
| 126 | + |
| 127 | + fn remove( |
| 128 | + &self, namespace: &str, sub_namespace: &str, key: &str, _lazy: bool, |
| 129 | + ) -> io::Result<()> { |
| 130 | + check_namespace_key_validity(namespace, sub_namespace, Some(key), "remove")?; |
| 131 | + let request = DeleteObjectRequest { |
| 132 | + store_id: self.store_id.to_string(), |
| 133 | + key_value: Some(KeyValue { |
| 134 | + key: self.build_key(namespace, sub_namespace, key)?, |
| 135 | + version: -1, |
| 136 | + value: vec![], |
| 137 | + }), |
| 138 | + }; |
| 139 | + |
| 140 | + tokio::task::block_in_place(|| self.runtime.block_on(self.client.delete_object(&request))) |
| 141 | + .map_err(|e| { |
| 142 | + let msg = format!("Failed to delete key {}/{}: {}", namespace, key, e); |
| 143 | + Error::new(ErrorKind::Other, msg) |
| 144 | + })?; |
| 145 | + Ok(()) |
| 146 | + } |
| 147 | + |
| 148 | + fn list(&self, namespace: &str, sub_namespace: &str) -> io::Result<Vec<String>> { |
| 149 | + check_namespace_key_validity(namespace, sub_namespace, None, "list")?; |
| 150 | + |
| 151 | + let keys = tokio::task::block_in_place(|| { |
| 152 | + self.runtime.block_on(self.list_all_keys(namespace, sub_namespace)) |
| 153 | + }) |
| 154 | + .map_err(|e| { |
| 155 | + let msg = format!("Failed to retrieve keys in namespace: {} : {}", namespace, e); |
| 156 | + Error::new(ErrorKind::Other, msg) |
| 157 | + })?; |
| 158 | + |
| 159 | + Ok(keys) |
| 160 | + } |
| 161 | +} |
| 162 | + |
| 163 | +#[cfg(test)] |
| 164 | +impl RefUnwindSafe for VssStore {} |
| 165 | + |
| 166 | +#[cfg(test)] |
| 167 | +#[cfg(feature = "vss-test")] |
| 168 | +mod tests { |
| 169 | + use super::*; |
| 170 | + use crate::io::test_utils::do_read_write_remove_list_persist; |
| 171 | + use rand::distributions::Alphanumeric; |
| 172 | + use rand::{thread_rng, Rng}; |
| 173 | + |
| 174 | + #[test] |
| 175 | + fn read_write_remove_list_persist() { |
| 176 | + let vss_base_url = std::env::var("TEST_VSS_BASE_URL").unwrap(); |
| 177 | + let mut rng = thread_rng(); |
| 178 | + let rand_store_id: String = (0..7).map(|_| rng.sample(Alphanumeric) as char).collect(); |
| 179 | + let vss_store = VssStore::new(&vss_base_url, rand_store_id); |
| 180 | + |
| 181 | + do_read_write_remove_list_persist(&vss_store); |
| 182 | + } |
| 183 | +} |
0 commit comments