Track pending fragment ids rather than completed ones.

Author: BoD

libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/BooleanExpression.kt

@@ -74,16 +74,20 @@ fun BooleanExpression<BTerm>.evaluate(
   return evaluate {
     when (it) {
       is BVariable -> !(variables?.contains(it.name) ?: false)
-      is BLabel -> hasDeferredFragment(deferredFragmentIdentifiers, croppedPath!!, it.label)
+      is BLabel -> !isDeferredFragmentPending(deferredFragmentIdentifiers, croppedPath!!, it.label)
       is BPossibleTypes -> it.possibleTypes.contains(typename)
     }
   }
 }
 
-private fun hasDeferredFragment(deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>?, path: List<Any>, label: String?): Boolean {
+private fun isDeferredFragmentPending(
+    deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>?,
+    path: List<Any>,
+    label: String?,
+): Boolean {
   if (deferredFragmentIdentifiers == null) {
     // By default, parse all deferred fragments - this is the case when parsing from the normalized cache.
-    return true
+    return false
   }
   return deferredFragmentIdentifiers.contains(DeferredFragmentIdentifier(path, label))
 }

libraries/apollo-runtime/api/android/apollo-runtime.api

@@ -219,7 +219,7 @@ public final class com/apollographql/apollo/internal/DeferredJsonMerger {
 	public fun <init> ()V
 	public final fun getHasNext ()Z
 	public final fun getMerged ()Ljava/util/Map;
-	public final fun getMergedFragmentIds ()Ljava/util/Set;
+	public final fun getPendingFragmentIds ()Ljava/util/Set;
 	public final fun isEmptyPayload ()Z
 	public final fun merge (Ljava/util/Map;)Ljava/util/Map;
 	public final fun merge (Lokio/BufferedSource;)Ljava/util/Map;

libraries/apollo-runtime/api/apollo-runtime.klib.api

@@ -205,8 +205,8 @@ final class com.apollographql.apollo.internal/DeferredJsonMerger { // com.apollo
 
     final val merged // com.apollographql.apollo.internal/DeferredJsonMerger.merged|{}merged[0]
         final fun <get-merged>(): kotlin.collections/Map<kotlin/String, kotlin/Any?> // com.apollographql.apollo.internal/DeferredJsonMerger.merged.<get-merged>|<get-merged>(){}[0]
-    final val mergedFragmentIds // com.apollographql.apollo.internal/DeferredJsonMerger.mergedFragmentIds|{}mergedFragmentIds[0]
-        final fun <get-mergedFragmentIds>(): kotlin.collections/Set<com.apollographql.apollo.api/DeferredFragmentIdentifier> // com.apollographql.apollo.internal/DeferredJsonMerger.mergedFragmentIds.<get-mergedFragmentIds>|<get-mergedFragmentIds>(){}[0]
+    final val pendingFragmentIds // com.apollographql.apollo.internal/DeferredJsonMerger.pendingFragmentIds|{}pendingFragmentIds[0]
+        final fun <get-pendingFragmentIds>(): kotlin.collections/Set<com.apollographql.apollo.api/DeferredFragmentIdentifier> // com.apollographql.apollo.internal/DeferredJsonMerger.pendingFragmentIds.<get-pendingFragmentIds>|<get-pendingFragmentIds>(){}[0]
 
     final var hasNext // com.apollographql.apollo.internal/DeferredJsonMerger.hasNext|{}hasNext[0]
         final fun <get-hasNext>(): kotlin/Boolean // com.apollographql.apollo.internal/DeferredJsonMerger.hasNext.<get-hasNext>|<get-hasNext>(){}[0]

libraries/apollo-runtime/api/jvm/apollo-runtime.api

@@ -219,7 +219,7 @@ public final class com/apollographql/apollo/internal/DeferredJsonMerger {
 	public fun <init> ()V
 	public final fun getHasNext ()Z
 	public final fun getMerged ()Ljava/util/Map;
-	public final fun getMergedFragmentIds ()Ljava/util/Set;
+	public final fun getPendingFragmentIds ()Ljava/util/Set;
 	public final fun isEmptyPayload ()Z
 	public final fun merge (Ljava/util/Map;)Ljava/util/Map;
 	public final fun merge (Lokio/BufferedSource;)Ljava/util/Map;

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

@@ -12,7 +12,7 @@ private typealias MutableJsonMap = MutableMap<String, Any?>
 /**
  * Utility class for merging GraphQL JSON payloads received in multiple chunks when using the `@defer` directive.
  *
- * Each call to [merge] will merge the given chunk into the [merged] Map, and will also update the [mergedFragmentIds] Set with the
+ * Each call to [merge] will merge the given chunk into the [merged] Map, and will also update the [pendingFragmentIds] Set with the
  * value of its `path` and `label` field.
  *
  * The fields in `data` are merged into the node found in [merged] at the path known by looking at the `id` field (for the first call to
@@ -32,10 +32,8 @@ class DeferredJsonMerger {
   /**
    * Map of identifiers to their corresponding DeferredFragmentIdentifier, found in `pending`.
    */
-  private val idsToDeferredFragmentIdentifiers = mutableMapOf<String, DeferredFragmentIdentifier>()
-
-  private val _mergedFragmentIds = mutableSetOf<DeferredFragmentIdentifier>()
-  val mergedFragmentIds: Set<DeferredFragmentIdentifier> = _mergedFragmentIds
+  private val _pendingFragmentIds = mutableMapOf<String, DeferredFragmentIdentifier>()
+  val pendingFragmentIds: Set<DeferredFragmentIdentifier> get() = _pendingFragmentIds.values.toSet()
 
   var hasNext: Boolean = true
     private set
@@ -95,7 +93,7 @@ class DeferredJsonMerger {
         val id = pendingItem["id"] as String
         val path = pendingItem["path"] as List<Any>
         val label = pendingItem["label"] as String?
-        idsToDeferredFragmentIdentifiers[id] = DeferredFragmentIdentifier(path = path, label = label)
+        _pendingFragmentIds[id] = DeferredFragmentIdentifier(path = path, label = label)
       }
     }
   }
@@ -104,16 +102,14 @@ class DeferredJsonMerger {
     val completed = payload["completed"] as? List<JsonMap>
     if (completed != null) {
       for (completedItem in completed) {
+        // Merge errors (if any) of the completed item
         val errors = completedItem["errors"] as? List<JsonMap>
         if (errors != null) {
-          // Merge errors (if any) of the completed item
           getOrPutMergedErrors() += errors
         } else {
-          // No errors: we have merged all the fields of the fragment so it can be parsed
+          // Fragment is no longer pending - only if there were no errors
           val id = completedItem["id"] as String
-          val deferredFragmentIdentifier = idsToDeferredFragmentIdentifiers.remove(id)
-              ?: error("Id '$id' not found in pending results")
-          _mergedFragmentIds += deferredFragmentIdentifier
+          _pendingFragmentIds.remove(id) ?: error("Id '$id' not found in pending results")
         }
       }
     }
@@ -123,7 +119,7 @@ class DeferredJsonMerger {
     val id = incrementalItem["id"] as String? ?: error("No id found in incremental item")
     val data = incrementalItem["data"] as JsonMap? ?: error("No data found in incremental item")
     val subPath = incrementalItem["subPath"] as List<Any>? ?: emptyList()
-    val path = (idsToDeferredFragmentIdentifiers[id]?.path ?: error("Id '$id' not found in pending results")) + subPath
+    val path = (_pendingFragmentIds[id]?.path ?: error("Id '$id' not found in pending results")) + subPath
     val mergedData = merged["data"] as JsonMap
     val nodeToMergeInto = nodeAtPath(mergedData, path) as MutableJsonMap
     deepMerge(nodeToMergeInto, data)
@@ -165,7 +161,7 @@ class DeferredJsonMerger {
 
   fun reset() {
     _merged.clear()
-    _mergedFragmentIds.clear()
+    _pendingFragmentIds.clear()
     hasNext = true
     isEmptyPayload = false
   }

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

@@ -222,7 +222,7 @@ private constructor(
               jsonMerger = DeferredJsonMerger()
             }
             val merged = jsonMerger.merge(part)
-            val deferredFragmentIds = jsonMerger.mergedFragmentIds
+            val deferredFragmentIds = jsonMerger.pendingFragmentIds
             val isLast = !jsonMerger.hasNext
 
             if (jsonMerger.isEmptyPayload) {

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

@@ -215,7 +215,7 @@ private class DefaultSubscriptionParser<D : Operation.Data>(private val request:
     }
 
     val (payload, mergedFragmentIds) = if (responseMap.isDeferred()) {
-      deferredJsonMerger.merge(responseMap) to deferredJsonMerger.mergedFragmentIds
+      deferredJsonMerger.merge(responseMap) to deferredJsonMerger.pendingFragmentIds
     } else {
       responseMap to null
     }

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

@@ -45,7 +45,6 @@ import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.onCompletion
 import kotlinx.coroutines.flow.onSubscription
 import kotlinx.coroutines.launch
-import okio.use
 
 /**
  * A [NetworkTransport] that manages a single instance of a [WebSocketConnection].
@@ -304,7 +303,7 @@ private constructor(
           val responsePayload = response.payload
           val requestCustomScalarAdapters = request.executionContext[CustomScalarAdapters]!!
           val (payload, mergedFragmentIds) = if (responsePayload.isDeferred()) {
-            deferredJsonMerger.merge(responsePayload) to deferredJsonMerger.mergedFragmentIds
+            deferredJsonMerger.merge(responsePayload) to deferredJsonMerger.pendingFragmentIds
           } else {
             responsePayload to null
           }