Remove CloseableBackgroundDispatcher (#6286)

* Remove CloseableBackgroundDispatcher

* bump Kotlin coroutines

Author: martinbonnin

gradle/libraries.toml

@@ -30,7 +30,7 @@ kotlin-plugin-min = "1.9.0"
 kotlin-plugin = "2.0.20"
 kotlin-plugin-max = "2.0.20"
 kotlin-stdlib = "2.0.0"
-kotlinx-coroutines = "1.8.0"
+kotlinx-coroutines = "1.9.0"
 kotlinx-datetime = "0.5.0"
 kotlinx-serialization-runtime = "1.6.2"
 ksp = "2.0.20-1.0.24"

libraries/apollo-runtime/src/appleMain/kotlin/com/apollographql/apollo/internal/dispatchers.kt

@@ -5,13 +5,3 @@ import okio.Closeable
 
 internal expect val defaultDispatcher: CoroutineDispatcher
 
-/**
- * A coroutine dispatcher backed by a single thread that can continue to run in the background
- * until it is closed. Typically, to handle a WebSocket connection or batched HTTP queries.
- */
-internal expect class CloseableSingleThreadDispatcher() : Closeable {
-  val coroutineDispatcher: CoroutineDispatcher
-
-  override fun close()
-}
-

libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/internal/dispatchers.kt

@@ -20,9 +20,9 @@ import com.apollographql.apollo.exception.ApolloException
 import com.apollographql.apollo.exception.ApolloHttpException
 import com.apollographql.apollo.exception.DefaultApolloException
 import com.apollographql.apollo.exception.JsonDataException
-import com.apollographql.apollo.internal.CloseableSingleThreadDispatcher
 import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.async
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.delay
@@ -54,6 +54,8 @@ import kotlin.time.TimeSource.Monotonic.markNow
  * HTTP headers will be merged from all requests in the batch by keeping the ones that have the same name and value in all requests. Any
  * headers present in only some requests, or with different values in some requests will be dropped.
  *
+ * Disposing [com.apollographql.apollo.network.http.BatchingHttpInterceptor] is not necessary but will cancel any pending request saving some bandwidth if needed.
+ *
  * @param batchIntervalMillis the maximum time interval before a new batch is sent
  * @param maxBatchSize the maximum number of requests queued before a new batch is sent
  * @param exposeErrorBody configures whether to expose the error body in [ApolloHttpException].
@@ -69,8 +71,8 @@ class BatchingHttpInterceptor @JvmOverloads constructor(
     private val exposeErrorBody: Boolean = false,
 ) : HttpInterceptor {
   private val startMark = markNow()
-  private val dispatcher = CloseableSingleThreadDispatcher()
-  private val scope = CoroutineScope(dispatcher.coroutineDispatcher)
+  private val dispatcher = Dispatchers.Default.limitedParallelism(1)
+  private val scope = CoroutineScope(dispatcher)
   private val mutex = Mutex()
   private var disposed = false
 
@@ -231,11 +233,15 @@ class BatchingHttpInterceptor @JvmOverloads constructor(
     }
   }
 
+  /**
+   * Cancels pending requests.
+   *
+   * Disposing [BatchingHttpInterceptor] is not necessary but allows reclaiming resources more rapidly.
+   */
   override fun dispose() {
     if (!disposed) {
       interceptorChain = null
       scope.cancel()
-      dispatcher.close()
       disposed = true
     }
   }

libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/network/http/BatchingHttpInterceptor.kt

@@ -13,6 +13,8 @@ interface HttpInterceptorChain {
 
 interface HttpInterceptor {
   suspend fun intercept(request: HttpRequest, chain: HttpInterceptorChain): HttpResponse
+
+  // TODO: remove dispose
   fun dispose() {}
 }
 

libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/network/http/HttpInterceptor.kt

@@ -10,7 +10,6 @@ import com.apollographql.apollo.api.toApolloResponse
 import com.apollographql.apollo.exception.ApolloException
 import com.apollographql.apollo.exception.ApolloNetworkException
 import com.apollographql.apollo.exception.SubscriptionOperationException
-import com.apollographql.apollo.internal.CloseableSingleThreadDispatcher
 import com.apollographql.apollo.internal.DeferredJsonMerger
 import com.apollographql.apollo.internal.isDeferred
 import com.apollographql.apollo.internal.transformWhile
@@ -31,6 +30,7 @@ import com.apollographql.apollo.network.ws.internal.StopOperation
 import com.benasher44.uuid.Uuid
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.CoroutineStart
+import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.channels.BufferOverflow
 import kotlinx.coroutines.channels.Channel
@@ -86,14 +86,12 @@ private constructor(
 
   val subscriptionCount = mutableEvents.subscriptionCount
 
-  private val backgroundDispatcher = CloseableSingleThreadDispatcher()
-  private val coroutineScope = CoroutineScope(backgroundDispatcher.coroutineDispatcher)
+  private val backgroundDispatcher = Dispatchers.Default.limitedParallelism(1)
+  private val coroutineScope = CoroutineScope(backgroundDispatcher)
 
   init {
     coroutineScope.launch {
-      backgroundDispatcher.use {
-        supervise(this)
-      }
+      supervise(this)
     }
   }
 
@@ -345,6 +343,12 @@ private constructor(
       .isLast(true)
       .build()
 
+  /**
+   * Closes the WebSocket. Active subscriptions stop receiving events.
+   *
+   * This is an asynchronous operation. The WebSocket is closed shortly after this call.
+   * Disposing [WebSocketNetworkTransport] is not necessary but allows reclaiming resources more rapidly.
+   */
   override fun dispose() {
     messages.trySend(Dispose)
   }

libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/network/ws/WebSocketNetworkTransport.kt

@@ -7,10 +7,3 @@ import okio.Closeable
 internal actual val defaultDispatcher: CoroutineDispatcher
   get() = Dispatchers.Default
 
-// We can't use threads in JS, so just fallback to defaultDispatcher()
-internal actual class CloseableSingleThreadDispatcher : Closeable {
-  actual val coroutineDispatcher: CoroutineDispatcher = Dispatchers.Default
-
-  actual override fun close() {
-  }
-}

libraries/apollo-runtime/src/jsMain/kotlin/com/apollographql/apollo/internal/dispatchers.js.kt

@@ -7,10 +7,3 @@ import okio.Closeable
 internal actual val defaultDispatcher: CoroutineDispatcher
   get() = Dispatchers.Default
 
-// We can't use threads in JS, so just fallback to defaultDispatcher()
-internal actual class CloseableSingleThreadDispatcher : Closeable {
-  actual val coroutineDispatcher: CoroutineDispatcher = Dispatchers.Default
-
-  actual override fun close() {
-  }
-}