feat: support OkHttp application interceptors - #899
Open
sylvesterkaczmarek wants to merge 3 commits into
Open
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5f687cddfc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
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
Add application-interceptor support to the SDK's public OkHttp transport builder so users can customise requests and responses without copying the SDK's
HttpClientimplementation.Fixes #339.
Problem
The SDK currently exposes several OkHttp transport settings, but there is no supported way to register an OkHttp
Interceptor. The documented workaround is to copy the SDK's OkHttp transport implementation and maintain a local fork just to add interceptors.That is unnecessarily heavy for common use cases such as request tagging, custom observability, organisation-specific headers, response inspection, and integration with existing OkHttp middleware.
Fix
Add a Java-callable builder method:
Configured interceptors are registered as standard OkHttp application interceptors when the underlying transport is built. Multiple calls preserve registration order, matching OkHttp's normal semantics.
The existing public construction path can then use the customised transport directly through
ClientOptionsandOpenAIClientImpl, without copying SDK source.Regression coverage
Extended
OkHttpClientTestwith a WireMock-backed test that:Validation
mainat81134d727946fb84cc48db98e6c8c53c8a8d22ab;OkHttpClient.kt;Full repository validation is left to GitHub Actions.
Risk
Low. No interceptor is installed by default, so existing clients behave exactly as before. The new behaviour is entirely opt-in and delegates interceptor semantics to OkHttp.