refactor: remove ObjectType in favour of a more flattened config hierarchy

Author: mmalenic

Cargo.lock

@@ -12,7 +12,7 @@ repository = "https://github.com/umccr/htsget-rs"
 
 [features]
 s3-storage = []
-url-storage = ["dep:reqwest"]
+url-storage = ["dep:reqwest", "dep:cfg-if"]
 experimental = ["dep:crypt4gh"]
 default = []
 
@@ -37,6 +37,7 @@ rustls-pki-types = "1"
 
 # url-storage
 reqwest = { version = "0.12", features = ["rustls-tls"], default-features = false, optional = true }
+cfg-if = { version = "1", optional = true }
 
 # Crypt4GH
 crypt4gh = { version = "0.4", git = "https://github.com/EGA-archive/crypt4gh-rust", optional = true }

htsget-config/Cargo.toml

@@ -8,9 +8,9 @@ use serde_with::with_prefix;
 use tracing::instrument;
 
 use crate::config::DataServerConfig;
-use crate::storage::local::LocalStorage;
+use crate::storage::local::Local;
 #[cfg(feature = "s3-storage")]
-use crate::storage::s3::S3Storage;
+use crate::storage::s3::S3;
 #[cfg(feature = "url-storage")]
 use crate::storage::url::UrlStorageClient;
 use crate::storage::{ResolvedId, Storage};
@@ -27,11 +27,11 @@ pub trait IdResolver {
 #[async_trait]
 pub trait ResolveResponse {
   /// Convert from `LocalStorage`.
-  async fn from_local(local_storage: &LocalStorage, query: &Query) -> Result<Response>;
+  async fn from_local(local_storage: &Local, query: &Query) -> Result<Response>;
 
   /// Convert from `S3Storage`.
   #[cfg(feature = "s3-storage")]
-  async fn from_s3(s3_storage: &S3Storage, query: &Query) -> Result<Response>;
+  async fn from_s3(s3_storage: &S3, query: &Query) -> Result<Response>;
 
   /// Convert from `UrlStorage`.
   #[cfg(feature = "url-storage")]
@@ -444,7 +444,7 @@ mod tests {
 
   use crate::config::tests::{test_config_from_env, test_config_from_file};
   #[cfg(feature = "s3-storage")]
-  use crate::storage::s3::S3Storage;
+  use crate::storage::s3::S3;
   use crate::types::Scheme::Http;
   use crate::types::Url;
 
@@ -454,15 +454,15 @@ mod tests {
 
   #[async_trait]
   impl ResolveResponse for TestResolveResponse {
-    async fn from_local(local_storage: &LocalStorage, _: &Query) -> Result<Response> {
+    async fn from_local(local_storage: &Local, _: &Query) -> Result<Response> {
       Ok(Response::new(
         Bam,
         vec![Url::new(local_storage.authority().to_string())],
       ))
     }
 
     #[cfg(feature = "s3-storage")]
-    async fn from_s3(s3_storage: &S3Storage, _: &Query) -> Result<Response> {
+    async fn from_s3(s3_storage: &S3, _: &Query) -> Result<Response> {
       Ok(Response::new(Bam, vec![Url::new(s3_storage.bucket())]))
     }
 
@@ -477,12 +477,11 @@ mod tests {
 
   #[tokio::test]
   async fn resolver_resolve_local_request() {
-    let local_storage = LocalStorage::new(
+    let local_storage = Local::new(
       Http,
       Authority::from_static("127.0.0.1:8080"),
       "data".to_string(),
       "/data".to_string(),
-      Default::default(),
       false,
     );
     let resolver = Resolver::new(
@@ -499,7 +498,7 @@ mod tests {
   #[cfg(feature = "s3-storage")]
   #[tokio::test]
   async fn resolver_resolve_s3_request_tagged() {
-    let s3_storage = S3Storage::new("id".to_string(), None, false, Default::default());
+    let s3_storage = S3::new("id".to_string(), None, false);
     let resolver = Resolver::new(
       Storage::S3(s3_storage),
       "(id)-1",
@@ -515,7 +514,7 @@ mod tests {
   #[tokio::test]
   async fn resolver_resolve_s3_request() {
     let resolver = Resolver::new(
-      Storage::S3(S3Storage::default()),
+      Storage::S3(S3::default()),
       "(id)-1",
       "$1-test",
       AllowGuard::default(),
@@ -538,7 +537,6 @@ mod tests {
       }),
       true,
       vec![],
-      Default::default(),
       client,
     );
 
@@ -693,8 +691,7 @@ mod tests {
           Interval::new(Some(100), Some(1000)),
         );
         let resolver = config.resolvers().first().unwrap();
-        let expected_storage =
-          S3Storage::new("bucket".to_string(), None, false, Default::default());
+        let expected_storage = S3::new("bucket".to_string(), None, false);
 
         assert_eq!(resolver.regex().to_string(), "regex");
         assert_eq!(resolver.substitution_string(), "substitution_string");

htsget-config/src/resolver.rs

@@ -117,7 +117,7 @@ mod tests {
     test_c4gh_storage_config(r#"backend = "Local""#, |config| {
       assert!(matches!(
             config.resolvers().first().unwrap().storage(),
-            Storage::Local(local_storage) if local_storage.object_type().keys().is_some()
+            Storage::Local(local_storage) if local_storage.keys().is_some()
       ));
     });
   }
@@ -133,7 +133,7 @@ mod tests {
       |config| {
         assert!(matches!(
               config.resolvers().first().unwrap().storage(),
-              Storage::S3(s3_storage) if s3_storage.object_type().keys().is_some()
+              Storage::S3(s3_storage) if s3_storage.keys().is_some()
         ));
       },
     );
@@ -152,7 +152,7 @@ mod tests {
       |config| {
         assert!(matches!(
               config.resolvers().first().unwrap().storage(),
-              Storage::Url(url_storage) if url_storage.object_type().keys().is_some()
+              Storage::Url(url_storage) if url_storage.keys().is_some()
         ));
       },
     );

htsget-config/src/storage/object/c4gh.rs renamed to htsget-config/src/storage/c4gh.rs

@@ -4,7 +4,8 @@ use http::uri::Authority;
 use serde::{Deserialize, Serialize};
 
 use crate::config::{default_localstorage_addr, default_path, DataServerConfig};
-use crate::storage::object::ObjectType;
+#[cfg(feature = "experimental")]
+use crate::storage::c4gh::C4GHKeys;
 use crate::tls::KeyPairScheme;
 use crate::types::Scheme;
 
@@ -18,34 +19,35 @@ fn default_local_path() -> String {
 
 #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
 #[serde(default)]
-pub struct LocalStorage {
+pub struct Local {
   scheme: Scheme,
   #[serde(with = "http_serde::authority")]
   authority: Authority,
   local_path: String,
   path_prefix: String,
-  #[serde(flatten)]
-  object_type: ObjectType,
   use_data_server_config: bool,
+  #[serde(skip_serializing, flatten)]
+  #[cfg(feature = "experimental")]
+  keys: Option<C4GHKeys>,
 }
 
-impl LocalStorage {
+impl Local {
   /// Create a new local storage.
   pub fn new(
     scheme: Scheme,
     authority: Authority,
     local_path: String,
     path_prefix: String,
-    object_type: ObjectType,
     use_data_server_config: bool,
   ) -> Self {
     Self {
       scheme,
       authority,
       local_path,
       path_prefix,
-      object_type,
       use_data_server_config,
+      #[cfg(feature = "experimental")]
+      keys: None,
     }
   }
 
@@ -69,38 +71,44 @@ impl LocalStorage {
     &self.path_prefix
   }
 
-  /// Get the object type.
-  pub fn object_type(&self) -> &ObjectType {
-    &self.object_type
-  }
-
   /// Get whether config should be inherited from the data server config.
   pub fn use_data_server_config(&self) -> bool {
     self.use_data_server_config
   }
+
+  #[cfg(feature = "experimental")]
+  /// Set the C4GH keys.
+  pub fn set_keys(mut self, keys: Option<C4GHKeys>) -> Self {
+    self.keys = keys;
+    self
+  }
+
+  #[cfg(feature = "experimental")]
+  /// Get the C4GH keys.
+  pub fn keys(&self) -> Option<&C4GHKeys> {
+    self.keys.as_ref()
+  }
 }
 
-impl Default for LocalStorage {
+impl Default for Local {
   fn default() -> Self {
-    Self {
-      scheme: Scheme::Http,
-      authority: default_authority(),
-      local_path: default_local_path(),
-      path_prefix: Default::default(),
-      object_type: Default::default(),
-      use_data_server_config: false,
-    }
+    Self::new(
+      Scheme::Http,
+      default_authority(),
+      default_local_path(),
+      Default::default(),
+      false,
+    )
   }
 }
 
-impl From<&DataServerConfig> for LocalStorage {
+impl From<&DataServerConfig> for Local {
   fn from(config: &DataServerConfig) -> Self {
-    LocalStorage::new(
+    Self::new(
       config.tls().get_scheme(),
       Authority::from_str(&config.addr().to_string()).expect("expected valid authority"),
       config.local_path().to_string_lossy().to_string(),
       config.serve_at().to_string(),
-      Default::default(),
       true,
     )
   }
@@ -151,13 +159,12 @@ mod tests {
       None,
       CorsConfig::default(),
     );
-    let result: LocalStorage = (&data_server_config).into();
-    let expected = LocalStorage::new(
+    let result: Local = (&data_server_config).into();
+    let expected = Local::new(
       Http,
       Authority::from_static("127.0.0.1:8080"),
       "data".to_string(),
       "/data".to_string(),
-      Default::default(),
       true,
     );
 

htsget-config/src/storage/local.rs

@@ -1,12 +1,13 @@
-use crate::storage::local::LocalStorage;
+use crate::storage::local::Local;
 #[cfg(feature = "s3-storage")]
-use crate::storage::s3::S3Storage;
+use crate::storage::s3::S3;
 #[cfg(feature = "url-storage")]
 use crate::storage::url::UrlStorageClient;
 use serde::{Deserialize, Serialize};
 
+#[cfg(feature = "experimental")]
+pub mod c4gh;
 pub mod local;
-pub mod object;
 #[cfg(feature = "s3-storage")]
 pub mod s3;
 #[cfg(feature = "url-storage")]
@@ -34,10 +35,10 @@ impl ResolvedId {
 #[non_exhaustive]
 pub enum Storage {
   #[serde(alias = "local", alias = "LOCAL")]
-  Local(LocalStorage),
+  Local(Local),
   #[cfg(feature = "s3-storage")]
   #[serde(alias = "s3")]
-  S3(S3Storage),
+  S3(S3),
   #[cfg(feature = "url-storage")]
   #[serde(alias = "url", alias = "URL")]
   Url(#[serde(skip_serializing)] UrlStorageClient),