Add clientName/clientVersion

apollographql · Nov 4, 2024 · 70010d8 · 70010d8
1 parent 986719b
commit 70010d8
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 14 deletions.
diff --git a/apollo-execution-reporting/api/apollo-execution-reporting.api b/apollo-execution-reporting/api/apollo-execution-reporting.api
@@ -1,7 +1,7 @@
 public final class com/apollographql/execution/reporting/ApolloOperationTracing {
 	public fun <init> ()V
 	public final fun beforeField (Lcom/apollographql/execution/ResolveInfo;)Lcom/apollographql/execution/FieldCallback;
-	public final fun toProtoTrace ()Lcom/apollographql/execution/reporting/Trace;
+	public final fun toProtoTrace (Ljava/lang/String;Ljava/lang/String;)Lcom/apollographql/execution/reporting/Trace;
 }
 
 public final class com/apollographql/execution/reporting/ApolloReportingInstrumentation : com/apollographql/execution/Instrumentation {
@@ -17,9 +17,12 @@ public final class com/apollographql/execution/reporting/ApolloReportingInstrume
 public final class com/apollographql/execution/reporting/ApolloReportingOperationContext : com/apollographql/apollo/api/ExecutionContext$Element {
 	public static final field Key Lcom/apollographql/execution/reporting/ApolloReportingOperationContext$Key;
 	public fun <init> ()V
-	public final fun getApolloOperationTracing ()Lcom/apollographql/execution/reporting/ApolloOperationTracing;
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
+	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final fun beforeField (Lcom/apollographql/execution/ResolveInfo;)Lcom/apollographql/execution/FieldCallback;
 	public synthetic fun getKey ()Lcom/apollographql/apollo/api/ExecutionContext$Key;
 	public fun getKey ()Lcom/apollographql/execution/reporting/ApolloReportingOperationContext$Key;
+	public final fun toProtoTrace ()Lcom/apollographql/execution/reporting/Trace;
 }
 
 public final class com/apollographql/execution/reporting/ApolloReportingOperationContext$Key : com/apollographql/apollo/api/ExecutionContext$Key {

diff --git a/apollo-execution-reporting/api/apollo-execution-reporting.klib.api b/apollo-execution-reporting/api/apollo-execution-reporting.klib.api
@@ -9,7 +9,7 @@
 final class com.apollographql.execution.reporting/ApolloOperationTracing { // com.apollographql.execution.reporting/ApolloOperationTracing|null[0]
     constructor <init>() // com.apollographql.execution.reporting/ApolloOperationTracing.<init>|<init>(){}[0]
     final fun beforeField(com.apollographql.execution/ResolveInfo): com.apollographql.execution/FieldCallback? // com.apollographql.execution.reporting/ApolloOperationTracing.beforeField|beforeField(com.apollographql.execution.ResolveInfo){}[0]
-    final fun toProtoTrace(): com.apollographql.execution.reporting/Trace // com.apollographql.execution.reporting/ApolloOperationTracing.toProtoTrace|toProtoTrace(){}[0]
+    final fun toProtoTrace(kotlin/String?, kotlin/String?): com.apollographql.execution.reporting/Trace // com.apollographql.execution.reporting/ApolloOperationTracing.toProtoTrace|toProtoTrace(kotlin.String?;kotlin.String?){}[0]
 }
 final class com.apollographql.execution.reporting/ApolloReportingInstrumentation : com.apollographql.execution/Instrumentation { // com.apollographql.execution.reporting/ApolloReportingInstrumentation|null[0]
     constructor <init>(kotlin/String? = ...) // com.apollographql.execution.reporting/ApolloReportingInstrumentation.<init>|<init>(kotlin.String?){}[0]
@@ -21,10 +21,10 @@ final class com.apollographql.execution.reporting/ApolloReportingInstrumentation
         final fun <get-client>(): io.ktor.client/HttpClient // com.apollographql.execution.reporting/ApolloReportingInstrumentation.client.<get-client>|<get-client>(){}[0]
 }
 final class com.apollographql.execution.reporting/ApolloReportingOperationContext : com.apollographql.apollo.api/ExecutionContext.Element { // com.apollographql.execution.reporting/ApolloReportingOperationContext|null[0]
-    constructor <init>() // com.apollographql.execution.reporting/ApolloReportingOperationContext.<init>|<init>(){}[0]
+    constructor <init>(kotlin/String? = ..., kotlin/String? = ...) // com.apollographql.execution.reporting/ApolloReportingOperationContext.<init>|<init>(kotlin.String?;kotlin.String?){}[0]
+    final fun beforeField(com.apollographql.execution/ResolveInfo): com.apollographql.execution/FieldCallback? // com.apollographql.execution.reporting/ApolloReportingOperationContext.beforeField|beforeField(com.apollographql.execution.ResolveInfo){}[0]
+    final fun toProtoTrace(): com.apollographql.execution.reporting/Trace // com.apollographql.execution.reporting/ApolloReportingOperationContext.toProtoTrace|toProtoTrace(){}[0]
     final object Key : com.apollographql.apollo.api/ExecutionContext.Key<com.apollographql.execution.reporting/ApolloReportingOperationContext> // com.apollographql.execution.reporting/ApolloReportingOperationContext.Key|null[0]
-    final val apolloOperationTracing // com.apollographql.execution.reporting/ApolloReportingOperationContext.apolloOperationTracing|{}apolloOperationTracing[0]
-        final fun <get-apolloOperationTracing>(): com.apollographql.execution.reporting/ApolloOperationTracing // com.apollographql.execution.reporting/ApolloReportingOperationContext.apolloOperationTracing.<get-apolloOperationTracing>|<get-apolloOperationTracing>(){}[0]
     final val key // com.apollographql.execution.reporting/ApolloReportingOperationContext.key|{}key[0]
         final fun <get-key>(): com.apollographql.execution.reporting/ApolloReportingOperationContext.Key // com.apollographql.execution.reporting/ApolloReportingOperationContext.key.<get-key>|<get-key>(){}[0]
 }

diff --git a/...ing/src/commonMain/kotlin/com/apollographql/execution/reporting/ApolloOperationTracing.kt b/...ing/src/commonMain/kotlin/com/apollographql/execution/reporting/ApolloOperationTracing.kt
@@ -37,13 +37,15 @@ class ApolloOperationTracing {
     return newNode(parentPath)
   }
 
-  fun toProtoTrace(): Trace {
+  fun toProtoTrace(clientName: String?, clientVersion: String?): Trace {
     val endInstant = Clock.System.now()
     return Trace(
       start_time = ofEpochSecond(startInstant.epochSeconds, startInstant.nanosecondsOfSecond.toLong()),
       end_time = ofEpochSecond(endInstant.epochSeconds, endInstant.nanosecondsOfSecond.toLong()),
       duration_ns = (markNow() - operationStartMark).inWholeNanoseconds,
-      root = rootNode.toProtoNode()
+      root = rootNode.toProtoNode(),
+      client_name = clientName ?: "",
+      client_version = clientVersion ?: ""
     )
   }
 

diff --git a/...commonMain/kotlin/com/apollographql/execution/reporting/ApolloReportingInstrumentation.kt b/...commonMain/kotlin/com/apollographql/execution/reporting/ApolloReportingInstrumentation.kt
@@ -64,7 +64,7 @@ class ApolloReportingInstrumentation(val apolloKey: String? = null) : Instrument
         val operationData = getOperationData(operationInfo)
         if (operationData != null) {
           val trace =
-            operationInfo.executionContext[ApolloReportingOperationContext]!!.apolloOperationTracing.toProtoTrace()
+            operationInfo.executionContext[ApolloReportingOperationContext]!!.toProtoTrace()
 
           val operation = operations.getOrPut(operationData.statsReportKey) { operationData }
           operation.traces.add(trace)
@@ -84,7 +84,7 @@ class ApolloReportingInstrumentation(val apolloKey: String? = null) : Instrument
     require(atc != null) {
       "ApolloTracingInstrumentation requires an ApolloTracingContext"
     }
-    return atc.apolloOperationTracing.beforeField(resolveInfo)
+    return atc.beforeField(resolveInfo)
   }
 }
 

diff --git a/...ommonMain/kotlin/com/apollographql/execution/reporting/ApolloReportingOperationContext.kt b/...ommonMain/kotlin/com/apollographql/execution/reporting/ApolloReportingOperationContext.kt
@@ -3,10 +3,19 @@
 package com.apollographql.execution.reporting
 
 import com.apollographql.apollo.api.ExecutionContext
+import com.apollographql.execution.FieldCallback
+import com.apollographql.execution.ResolveInfo
 import kotlin.io.encoding.ExperimentalEncodingApi
 
-class ApolloReportingOperationContext() : ExecutionContext.Element {
-  val apolloOperationTracing = ApolloOperationTracing()
+class ApolloReportingOperationContext(
+  private val clientName: String? = null,
+  private val clientVersion: String? = null,
+) : ExecutionContext.Element {
+  private val apolloOperationTracing = ApolloOperationTracing()
+
+  fun beforeField(info: ResolveInfo): FieldCallback? = apolloOperationTracing.beforeField(info)
+
+  fun toProtoTrace(): Trace = apolloOperationTracing.toProtoTrace(clientName, clientVersion)
 
   override val key = Key
 

diff --git a/apollo-execution-reporting/src/commonTest/kotlin/TracingTest.kt b/apollo-execution-reporting/src/commonTest/kotlin/TracingTest.kt
@@ -52,7 +52,7 @@ class TracingTest {
       schema().execute("{ widgets { foo, baz: bar }, listOfLists { foo }, listOfScalars }".toGraphQLRequest(), context)
     }
 
-    val trace = context.apolloOperationTracing.toProtoTrace()
+    val trace = context.toProtoTrace()
 
     assertTrue(trace.start_time!!.getEpochSecond() > 0, "Start time has seconds")
     assertTrue(trace.start_time.getNano() > 0, "Start time has nanoseconds")

diff --git a/...ubgraph/src/commonMain/kotlin/com/apollographql/execution/subgraph/Ftv1Instrumentation.kt b/...ubgraph/src/commonMain/kotlin/com/apollographql/execution/subgraph/Ftv1Instrumentation.kt
@@ -27,7 +27,7 @@ class Ftv1Instrumentation : Instrumentation() {
       response
     } else {
       response.newBuilder()
-        .extensions(mapOf("ftv1" to Base64.encode(ftv1Context.apolloOperationTracing.toProtoTrace().encode())))
+        .extensions(mapOf("ftv1" to Base64.encode(ftv1Context.apolloOperationTracing.toProtoTrace(null, null).encode())))
         .build()
     }
   }