Add WebSocketEngine(WebSocket.Factory) and fix documentation

See #5862
apollographql · Jul 23, 2024 · 899cb4a · 899cb4a
1 parent 29434df
commit 899cb4a
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 17 deletions.
diff --git a/docs/source/advanced/experimental-websockets.mdx b/docs/source/advanced/experimental-websockets.mdx
@@ -111,19 +111,35 @@ The above uses the default retry algorithm:
 * Wait until the network is available if you configured a [NetworkMonitor](network-connectivity).
 * Or use exponential backoff else.
 
-To customize the retry logic more, use `addRetryOnErrorInterceptor`:
+To customize the retry logic more, use `retryOnErrorInterceptor`:
 
 ```kotlin
 val apolloClient = ApolloClient.Builder()
-    .subscriptionNetworkTransport(
-        WebSocketNetworkTransport.Builder()
-            .serverUrl(url)
-            .build()
-    )
-    .addRetryOnErrorInterceptor { exception, attempt -> 
-      // retry logic here
-
-      // return true to retry or false to terminate the Flow
-      true
-    }
+    .retryOnErrorInterceptor(MyRetryOnErrorInterceptor())
+    .build()
+
+class MyRetryOnErrorInterceptor : ApolloInterceptor {
+  object RetryException : Exception()
+
+  override fun <D : Operation.Data> intercept(request: ApolloRequest<D>, chain: ApolloInterceptorChain): Flow<ApolloResponse<D>> {
+    var attempt = 0
+    return request.ensureUniqueUuid()
+        .flatMapConcat { chain.proceed(it) }.onEach {
+          if (request.retryOnError == true && it.exception != null && it.exception is ApolloNetworkException) {
+            throw RetryException
+          } else {
+            attempt = 0
+          }
+        }.retryWhen { cause, _ ->
+          if (cause is RetryException) {
+            attempt++
+            delay(2.0.pow(attempt).seconds)
+            true
+          } else {
+            // Not a RetryException, probably a programming error, pass it through
+            false
+          }
+        }
+  }
+}
 ```
diff --git a/...rc/jvmCommonMain/kotlin/com/apollographql/apollo/network/websocket/WebSocketEngine.jvm.kt b/...rc/jvmCommonMain/kotlin/com/apollographql/apollo/network/websocket/WebSocketEngine.jvm.kt
@@ -1,10 +1,9 @@
 package com.apollographql.apollo.network.websocket
 
+import com.apollographql.apollo.annotations.ApolloExperimental
 import com.apollographql.apollo.api.http.HttpHeader
 import com.apollographql.apollo.exception.ApolloNetworkException
 import com.apollographql.apollo.network.defaultOkHttpClientBuilder
-import com.apollographql.apollo.network.websocket.WebSocket
-import com.apollographql.apollo.network.websocket.WebSocketListener
 import okhttp3.Headers
 import okhttp3.OkHttpClient
 import okhttp3.Request
@@ -16,9 +15,9 @@ import java.util.concurrent.atomic.AtomicReference
 import okhttp3.WebSocket as PlatformWebSocket
 import okhttp3.WebSocketListener as PlatformWebSocketListener
 
-internal class JvmWebSocketEngine(private val okHttpClient: OkHttpClient) : WebSocketEngine {
+internal class JvmWebSocketEngine(private val webSocketFactory: PlatformWebSocket.Factory) : WebSocketEngine {
   override fun newWebSocket(url: String, headers: List<HttpHeader>, listener: WebSocketListener): WebSocket {
-    return JvmWebSocket(okHttpClient, url, headers, listener)
+    return JvmWebSocket(webSocketFactory, url, headers, listener)
   }
 
   override fun close() {
@@ -107,4 +106,7 @@ internal class JvmWebSocket(
 }
 
 
-actual fun WebSocketEngine(): WebSocketEngine = JvmWebSocketEngine(defaultOkHttpClientBuilder.build())
+actual fun WebSocketEngine(): WebSocketEngine = JvmWebSocketEngine(defaultOkHttpClientBuilder.build())
+
+@ApolloExperimental
+fun WebSocketEngine(webSocketFactory: PlatformWebSocket.Factory): WebSocketEngine = JvmWebSocketEngine(webSocketFactory)