Use re-exports to make depending on propolis-client less cumbersome

Author: lif

Cargo.lock

@@ -28,23 +28,6 @@ You'll need to add add the following to `Cargo.toml`:
 ```diff
 [dependencies]
 +progenitor = { git = "https://github.com/oxidecomputer/progenitor" }
-+reqwest = { version = "0.11", features = ["json", "stream"] }
-+serde = { version = "1.0", features = ["derive"] }
-```
-
-In addition, if the OpenAPI document contains string types with the `format`
-field set to `date` or `date-time`, include
-
-```diff
-[dependencies]
-+chrono = { version = "0.4", features = ["serde"] }
-```
-
-Similarly if there is a `format` field set to `uuid`:
-
-```diff
-[dependencies]
-+uuid = { version = "1.0.0", features = ["serde", "v4"] }
 ```
 
 The macro has some additional fancy options to control the generated code:
@@ -109,11 +92,23 @@ You'll need to add add the following to `Cargo.toml`:
 +serde_json = "1.0"
 ```
 
-(`chrono` and `uuid` as above)
-
 Note that `progenitor` is used by `build.rs`, but the generated code required
 `progenitor-client`.
 
+In addition, if the OpenAPI document contains string types with the `format`
+field set to `date` or `date-time`, include
+
+```diff
+[dependencies]
++chrono = { version = "0.4", features = ["serde"] }
+```
+
+Similarly if there is a `format` field set to `uuid`:
+
+```diff
+[dependencies]
++uuid = { version = "1.0.0", features = ["serde", "v4"] }
+```
 
 ### Static Crate
 
@@ -139,7 +134,7 @@ For example:
 
 This will produce a package in the specified directory. The output has no
 persistent dependency on Progenitor including the `progenitor-client` crate.
-Here's a excerpt from the emitted `Cargo.toml`:
+Here's an excerpt from the emitted `Cargo.toml`:
 
 ```toml
 [dependencies]
@@ -154,3 +149,7 @@ uuid = { version = ">=0.8.0, <2.0.0", features = ["serde", "v4"] }
 
 Note that there is a dependency on `percent-encoding` which macro- and
 build.rs-generated clients is included from `progenitor-client`.
+
+Additionally, note that `chrono` is only required if the OpenAPI document
+contains string types with the `format` field set to `date` or `date-time`,
+and `uuid` is only required if there is a `format` field set to `uuid`.

README.md

@@ -5,10 +5,5 @@ authors = ["Adam H. Leventhal <ahl@oxidecomputer.com>"]
 edition = "2021"
 
 [dependencies]
-chrono = { version = "0.4", features = ["serde"] }
 progenitor = { path = "../progenitor" }
-reqwest = { git = "https://github.com/seanmonstar/reqwest", rev = "6ceb23958c8b6d7f1d8ee093f0ad73184d133d40", features = ["json", "stream"] }
-#reqwest = { version = "0.11", features = ["json", "stream"] }
 schemars = { version = "0.8.10", features = ["uuid1"] }
-serde = { version = "1.0", features = ["derive"] }
-uuid = { version = "1.0", features = ["serde", "v4"] }

example-macro/Cargo.toml

@@ -11,8 +11,9 @@ bytes = "1.2.1"
 futures-core = "0.3.24"
 percent-encoding = "2.1"
 reqwest = { git = "https://github.com/seanmonstar/reqwest", rev = "6ceb23958c8b6d7f1d8ee093f0ad73184d133d40", features = ["json", "stream"] }
-#reqwest = { version = "0.11", default-features = false, features = ["json", "stream"] }
-serde = "1.0"
+chrono = { version = "0.4", features = ["serde"] }
+uuid = { version = "1.0.0", features = ["serde", "v4"] }
+serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 serde_urlencoded = "0.7.1"
 base64 = "0.13"

progenitor-client/Cargo.toml

@@ -4,6 +4,13 @@ mod progenitor_client;
 
 pub use crate::progenitor_client::*;
 
+pub mod deps {
+    pub use ::chrono;
+    pub use ::reqwest;
+    pub use ::serde;
+    pub use ::uuid;
+}
+
 // For stand-alone crates, rather than adding a dependency on
 // progenitor-client, we simply dump the code right in. This means we don't
 // need to determine the provenance of progenitor (crates.io, github, etc.)

progenitor-client/src/lib.rs

@@ -127,7 +127,10 @@ impl Generator {
         let mut type_settings = TypeSpaceSettings::default();
         type_settings
             .with_type_mod("types")
-            .with_struct_builder(settings.interface == InterfaceStyle::Builder);
+            .with_struct_builder(settings.interface == InterfaceStyle::Builder)
+            .with_serde_crate_location(
+                "progenitor_client::deps::serde".to_string(),
+            );
         settings.extra_derives.iter().for_each(|derive| {
             let _ = type_settings.with_derive(derive.clone());
         });
@@ -225,6 +228,8 @@ impl Generator {
             use progenitor_client::{encode_path, RequestBuilderExt};
 
             pub mod types {
+                #[allow(unused_imports)]
+                use super::*;
                 use serde::{Deserialize, Serialize};
 
                 // This may be used by some impl Deserialize, but not all.
@@ -389,6 +394,8 @@ impl Generator {
     }
 
     /// Render text output.
+    // TODO: configuration for whether to use re-exports from progenitor-client
+    // (standalone crate vs. build.rs codegen)
     pub fn generate_text(&mut self, spec: &OpenAPI) -> Result<String> {
         self.generate_text_impl(
             spec,

progenitor-impl/src/lib.rs

@@ -2,10 +2,13 @@
 use progenitor_client::{encode_path, RequestBuilderExt};
 pub use progenitor_client::{generate_websocket_key, ByteStream, Error, ResponseValue};
 pub mod types {
+    #[allow(unused_imports)]
+    use super::*;
     use serde::{Deserialize, Serialize};
     #[allow(unused_imports)]
     use std::convert::TryFrom;
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct Task {
         pub id: String,
         pub name: String,
@@ -21,6 +24,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct TaskEvent {
         pub payload: String,
         pub seq: u32,
@@ -35,6 +39,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct TaskOutput {
         pub id: String,
         pub path: String,
@@ -48,6 +53,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct TaskSubmit {
         pub name: String,
         #[serde(default, skip_serializing_if = "Vec::is_empty")]
@@ -62,6 +68,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct TaskSubmitResult {
         pub id: String,
     }
@@ -73,6 +80,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct UploadedChunk {
         pub id: String,
     }
@@ -84,6 +92,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct UserCreate {
         pub name: String,
     }
@@ -95,6 +104,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct UserCreateResult {
         pub id: String,
         pub name: String,
@@ -108,6 +118,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WhoamiResult {
         pub id: String,
         pub name: String,
@@ -120,6 +131,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct Worker {
         pub deleted: bool,
         pub id: String,
@@ -138,6 +150,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WorkerAddOutput {
         pub chunks: Vec<String>,
         pub path: String,
@@ -151,6 +164,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WorkerAppendTask {
         pub payload: String,
         pub stream: String,
@@ -164,6 +178,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WorkerBootstrap {
         pub bootstrap: String,
         pub token: String,
@@ -176,6 +191,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WorkerBootstrapResult {
         pub id: String,
     }
@@ -187,6 +203,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WorkerCompleteTask {
         pub failed: bool,
     }
@@ -198,6 +215,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WorkerPingResult {
         pub poweroff: bool,
         #[serde(default, skip_serializing_if = "Option::is_none")]
@@ -211,6 +229,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WorkerPingTask {
         pub id: String,
         pub output_rules: Vec<String>,
@@ -224,6 +243,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WorkerTask {
         pub id: String,
         pub name: String,
@@ -237,6 +257,7 @@ pub mod types {
     }
 
     #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[serde(crate = "progenitor_client::deps::serde")]
     pub struct WorkersResult {
         pub workers: Vec<Worker>,
     }