feature: Enhanced Client Awareness (v4.x) (#6567)

* Adds ApolloClient configuration

* Adds ApolloRequest configuration

* Apollo API: generate the version (#6539)

* Apollo API: generate the version

* update apiDump

* Updates DefaultHttpRequestComposer

* Update API signature files

* Update fixtures when making a release

* Updates tests

* Reformat files

* Fix test data

* Update test fixtures

* Keep binary compatibility

* update apiDump

---------

Co-authored-by: Martin Bonnin <[email protected]>
Co-authored-by: BoD <[email protected]>

Author: 3 people

libraries/apollo-api/api/apollo-api.api

@@ -37,6 +37,10 @@ public final class com/apollographql/apollo/api/Adapters {
 	public static synthetic fun -toJson$default (Lcom/apollographql/apollo/api/Adapter;Ljava/lang/Object;Lcom/apollographql/apollo/api/CustomScalarAdapters;Ljava/lang/String;ILjava/lang/Object;)Ljava/lang/String;
 }
 
+public final class com/apollographql/apollo/api/ApolloApiVersionKt {
+	public static final field apolloApiVersion Ljava/lang/String;
+}
+
 public final class com/apollographql/apollo/api/ApolloOptionalAdapter : com/apollographql/apollo/api/Adapter {
 	public fun <init> (Lcom/apollographql/apollo/api/Adapter;)V
 	public fun fromJson (Lcom/apollographql/apollo/api/json/JsonReader;Lcom/apollographql/apollo/api/CustomScalarAdapters;)Lcom/apollographql/apollo/api/Optional;
@@ -46,7 +50,7 @@ public final class com/apollographql/apollo/api/ApolloOptionalAdapter : com/apol
 }
 
 public final class com/apollographql/apollo/api/ApolloRequest : com/apollographql/apollo/api/ExecutionOptions {
-	public synthetic fun <init> (Lcom/apollographql/apollo/api/Operation;Ljava/util/UUID;Lcom/apollographql/apollo/api/ExecutionContext;Lcom/apollographql/apollo/api/http/HttpMethod;Ljava/util/List;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> (Lcom/apollographql/apollo/api/Operation;Ljava/util/UUID;Lcom/apollographql/apollo/api/ExecutionContext;Lcom/apollographql/apollo/api/http/HttpMethod;Ljava/util/List;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;ZLkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun getCanBeBatched ()Ljava/lang/Boolean;
 	public fun getEnableAutoPersistedQueries ()Ljava/lang/Boolean;
 	public fun getExecutionContext ()Lcom/apollographql/apollo/api/ExecutionContext;
@@ -59,6 +63,7 @@ public final class com/apollographql/apollo/api/ApolloRequest : com/apollographq
 	public final fun getRetryOnError ()Ljava/lang/Boolean;
 	public fun getSendApqExtensions ()Ljava/lang/Boolean;
 	public fun getSendDocument ()Ljava/lang/Boolean;
+	public final fun getSendEnhancedClientAwareness ()Z
 	public final fun newBuilder ()Lcom/apollographql/apollo/api/ApolloRequest$Builder;
 	public final fun newBuilder (Lcom/apollographql/apollo/api/Operation;)Lcom/apollographql/apollo/api/ApolloRequest$Builder;
 }
@@ -88,6 +93,7 @@ public final class com/apollographql/apollo/api/ApolloRequest$Builder : com/apol
 	public final fun getRetryOnError ()Ljava/lang/Boolean;
 	public fun getSendApqExtensions ()Ljava/lang/Boolean;
 	public fun getSendDocument ()Ljava/lang/Boolean;
+	public final fun getSendEnhancedClientAwareness ()Z
 	public fun httpHeaders (Ljava/util/List;)Lcom/apollographql/apollo/api/ApolloRequest$Builder;
 	public synthetic fun httpHeaders (Ljava/util/List;)Ljava/lang/Object;
 	public fun httpMethod (Lcom/apollographql/apollo/api/http/HttpMethod;)Lcom/apollographql/apollo/api/ApolloRequest$Builder;
@@ -99,6 +105,7 @@ public final class com/apollographql/apollo/api/ApolloRequest$Builder : com/apol
 	public synthetic fun sendApqExtensions (Ljava/lang/Boolean;)Ljava/lang/Object;
 	public fun sendDocument (Ljava/lang/Boolean;)Lcom/apollographql/apollo/api/ApolloRequest$Builder;
 	public synthetic fun sendDocument (Ljava/lang/Boolean;)Ljava/lang/Object;
+	public final fun sendEnhancedClientAwareness (Z)Lcom/apollographql/apollo/api/ApolloRequest$Builder;
 }
 
 public final class com/apollographql/apollo/api/ApolloResponse {
@@ -935,6 +942,7 @@ public final class com/apollographql/apollo/api/http/DefaultHttpRequestComposer
 public final class com/apollographql/apollo/api/http/DefaultHttpRequestComposer$Companion {
 	public final fun appendQueryParameters (Ljava/lang/String;Ljava/util/Map;)Ljava/lang/String;
 	public final fun buildParamsMap (Lcom/apollographql/apollo/api/Operation;Lcom/apollographql/apollo/api/CustomScalarAdapters;ZZ)Lokio/ByteString;
+	public final fun buildParamsMap (Lcom/apollographql/apollo/api/Operation;Lcom/apollographql/apollo/api/CustomScalarAdapters;ZZZ)Lokio/ByteString;
 	public final fun buildPostBody (Lcom/apollographql/apollo/api/Operation;Lcom/apollographql/apollo/api/CustomScalarAdapters;Ljava/lang/String;Lkotlin/jvm/functions/Function1;)Lcom/apollographql/apollo/api/http/HttpBody;
 	public final fun buildPostBody (Lcom/apollographql/apollo/api/Operation;Lcom/apollographql/apollo/api/CustomScalarAdapters;ZLjava/lang/String;)Lcom/apollographql/apollo/api/http/HttpBody;
 	public final fun composePayload (Lcom/apollographql/apollo/api/ApolloRequest;)Ljava/util/Map;

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

@@ -310,6 +310,8 @@ final class <#A: com.apollographql.apollo.api/Operation.Data> com.apollographql.
         final fun <get-sendApqExtensions>(): kotlin/Boolean? // com.apollographql.apollo.api/ApolloRequest.sendApqExtensions.<get-sendApqExtensions>|<get-sendApqExtensions>(){}[0]
     final val sendDocument // com.apollographql.apollo.api/ApolloRequest.sendDocument|{}sendDocument[0]
         final fun <get-sendDocument>(): kotlin/Boolean? // com.apollographql.apollo.api/ApolloRequest.sendDocument.<get-sendDocument>|<get-sendDocument>(){}[0]
+    final val sendEnhancedClientAwareness // com.apollographql.apollo.api/ApolloRequest.sendEnhancedClientAwareness|{}sendEnhancedClientAwareness[0]
+        final fun <get-sendEnhancedClientAwareness>(): kotlin/Boolean // com.apollographql.apollo.api/ApolloRequest.sendEnhancedClientAwareness.<get-sendEnhancedClientAwareness>|<get-sendEnhancedClientAwareness>(){}[0]
 
     final fun <#A1: com.apollographql.apollo.api/Operation.Data> newBuilder(com.apollographql.apollo.api/Operation<#A1>): com.apollographql.apollo.api/ApolloRequest.Builder<#A1> // com.apollographql.apollo.api/ApolloRequest.newBuilder|newBuilder(com.apollographql.apollo.api.Operation<0:0>){0§<com.apollographql.apollo.api.Operation.Data>}[0]
     final fun newBuilder(): com.apollographql.apollo.api/ApolloRequest.Builder<#A> // com.apollographql.apollo.api/ApolloRequest.newBuilder|newBuilder(){}[0]
@@ -342,6 +344,8 @@ final class <#A: com.apollographql.apollo.api/Operation.Data> com.apollographql.
             final fun <get-sendApqExtensions>(): kotlin/Boolean? // com.apollographql.apollo.api/ApolloRequest.Builder.sendApqExtensions.<get-sendApqExtensions>|<get-sendApqExtensions>(){}[0]
         final var sendDocument // com.apollographql.apollo.api/ApolloRequest.Builder.sendDocument|{}sendDocument[0]
             final fun <get-sendDocument>(): kotlin/Boolean? // com.apollographql.apollo.api/ApolloRequest.Builder.sendDocument.<get-sendDocument>|<get-sendDocument>(){}[0]
+        final var sendEnhancedClientAwareness // com.apollographql.apollo.api/ApolloRequest.Builder.sendEnhancedClientAwareness|{}sendEnhancedClientAwareness[0]
+            final fun <get-sendEnhancedClientAwareness>(): kotlin/Boolean // com.apollographql.apollo.api/ApolloRequest.Builder.sendEnhancedClientAwareness.<get-sendEnhancedClientAwareness>|<get-sendEnhancedClientAwareness>(){}[0]
 
         final fun addExecutionContext(com.apollographql.apollo.api/ExecutionContext): com.apollographql.apollo.api/ApolloRequest.Builder<#A1> // com.apollographql.apollo.api/ApolloRequest.Builder.addExecutionContext|addExecutionContext(com.apollographql.apollo.api.ExecutionContext){}[0]
         final fun addHttpHeader(kotlin/String, kotlin/String): com.apollographql.apollo.api/ApolloRequest.Builder<#A1> // com.apollographql.apollo.api/ApolloRequest.Builder.addHttpHeader|addHttpHeader(kotlin.String;kotlin.String){}[0]
@@ -357,6 +361,7 @@ final class <#A: com.apollographql.apollo.api/Operation.Data> com.apollographql.
         final fun retryOnError(kotlin/Boolean?): com.apollographql.apollo.api/ApolloRequest.Builder<#A1> // com.apollographql.apollo.api/ApolloRequest.Builder.retryOnError|retryOnError(kotlin.Boolean?){}[0]
         final fun sendApqExtensions(kotlin/Boolean?): com.apollographql.apollo.api/ApolloRequest.Builder<#A1> // com.apollographql.apollo.api/ApolloRequest.Builder.sendApqExtensions|sendApqExtensions(kotlin.Boolean?){}[0]
         final fun sendDocument(kotlin/Boolean?): com.apollographql.apollo.api/ApolloRequest.Builder<#A1> // com.apollographql.apollo.api/ApolloRequest.Builder.sendDocument|sendDocument(kotlin.Boolean?){}[0]
+        final fun sendEnhancedClientAwareness(kotlin/Boolean): com.apollographql.apollo.api/ApolloRequest.Builder<#A1> // com.apollographql.apollo.api/ApolloRequest.Builder.sendEnhancedClientAwareness|sendEnhancedClientAwareness(kotlin.Boolean){}[0]
     }
 }
 
@@ -490,6 +495,7 @@ final class com.apollographql.apollo.api.http/DefaultHttpRequestComposer : com.a
 
         final fun (kotlin/String).appendQueryParameters(kotlin.collections/Map<kotlin/String, kotlin/String>): kotlin/String // com.apollographql.apollo.api.http/DefaultHttpRequestComposer.Companion.appendQueryParameters|[email protected](kotlin.collections.Map<kotlin.String,kotlin.String>){}[0]
         final fun <#A2: com.apollographql.apollo.api/Operation.Data> buildParamsMap(com.apollographql.apollo.api/Operation<#A2>, com.apollographql.apollo.api/CustomScalarAdapters, kotlin/Boolean, kotlin/Boolean): okio/ByteString // com.apollographql.apollo.api.http/DefaultHttpRequestComposer.Companion.buildParamsMap|buildParamsMap(com.apollographql.apollo.api.Operation<0:0>;com.apollographql.apollo.api.CustomScalarAdapters;kotlin.Boolean;kotlin.Boolean){0§<com.apollographql.apollo.api.Operation.Data>}[0]
+        final fun <#A2: com.apollographql.apollo.api/Operation.Data> buildParamsMap(com.apollographql.apollo.api/Operation<#A2>, com.apollographql.apollo.api/CustomScalarAdapters, kotlin/Boolean, kotlin/Boolean, kotlin/Boolean): okio/ByteString // com.apollographql.apollo.api.http/DefaultHttpRequestComposer.Companion.buildParamsMap|buildParamsMap(com.apollographql.apollo.api.Operation<0:0>;com.apollographql.apollo.api.CustomScalarAdapters;kotlin.Boolean;kotlin.Boolean;kotlin.Boolean){0§<com.apollographql.apollo.api.Operation.Data>}[0]
         final fun <#A2: com.apollographql.apollo.api/Operation.Data> buildPostBody(com.apollographql.apollo.api/Operation<#A2>, com.apollographql.apollo.api/CustomScalarAdapters, kotlin/Boolean, kotlin/String?): com.apollographql.apollo.api.http/HttpBody // com.apollographql.apollo.api.http/DefaultHttpRequestComposer.Companion.buildPostBody|buildPostBody(com.apollographql.apollo.api.Operation<0:0>;com.apollographql.apollo.api.CustomScalarAdapters;kotlin.Boolean;kotlin.String?){0§<com.apollographql.apollo.api.Operation.Data>}[0]
         final fun <#A2: com.apollographql.apollo.api/Operation.Data> buildPostBody(com.apollographql.apollo.api/Operation<#A2>, com.apollographql.apollo.api/CustomScalarAdapters, kotlin/String?, kotlin/Function1<com.apollographql.apollo.api.json/JsonWriter, kotlin/Unit>): com.apollographql.apollo.api.http/HttpBody // com.apollographql.apollo.api.http/DefaultHttpRequestComposer.Companion.buildPostBody|buildPostBody(com.apollographql.apollo.api.Operation<0:0>;com.apollographql.apollo.api.CustomScalarAdapters;kotlin.String?;kotlin.Function1<com.apollographql.apollo.api.json.JsonWriter,kotlin.Unit>){0§<com.apollographql.apollo.api.Operation.Data>}[0]
         final fun <#A2: com.apollographql.apollo.api/Operation.Data> composePayload(com.apollographql.apollo.api/ApolloRequest<#A2>): kotlin.collections/Map<kotlin/String, kotlin/Any?> // com.apollographql.apollo.api.http/DefaultHttpRequestComposer.Companion.composePayload|composePayload(com.apollographql.apollo.api.ApolloRequest<0:0>){0§<com.apollographql.apollo.api.Operation.Data>}[0]
@@ -1348,6 +1354,9 @@ final object com.apollographql.apollo.exception/OfflineException : okio/IOExcept
     final fun toString(): kotlin/String // com.apollographql.apollo.exception/OfflineException.toString|toString(){}[0]
 }
 
+final const val com.apollographql.apollo.api/apolloApiVersion // com.apollographql.apollo.api/apolloApiVersion|{}apolloApiVersion[0]
+    final fun <get-apolloApiVersion>(): kotlin/String // com.apollographql.apollo.api/apolloApiVersion.<get-apolloApiVersion>|<get-apolloApiVersion>(){}[0]
+
 final val com.apollographql.apollo.api/AnyAdapter // com.apollographql.apollo.api/AnyAdapter|{}AnyAdapter[0]
     final fun <get-AnyAdapter>(): com.apollographql.apollo.api/Adapter<kotlin/Any> // com.apollographql.apollo.api/AnyAdapter.<get-AnyAdapter>|<get-AnyAdapter>(){}[0]
 final val com.apollographql.apollo.api/ApolloOptionalAnyAdapter // com.apollographql.apollo.api/ApolloOptionalAnyAdapter|{}ApolloOptionalAnyAdapter[0]

libraries/apollo-api/build.gradle.kts

@@ -1,3 +1,7 @@
+import org.jetbrains.kotlin.gradle.dsl.KotlinBaseExtension
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+import kotlin.jvm.java
+
 plugins {
   id("org.jetbrains.kotlin.multiplatform")
 }
@@ -18,3 +22,39 @@ kotlin {
   }
 }
 
+abstract class GenerateLibraryVersion : DefaultTask() {
+  @get:Input
+  abstract val version: Property<String>
+
+  @get:OutputDirectory
+  abstract val outputDir: DirectoryProperty
+
+  @TaskAction
+  fun taskAction() {
+    outputDir.asFile.get().apply {
+      deleteRecursively()
+      mkdirs()
+    }
+
+    val versionFile = File(outputDir.asFile.get(), "com/apollographql/apollo/api/ApolloApiVersion.kt")
+    versionFile.parentFile.mkdirs()
+    versionFile.writeText("""// Generated file. Do not edit!
+package com.apollographql.apollo.api
+const val apolloApiVersion = "${version.get()}"
+""")
+  }
+}
+
+val pluginVersionTaskProvider = tasks.register("generateLibraryVersion", GenerateLibraryVersion::class.java) {
+  outputDir.set(project.layout.buildDirectory.dir("generated/kotlin/"))
+  version.set(project.version.toString())
+}
+
+extensions.getByType(KotlinBaseExtension::class.java).apply {
+  val versionFileProvider = pluginVersionTaskProvider.flatMap { it.outputDir }
+  sourceSets.getByName("commonMain").kotlin.srcDir(versionFileProvider)
+}
+
+tasks.withType(KotlinCompile::class.java) {
+  dependsOn(pluginVersionTaskProvider)
+}

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

@@ -39,6 +39,7 @@ private constructor(
     val retryOnError: Boolean?,
     @ApolloExperimental
     val failFastIfOffline: Boolean?,
+    val sendEnhancedClientAwareness: Boolean,
 ) : ExecutionOptions {
 
   fun newBuilder(): Builder<D> = newBuilder(operation)
@@ -57,6 +58,7 @@ private constructor(
         .retryOnError(retryOnError)
         .failFastIfOffline(failFastIfOffline)
         .ignoreApolloClientHttpHeaders(ignoreApolloClientHttpHeaders)
+        .sendEnhancedClientAwareness(sendEnhancedClientAwareness)
   }
 
   class Builder<D : Operation.Data>(
@@ -80,13 +82,16 @@ private constructor(
       private set
     var ignoreApolloClientHttpHeaders: Boolean? = null
       private set
+
     @ApolloExperimental
     var retryOnError: Boolean? = null
       private set
+
     @ApolloExperimental
     var failFastIfOffline: Boolean? = null
       private set
-
+    var sendEnhancedClientAwareness: Boolean = true
+      private set
 
     fun requestUuid(requestUuid: Uuid) = apply {
       this.requestUuid = requestUuid
@@ -142,6 +147,10 @@ private constructor(
       this.failFastIfOffline = failFastIfOffline
     }
 
+    fun sendEnhancedClientAwareness(sendEnhancedClientAwareness: Boolean): Builder<D> = apply {
+      this.sendEnhancedClientAwareness = sendEnhancedClientAwareness
+    }
+
     fun build(): ApolloRequest<D> {
       return ApolloRequest(
           operation = operation,
@@ -156,6 +165,7 @@ private constructor(
           ignoreApolloClientHttpHeaders = ignoreApolloClientHttpHeaders,
           retryOnError = retryOnError,
           failFastIfOffline = failFastIfOffline,
+          sendEnhancedClientAwareness = sendEnhancedClientAwareness,
       )
     }
   }