Merge pull request #1020 from DataDog/nogorodnikov/rumm-2380/enable-c…

…ustom-version-support-during-initialization RUMM-2380: Enable custom application version support
DataDog · Aug 25, 2022 · 1a96ca1 · 1a96ca1
2 parents 52deb46 + ed486e6
commit 1a96ca1
Show file tree

Hide file tree

Showing 31 changed files with 384 additions and 95 deletions.
diff --git a/dd-sdk-android/apiSurface b/dd-sdk-android/apiSurface
@@ -66,6 +66,7 @@ class com.datadog.android._InternalProxy
     fun error(String, Throwable? = null)
     fun error(String, String?, String?)
   val _telemetry: _TelemetryProxy
+  fun setCustomAppVersion(String)
 enum com.datadog.android.core.configuration.BatchSize
   constructor(Long)
   - SMALL

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/Datadog.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/Datadog.kt
@@ -351,6 +351,7 @@ object Datadog {
         )
     }
 
+    @Suppress("ComplexMethod")
     private fun applyAdditionalConfiguration(
         additionalConfiguration: Map<String, Any>
     ) {
@@ -368,6 +369,12 @@ object Datadog {
                 CoreFeature.sdkVersion = it
             }
         }
+
+        additionalConfiguration[DD_APP_VERSION_TAG]?.let {
+            if (it is String && it.isNotBlank()) {
+                CoreFeature.packageVersionProvider.version = it
+            }
+        }
     }
 
     @Suppress("ThrowingInternalException")
@@ -426,6 +433,7 @@ object Datadog {
 
     internal const val DD_SOURCE_TAG = "_dd.source"
     internal const val DD_SDK_VERSION_TAG = "_dd.sdk_version"
+    internal const val DD_APP_VERSION_TAG = "_dd.version"
 
     // endregion
 }
diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/_InternalProxy.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/_InternalProxy.kt
@@ -6,6 +6,7 @@
 
 package com.datadog.android
 
+import com.datadog.android.core.internal.CoreFeature
 import com.datadog.android.telemetry.internal.Telemetry
 
 /**
@@ -22,16 +23,12 @@ import com.datadog.android.telemetry.internal.Telemetry
     "UndocumentedPublicClass",
     "UndocumentedPublicFunction",
     "UndocumentedPublicProperty",
+    "ClassName",
     "ClassNaming",
     "VariableNaming"
 )
-class _InternalProxy {
-    class _TelemetryProxy {
-        private val telemetry: Telemetry
-
-        internal constructor(telemetry: Telemetry) {
-            this.telemetry = telemetry
-        }
+class _InternalProxy internal constructor(telemetry: Telemetry) {
+    class _TelemetryProxy internal constructor(private val telemetry: Telemetry) {
 
         fun debug(message: String) {
             telemetry.debug(message)
@@ -46,9 +43,9 @@ class _InternalProxy {
         }
     }
 
-    val _telemetry: _TelemetryProxy
+    val _telemetry: _TelemetryProxy = _TelemetryProxy(telemetry)
 
-    internal constructor(telemetry: Telemetry) {
-        _telemetry = _TelemetryProxy(telemetry)
+    fun setCustomAppVersion(version: String) {
+        CoreFeature.packageVersionProvider.version = version
     }
 }
diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/core/internal/CoreFeature.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/core/internal/CoreFeature.kt
@@ -33,9 +33,12 @@ import com.datadog.android.core.internal.privacy.ConsentProvider
 import com.datadog.android.core.internal.privacy.NoOpConsentProvider
 import com.datadog.android.core.internal.privacy.TrackingConsentProvider
 import com.datadog.android.core.internal.system.AndroidInfoProvider
+import com.datadog.android.core.internal.system.AppVersionProvider
 import com.datadog.android.core.internal.system.BroadcastReceiverSystemInfoProvider
 import com.datadog.android.core.internal.system.DefaultAndroidInfoProvider
+import com.datadog.android.core.internal.system.DefaultAppVersionProvider
 import com.datadog.android.core.internal.system.NoOpAndroidInfoProvider
+import com.datadog.android.core.internal.system.NoOpAppVersionProvider
 import com.datadog.android.core.internal.system.NoOpSystemInfoProvider
 import com.datadog.android.core.internal.system.SystemInfoProvider
 import com.datadog.android.core.internal.time.KronosTimeProvider
@@ -134,7 +137,7 @@ internal object CoreFeature {
 
     internal var clientToken: String = ""
     internal var packageName: String = ""
-    internal var packageVersion: String = ""
+    internal var packageVersionProvider: AppVersionProvider = NoOpAppVersionProvider()
     internal var serviceName: String = ""
     internal var sourceName: String = DEFAULT_SOURCE_NAME
     internal var sdkVersion: String = DEFAULT_SDK_VERSION
@@ -259,7 +262,7 @@ internal object CoreFeature {
                     timeProvider,
                     sdkVersion,
                     envName,
-                    packageVersion
+                    packageVersionProvider
                 ),
                 NdkCrashLogDeserializer(sdkLogger),
                 RumEventDeserializer(),
@@ -306,12 +309,14 @@ internal object CoreFeature {
             devLogger.e("Unable to read your application's version name", e)
             null
         }
-        packageVersion = packageInfo?.let {
-            // we need to use the deprecated method because getLongVersionCode method is only
-            // available from API 28 and above
-            @Suppress("DEPRECATION")
-            it.versionName ?: it.versionCode.toString()
-        } ?: DEFAULT_APP_VERSION
+        packageVersionProvider = DefaultAppVersionProvider(
+            packageInfo?.let {
+                // we need to use the deprecated method because getLongVersionCode method is only
+                // available from API 28 and above
+                @Suppress("DEPRECATION")
+                it.versionName ?: it.versionCode.toString()
+            } ?: DEFAULT_APP_VERSION
+        )
         clientToken = credentials.clientToken
         serviceName = credentials.serviceName ?: appContext.packageName
         rumApplicationId = credentials.rumApplicationId
@@ -468,7 +473,7 @@ internal object CoreFeature {
     private fun cleanupApplicationInfo() {
         clientToken = ""
         packageName = ""
-        packageVersion = ""
+        packageVersionProvider = NoOpAppVersionProvider()
         serviceName = ""
         sourceName = DEFAULT_SOURCE_NAME
         rumApplicationId = null

diff --git a/...dk-android/src/main/kotlin/com/datadog/android/core/internal/system/AppVersionProvider.kt b/...dk-android/src/main/kotlin/com/datadog/android/core/internal/system/AppVersionProvider.kt
@@ -0,0 +1,11 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.android.core.internal.system
+
+internal interface AppVersionProvider {
+    var version: String
+}
diff --git a/...oid/src/main/kotlin/com/datadog/android/core/internal/system/DefaultAppVersionProvider.kt b/...oid/src/main/kotlin/com/datadog/android/core/internal/system/DefaultAppVersionProvider.kt
@@ -0,0 +1,24 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.android.core.internal.system
+
+import java.util.concurrent.atomic.AtomicReference
+
+internal class DefaultAppVersionProvider(initialVersion: String) : AppVersionProvider {
+
+    private val value: AtomicReference<String>
+
+    override var version: String
+        get() = value.get()
+        set(value) {
+            this.value.set(value)
+        }
+
+    init {
+        this.value = AtomicReference(initialVersion)
+    }
+}
diff --git a/...ndroid/src/main/kotlin/com/datadog/android/core/internal/system/NoOpAppVersionProvider.kt b/...ndroid/src/main/kotlin/com/datadog/android/core/internal/system/NoOpAppVersionProvider.kt
@@ -0,0 +1,14 @@
+/*
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2016-Present Datadog, Inc.
+ */
+
+package com.datadog.android.core.internal.system
+
+internal class NoOpAppVersionProvider : AppVersionProvider {
+    @Suppress("UNUSED_PARAMETER")
+    override var version: String
+        get() = ""
+        set(value) {}
+}
diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/error/internal/CrashReportsFeature.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/error/internal/CrashReportsFeature.kt
@@ -79,7 +79,7 @@ internal object CrashReportsFeature : SdkFeature<LogEvent, Configuration.Feature
                 CoreFeature.timeProvider,
                 CoreFeature.sdkVersion,
                 CoreFeature.envName,
-                CoreFeature.packageVersion
+                CoreFeature.packageVersionProvider
             ),
             writer = persistenceStrategy.getWriter(),
             appContext = appContext

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/log/Logger.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/log/Logger.kt
@@ -344,7 +344,7 @@ internal constructor(internal var handler: LogHandler) {
                 CoreFeature.timeProvider,
                 CoreFeature.sdkVersion,
                 CoreFeature.envName,
-                CoreFeature.packageVersion
+                CoreFeature.packageVersionProvider
             )
         }
 

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/log/internal/domain/LogGenerator.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/log/internal/domain/LogGenerator.kt
@@ -7,6 +7,7 @@
 package com.datadog.android.log.internal.domain
 
 import com.datadog.android.core.internal.net.info.NetworkInfoProvider
+import com.datadog.android.core.internal.system.AppVersionProvider
 import com.datadog.android.core.internal.time.TimeProvider
 import com.datadog.android.core.model.NetworkInfo
 import com.datadog.android.core.model.UserInfo
@@ -26,7 +27,7 @@ internal class LogGenerator(
     internal val timeProvider: TimeProvider,
     internal val sdkVersion: String,
     envName: String,
-    appVersion: String
+    internal val appVersionProvider: AppVersionProvider
 ) {
 
     private val simpleDateFormat = buildLogDateFormat()
@@ -37,11 +38,15 @@ internal class LogGenerator(
         null
     }
 
-    private val appVersionTag = if (appVersion.isNotEmpty()) {
-        "${LogAttributes.APPLICATION_VERSION}:$appVersion"
-    } else {
-        null
-    }
+    private val appVersionTag: String?
+        get() {
+            val appVersion = appVersionProvider.version
+            return if (appVersion.isNotEmpty()) {
+                "${LogAttributes.APPLICATION_VERSION}:$appVersion"
+            } else {
+                null
+            }
+        }
 
     @Suppress("LongParameterList")
     fun generateLog(

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/rum/_RumInternalProxy.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/rum/_RumInternalProxy.kt
@@ -22,15 +22,11 @@ import com.datadog.android.rum.internal.monitor.AdvancedRumMonitor
     "UndocumentedPublicClass",
     "UndocumentedPublicFunction",
     "UndocumentedPublicProperty",
+    "ClassName",
     "ClassNaming",
     "VariableNaming"
 )
-class _RumInternalProxy {
-    private val rumMonitor: AdvancedRumMonitor
-
-    internal constructor(rumMonitor: AdvancedRumMonitor) {
-        this.rumMonitor = rumMonitor
-    }
+class _RumInternalProxy internal constructor(private val rumMonitor: AdvancedRumMonitor) {
 
     fun addLongTask(durationNs: Long, target: String) {
         rumMonitor.addLongTask(durationNs, target)

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/rum/internal/RumFeature.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/rum/internal/RumFeature.kt
@@ -137,7 +137,8 @@ internal object RumFeature : SdkFeature<Any, Configuration.Feature.RUM>() {
             CoreFeature.sourceName,
             CoreFeature.sdkVersion,
             CoreFeature.okHttpClient,
-            CoreFeature.androidInfoProvider
+            CoreFeature.androidInfoProvider,
+            CoreFeature.packageVersionProvider
         )
     }
 

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/rum/internal/net/RumOkHttpUploaderV2.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/rum/internal/net/RumOkHttpUploaderV2.kt
@@ -9,6 +9,7 @@ package com.datadog.android.rum.internal.net
 import com.datadog.android.core.internal.CoreFeature
 import com.datadog.android.core.internal.net.DataOkHttpUploaderV2
 import com.datadog.android.core.internal.system.AndroidInfoProvider
+import com.datadog.android.core.internal.system.AppVersionProvider
 import com.datadog.android.core.internal.utils.sdkLogger
 import com.datadog.android.rum.RumAttributes
 import okhttp3.Call
@@ -19,7 +20,8 @@ internal open class RumOkHttpUploaderV2(
     source: String,
     sdkVersion: String,
     callFactory: Call.Factory,
-    androidInfoProvider: AndroidInfoProvider
+    androidInfoProvider: AndroidInfoProvider,
+    private val appVersionProvider: AppVersionProvider
 ) : DataOkHttpUploaderV2(
     buildUrl(endpoint, TrackType.RUM),
     clientToken,
@@ -31,20 +33,21 @@ internal open class RumOkHttpUploaderV2(
     sdkLogger
 ) {
 
-    private val tags: String by lazy {
-        val elements = mutableListOf(
-            "${RumAttributes.SERVICE_NAME}:${CoreFeature.serviceName}",
-            "${RumAttributes.APPLICATION_VERSION}:${CoreFeature.packageVersion}",
-            "${RumAttributes.SDK_VERSION}:$sdkVersion",
-            "${RumAttributes.ENV}:${CoreFeature.envName}"
-        )
+    private val tags: String
+        get() {
+            val elements = mutableListOf(
+                "${RumAttributes.SERVICE_NAME}:${CoreFeature.serviceName}",
+                "${RumAttributes.APPLICATION_VERSION}:${appVersionProvider.version}",
+                "${RumAttributes.SDK_VERSION}:$sdkVersion",
+                "${RumAttributes.ENV}:${CoreFeature.envName}"
+            )
 
-        if (CoreFeature.variant.isNotEmpty()) {
-            elements.add("${RumAttributes.VARIANT}:${CoreFeature.variant}")
-        }
+            if (CoreFeature.variant.isNotEmpty()) {
+                elements.add("${RumAttributes.VARIANT}:${CoreFeature.variant}")
+            }
 
-        elements.joinToString(",")
-    }
+            return elements.joinToString(",")
+        }
 
     // region DataOkHttpUploaderV2
 

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/tracing/internal/TracingFeature.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/tracing/internal/TracingFeature.kt
@@ -34,6 +34,7 @@ internal object TracingFeature : SdkFeature<DDSpan, Configuration.Feature.Tracin
             CoreFeature.timeProvider,
             CoreFeature.networkInfoProvider,
             CoreFeature.userInfoProvider,
+            CoreFeature.packageVersionProvider,
             CoreFeature.envName,
             sdkLogger,
             configuration.spanEventMapper,

diff --git a/.../main/kotlin/com/datadog/android/tracing/internal/domain/TracesFilePersistenceStrategy.kt b/.../main/kotlin/com/datadog/android/tracing/internal/domain/TracesFilePersistenceStrategy.kt
@@ -13,6 +13,7 @@ import com.datadog.android.core.internal.persistence.file.advanced.FeatureFileOr
 import com.datadog.android.core.internal.persistence.file.batch.BatchFileHandler
 import com.datadog.android.core.internal.persistence.file.batch.BatchFilePersistenceStrategy
 import com.datadog.android.core.internal.privacy.ConsentProvider
+import com.datadog.android.core.internal.system.AppVersionProvider
 import com.datadog.android.core.internal.time.TimeProvider
 import com.datadog.android.event.SpanEventMapper
 import com.datadog.android.log.Logger
@@ -33,6 +34,7 @@ internal class TracesFilePersistenceStrategy(
     timeProvider: TimeProvider,
     networkInfoProvider: NetworkInfoProvider,
     userInfoProvider: UserInfoProvider,
+    appVersionProvider: AppVersionProvider,
     envName: String,
     internalLogger: Logger,
     spanEventMapper: SpanEventMapper,
@@ -50,7 +52,8 @@ internal class TracesFilePersistenceStrategy(
         DdSpanToSpanEventMapper(
             timeProvider,
             networkInfoProvider,
-            userInfoProvider
+            userInfoProvider,
+            appVersionProvider
         ),
         SpanEventMapperWrapper(spanEventMapper),
         SpanEventSerializer(envName)

diff --git a/.../main/kotlin/com/datadog/android/tracing/internal/domain/event/DdSpanToSpanEventMapper.kt b/.../main/kotlin/com/datadog/android/tracing/internal/domain/event/DdSpanToSpanEventMapper.kt
@@ -9,6 +9,7 @@ package com.datadog.android.tracing.internal.domain.event
 import com.datadog.android.core.internal.CoreFeature
 import com.datadog.android.core.internal.Mapper
 import com.datadog.android.core.internal.net.info.NetworkInfoProvider
+import com.datadog.android.core.internal.system.AppVersionProvider
 import com.datadog.android.core.internal.time.TimeProvider
 import com.datadog.android.core.internal.utils.toHexString
 import com.datadog.android.core.model.NetworkInfo
@@ -19,7 +20,8 @@ import com.datadog.opentracing.DDSpan
 internal class DdSpanToSpanEventMapper(
     private val timeProvider: TimeProvider,
     private val networkInfoProvider: NetworkInfoProvider,
-    private val userInfoProvider: UserInfoProvider
+    private val userInfoProvider: UserInfoProvider,
+    private val appVersionProvider: AppVersionProvider
 ) : Mapper<DDSpan, SpanEvent> {
 
     // region Mapper
@@ -71,7 +73,7 @@ internal class DdSpanToSpanEventMapper(
             additionalProperties = userInfo.additionalProperties
         )
         return SpanEvent.Meta(
-            version = CoreFeature.packageVersion,
+            version = appVersionProvider.version,
             dd = SpanEvent.Dd(source = CoreFeature.sourceName),
             span = SpanEvent.Span(),
             tracer = SpanEvent.Tracer(

diff --git a/dd-sdk-android/src/main/kotlin/com/datadog/android/webview/DatadogEventBridge.kt b/dd-sdk-android/src/main/kotlin/com/datadog/android/webview/DatadogEventBridge.kt
@@ -139,7 +139,8 @@ internal constructor(
                 WebViewLogEventConsumer(
                     userLogsWriter = WebViewLogsFeature.persistenceStrategy.getWriter(),
                     rumContextProvider = contextProvider,
-                    timeProvider = CoreFeature.timeProvider
+                    timeProvider = CoreFeature.timeProvider,
+                    appVersionProvider = CoreFeature.packageVersionProvider
                 )
             )
         }