Revert typealiases and use DeferredFragmentIdentifier again

BoD · BoD · commit ab9449af6a25 · 2025-10-15T11:06:44.000+02:00
diff --git a/libraries/apollo-api/api/apollo-api.api b/libraries/apollo-api/api/apollo-api.api
@@ -530,6 +530,7 @@ public final class com/apollographql/apollo/api/DefaultUploadKt {
 }
 
 public final class com/apollographql/apollo/api/DeferredFragmentIdentifier {
+	public static final field Companion Lcom/apollographql/apollo/api/DeferredFragmentIdentifier$Companion;
 	public fun <init> (Ljava/util/List;Ljava/lang/String;)V
 	public final fun component1 ()Ljava/util/List;
 	public final fun component2 ()Ljava/lang/String;
@@ -542,6 +543,10 @@ public final class com/apollographql/apollo/api/DeferredFragmentIdentifier {
 	public fun toString ()Ljava/lang/String;
 }
 
+public final class com/apollographql/apollo/api/DeferredFragmentIdentifier$Companion {
+	public final fun getPending ()Lcom/apollographql/apollo/api/DeferredFragmentIdentifier;
+}
+
 public final class com/apollographql/apollo/api/EnumType : com/apollographql/apollo/api/CompiledNamedType {
 	public fun <init> (Ljava/lang/String;Ljava/util/List;)V
 	public final fun getValues ()Ljava/util/List;
@@ -713,12 +718,6 @@ public final class com/apollographql/apollo/api/ImmutableMapBuilder {
 	public final fun put (Ljava/lang/Object;Ljava/lang/Object;)Lcom/apollographql/apollo/api/ImmutableMapBuilder;
 }
 
-public final class com/apollographql/apollo/api/IncrementalResultIdentifierKt {
-	public static final fun isPending (Ljava/util/Set;)Z
-	public static final fun nonPending (Ljava/util/Set;)Ljava/util/Set;
-	public static final fun pending (Ljava/util/Set;)Ljava/util/Set;
-}
-
 public final class com/apollographql/apollo/api/InputObjectType : com/apollographql/apollo/api/CompiledNamedType {
 	public fun <init> (Ljava/lang/String;)V
 }
diff --git a/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/BooleanExpression.kt b/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/BooleanExpression.kt
@@ -67,30 +67,26 @@ internal fun <T : Any> BooleanExpression<T>.evaluate(block: (T) -> Boolean): Boo
 fun BooleanExpression<BTerm>.evaluate(
     variables: Set<String>?,
     typename: String?,
-    deferredFragmentIdentifiers: IncrementalResultIdentifiers?,
+    deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>?,
     path: List<Any>?,
 ): Boolean {
   // Remove "data" from the path
   val croppedPath = path?.drop(1)
   return evaluate {
     when (it) {
       is BVariable -> !(variables?.contains(it.name) ?: false)
-      is BLabel -> shouldParseFragment(deferredFragmentIdentifiers = deferredFragmentIdentifiers, path = croppedPath!!, label = it.label)
+      is BLabel -> shouldParseFragment(deferredFragmentIdentifiers, croppedPath!!, it.label)
       is BPossibleTypes -> it.possibleTypes.contains(typename)
     }
   }
 }
 
-private fun shouldParseFragment(
-    deferredFragmentIdentifiers: IncrementalResultIdentifiers?,
-    path: List<Any>,
-    label: String?,
-): Boolean {
+private fun shouldParseFragment(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
   }
-  val identifier = IncrementalResultIdentifier(path, label)
+  val identifier = DeferredFragmentIdentifier(path, label)
   return if (deferredFragmentIdentifiers.isPending()) {
     // Modern protocol: parse fragments that are _not_ pending
     !deferredFragmentIdentifiers.contains(identifier)
@@ -100,6 +96,10 @@ private fun shouldParseFragment(
   }
 }
 
+private fun Set<DeferredFragmentIdentifier>.isPending(): Boolean {
+  return any { it === DeferredFragmentIdentifier.Pending }
+}
+
 /**
  * A generic term in a [BooleanExpression]
  */
diff --git a/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/CustomScalarAdapters.kt b/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/CustomScalarAdapters.kt
@@ -19,10 +19,10 @@ class CustomScalarAdapters private constructor(
     @JvmField
     val falseVariables: Set<String>?,
     /**
-     * Incremental result identifiers used to determine whether the parser must parse deferred fragments
+     * Identifiers used to determine whether the parser must parse deferred fragments
      */
     @JvmField
-    val deferredFragmentIdentifiers: IncrementalResultIdentifiers?,
+    val deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>?,
     /**
      * Errors to use with @catch
      */
@@ -131,14 +131,14 @@ class CustomScalarAdapters private constructor(
   class Builder {
     private val adaptersMap: MutableMap<String, Adapter<*>> = mutableMapOf()
     private var falseVariables: Set<String>? = null
-    private var deferredFragmentIdentifiers: IncrementalResultIdentifiers? = null
+    private var deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>? = null
     private var errors: List<Error>? = null
 
     fun falseVariables(falseVariables: Set<String>?) = apply {
       this.falseVariables = falseVariables
     }
 
-    fun deferredFragmentIdentifiers(deferredFragmentIdentifiers: IncrementalResultIdentifiers?) = apply {
+    fun deferredFragmentIdentifiers(deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>?) = apply {
       this.deferredFragmentIdentifiers = deferredFragmentIdentifiers
     }
 
diff --git a/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/DeferredFragmentIdentifier.kt b/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/DeferredFragmentIdentifier.kt
@@ -0,0 +1,19 @@
+package com.apollographql.apollo.api
+
+import com.apollographql.apollo.annotations.ApolloInternal
+
+data class DeferredFragmentIdentifier(
+    /**
+     * Path of the fragment in the overall JSON response. The elements can either be Strings (names) or Integers (array indices).
+     */
+    val path: List<Any>,
+    val label: String?,
+) {
+  companion object {
+    /**
+     * Special identifier to signal that the identifiers are pending, as in the modern version of the protocol.
+     */
+    @ApolloInternal
+    val Pending = DeferredFragmentIdentifier(emptyList(), "__pending")
+  }
+}
diff --git a/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/Executables.kt b/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/Executables.kt
@@ -71,8 +71,8 @@ fun <D : Executable.Data> Executable<D>.parseData(
     jsonReader: JsonReader,
     customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty,
     falseVariables: Set<String>? = null,
-    deferredFragmentIds: IncrementalResultIdentifiers? = null,
-    errors: List<Error>? = null,
+    deferredFragmentIds: Set<DeferredFragmentIdentifier>? = null,
+    errors: List<Error>? = null
 ): D? {
   val customScalarAdapters1 = customScalarAdapters.newBuilder()
       .falseVariables(falseVariables)
@@ -89,4 +89,4 @@ fun <D : Executable.Data> Executable<D>.composeData(
     value: D
 ) {
   adapter().toJson(jsonWriter, customScalarAdapters, value)
-}
+}
diff --git a/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/IncrementalResultIdentifier.kt b/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/IncrementalResultIdentifier.kt
diff --git a/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/Operations.kt b/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/Operations.kt
@@ -70,7 +70,7 @@ fun <D : Operation.Data> Operation<D>.composeJsonRequest(
 fun <D : Operation.Data> Operation<D>.parseJsonResponse(
     jsonReader: JsonReader,
     customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty,
-    deferredFragmentIdentifiers: IncrementalResultIdentifiers? = null,
+    deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>? = null,
 ): ApolloResponse<D> {
   return jsonReader.use {
     ResponseParser.parse(
@@ -103,7 +103,7 @@ fun <D : Operation.Data> Operation<D>.parseResponse(
     jsonReader: JsonReader,
     requestUuid: Uuid? = null,
     customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty,
-    deferredFragmentIdentifiers: IncrementalResultIdentifiers? = null,
+    deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>? = null,
 ): ApolloResponse<D> {
   return try {
     ResponseParser.parse(
@@ -177,7 +177,7 @@ fun <D : Operation.Data> JsonReader.toApolloResponse(
     operation: Operation<D>,
     requestUuid: Uuid? = null,
     customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty,
-    deferredFragmentIdentifiers: IncrementalResultIdentifiers? = null,
+    deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>? = null,
 ): ApolloResponse<D> {
   return use {
     try {
@@ -213,7 +213,7 @@ fun <D : Operation.Data> JsonReader.parseResponse(
     operation: Operation<D>,
     requestUuid: Uuid? = null,
     customScalarAdapters: CustomScalarAdapters = CustomScalarAdapters.Empty,
-    deferredFragmentIdentifiers: IncrementalResultIdentifiers? = null,
+    deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>? = null,
 ): ApolloResponse<D> {
   return try {
     ResponseParser.parse(
diff --git a/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/internal/ResponseParser.kt b/libraries/apollo-api/src/commonMain/kotlin/com/apollographql/apollo/api/internal/ResponseParser.kt
@@ -3,8 +3,8 @@ package com.apollographql.apollo.api.internal
 import com.apollographql.apollo.annotations.ApolloInternal
 import com.apollographql.apollo.api.ApolloResponse
 import com.apollographql.apollo.api.CustomScalarAdapters
+import com.apollographql.apollo.api.DeferredFragmentIdentifier
 import com.apollographql.apollo.api.Error
-import com.apollographql.apollo.api.IncrementalResultIdentifiers
 import com.apollographql.apollo.api.Operation
 import com.apollographql.apollo.api.falseVariables
 import com.apollographql.apollo.api.json.JsonReader
@@ -24,7 +24,7 @@ internal object ResponseParser {
       operation: Operation<D>,
       requestUuid: Uuid?,
       customScalarAdapters: CustomScalarAdapters,
-      deferredFragmentIds: IncrementalResultIdentifiers?,
+      deferredFragmentIds: Set<DeferredFragmentIdentifier>?,
   ): ApolloResponse<D> {
     jsonReader.beginObject()
 
diff --git a/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/internal/incremental/GraphQL17Alpha2IncrementalResultsMerger.kt b/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/internal/incremental/GraphQL17Alpha2IncrementalResultsMerger.kt
@@ -1,7 +1,6 @@
 package com.apollographql.apollo.internal.incremental
 
-import com.apollographql.apollo.api.IncrementalResultIdentifier
-import com.apollographql.apollo.api.IncrementalResultIdentifiers
+import com.apollographql.apollo.api.DeferredFragmentIdentifier
 import okio.BufferedSource
 
 /**
@@ -12,12 +11,12 @@ internal class GraphQL17Alpha2IncrementalResultsMerger : IncrementalResultsMerge
   private val _merged: MutableJsonMap = mutableMapOf()
   override val merged: JsonMap = _merged
 
-  private val _incrementalResultIds = mutableSetOf<IncrementalResultIdentifier>()
+  private val _deferredFragmentIdentifiers = mutableSetOf<DeferredFragmentIdentifier>()
 
   /**
    * For this protocol, this represents the set of fragment ids that are already merged.
    */
-  override val incrementalResultIdentifiers: IncrementalResultIdentifiers = _incrementalResultIds
+  override val deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier> = _deferredFragmentIdentifiers
 
   override var hasNext: Boolean = true
     private set
@@ -77,13 +76,13 @@ internal class GraphQL17Alpha2IncrementalResultsMerger : IncrementalResultsMerge
       val nodeToMergeInto = nodeAtPath(mergedData, path) as MutableJsonMap
       deepMergeObject(nodeToMergeInto, data)
 
-      _incrementalResultIds += IncrementalResultIdentifier(path = path, label = incrementalResult["label"] as String?)
+      _deferredFragmentIdentifiers += DeferredFragmentIdentifier(path = path, label = incrementalResult["label"] as String?)
     }
   }
 
   override fun reset() {
     _merged.clear()
-    _incrementalResultIds.clear()
+    _deferredFragmentIdentifiers.clear()
     hasNext = true
     isEmptyResponse = false
   }
diff --git a/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/internal/incremental/GraphQL17Alpha9IncrementalResultsMerger.kt b/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/internal/incremental/GraphQL17Alpha9IncrementalResultsMerger.kt
@@ -1,8 +1,6 @@
 package com.apollographql.apollo.internal.incremental
 
-import com.apollographql.apollo.api.IncrementalResultIdentifier
-import com.apollographql.apollo.api.IncrementalResultIdentifiers
-import com.apollographql.apollo.api.pending
+import com.apollographql.apollo.api.DeferredFragmentIdentifier
 import okio.BufferedSource
 
 /**
@@ -16,12 +14,12 @@ internal class GraphQL17Alpha9IncrementalResultsMerger : IncrementalResultsMerge
   /**
    * Map of identifiers to their corresponding IncrementalResultIdentifier, found in `pending`.
    */
-  private val _pendingResultIds = mutableMapOf<String, IncrementalResultIdentifier>()
+  private val _pendingResultIds = mutableMapOf<String, DeferredFragmentIdentifier>()
 
   /**
    * For this protocol, this represents the set of ids that are pending.
    */
-  override val incrementalResultIdentifiers: IncrementalResultIdentifiers get() = _pendingResultIds.values.toSet().pending()
+  override val deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier> get() = _pendingResultIds.values.toSet() + DeferredFragmentIdentifier.Pending
 
   override var hasNext: Boolean = true
     private set
@@ -74,7 +72,7 @@ internal class GraphQL17Alpha9IncrementalResultsMerger : IncrementalResultsMerge
         val id = pendingResult["id"] as String
         val path = pendingResult["path"] as List<Any>
         val label = pendingResult["label"] as String?
-        _pendingResultIds[id] = IncrementalResultIdentifier(path = path, label = label)
+        _pendingResultIds[id] = DeferredFragmentIdentifier(path = path, label = label)
       }
     }
   }
diff --git a/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/internal/incremental/IncrementalResultsMerger.kt b/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/internal/incremental/IncrementalResultsMerger.kt
@@ -1,12 +1,12 @@
 package com.apollographql.apollo.internal.incremental
 
-import com.apollographql.apollo.api.IncrementalResultIdentifiers
+import com.apollographql.apollo.api.DeferredFragmentIdentifier
 import okio.BufferedSource
 
 /**
  * Utility for merging GraphQL incremental results received in multiple chunks when using the `@defer` and/or `@stream` directives.
  *
- * Each call to [merge] will merge the given results into the [merged] Map, and will also update [incrementalResultIdentifiers] with the
+ * Each call to [merge] will merge the given results into the [merged] Map, and will also update [deferredFragmentIdentifiers] with the
  * value of their `path` and `label` fields.
  *
  * 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
@@ -17,11 +17,10 @@ import okio.BufferedSource
  * `extensions` in incremental results (if present) are merged together in an array and then set to the `extensions` field of the [merged]
  * Map.
  */
-
 internal sealed interface IncrementalResultsMerger {
   val merged: JsonMap
 
-  val incrementalResultIdentifiers: IncrementalResultIdentifiers
+  val deferredFragmentIdentifiers: Set<DeferredFragmentIdentifier>
 
   val hasNext: Boolean
 
diff --git a/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/internal/incremental/JsonMap.kt b/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/internal/incremental/JsonMap.kt
@@ -9,7 +9,6 @@ import okio.BufferedSource
 internal typealias JsonMap = Map<String, Any?>
 internal typealias MutableJsonMap = MutableMap<String, Any?>
 
-
 /**
  * Find the node in the [map] at the given [path].
  * @param path The path to the node to find, as a list of either `String` (name of field in object) or `Int` (index of element in array).
diff --git a/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/network/http/HttpNetworkTransport.kt b/libraries/apollo-runtime/src/commonMain/kotlin/com/apollographql/apollo/network/http/HttpNetworkTransport.kt
@@ -237,7 +237,7 @@ private constructor(
               incrementalResultsMerger = incrementalDeliveryProtocolImpl.newIncrementalResultsMerger()
             }
             val merged = incrementalResultsMerger.merge(part)
-            val deferredFragmentIds = incrementalResultsMerger.incrementalResultIdentifiers
+            val deferredFragmentIdentifiers = incrementalResultsMerger.deferredFragmentIdentifiers
             val isLast = !incrementalResultsMerger.hasNext
 
             if (incrementalResultsMerger.isEmptyResponse) {
@@ -246,7 +246,7 @@ private constructor(
               merged.jsonReader().toApolloResponse(
                   operation = operation,
                   customScalarAdapters = customScalarAdapters,
-                  deferredFragmentIdentifiers = deferredFragmentIds
+                  deferredFragmentIdentifiers = deferredFragmentIdentifiers
               ).newBuilder().isLast(isLast).build()
             }
           }
diff --git a/libraries/apollo-runtime/src/commonTest/kotlin/test/defer/GraphQL17Alpha2IncrementalResultsMergerTest.kt b/libraries/apollo-runtime/src/commonTest/kotlin/test/defer/GraphQL17Alpha2IncrementalResultsMergerTest.kt
diff --git a/libraries/apollo-runtime/src/commonTest/kotlin/test/defer/GraphQL17Alpha9IncrementalResultsMergerTest.kt b/libraries/apollo-runtime/src/commonTest/kotlin/test/defer/GraphQL17Alpha9IncrementalResultsMergerTest.kt
diff --git a/tests/defer/src/commonTest/kotlin/test/DeferGraphQL17Alpha2NormalizedCacheTest.kt b/tests/defer/src/commonTest/kotlin/test/DeferGraphQL17Alpha2NormalizedCacheTest.kt
diff --git a/tests/defer/src/commonTest/kotlin/test/DeferGraphQL17Alpha2Test.kt b/tests/defer/src/commonTest/kotlin/test/DeferGraphQL17Alpha2Test.kt
diff --git a/tests/defer/src/jvmTest/kotlin/test/DeferJvmTest.kt b/tests/defer/src/jvmTest/kotlin/test/DeferJvmTest.kt
