Add option to select HTTP client type #1079
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently `reqwest::Client` is the only type we allow as the underlying HTTP client. Some consumers of Progenitor may want to use `reqwest_middleware` to enable conveniences like automatic retries and support for `tracing`. Add a new `with_client_type` argument for `GenerationSettings` to allow callers to select which of these types to use as the client.
Reqwest added the `from_parts` and `build_split` methods on `RequestBuilder` for wasm targets with v0.12.5. Bump Reqwest on the wasm example to that version.
ahl
requested changes
Mar 6, 2025
| @@ -244,6 +265,7 @@ pub fn dependencies(builder: Generator, include_client: bool) -> Vec<String> { | |||
| format!("bytes = \"{}\"", DEPENDENCIES.bytes), | |||
| format!("futures-core = \"{}\"", DEPENDENCIES.futures), | |||
| format!("reqwest = {{ version = \"{}\", default-features=false, features = [\"json\", \"stream\"] }}", DEPENDENCIES.reqwest), | |||
| format!("reqwest-middleware = {{ version = \"{}\", default-features=false, features = [\"json\"] }}", DEPENDENCIES.reqwest_middleware), | |||
There was a problem hiding this comment.
I don't think we want to always include this dependency.
| bytes = { workspace = true } | ||
| futures-core = { workspace = true } | ||
| percent-encoding = { workspace = true } | ||
| reqwest = { workspace = true } | ||
| reqwest-middleware = { workspace = true } |
There was a problem hiding this comment.
I don't think this should be a mandatory dependency
| @@ -7,10 +7,12 @@ repository = "https://github.com/oxidecomputer/progenitor.git" | |||
| description = "An OpenAPI client generator - client support" | |||
|
|
|||
| [dependencies] | |||
| anyhow = { workspace = true } | |||
There was a problem hiding this comment.
This feels like a step in the wrong direction. If we need a generic error, could we use Box?
Comment on lines
+125
to
+130
| impl Default for ClientType { | ||
| fn default() -> Self { | ||
| Self::Reqwest | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
I thought you could derive default on enums and use a marker annotation
Comment on lines
+432
to
+433
| ClientType::Reqwest => quote! { reqwest::Client }, | ||
| ClientType::ReqwestMiddleware => quote! { reqwest_middleware::ClientWithMiddleware }, |
There was a problem hiding this comment.
Suggested change
| ClientType::Reqwest => quote! { reqwest::Client }, | |
| ClientType::ReqwestMiddleware => quote! { reqwest_middleware::ClientWithMiddleware }, | |
| ClientType::Reqwest => quote! { ::reqwest::Client }, | |
| ClientType::ReqwestMiddleware => quote! { ::reqwest_middleware::ClientWithMiddleware }, |
| @@ -31,6 +31,7 @@ http = { workspace = true } | |||
| hyper = { workspace = true } | |||
| progenitor-client = { workspace = true } | |||
| reqwest = { workspace = true } | |||
| reqwest-middleware = { workspace = true } | |||
There was a problem hiding this comment.
what fails if this is not present?
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently
reqwest::Clientis the only type we allow as the underlying HTTP client. Some consumers of Progenitor may want to usereqwest_middlewareto enable conveniences like automatic retries and support fortracing.Add a new
with_client_typeargument forGenerationSettingsto allow callers to select which of these types to use as the client.