Return WebSocket response headers (#513)

VERSION.txt

@@ -1 +1 @@
-0.3.15
+0.3.16

kittycad.rs.patch.json

@@ -4,7 +4,7 @@
     "path": "/info/x-rust",
     "value": {
       "client": "// Authenticate via an API token.\nlet client = kittycad::Client::new(\"$TOKEN\");\n\n// - OR -\n\n// Authenticate with your token and host parsed from the environment variables:\n// `KITTYCAD_API_TOKEN`.\nlet client = kittycad::Client::new_from_env();",
-      "install": "[dependencies]\nkittycad = \"0.3.15\""
+      "install": "[dependencies]\nkittycad = \"0.3.16\""
     }
   },
   {

kittycad/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "kittycad"
 description = "A fully generated & opinionated API client for the KittyCAD API."
-version = "0.3.15"
+version = "0.3.16"
 documentation = "https://docs.rs/kittycad"
 readme = "README.md"
 repository = "https://github.com/KittyCAD/kittycad.rs/tree/main/kittycad"

kittycad/README.md

@@ -31,7 +31,7 @@ To install the library, add the following to your `Cargo.toml` file.
 
 ```toml
 [dependencies]
-kittycad = "0.3.15"
+kittycad = "0.3.16"
 ```
 
 ## Basic example

kittycad/src/executor.rs

@@ -71,7 +71,7 @@ impl Executor {
     #[cfg(not(target_arch = "wasm32"))]
     pub async fn create_term<'a>(
         &'a self,
-    ) -> Result<reqwest::Upgraded, crate::types::error::Error> {
+    ) -> Result<(reqwest::Upgraded, http::HeaderMap), crate::types::error::Error> {
         let mut req = self.client.client_http1_only.request(
             http::Method::GET,
             format!("{}/{}", self.client.base_url, "ws/executor/term"),
@@ -93,10 +93,11 @@ impl Executor {
             return Err(crate::types::error::Error::UnexpectedResponse(resp));
         }
 
+        let headers = resp.headers().clone();
         let upgraded = resp
             .upgrade()
             .await
             .map_err(crate::types::error::Error::RequestError)?;
-        Ok(upgraded)
+        Ok((upgraded, headers))
     }
 }

kittycad/src/lib.rs

@@ -29,7 +29,7 @@
 //!
 //! ```toml
 //! [dependencies]
-//! kittycad = "0.3.15"
+//! kittycad = "0.3.16"
 //! ```
 //!
 //! ## Basic example

kittycad/src/modeling.rs

@@ -36,7 +36,7 @@ impl Modeling {
         video_res_height: Option<u32>,
         video_res_width: Option<u32>,
         webrtc: Option<bool>,
-    ) -> Result<reqwest::Upgraded, crate::types::error::Error> {
+    ) -> Result<(reqwest::Upgraded, http::HeaderMap), crate::types::error::Error> {
         let mut req = self.client.client_http1_only.request(
             http::Method::GET,
             format!("{}/{}", self.client.base_url, "ws/modeling/commands"),
@@ -92,10 +92,11 @@ impl Modeling {
             return Err(crate::types::error::Error::UnexpectedResponse(resp));
         }
 
+        let headers = resp.headers().clone();
         let upgraded = resp
             .upgrade()
             .await
             .map_err(crate::types::error::Error::RequestError)?;
-        Ok(upgraded)
+        Ok((upgraded, headers))
     }
 }

kittycad/src/tests.rs

@@ -222,7 +222,7 @@ async fn test_modeling_websocket() {
         .commands_ws(None, None, None, None, None, None, None, None)
         .await
     {
-        Ok(ws) => ws,
+        Ok((ws, _headers)) => ws,
         Err(crate::types::error::Error::UnexpectedResponse(resp)) => {
             let txt = resp.text().await.unwrap();
             panic!("Failed to connect to modeling websocket: {}", txt);

kittycad/tests/tabled_one_of.txt

@@ -1,5 +1,5 @@
-+----------------+------------------+----------+------------+-------------+-----------------+-----------+
-| FileConversion | FileCenterOfMass | FileMass | FileVolume | FileDensity | FileSurfaceArea | TextToCad |
-+----------------+------------------+----------+------------+-------------+-----------------+-----------+
-| +              |                  |          |            |             |                 |           |
-+----------------+------------------+----------+------------+-------------+-----------------+-----------+
++----------------+------------------+----------+------------+-------------+-----------------+-----------+--------------------+
+| FileConversion | FileCenterOfMass | FileMass | FileVolume | FileDensity | FileSurfaceArea | TextToCad | TextToCadIteration |
++----------------+------------------+----------+------------+-------------+-----------------+-----------+--------------------+
+| +              |                  |          |            |             |                 |           |                    |
++----------------+------------------+----------+------------+-------------+-----------------+-----------+--------------------+

openapitor/src/functions.rs

@@ -29,7 +29,7 @@ fn generate_websocket_fn(
     // Get the function name.
     let fn_name = op.get_fn_name()?;
     let fn_name_ident = format_ident!("{}", fn_name);
-    let response_type = quote!(reqwest::Upgraded);
+    let response_type = quote!((reqwest::Upgraded, http::HeaderMap));
     // Get the function args.
     let raw_args = get_args(name, method, type_space, op, global_params)?;
     // Make sure if we have args, we start with a comma.
@@ -86,10 +86,12 @@ fn generate_websocket_fn(
         if resp.status().is_client_error() || resp.status().is_server_error() {
             return Err(crate::types::error::Error::UnexpectedResponse(resp));
         }
+
+        let headers = resp.headers().clone();
         // TODO: This isn't really a request error, but the response was already consumed.
         // So we can't use Error::UnexpectedResponse.
         let upgraded = resp.upgrade().await.map_err(crate::types::error::Error::RequestError)?;
-        Ok(upgraded)
+        Ok((upgraded, headers))
     };
 
     let function = quote! {

openapitor/tests/types/websocket.rs.gen

@@ -4,7 +4,7 @@
 pub async fn example_api_websocket_counter<'a>(
     &'a self,
     start: Option<u8>,
-) -> Result<reqwest::Upgraded, crate::types::error::Error> {
+) -> Result<(reqwest::Upgraded, http::HeaderMap), crate::types::error::Error> {
     let mut req = self.client.client_http1_only.request(
         http::Method::GET,
         format!("{}/{}", self.client.base_url, "counter"),
@@ -30,9 +30,10 @@ pub async fn example_api_websocket_counter<'a>(
     if resp.status().is_client_error() || resp.status().is_server_error() {
         return Err(crate::types::error::Error::UnexpectedResponse(resp));
     }
+    let headers = resp.headers().clone();
     let upgraded = resp
         .upgrade()
         .await
         .map_err(crate::types::error::Error::RequestError)?;
-    Ok(upgraded)
+    Ok((upgraded, headers))
 }