Making SQL and NoSQL storage engines optional

Author: dr-orlovsky

.gitignore

@@ -10,3 +10,5 @@
 # Temporary directory for debug data storage
 /data
 # /sample
+
+test/data

Cargo.toml

@@ -47,8 +47,8 @@ electrum-client = { version = "0.5.0-beta.1", optional = true, git = "https://gi
 lazy_static = "1.4"
 nix = { version = "0.19", optional = true }
 chrono = "0.4"
-diesel = { version = "1.4", features = ["sqlite", "uuid", "numeric", "chrono"] }
-hammersbald = "2.4"
+diesel = { version = "1.4", optional = true, features = ["sqlite", "uuid", "numeric", "chrono"] }
+hammersbald = { version = "2.4", optional = true }
 # Serialization & parsing
 serde_crate = { package = "serde", version = "1", features = ["derive"], optional = true }
 serde_with = { version = "1.5", optional = true }
@@ -75,6 +75,7 @@ shellexpand = { version = "2.0", optional = true }
 # 5. Simple cli utility app: `shell`
 [features]
 default = ["client", "fungibles"]
+all = ["server", "cli", "serde", "tor", "sql", "nosql", "vendored_openssl", "fungibles", "collectibles", "identities", "auditlogs"]
 
 # Server is a standalone application that runs daemon
 server = ["node", "shell", "nix", "microservices/server"]
@@ -110,6 +111,8 @@ serde = ["serde_crate", "serde_with", "serde_yaml", "serde_json", "toml",
          "amplify/serde", "lnpbp/serde", "internet2/serde", "microservices/serde",
          "chrono/serde", "bitcoin/serde", "rgb20/serde"]
 tor = ["microservices/tor", "internet2/tor"]
+sql = ["diesel"]
+nosql = ["hammersbald"]
 vendored_openssl = ["microservices/vendored_openssl", "internet2/vendored_openssl"]
 
 # Schema-specific components exposed as features:

src/error.rs

@@ -39,7 +39,7 @@ pub enum BootstrapError {
 
     #[cfg(feature = "fungibles")]
     #[from(crate::fungibled::FileCacheError)]
-    #[from(crate::fungibled::SqlCacheError)]
+    #[cfg_attr(feature = "sql", from(crate::fungibled::SqlCacheError))]
     CacheError,
 
     Other,
@@ -90,7 +90,7 @@ pub enum ServiceErrorDomain {
 
     #[cfg(feature = "fungibles")]
     #[from(crate::fungibled::FileCacheError)]
-    #[from(crate::fungibled::SqlCacheError)]
+    #[cfg_attr(feature = "sql", from(crate::fungibled::SqlCacheError))]
     Cache,
 
     Multithreading,

src/fungibled/cache/cache.rs

@@ -15,7 +15,6 @@ use rgb::prelude::*;
 use rgb20::Asset;
 use std::collections::BTreeMap;
 
-use super::sql::SqlCacheError;
 use super::FileCacheError;
 use crate::error::{BootstrapError, ServiceErrorDomain};
 use crate::util::file::FileMode;
@@ -102,30 +101,3 @@ impl From<FileCacheError> for CacheError {
         }
     }
 }
-
-impl From<SqlCacheError> for CacheError {
-    fn from(err: SqlCacheError) -> Self {
-        match err {
-            SqlCacheError::Io(e) => Self::Io(format!("{:?}", e)),
-            SqlCacheError::Sqlite(e) => {
-                Self::Sqlite(format!("Error from sqlite asset cache {}", e.to_string()))
-            }
-            SqlCacheError::HexDecoding(_) => Self::DataIntegrityError(format!(
-                "Wrong hex encoded data in sqlite asset cache table"
-            )),
-            SqlCacheError::Generic(e) => Self::DataIntegrityError(e),
-            SqlCacheError::WrongChainData(e) => Self::DataIntegrityError(format!(
-                "Wrong Chain data in sqlite asset cache table: {}",
-                e
-            )),
-            SqlCacheError::NotFound => {
-                Self::DataIntegrityError(format!("Asset cache sqlite database file not found"))
-            }
-            SqlCacheError::BlindKey(e) => Self::DataIntegrityError(format!(
-                "Wrong amount blinding factor in asset cache sqlite database: {}",
-                e
-            )),
-            SqlCacheError::Bech32(e) => Self::DataIntegrityError(e.to_string()),
-        }
-    }
-}

src/fungibled/cache/file.rs

@@ -264,7 +264,7 @@ impl Cache for FileCache {
     }
 }
 
-#[cfg(test)]
+#[cfg(all(test, feature = "sql"))]
 mod test {
     use super::super::sql::{SqlCache, SqlCacheConfig};
     use super::*;

src/fungibled/cache/mod.rs

@@ -13,8 +13,10 @@
 
 mod cache;
 mod file;
+#[cfg(feature = "sql")]
 mod sql;
 
 pub use cache::{Cache, CacheError};
 pub use file::{FileCache, FileCacheConfig, FileCacheError};
+#[cfg(feature = "sql")]
 pub use sql::{SqlCache, SqlCacheConfig, SqlCacheError};

src/fungibled/cache/sql.rs

@@ -61,6 +61,33 @@ pub enum SqlCacheError {
     NotFound,
 }
 
+impl From<SqlCacheError> for CacheError {
+    fn from(err: SqlCacheError) -> Self {
+        match err {
+            SqlCacheError::Io(e) => Self::Io(format!("{:?}", e)),
+            SqlCacheError::Sqlite(e) => {
+                Self::Sqlite(format!("Error from sqlite asset cache {}", e.to_string()))
+            }
+            SqlCacheError::HexDecoding(_) => Self::DataIntegrityError(format!(
+                "Wrong hex encoded data in sqlite asset cache table"
+            )),
+            SqlCacheError::Generic(e) => Self::DataIntegrityError(e),
+            SqlCacheError::WrongChainData(e) => Self::DataIntegrityError(format!(
+                "Wrong Chain data in sqlite asset cache table: {}",
+                e
+            )),
+            SqlCacheError::NotFound => {
+                Self::DataIntegrityError(format!("Asset cache sqlite database file not found"))
+            }
+            SqlCacheError::BlindKey(e) => Self::DataIntegrityError(format!(
+                "Wrong amount blinding factor in asset cache sqlite database: {}",
+                e
+            )),
+            SqlCacheError::Bech32(e) => Self::DataIntegrityError(e.to_string()),
+        }
+    }
+}
+
 #[derive(Clone, PartialEq, Eq, Hash, Debug, Display)]
 #[display(Debug)]
 pub struct SqlCacheConfig {

src/fungibled/mod.rs

@@ -13,11 +13,14 @@
 
 mod config;
 mod runtime;
+#[cfg(feature = "sql")]
 pub(self) mod sql;
 
 pub(self) mod cache;
 
 pub use config::{Config, Opts};
 pub use runtime::{main_with_config, Runtime};
 
-pub use cache::{CacheError, FileCacheError, SqlCacheError};
+#[cfg(feature = "sql")]
+pub use cache::SqlCacheError;
+pub use cache::{CacheError, FileCacheError};

src/lib.rs

@@ -34,10 +34,9 @@ extern crate serde_crate as serde;
 #[macro_use]
 extern crate serde_with;
 
-#[cfg_attr(feature = "fungibles", macro_use)]
-pub extern crate diesel;
-
-extern crate hammersbald;
+#[cfg(all(feature = "fungibles", feature = "sql"))]
+#[macro_use]
+extern crate diesel;
 
 #[cfg(feature = "cli")]
 pub mod cli;

src/stashd/storage/mod.rs

@@ -12,9 +12,11 @@
 // If not, see <https://opensource.org/licenses/MIT>.
 
 mod disk;
+#[cfg(feature = "hammersbald")]
 mod hammersbald;
 mod store;
 
+#[cfg(feature = "hammersbald")]
 pub use self::hammersbald::HammersbaldStorage;
 pub use disk::{DiskStorage, DiskStorageConfig, DiskStorageError};
 pub use store::Store;