Merge pull request #265 from umccr/feat/c4gh-misc

refactor: C4GH and storage changes

Author: mmalenic

Cargo.lock

@@ -13,12 +13,12 @@ repository = "https://github.com/umccr/htsget-rs"
 [features]
 s3-storage = ["htsget-config/s3-storage", "htsget-search/s3-storage", "htsget-http/s3-storage", "htsget-axum/s3-storage", "htsget-test/s3-storage"]
 url-storage = ["htsget-config/url-storage", "htsget-search/url-storage", "htsget-http/url-storage", "htsget-axum/url-storage", "htsget-test/url-storage"]
-c4gh-experimental = [
-    "htsget-config/c4gh-experimental",
-    "htsget-search/c4gh-experimental",
-    "htsget-http/c4gh-experimental",
-    "htsget-axum/c4gh-experimental",
-    "htsget-test/c4gh-experimental"
+experimental = [
+    "htsget-config/experimental",
+    "htsget-search/experimental",
+    "htsget-http/experimental",
+    "htsget-axum/experimental",
+    "htsget-test/experimental"
 ]
 default = []
 

htsget-actix/Cargo.toml

@@ -31,7 +31,7 @@ This crate is used for running a local instance of htsget-rs. It is based on:
 
 ## Usage
 
-This application has the same functionality as [htsget-axum]. To use it, following the [htsget-axum][htsget-axum-usage] instructions, and
+This application has the same functionality as [htsget-axum]. To use it, following the [htsget-axum][htsget-axum] instructions, and
 replace any calls to `htsget-axum` with `htsget-actix`.
 
 It is recommended to use [htsget-axum] because it better fits with the rest of [htsget-rs]. For example [htsget-actix]
@@ -50,7 +50,7 @@ are exposed in the public API.
 This crate has the following features:
 * `s3-storage`: used to enable `S3Storage` functionality.
 * `url-storage`: used to enable `UrlStorage` functionality.
-* `c4gh-experimental`: used to enable `C4GHStorage` functionality.
+* `experimental`: used to enable `C4GHStorage` functionality.
 
 ## Benchmarks
 Benchmarks for this crate written using [Criterion.rs][criterion-rs], and aim to compare the performance of this crate with the
@@ -76,6 +76,7 @@ cargo bench -p htsget-axum -- HEAVY
 [criterion-rs]: https://github.com/bheisler/criterion.rs
 [htsget-refserver]: https://github.com/ga4gh/htsget-refserver
 [data-vcf]: ../data/vcf
+[htsget-axum]: ../htsget-axum/README.md#usage
 
 ## License
 

htsget-actix/README.md

@@ -17,7 +17,7 @@ use super::handle_response;
 
 /// GET request reads endpoint
 #[instrument(skip(app_state))]
-pub async fn reads<H: HtsGet + Send + Sync + 'static>(
+pub async fn reads<H: HtsGet + Clone + Send + Sync + 'static>(
   request: Query<HashMap<String, String>>,
   path: Path<String>,
   http_request: HttpRequest,
@@ -32,7 +32,7 @@ pub async fn reads<H: HtsGet + Send + Sync + 'static>(
 
 /// GET request variants endpoint
 #[instrument(skip(app_state))]
-pub async fn variants<H: HtsGet + Send + Sync + 'static>(
+pub async fn variants<H: HtsGet + Clone + Send + Sync + 'static>(
   request: Query<HashMap<String, String>>,
   path: Path<String>,
   http_request: HttpRequest,

htsget-actix/src/handlers/get.rs

@@ -18,7 +18,7 @@ use super::handle_response;
 
 /// POST request reads endpoint
 #[instrument(skip(app_state))]
-pub async fn reads<H: HtsGet + Send + Sync + 'static>(
+pub async fn reads<H: HtsGet + Clone + Send + Sync + 'static>(
   request: Query<HashMap<String, String>>,
   body: Json<PostRequest>,
   path: Path<String>,
@@ -42,7 +42,7 @@ pub async fn reads<H: HtsGet + Send + Sync + 'static>(
 
 /// POST request variants endpoint
 #[instrument(skip(app_state))]
-pub async fn variants<H: HtsGet + Send + Sync + 'static>(
+pub async fn variants<H: HtsGet + Clone + Send + Sync + 'static>(
   request: Query<HashMap<String, String>>,
   body: Json<PostRequest>,
   path: Path<String>,

htsget-actix/src/handlers/post.rs

@@ -12,7 +12,7 @@ use crate::AppState;
 
 /// Gets the JSON to return for a service-info endpoint
 #[instrument(skip(app_state))]
-pub fn get_service_info_json<H: HtsGet + Send + Sync + 'static>(
+pub fn get_service_info_json<H: HtsGet + Clone + Send + Sync + 'static>(
   app_state: &AppState<H>,
   endpoint: Endpoint,
 ) -> impl Responder {
@@ -26,14 +26,14 @@ pub fn get_service_info_json<H: HtsGet + Send + Sync + 'static>(
 }
 
 /// Gets the JSON to return for the reads service-info endpoint
-pub async fn reads_service_info<H: HtsGet + Send + Sync + 'static>(
+pub async fn reads_service_info<H: HtsGet + Clone + Send + Sync + 'static>(
   app_state: Data<AppState<H>>,
 ) -> impl Responder {
   get_service_info_json(app_state.get_ref(), Endpoint::Reads)
 }
 
 /// Gets the JSON to return for the variants service-info endpoint
-pub async fn variants_service_info<H: HtsGet + Send + Sync + 'static>(
+pub async fn variants_service_info<H: HtsGet + Clone + Send + Sync + 'static>(
   app_state: Data<AppState<H>>,
 ) -> impl Responder {
   get_service_info_json(app_state.get_ref(), Endpoint::Variants)

htsget-actix/src/handlers/service_info.rs

@@ -1,5 +1,3 @@
-use std::sync::Arc;
-
 use actix_cors::Cors;
 use actix_web::dev::Server;
 use actix_web::{web, App, HttpServer};
@@ -18,19 +16,19 @@ pub mod handlers;
 
 /// Represents the actix app state.
 pub struct AppState<H: HtsGet> {
-  pub htsget: Arc<H>,
+  pub htsget: H,
   pub config_service_info: ServiceInfo,
 }
 
 /// Configure the query server.
-pub fn configure_server<H: HtsGet + Send + Sync + 'static>(
+pub fn configure_server<H: HtsGet + Clone + Send + Sync + 'static>(
   service_config: &mut web::ServiceConfig,
   htsget: H,
   config_service_info: ServiceInfo,
 ) {
   service_config
     .app_data(web::Data::new(AppState {
-      htsget: Arc::new(htsget),
+      htsget,
       config_service_info,
     }))
     .service(

htsget-actix/src/lib.rs

@@ -24,11 +24,11 @@ url-storage = [
     "htsget-test/url-storage",
     "htsget-http/url-storage"
 ]
-c4gh-experimental = [
-    "htsget-config/c4gh-experimental",
-    "htsget-search/c4gh-experimental",
-    "htsget-test/c4gh-experimental",
-    "htsget-http/c4gh-experimental"
+experimental = [
+    "htsget-config/experimental",
+    "htsget-search/experimental",
+    "htsget-test/experimental",
+    "htsget-http/experimental"
 ]
 default = []
 
@@ -40,7 +40,7 @@ tower-http = { version = "0.5", features = ["trace", "cors", "fs"] }
 http = "1"
 axum = { version = "0.7", features = ["http2"] }
 axum-extra = { version = "0.9", features = ["erased-json"] }
-tower = { version = "0.4", features = ["make"] }
+tower = { version = "0.5", features = ["make", "util"] }
 
 # Async
 tokio-rustls = "0.26"

htsget-axum/Cargo.toml

@@ -108,7 +108,7 @@ for more details on how to configure this.
 Run the server with the following to enable Crypt4GH support using the [example config][example-config]:
 
 ```sh
-cargo run -p htsget-axum --features c4gh-experimental -- --config htsget-config/examples/config-files/c4gh.toml
+cargo run -p htsget-axum --features experimental -- --config htsget-config/examples/config-files/c4gh.toml
 ```
 
 Crypt4GH encrypted byte ranges can be queried:
@@ -171,7 +171,7 @@ htsget-rs. It also contains the data block server which fetches data from a `Loc
 This crate has the following features:
 * `s3-storage`: used to enable `S3Storage` functionality.
 * `url-storage`: used to enable `UrlStorage` functionality.
-* `c4gh-experimental`: used to enable `C4GHStorage` functionality.
+* `experimental`: used to enable `C4GHStorage` functionality.
 
 ## License
 

htsget-axum/README.md

@@ -14,7 +14,7 @@ use crate::server::AppState;
 use super::handle_response;
 
 /// POST request reads endpoint.
-pub async fn reads<H: HtsGet + Send + Sync + 'static>(
+pub async fn reads<H: HtsGet + Clone + Send + Sync + 'static>(
   request: Query<HashMap<String, String>>,
   path: Path<String>,
   headers: HeaderMap,
@@ -27,7 +27,7 @@ pub async fn reads<H: HtsGet + Send + Sync + 'static>(
 }
 
 /// POST request variants endpoint.
-pub async fn variants<H: HtsGet + Send + Sync + 'static>(
+pub async fn variants<H: HtsGet + Clone + Send + Sync + 'static>(
   request: Query<HashMap<String, String>>,
   path: Path<String>,
   headers: HeaderMap,