Skip to content
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

Deprecate all intermediate Builder functions #6287

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Deprecate all intermediate Builder functions #6287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...tions/src/commonMain/kotlin/com/apollographql/apollo/annotations/ApolloDeprecatedSince.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,6 @@ annotation class ApolloDeprecatedSince(val version: Version) {
v4_0_0,
v4_0_1,
v4_0_2,
v4_1_1,
}
}
121 changes: 115 additions & 6 deletions libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/ApolloClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ import kotlin.jvm.JvmStatic
*
* On native targets, [ApolloClient.close] must be called to release resources when not in use anymore.
*/
@Suppress("DEPRECATION")
class ApolloClient
private constructor(
private val builder: Builder,
Expand Down Expand Up @@ -351,6 +352,8 @@ private constructor(
val interceptors: List<ApolloInterceptor> = _interceptors

private val _httpInterceptors: MutableList<HttpInterceptor> = mutableListOf()
@Deprecated("HTTP properties should be set on HttpNetworkTransport directly")
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
val httpInterceptors: List<HttpInterceptor> = _httpInterceptors

private val _listeners: MutableList<ApolloClientListener> = mutableListOf()
Expand Down Expand Up @@ -378,20 +381,36 @@ private constructor(
private set
var httpServerUrl: String? = null
private set
@Deprecated("HTTP properties should be set on HttpNetworkTransport directly")
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
var httpEngine: HttpEngine? = null
private set
@Deprecated("WebSockets properties should be set on WebSocketNetworkTransport directly")
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
var webSocketServerUrl: String? = null
private set
@Deprecated("WebSockets properties should be set on WebSocketNetworkTransport directly")
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
var webSocketIdleTimeoutMillis: Long? = null
private set
@Deprecated("WebSockets properties should be set on WebSocketNetworkTransport directly")
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
var wsProtocolFactory: WsProtocol.Factory? = null
private set
@Deprecated("HTTP properties should be set on HttpNetworkTransport directly")
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
var httpExposeErrorBody: Boolean? = null
private set
@Deprecated("WebSockets properties should be set on WebSocketNetworkTransport directly")
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
var webSocketEngine: WebSocketEngine? = null
private set
@Deprecated("WebSockets properties should be set on WebSocketNetworkTransport directly")
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
var webSocketReopenWhen: (suspend (Throwable, attempt: Long) -> Boolean)? = null
private set
@Deprecated("WebSockets properties should be set on WebSocketNetworkTransport directly")
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
var webSocketReopenServerUrl: (suspend () -> String)? = null
private set

Expand Down Expand Up @@ -560,11 +579,11 @@ private constructor(
/**
* The http:// or https:// url of the GraphQL server.
*
* This is the same as [httpServerUrl].
*
* This is a convenience function that configures the underlying [HttpNetworkTransport]. See also [networkTransport] for more customization.
* This is a convenience function that configures a default [HttpNetworkTransport] to use with queries/mutations
* and a default [WebSocketNetworkTransport] to use with subscriptions.
*
* @see networkTransport
* @see subscriptionNetworkTransport
*/
fun serverUrl(serverUrl: String) = apply {
httpServerUrl = serverUrl
Expand All @@ -573,12 +592,18 @@ private constructor(
/**
* The http:// or https:// url of the GraphQL server.
*
* This is the same as [serverUrl].
*
* This is a convenience function that configures the underlying [HttpNetworkTransport]. See also [networkTransport] for more customization.
*
* @see networkTransport
*/
@Deprecated(
"Use networkTransport() instead",
ReplaceWith(
"networkTransport(HttpNetworkTransport.Builder().serverUrl(httpServerUrl).build())",
"com.apollographql.apollo.network.http.HttpNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun httpServerUrl(httpServerUrl: String?) = apply {
this.httpServerUrl = httpServerUrl
}
Expand All @@ -590,6 +615,14 @@ private constructor(
*
* @see networkTransport
*/
@Deprecated(
"Use networkTransport() instead",
ReplaceWith(
"networkTransport(HttpNetworkTransport.Builder().httpEngine(httpEngine).build())",
"com.apollographql.apollo.network.http.HttpNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun httpEngine(httpEngine: HttpEngine?) = apply {
this.httpEngine = httpEngine
}
Expand All @@ -604,17 +637,33 @@ private constructor(
*
* @param httpExposeErrorBody whether to expose the error body or `null` to use the `false` default.
*/
@Deprecated(
"Use networkTransport() instead",
ReplaceWith(
"networkTransport(HttpNetworkTransport.Builder().exposeErrorBody(httpExposeErrorBody).build())",
"com.apollographql.apollo.network.http.HttpNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun httpExposeErrorBody(httpExposeErrorBody: Boolean?) = apply {
this.httpExposeErrorBody = httpExposeErrorBody
}

/**
* Adds [httpInterceptor] to the list of HTTP interceptors.
* Adds [httpInterceptors] to the list of HTTP interceptors.
*
* This is a convenience function that configures the underlying [HttpNetworkTransport]. See also [networkTransport] for more customization.
*
* @see networkTransport
*/
@Deprecated(
"Use networkTransport() instead",
ReplaceWith(
"networkTransport(HttpNetworkTransport.Builder().interceptors(httpInterceptors).build())",
"com.apollographql.apollo.network.http.HttpNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun httpInterceptors(httpInterceptors: List<HttpInterceptor>) = apply {
_httpInterceptors.clear()
_httpInterceptors.addAll(httpInterceptors)
Expand All @@ -627,13 +676,25 @@ private constructor(
*
* @see networkTransport
*/
@Deprecated(
"Use networkTransport() instead",
ReplaceWith(
"networkTransport(HttpNetworkTransport.Builder().addInterceptor(httpInterceptor).build())",
"com.apollographql.apollo.network.http.HttpNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun addHttpInterceptor(httpInterceptor: HttpInterceptor) = apply {
_httpInterceptors += httpInterceptor
}

/**
* Removes [httpInterceptor] from the list of HTTP interceptors.
*/
@Deprecated(
"Use networkTransport() instead",
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun removeHttpInterceptor(httpInterceptor: HttpInterceptor) = apply {
_httpInterceptors -= httpInterceptor
}
Expand All @@ -646,6 +707,14 @@ private constructor(
*
* @see subscriptionNetworkTransport
*/
@Deprecated(
"Use subscriptionNetworkTransport() instead",
ReplaceWith(
"subscriptionNetworkTransport(WebSocketNetworkTransport.Builder().serverUrl(webSocketServerUrl).build())",
"com.apollographql.apollo.network.ws.WebSocketNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun webSocketServerUrl(webSocketServerUrl: String?) = apply {
this.webSocketServerUrl = webSocketServerUrl
}
Expand All @@ -664,6 +733,14 @@ private constructor(
*
* @see subscriptionNetworkTransport
*/
@Deprecated(
"Use subscriptionNetworkTransport() instead",
ReplaceWith(
"subscriptionNetworkTransport(WebSocketNetworkTransport.Builder().serverUrl(webSocketServerUrl).build())",
"com.apollographql.apollo.network.ws.WebSocketNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun webSocketServerUrl(webSocketServerUrl: (suspend () -> String)?) = apply {
this.webSocketReopenServerUrl = webSocketServerUrl
}
Expand All @@ -677,6 +754,14 @@ private constructor(
*
* @see subscriptionNetworkTransport
*/
@Deprecated(
"Use subscriptionNetworkTransport() instead",
ReplaceWith(
"subscriptionNetworkTransport(WebSocketNetworkTransport.Builder().idleTimeoutMillis(webSocketIdleTimeoutMillis).build())",
"com.apollographql.apollo.network.ws.WebSocketNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun webSocketIdleTimeoutMillis(webSocketIdleTimeoutMillis: Long?) = apply {
this.webSocketIdleTimeoutMillis = webSocketIdleTimeoutMillis
}
Expand All @@ -688,6 +773,14 @@ private constructor(
*
* @see subscriptionNetworkTransport
*/
@Deprecated(
"Use subscriptionNetworkTransport() instead",
ReplaceWith(
"subscriptionNetworkTransport(WebSocketNetworkTransport.Builder().protocol(wsProtocolFactory).build())",
"com.apollographql.apollo.network.ws.WebSocketNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun wsProtocol(wsProtocolFactory: WsProtocol.Factory?) = apply {
this.wsProtocolFactory = wsProtocolFactory
}
Expand All @@ -699,6 +792,14 @@ private constructor(
*
* @see subscriptionNetworkTransport
*/
@Deprecated(
"Use subscriptionNetworkTransport() instead",
ReplaceWith(
"subscriptionNetworkTransport(WebSocketNetworkTransport.Builder().webSocketEngine(webSocketEngine).build())",
"com.apollographql.apollo.network.ws.WebSocketNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun webSocketEngine(webSocketEngine: WebSocketEngine?) = apply {
this.webSocketEngine = webSocketEngine
}
Expand All @@ -717,6 +818,14 @@ private constructor(
*
* @see subscriptionNetworkTransport
*/
@Deprecated(
"Use subscriptionNetworkTransport() instead",
ReplaceWith(
"subscriptionNetworkTransport(WebSocketNetworkTransport.Builder().reopenWhen(webSocketReopenWhen).build())",
"com.apollographql.apollo.network.ws.WebSocketNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun webSocketReopenWhen(webSocketReopenWhen: (suspend (Throwable, attempt: Long) -> Boolean)?) = apply {
this.webSocketReopenWhen = webSocketReopenWhen
}
Expand Down
52 changes: 46 additions & 6 deletions ...llo-runtime/src/jvmCommonMain/kotlin/com/apollographql/apollo/network/OkHttpExtensions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
@file:Suppress("DEPRECATION")

package com.apollographql.apollo.network

import com.apollographql.apollo.ApolloClient
import com.apollographql.apollo.annotations.ApolloDeprecatedSince
import com.apollographql.apollo.api.http.HttpHeader
import com.apollographql.apollo.network.http.DefaultHttpEngine
import com.apollographql.apollo.network.http.HttpNetworkTransport
Expand All @@ -16,6 +19,18 @@ import okhttp3.OkHttpClient
*
* See also [ApolloClient.Builder.httpEngine] and [ApolloClient.Builder.webSocketEngine]
*/
@Deprecated(
"Use networkTransport() instead",
ReplaceWith(
"networkTransport(HttpNetworkTransport.Builder().httpEngine(DefaultHttpEngine(okHttpClient)).build())" +
".subscriptionNetworkTransport(WebSocketNetworkTransport.Builder().webSocketEngine(DefaultWebSocketEngine(okHttpClient)).build())",
"com.apollographql.apollo.network.http.HttpNetworkTransport",
"com.apollographql.apollo.network.http.DefaultHttpEngine",
"com.apollographql.apollo.network.ws.DefaultWebSocketEngine",
"com.apollographql.apollo.network.ws.WebSocketNetworkTransport"
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I worry a bit about this one in particular as it's probably one the most often used, and the replacement expression is a bit of mouthful... But I agree about the tradeoff, it's for the better.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a fair point. We don't want to become the capitalized() of GraphQL... Will think more about this

fun ApolloClient.Builder.okHttpClient(okHttpClient: OkHttpClient) = apply {
httpEngine(DefaultHttpEngine(okHttpClient))
webSocketEngine(DefaultWebSocketEngine(okHttpClient))
Expand All @@ -24,36 +39,61 @@ fun ApolloClient.Builder.okHttpClient(okHttpClient: OkHttpClient) = apply {
/**
* Configures the [ApolloClient] to use the [callFactory] for network requests.
*/
@Deprecated(
"Use networkTransport() instead",
ReplaceWith(
"networkTransport(HttpNetworkTransport.Builder().httpEngine(DefaultHttpEngine(callFactory)).build())",
"com.apollographql.apollo.network.http.HttpNetworkTransport",
"com.apollographql.apollo.network.http.DefaultHttpEngine",
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun ApolloClient.Builder.okHttpCallFactory(callFactory: Call.Factory) = apply {
httpEngine(DefaultHttpEngine(callFactory))
}

/**
* Configures the [ApolloClient] to use the lazily initialized [callFactory] for network requests.
*/
@Deprecated(
"Use networkTransport() instead",
ReplaceWith(
"networkTransport(HttpNetworkTransport.Builder().httpEngine(DefaultHttpEngine(callFactory)).build())",
"com.apollographql.apollo.network.http.HttpNetworkTransport",
"com.apollographql.apollo.network.http.DefaultHttpEngine",
)
)
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun ApolloClient.Builder.okHttpCallFactory(callFactory: () -> Call.Factory) = apply {
httpEngine(DefaultHttpEngine(callFactory))
}

/**
* Configures the [HttpNetworkTransport] to use the [DefaultHttpEngine] for network requests.
*/
@Deprecated("Use httpEngine instead.", ReplaceWith("httpEngine(DefaultHttpEngine(okHttpClient))"))
fun HttpNetworkTransport.Builder.okHttpClient(okHttpClient: OkHttpClient) = apply {
httpEngine(DefaultHttpEngine(okHttpClient))
}

/**
* Configures the [HttpNetworkTransport] to use the [okHttpCallFactory] for network requests.
* Configures the [OkHttpClient] to use for HTTP requests.
*
* This is the same function as [okHttpCallFactory]
*/
fun HttpNetworkTransport.Builder.okHttpCallFactory(okHttpCallFactory: Call.Factory) = apply {
httpEngine(DefaultHttpEngine(okHttpCallFactory))
@Deprecated("Use webSocketEngine instead.", ReplaceWith("webSocketEngine(DefaultWebSocketEngine(okHttpClient))"))
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun WebSocketNetworkTransport.Builder.okHttpClient(okHttpClient: OkHttpClient) = apply {
webSocketEngine(DefaultWebSocketEngine(okHttpClient))
}

/**
* Configures the [WebSocketNetworkTransport] to use the [okHttpCallFactory] for network requests.
* Configures the [Call.Factory] to use for HTTP requests.
*/
fun WebSocketNetworkTransport.Builder.okHttpClient(okHttpClient: OkHttpClient) = apply {
webSocketEngine(DefaultWebSocketEngine(okHttpClient))
@Deprecated("Use httpEngine instead.", ReplaceWith("httpEngine(DefaultHttpEngine(callFactory))"))
@ApolloDeprecatedSince(ApolloDeprecatedSince.Version.v4_1_1)
fun HttpNetworkTransport.Builder.okHttpCallFactory(callFactory: Call.Factory) = apply {
httpEngine(DefaultHttpEngine(callFactory))
}

internal fun List<HttpHeader>.toOkHttpHeaders(): Headers =
Expand Down
3 changes: 3 additions & 0 deletions ...e/src/jvmCommonMain/kotlin/com/apollographql/apollo/network/http/DefaultHttpEngine.jvm.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ actual fun DefaultHttpEngine(timeoutMillis: Long): HttpEngine = JvmHttpEngine(ti

fun DefaultHttpEngine(httpCallFactory: Call.Factory): HttpEngine = JvmHttpEngine(httpCallFactory)

/**
* See https://github.com/square/okhttp/pull/8248 for why we use a lambda here
*/
fun DefaultHttpEngine(httpCallFactory: () -> Call.Factory): HttpEngine = JvmHttpEngine(httpCallFactory)

fun DefaultHttpEngine(okHttpClient: OkHttpClient): HttpEngine = JvmHttpEngine(okHttpClient)
Expand Down
1 change: 1 addition & 0 deletions ...ime/src/jvmCommonMain/kotlin/com/apollographql/apollo/network/ws/OkHttpWebSocketEngine.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ actual class DefaultWebSocketEngine(
* See https://github.com/square/okhttp/pull/8248
*/
constructor(webSocketFactory: WebSocket.Factory): this({webSocketFactory})

actual constructor() : this(
webSocketFactory = defaultOkHttpClientBuilder.build()
)
Expand Down
Loading