Refactor DefaultClient from constructor-based to Builder pattern for configurable HTTP client options #910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

utkrishtsahu wants to merge 1 commit into v4_development from builder-pattern-default-client

Contributor

utkrishtsahu commented Feb 11, 2026 •

edited

Loading

Changes

Added:

DefaultClient.Builder class — a new builder pattern API for constructing DefaultClient instances with full configuration control
connectTimeout(Int) — connection timeout in seconds (default: 10)
readTimeout(Int) — read timeout in seconds (default: 10)
writeTimeout(Int) — write timeout in seconds (default: 10)
callTimeout(Int) — overall call timeout in seconds (default: 0/disabled)
defaultHeaders(Map<String, String>) — headers included on every request
enableLogging(Boolean) — toggle HTTP logging
logLevel(HttpLoggingInterceptor.Level) — granular log level control
logger(HttpLoggingInterceptor.Logger) — custom logger implementation
addInterceptor(Interceptor) — add custom OkHttp interceptors
build() — creates the DefaultClient instance

Deprecated:

DefaultClient public constructor (DefaultClient(connectTimeout, readTimeout, defaultHeaders, enableLogging)) — deprecated with @deprecated annotation and ReplaceWith pointing to the Builder API. Still compiles and functions identically; IDE provides one-click quick-fix migration.

Usage:

val client = DefaultClient.Builder()
    .connectTimeout(30)
    .readTimeout(30)
    .writeTimeout(30)
    .enableLogging(true)
    .addInterceptor(myCustomInterceptor)
    .build()

account.networkingClient = client

References

SDK-7763

Testing

Build Passed
Unit Test Passed

Checklist

I have read the Auth0 general contribution guidelines
I have read the Auth0 Code of Conduct
All existing and new tests complete without errors


          feat: add Builder pattern for DefaultClient with deprecated legacy co…

ca43f5e

…nstructor

utkrishtsahu requested a review from a team as a code owner

February 11, 2026 10:32

pmathew92 reviewed

View reviewed changes

auth0/src/main/java/com/auth0/android/request/DefaultClient.kt

+                      private var callTimeout: Int = 0
+                      private var defaultHeaders: Map<String, String> = mapOf()
+                      private var enableLogging: Boolean = false
+                      private var logLevel: HttpLoggingInterceptor.Level = HttpLoggingInterceptor.Level.BODY

Contributor

pmathew92 Feb 12, 2026

No need to provide the logLevel option. If the customer wants more control ,they can use a custom logging interceptor

pmathew92 reviewed

View reviewed changes

auth0/src/main/java/com/auth0/android/request/DefaultClient.kt

+                      private var enableLogging: Boolean = false
+                      private var logLevel: HttpLoggingInterceptor.Level = HttpLoggingInterceptor.Level.BODY
+                      private var logger: HttpLoggingInterceptor.Logger? = null
+                      private val interceptors: MutableList<Interceptor> = mutableListOf()

Contributor

pmathew92 Feb 12, 2026

Lets not add option to configure interceptors . If there is a major request we can add this later .

pmathew92 reviewed

View reviewed changes

auth0/src/main/java/com/auth0/android/request/DefaultClient.kt

+                       * by calling this method multiple times. They are invoked in the order they were added,
+                       * after the built-in [RetryInterceptor] and before the logging interceptor.
+                       */
+                      public fun addInterceptor(interceptor: Interceptor): Builder =

Contributor

pmathew92 Feb 12, 2026

Lets not ad this option

pmathew92 reviewed

View reviewed changes

auth0/src/main/java/com/auth0/android/request/DefaultClient.kt

+                       * Only takes effect if [enableLogging] is set to `true`.
+                       * Default is [HttpLoggingInterceptor.Level.BODY].
+                       */
+                      public fun logLevel(level: HttpLoggingInterceptor.Level): Builder =

Contributor

pmathew92 Feb 12, 2026

Lets not add this option

pmathew92 reviewed

View reviewed changes

auth0/src/main/java/com/auth0/android/request/DefaultClient.kt


		okBuilder.addInterceptor(RetryInterceptor())

		interceptors.forEach { okBuilder.addInterceptor(it) }

Contributor

pmathew92 Feb 12, 2026

Remove the custom interceptors for now

pmathew92 reviewed

View reviewed changes

auth0/src/main/java/com/auth0/android/request/DefaultClient.kt

+                              } else {
+                                  HttpLoggingInterceptor()
+                              }
+                              loggingInterceptor.setLevel(logLevel)

Contributor

pmathew92 Feb 12, 2026

#763
Check the second approach suggested. We can follow that pattern

pmathew92 reviewed

View reviewed changes

auth0/src/main/java/com/auth0/android/request/DefaultClient.kt

+                  /**
+                   * Internal constructor used by tests to inject SSL and Gson.
+                   */
+                  @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)

Contributor

pmathew92 Feb 12, 2026 •

edited

Loading

Can't the tests use the builder now instead of this ?

pmathew92 reviewed

View reviewed changes

auth0/src/main/java/com/auth0/android/request/DefaultClient.kt

-                              .setLevel(HttpLoggingInterceptor.Level.BODY)
-                          builder.addInterceptor(logger)
-                      }
+                      okHttpClient = okHttpClientBuilder.build()

Contributor

pmathew92 Feb 12, 2026

Wouldn't this create a new client here ? Is this init block required now ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet