Allow OkHttpClient overrides in Interceptor by yschimke · Pull Request #9108 · square/okhttp

yschimke · 2025-10-05T09:06:35Z

This pull request introduces significant enhancements to the Interceptor.Chain API in OkHttp, allowing much more fine-grained and dynamic control over the HTTP client's configuration on a per-call basis.

Let's delve into it;

API Extensions for Interceptor.Chain

Added numerous getter and setter methods to the Interceptor.Chain interface for properties such as DNS, proxy, cache, authenticators, SSL factories, certificate pinners, connection pool, cookie jar, hostname verifier, and retry settings. These methods allow interceptors and clients to override or access the OkHttpClient's configuration dynamically within the interceptor chain.

Internal Refactoring to Use Chain Properties

Refactored BridgeInterceptor and CacheInterceptor to use the new properties from Interceptor.Chain instead of being directly constructed with dependencies like CookieJar or Cache. This makes interceptors more decoupled and flexible.

Extensive test of overrides

InterceptorOverridesTest exhaustively tests that overrides can be applied by an application interceptor and observed from a network interceptor. That they can't be set in a network interceptor. And finally that bad defaults on OkHttpClient, can be saved by good overrides.

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt

okhttp/src/commonJvmAndroid/kotlin/okhttp3/OkHttpClient.kt

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/http/RealInterceptorChain.kt

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/http/RealInterceptorChain.kt

# Conflicts: # okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/connection/RealCall.kt # okhttp/src/jvmTest/kotlin/okhttp3/internal/connection/RouteSelectorTest.kt

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt

swankjesse

I think this is pretty rad actually. The most difficult part is gonna be making the tests?

okhttp/src/commonJvmAndroid/kotlin/okhttp3/OkHttpClient.kt

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/connection/RealCall.kt

yschimke · 2025-11-09T13:28:01Z

@swankjesse I'll follow up with more specific samples, such as Android Network Pinning.

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt

swankjesse

Love it

I would like more confidence that the override value is actually used, different from whether it’s reflected in the chain’s own properties. That’s necessary but not sufficient.

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/connection/RealCall.kt

okhttp/src/jvmTest/kotlin/okhttp3/InterceptorOverridesTest.kt

yschimke · 2025-12-11T07:58:20Z

@swankjesse still have a few tests to fix, but ready for review

yschimke · 2025-12-13T12:04:23Z

okhttp/src/jvmTest/kotlin/okhttp3/InterceptorOverridesTest.kt

+              if (sink
+                  .timeout()
+                  .timeoutNanos()
+                  .nanoseconds.inWholeMilliseconds == 10L


@swankjesse I tried to implement this using

.socketFactory( DelayingSocketFactory(onWrite = { Thread.sleep(100L) }),

But if I break point at Thread.sleep, then socket.sink().timeout().timeoutNanos() is always cleared (0).

I suspect a bug with write timeout, but this replicates a timeout just by checking if we have the bad timeout value.

yschimke · 2025-12-13T12:06:53Z

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/connection/RealCall.kt

-    interceptors += RetryAndFollowUpInterceptor(client)
-    interceptors += BridgeInterceptor(client.cookieJar)
-    interceptors += CacheInterceptor(this, client.cache)
+    interceptors += RetryAndFollowUpInterceptor()


@swankjesse this seems like a nice win.

EXTREMELY SO

yschimke · 2026-01-11T12:04:44Z

@swankjesse requesting post review. I think I've addressed major comments, and taking a previous positive impression.

Happy to revert or fix forward with any feedback.

swankjesse

LGTM!

swankjesse · 2026-03-10T13:12:59Z

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/connection/RealCall.kt

-    interceptors += RetryAndFollowUpInterceptor(client)
-    interceptors += BridgeInterceptor(client.cookieJar)
-    interceptors += CacheInterceptor(this, client.cache)
+    interceptors += RetryAndFollowUpInterceptor()


EXTREMELY SO

swankjesse · 2026-03-10T13:20:27Z

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/http/RealInterceptorChain.kt


  override fun withReadTimeout(
-    timeout: Int,
+    timeout: Long,


Ugh, this is binary-incompatible and we must revert to Int

Not sure what I was thinking

swankjesse · 2026-03-10T13:20:43Z

okhttp/api/jvm/okhttp.api

 	public abstract fun request ()Lokhttp3/Request;
-	public abstract fun withConnectTimeout (ILjava/util/concurrent/TimeUnit;)Lokhttp3/Interceptor$Chain;
-	public abstract fun withReadTimeout (ILjava/util/concurrent/TimeUnit;)Lokhttp3/Interceptor$Chain;
-	public abstract fun withWriteTimeout (ILjava/util/concurrent/TimeUnit;)Lokhttp3/Interceptor$Chain;


This file must never have red in it

swankjesse · 2026-03-10T13:22:00Z

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/http/RealInterceptorChain.kt

+    return copy(proxyAuthenticator = proxyAuthenticator)
+  }
+
+  override fun withSslSocketFactory(


Nice nice nice

swankjesse · 2026-03-10T13:23:09Z

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt

    fun call(): Call

+    /**
+     * Returns the connect timeout in milliseconds.


😬 https://publicobject.com/2007/08/05/stop_writing_redundant_javadoc/

swankjesse · 2026-03-10T13:24:38Z

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt

+    fun withAuthenticator(authenticator: Authenticator): Chain
+
+    /**
+     * Returns the [CookieJar] for the OkHttpClient, or an override from the Call.Chain.


These docs describe the implementation mechanism, but not the purpose.

I’d prefer, ‘Returns the cookie jar that'll be used for this call’

swankjesse · 2026-03-10T13:25:16Z

okhttp/src/jvmTest/kotlin/okhttp3/InterceptorOverridesTest.kt

@@ -0,0 +1,858 @@
+package okhttp3


We should attribute copyright to somebody here.

swankjesse · 2026-03-10T13:26:08Z

okhttp/src/jvmTest/kotlin/okhttp3/InterceptorOverridesTest.kt

+      ),
+    isDefault: Boolean,
+  ) {
+    fun <T> Override<T>.testApplicationInterceptor(chain: Interceptor.Chain): Response {


swankjesse · 2026-03-10T13:28:17Z

okhttp/src/jvmTest/kotlin/okhttp3/InterceptorOverridesTest.kt

+          // Set the bad override directly on the client
+          .withOverride(badValue)
+          .addInterceptor { chain ->
+            // the only way to stop a bad override of a client is with a good override of an interceptor


The only way to stop a bad override with a gun...

Allow OkHttpClient overrides in Interceptor

4a425f7

yschimke requested a review from squarejesse October 5, 2025 09:06

cleanup

2dfddae

yschimke commented Oct 6, 2025

View reviewed changes

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt Outdated Show resolved Hide resolved

swankjesse requested changes Oct 6, 2025

View reviewed changes

yschimke added 2 commits October 10, 2025 17:43

Merge branch 'master' into with_dns

625589a

# Conflicts: # okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/connection/RealCall.kt # okhttp/src/jvmTest/kotlin/okhttp3/internal/connection/RouteSelectorTest.kt

all fields

7abf8ee

yschimke commented Oct 10, 2025

View reviewed changes

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt Show resolved Hide resolved

swankjesse reviewed Oct 22, 2025

View reviewed changes

okhttp/src/commonJvmAndroid/kotlin/okhttp3/OkHttpClient.kt Outdated Show resolved Hide resolved

swankjesse reviewed Oct 22, 2025

View reviewed changes

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt Show resolved Hide resolved

yschimke added 3 commits November 9, 2025 11:38

Merge branch 'master' into with_dns

01641c1

Add test

a964f63

Add test

76d0023

yschimke commented Nov 9, 2025

View reviewed changes

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/connection/RealCall.kt Outdated Show resolved Hide resolved

yschimke added 3 commits November 9, 2025 13:30

cleanup

dba52bc

Fix tests

e175b8e

Fix api checks

638a2de

yschimke requested a review from swankjesse November 10, 2025 08:48

swankjesse reviewed Nov 21, 2025

View reviewed changes

okhttp/src/commonJvmAndroid/kotlin/okhttp3/Interceptor.kt Outdated Show resolved Hide resolved

swankjesse reviewed Nov 21, 2025

View reviewed changes

okhttp/src/commonJvmAndroid/kotlin/okhttp3/internal/connection/RealCall.kt Outdated Show resolved Hide resolved

yschimke added 2 commits December 8, 2025 19:24

Merge branch 'master' into with_dns

cc76f02

Fixes and start on test

b1473e7

yschimke marked this pull request as draft December 9, 2025 08:56

yschimke added 3 commits December 10, 2025 21:52

Add more tests

d13d0ee

comments

c2b7479

comments

27a8d60

yschimke commented Dec 10, 2025

View reviewed changes

okhttp/src/jvmTest/kotlin/okhttp3/InterceptorOverridesTest.kt Outdated Show resolved Hide resolved

yschimke added 2 commits December 10, 2025 23:07

Add tests to work through

c28672a

revert

0c665c1

yschimke added 2 commits December 11, 2025 00:06

More testing

d450c1b

simplify test

e86a858

yschimke marked this pull request as ready for review December 11, 2025 07:57

yschimke added 5 commits December 13, 2025 10:56

Fix test

101e588

Merge branch 'master' into with_dns

adf491b

cleanup

40ee3db

Use interceptor for redirect flags

efd106c

Cleanup

769cf19

yschimke requested a review from swankjesse December 13, 2025 12:00

yschimke commented Dec 13, 2025

View reviewed changes

yschimke added 2 commits December 14, 2025 06:09

Fix test

5894c95

Merge branch 'master' into with_dns

b66f05a

yschimke merged commit 7c4b35b into square:master Jan 11, 2026
26 of 27 checks passed

swankjesse reviewed Mar 10, 2026

View reviewed changes

yschimke mentioned this pull request Mar 10, 2026

We should attribute copyright to somebody here. #9361

Closed

Conversation

yschimke commented Oct 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

swankjesse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yschimke commented Nov 9, 2025

Uh oh!

Uh oh!

swankjesse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

yschimke commented Dec 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yschimke commented Jan 11, 2026

Uh oh!

Uh oh!

swankjesse left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

yschimke commented Oct 5, 2025 •

edited

Loading