Add HTTP Client trait abstraction for middleware support#422
Draft
timvw wants to merge 5 commits into64bit:mainfrom
Draft
Add HTTP Client trait abstraction for middleware support#422timvw wants to merge 5 commits into64bit:mainfrom
timvw wants to merge 5 commits into64bit:mainfrom
Conversation
…eqwest::Client - Replace hardcoded reqwest::Client with HttpClient trait throughout - Client struct now accepts any HttpClient implementation - Remove duplicate ClientWithTrait and ChatWithTrait structures - All API methods (get, post, delete) now use the trait - Backward compatibility: forms and streaming still use reqwest directly (TODO) - Default implementation uses reqwest::Client for zero breaking changes - This enables middleware injection for tracing, logging, etc.
… support - Extended HttpClient trait with request_multipart() for file uploads - Extended HttpClient trait with request_stream() for SSE streaming - Added MultipartForm struct and conversion helper from reqwest forms - Added SseEvent struct for streaming responses - Updated post_form_raw to use HttpClient trait instead of reqwest directly - Updated streaming methods to use HttpClient trait - Removed all outdated comments about multipart forms not being supported - Added uuid dependency for multipart boundary generation - Eliminated all direct reqwest usage except for eventsource compatibility Note: One method (post_stream_mapped_raw_events) still uses reqwest directly for eventsource_stream::Event compatibility, documented with TODO
- Removed unused EventSource import in http_client.rs - Removed unused stream() function in client.rs (replaced by stream_from_sse) - Fixed formatting in responses-stream example - Reordered http_client module export in lib.rs
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Summary
This PR introduces an
HttpClienttrait abstraction that allows users to provide custom HTTP client implementations, enabling middleware support for automatic instrumentation, logging, retry logic, and more.Motivation
Currently,
async-openaiis tightly coupled toreqwest::Client, which prevents users from:This is particularly important for production applications that need automatic OpenTelemetry instrumentation without manually wrapping every API call.
Changes
New
http_clientmodule (src/http_client.rs):HttpClienttrait for abstract HTTP operationsHttpErrorandHttpResponsetypes for trait methodsreqwest::ClientBoxedHttpClienttype alias for convenienceNew
ClientWithTraitstruct (src/client.rs):HttpClientimplementationClientunchangedBenefits
reqwest-middlewarefor automatic OpenTelemetry/tracingHttpClientimplementationsExample Usage
Testing
The changes compile successfully and maintain full backward compatibility. The new trait has been tested with
reqwest-middlewarefor OpenTelemetry instrumentation.Next Steps
If this abstraction is accepted, future work could: