Add HTTP Client trait abstraction for middleware support #422
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
HttpClient
trait abstraction that allows users to provide custom HTTP client implementations, enabling middleware support for automatic instrumentation, logging, retry logic, and more.Motivation
Currently,
async-openai
is 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_client
module (src/http_client.rs
):HttpClient
trait for abstract HTTP operationsHttpError
andHttpResponse
types for trait methodsreqwest::Client
BoxedHttpClient
type alias for convenienceNew
ClientWithTrait
struct (src/client.rs
):HttpClient
implementationClient
unchangedBenefits
reqwest-middleware
for automatic OpenTelemetry/tracingHttpClient
implementationsExample Usage
Testing
The changes compile successfully and maintain full backward compatibility. The new trait has been tested with
reqwest-middleware
for OpenTelemetry instrumentation.Next Steps
If this abstraction is accepted, future work could: