Merge pull request #16 from ATLAS-Space-Operations/dev

Add universal headers

Author: caleb-leinz

Cargo.toml

@@ -28,7 +28,7 @@ moka = { version = "0.12.10", features = ["future"], optional = true }
 
 # ATLAS internal dependencies
 freedom-config = { version = "1.0.0", features = ["serde"] }
-freedom-models = { version = "2.2.0", features = ["serde"] }
+freedom-models = { git = "https://github.com/ATLAS-Space-Operations/rust-freedom-models", branch = "dev", features = ["serde"] }
 
 [dev-dependencies]
 futures = { version = "0.3.30" }
@@ -38,6 +38,7 @@ tokio-test = { version = "0.4.4"}
 tracing-test = { version = "0.2.4" }
 
 [features]
+bundles = ["freedom-models/bundles"]
 caching = ["dep:moka", "serde/rc"]
 
 [[example]]

src/api.rs

@@ -31,6 +31,8 @@ use futures_core::Stream;
 
 use crate::error::Error;
 
+#[cfg(feature = "bundles")]
+pub(crate) mod bundle;
 pub(crate) mod post;
 
 /// A super trait containing all the requirements for Freedom API Values

src/api/bundle.rs

@@ -0,0 +1,33 @@
+use freedom_models::bundle::fps_task;
+use time::{OffsetDateTime, format_description::well_known::Iso8601};
+
+use super::{Api, Error};
+
+/// Adds additional functionality by exposing bundle endpoints.
+///
+/// These are primarily used internally by the FPS and Gateway but exist in the public API, and are
+/// thus included here. In general, use of these should be avoided for customers
+pub trait BundleApi: Api {
+    /// Produces a list of [`fps_task::Bundle`]s within the designated window
+    ///
+    /// See [`get`](Api::get) documentation for more details about the process and return type
+    fn get_fps_task_bundle(
+        &self,
+        start: OffsetDateTime,
+        end: OffsetDateTime,
+    ) -> impl Future<Output = Result<Self::Container<Vec<fps_task::Bundle>>, Error>> + Send + Sync
+    {
+        async move {
+            let start = start.format(&Iso8601::DEFAULT).map_err(Error::from)?;
+            let end = end.format(&Iso8601::DEFAULT).map_err(Error::from)?;
+
+            let mut uri = self.path_to_url("fpstaskbundle/search/findByOverlapping");
+            uri.set_query(Some(&format!("start={}&end={}", start, end)));
+
+            self.get_json_map::<Self::Container<Vec<fps_task::Bundle>>>(uri)
+                .await
+        }
+    }
+}
+
+impl<T> BundleApi for T where T: Api {}

src/client.rs

@@ -1,6 +1,6 @@
 use bytes::Bytes;
 use freedom_config::Config;
-use reqwest::{Response, StatusCode};
+use reqwest::{RequestBuilder, Response, StatusCode};
 use url::Url;
 
 use crate::api::{Api, Inner, Value};
@@ -13,6 +13,7 @@ use crate::api::{Api, Inner, Value};
 pub struct Client {
     pub(crate) config: Config,
     pub(crate) client: reqwest::Client,
+    universal_headers: Vec<(String, String)>,
 }
 
 impl PartialEq for Client {
@@ -42,6 +43,7 @@ impl Client {
         Self {
             config,
             client: reqwest::Client::new(),
+            universal_headers: Vec::new(),
         }
     }
 
@@ -56,6 +58,23 @@ impl Client {
         let config = Config::from_env()?;
         Ok(Self::from_config(config))
     }
+
+    /// Adds a universal header key and value to all GET POST, and DELETEs made with the client
+    pub fn with_universal_header(
+        mut self,
+        key: impl Into<String>,
+        value: impl Into<String>,
+    ) -> Self {
+        self.universal_headers.push((key.into(), value.into()));
+        self
+    }
+
+    fn append_headers(&self, mut req: RequestBuilder) -> RequestBuilder {
+        for (header, value) in self.universal_headers.iter() {
+            req = req.header(header, value);
+        }
+        req
+    }
 }
 
 impl Api for Client {
@@ -64,9 +83,9 @@ impl Api for Client {
     async fn get(&self, url: Url) -> Result<(Bytes, StatusCode), crate::error::Error> {
         tracing::trace!("GET to {}", url);
 
-        let resp = self
-            .client
-            .get(url.clone())
+        let req = self.append_headers(self.client.get(url.clone()));
+
+        let resp = req
             .basic_auth(self.config.key(), Some(&self.config.expose_secret()))
             .send()
             .await?;
@@ -84,9 +103,9 @@ impl Api for Client {
     async fn delete(&self, url: Url) -> Result<Response, crate::error::Error> {
         tracing::trace!("DELETE to {}", url);
 
-        self.client
-            .delete(url.clone())
-            .basic_auth(self.config.key(), Some(self.config.expose_secret()))
+        let req = self.append_headers(self.client.delete(url.clone()));
+
+        req.basic_auth(self.config.key(), Some(self.config.expose_secret()))
             .send()
             .await
             .inspect_err(|error| tracing::warn!(%error, %url, "Failed to DELETE"))
@@ -100,9 +119,9 @@ impl Api for Client {
     {
         tracing::trace!("POST to {}", url);
 
-        self.client
-            .post(url.clone())
-            .basic_auth(self.config.key(), Some(self.config.expose_secret()))
+        let req = self.append_headers(self.client.post(url.clone()));
+
+        req.basic_auth(self.config.key(), Some(self.config.expose_secret()))
             .json(&msg)
             .send()
             .await
@@ -193,7 +212,7 @@ mod tests {
 
         assert_eq!(response, RESPONSE.as_bytes());
         assert_eq!(status, StatusCode::OK);
-        mock.assert_hits(1);
+        mock.assert_calls(1);
     }
 
     #[tokio::test]
@@ -211,7 +230,7 @@ mod tests {
 
         assert_eq!(response, RESPONSE.as_bytes());
         assert_eq!(status, StatusCode::NOT_FOUND);
-        mock.assert_hits(1);
+        mock.assert_calls(1);
     }
 
     #[tokio::test]
@@ -231,6 +250,6 @@ mod tests {
         let url = Url::parse(&format!("http://{}/testing", addr)).unwrap();
         client.post(url, &json).await.unwrap();
 
-        mock.assert_hits(1);
+        mock.assert_calls(1);
     }
 }

src/lib.rs

@@ -8,6 +8,8 @@ pub mod error;
 pub mod extensions;
 mod utils;
 
+#[cfg(feature = "bundles")]
+pub use self::api::bundle::BundleApi;
 pub use self::{
     api::{Api, Container, Inner, PaginatedStream, Value},
     client::Client,

tests/common.rs

@@ -41,11 +41,11 @@ impl TestingEnv {
     }
 
     pub fn get_json_from_file(
-        &self,
+        &'_ self,
         path: &str,
         query: Vec<(&str, &str)>,
         file: impl AsRef<Path>,
-    ) -> Mock {
+    ) -> Mock<'_> {
         let file = std::fs::read(file).unwrap();
         let file = String::from_utf8(file).unwrap();
         let file = file.replace("localhost:8080", &format!("localhost:{}", self.port()));