RUM-391 make network info optional in span schema

DataDog · Sep 23, 2023 · 56c1d47 · 56c1d47
1 parent 99c47fb
commit 56c1d47
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 33 deletions.
diff --git a/features/dd-sdk-android-trace/api/apiSurface b/features/dd-sdk-android-trace/api/apiSurface
@@ -41,7 +41,7 @@ data class com.datadog.android.trace.model.SpanEvent
       fun fromJson(kotlin.String): Metrics
       fun fromJsonObject(com.google.gson.JsonObject): Metrics
   data class Meta
-    constructor(kotlin.String, Dd, Span, Tracer, Usr, Network, kotlin.collections.MutableMap<kotlin.String, kotlin.String> = mutableMapOf())
+    constructor(kotlin.String, Dd, Span, Tracer, Usr, Network? = null, kotlin.collections.MutableMap<kotlin.String, kotlin.String> = mutableMapOf())
     fun toJson(): com.google.gson.JsonElement
     companion object 
       fun fromJson(kotlin.String): Meta
@@ -68,13 +68,13 @@ data class com.datadog.android.trace.model.SpanEvent
       fun fromJson(kotlin.String): Usr
       fun fromJsonObject(com.google.gson.JsonObject): Usr
   data class Network
-    constructor(Client)
+    constructor(Client? = null)
     fun toJson(): com.google.gson.JsonElement
     companion object 
       fun fromJson(kotlin.String): Network
       fun fromJsonObject(com.google.gson.JsonObject): Network
   data class Client
-    constructor(SimCarrier? = null, kotlin.String? = null, kotlin.String? = null, kotlin.String? = null, kotlin.String)
+    constructor(SimCarrier? = null, kotlin.String? = null, kotlin.String? = null, kotlin.String? = null, kotlin.String? = null)
     fun toJson(): com.google.gson.JsonElement
     companion object 
       fun fromJson(kotlin.String): Client

diff --git a/features/dd-sdk-android-trace/api/dd-sdk-android-trace.api b/features/dd-sdk-android-trace/api/dd-sdk-android-trace.api
@@ -100,6 +100,7 @@ public final class com/datadog/android/trace/model/SpanEvent {
 
 public final class com/datadog/android/trace/model/SpanEvent$Client {
 	public static final field Companion Lcom/datadog/android/trace/model/SpanEvent$Client$Companion;
+	public fun <init> ()V
 	public fun <init> (Lcom/datadog/android/trace/model/SpanEvent$SimCarrier;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
 	public synthetic fun <init> (Lcom/datadog/android/trace/model/SpanEvent$SimCarrier;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Lcom/datadog/android/trace/model/SpanEvent$SimCarrier;
@@ -213,7 +214,9 @@ public final class com/datadog/android/trace/model/SpanEvent$Metrics$Companion {
 
 public final class com/datadog/android/trace/model/SpanEvent$Network {
 	public static final field Companion Lcom/datadog/android/trace/model/SpanEvent$Network$Companion;
+	public fun <init> ()V
 	public fun <init> (Lcom/datadog/android/trace/model/SpanEvent$Client;)V
+	public synthetic fun <init> (Lcom/datadog/android/trace/model/SpanEvent$Client;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Lcom/datadog/android/trace/model/SpanEvent$Client;
 	public final fun copy (Lcom/datadog/android/trace/model/SpanEvent$Client;)Lcom/datadog/android/trace/model/SpanEvent$Network;
 	public static synthetic fun copy$default (Lcom/datadog/android/trace/model/SpanEvent$Network;Lcom/datadog/android/trace/model/SpanEvent$Client;ILjava/lang/Object;)Lcom/datadog/android/trace/model/SpanEvent$Network;

diff --git a/features/dd-sdk-android-trace/src/main/json/trace/span-schema.json b/features/dd-sdk-android-trace/src/main/json/trace/span-schema.json
@@ -195,25 +195,18 @@
                   "readOnly": true
                 }
               },
-              "readOnly": true,
-              "required": [
-                "connectivity"
-              ]
+              "readOnly": true
             }
           },
-          "readOnly": true,
-          "required": [
-            "client"
-          ]
+          "readOnly": true
         }
       },
       "required": [
         "version",
         "_dd",
         "span",
         "tracer",
-        "usr",
-        "network"
+        "usr"
       ],
       "additionalProperties": {
         "type": "string",

diff --git a/...dd-sdk-android-trace/src/test/kotlin/com/datadog/android/trace/assertj/SpanEventAssert.kt b/...dd-sdk-android-trace/src/test/kotlin/com/datadog/android/trace/assertj/SpanEventAssert.kt
@@ -186,46 +186,46 @@ internal class SpanEventAssert(actual: SpanEvent) :
     }
 
     fun hasNetworkInfo(networkInfo: NetworkInfo): SpanEventAssert {
-        assertThat(actual.meta.network.client.connectivity)
+        assertThat(actual.meta.network?.client?.connectivity)
             .overridingErrorMessage(
                 "Expected SpanEvent to have connectivity: " +
                     "${networkInfo.connectivity} but " +
-                    "instead was: ${actual.meta.network.client.connectivity}"
+                    "instead was: ${actual.meta.network?.client?.connectivity}"
             )
             .isEqualTo(networkInfo.connectivity.toString())
-        assertThat(actual.meta.network.client.downlinkKbps)
+        assertThat(actual.meta.network?.client?.downlinkKbps)
             .overridingErrorMessage(
                 "Expected SpanEvent to have downlinkKbps: " +
                     "${networkInfo.downKbps?.toString()} but " +
-                    "instead was: ${actual.meta.network.client.downlinkKbps}"
+                    "instead was: ${actual.meta.network?.client?.downlinkKbps}"
             )
             .isEqualTo(networkInfo.downKbps?.toString())
-        assertThat(actual.meta.network.client.uplinkKbps)
+        assertThat(actual.meta.network?.client?.uplinkKbps)
             .overridingErrorMessage(
                 "Expected SpanEvent to have uplinkKbps: " +
                     "${networkInfo.upKbps?.toString()} but " +
-                    "instead was: ${actual.meta.network.client.uplinkKbps}"
+                    "instead was: ${actual.meta.network?.client?.uplinkKbps}"
             )
             .isEqualTo(networkInfo.upKbps?.toString())
-        assertThat(actual.meta.network.client.signalStrength)
+        assertThat(actual.meta.network?.client?.signalStrength)
             .overridingErrorMessage(
                 "Expected SpanEvent to have signal strength: " +
                     "${networkInfo.strength?.toString()} but " +
-                    "instead was: ${actual.meta.network.client.signalStrength}"
+                    "instead was: ${actual.meta.network?.client?.signalStrength}"
             )
             .isEqualTo(networkInfo.strength?.toString())
-        assertThat(actual.meta.network.client.simCarrier?.id)
+        assertThat(actual.meta.network?.client?.simCarrier?.id)
             .overridingErrorMessage(
                 "Expected SpanEvent to have carrier id: " +
                     "${networkInfo.carrierId?.toString()} but " +
-                    "instead was: ${actual.meta.network.client.simCarrier?.id}"
+                    "instead was: ${actual.meta.network?.client?.simCarrier?.id}"
             )
             .isEqualTo(networkInfo.carrierId?.toString())
-        assertThat(actual.meta.network.client.simCarrier?.name)
+        assertThat(actual.meta.network?.client?.simCarrier?.name)
             .overridingErrorMessage(
                 "Expected SpanEvent to have carrier name: " +
                     "${networkInfo.carrierName} but " +
-                    "instead was: ${actual.meta.network.client.simCarrier?.name}"
+                    "instead was: ${actual.meta.network?.client?.simCarrier?.name}"
             )
             .isEqualTo(networkInfo.carrierName)
         return this

diff --git a/...rc/test/kotlin/com/datadog/android/trace/internal/domain/event/SpanEventSerializerTest.kt b/...rc/test/kotlin/com/datadog/android/trace/internal/domain/event/SpanEventSerializerTest.kt
@@ -220,11 +220,13 @@ internal class SpanEventSerializerTest {
         spanEvent: SpanEvent
     ) {
         val network = spanEvent.meta.network
-        hasField(
-            KEY_NETWORK_CONNECTIVITY,
-            network.client.connectivity
-        )
-        val simCarrier = network.client.simCarrier
+        val connectivity = network?.client?.connectivity
+        if (connectivity != null) {
+            hasField(KEY_NETWORK_CONNECTIVITY, connectivity)
+        } else {
+            doesNotHaveField(KEY_NETWORK_CONNECTIVITY)
+        }
+        val simCarrier = network?.client?.simCarrier
         if (simCarrier != null) {
             hasField(KEY_SIM_CARRIER) {
                 val simCarrierName = simCarrier.name
@@ -246,13 +248,13 @@ internal class SpanEventSerializerTest {
         } else {
             doesNotHaveField(KEY_SIM_CARRIER)
         }
-        val uplinkKbps = network.client.uplinkKbps
+        val uplinkKbps = network?.client?.uplinkKbps
         if (uplinkKbps != null) {
             hasField(KEY_NETWORK_UP_KBPS, uplinkKbps)
         } else {
             doesNotHaveField(KEY_NETWORK_UP_KBPS)
         }
-        val downlinkKbps = network.client.downlinkKbps
+        val downlinkKbps = network?.client?.downlinkKbps
         if (downlinkKbps != null) {
             hasField(
                 KEY_NETWORK_DOWN_KBPS,
@@ -261,7 +263,7 @@ internal class SpanEventSerializerTest {
         } else {
             doesNotHaveField(KEY_NETWORK_DOWN_KBPS)
         }
-        val signalStrength = network.client.signalStrength
+        val signalStrength = network?.client?.signalStrength
         if (signalStrength != null) {
             hasField(
                 KEY_NETWORK_SIGNAL_STRENGTH,