Merge pull request #1439 from DataDog/nogorodnikov/prepare-release-1.19.1

Prepare release 1.19.1

Author: 0xnm

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.19.1 / 2023-05-30
+
+* [IMPROVEMENT] RUM: Force new session at SDK initialization. See [#1399](https://github.com/DataDog/dd-sdk-android/pull/1399)
+* [BUGFIX] RUM: Ignore adding custom timings and feature flags for the stopped view. See [#1433](https://github.com/DataDog/dd-sdk-android/pull/1433)
+
 # 1.19.0 / 2023-04-24
 
 * [FEATURE] RUM: Allow users to stop a RUM session. See [#1356](https://github.com/DataDog/dd-sdk-android/pull/1356)

buildSrc/src/main/kotlin/com/datadog/gradle/config/AndroidConfig.kt

@@ -19,7 +19,7 @@ object AndroidConfig {
     const val MIN_SDK_FOR_WEAR = 23
     const val BUILD_TOOLS_VERSION = "33.0.0"
 
-    val VERSION = Version(1, 19, 0, Version.Type.Release)
+    val VERSION = Version(1, 19, 1, Version.Type.Release)
 }
 
 @Suppress("UnstableApiUsage")

dd-sdk-android/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumRawEvent.kt

@@ -204,6 +204,10 @@ internal sealed class RumRawEvent {
         override val eventTime: Time = Time()
     ) : RumRawEvent()
 
+    internal data class SdkInit(
+        override val eventTime: Time = Time()
+    ) : RumRawEvent()
+
     internal data class WebViewEvent(override val eventTime: Time = Time()) : RumRawEvent()
 
     internal data class SendTelemetry(

dd-sdk-android/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumSessionScope.kt

@@ -146,7 +146,9 @@ internal class RumSessionScope(
         val isInteraction = (event is RumRawEvent.StartView) || (event is RumRawEvent.StartAction)
         val isBackgroundEvent = (event.javaClass in RumViewManagerScope.validBackgroundEventTypes)
 
-        if (isInteraction) {
+        if (event is RumRawEvent.SdkInit && isNewSession) {
+            renewSession(nanoTime)
+        } else if (isInteraction) {
             if (isNewSession || isExpired || isTimedOut) {
                 renewSession(nanoTime)
             }

dd-sdk-android/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumViewManagerScope.kt

@@ -85,7 +85,7 @@ internal class RumViewManagerScope(
 
     // region Internal
 
-    fun isViewManagerComplete(): Boolean {
+    private fun isViewManagerComplete(): Boolean {
         return stopped && childrenScopes.isEmpty()
     }
 

dd-sdk-android/src/main/kotlin/com/datadog/android/rum/internal/domain/scope/RumViewScope.kt

@@ -106,7 +106,7 @@ internal open class RumViewScope(
     private var version: Long = 1
     private var loadingTime: Long? = null
     private var loadingType: ViewEvent.LoadingType? = null
-    private val customTimings: MutableMap<String, Long> = mutableMapOf()
+    internal val customTimings: MutableMap<String, Long> = mutableMapOf()
     internal val featureFlags: MutableMap<String, Any?> = mutableMapOf()
 
     internal var stopped: Boolean = false
@@ -467,6 +467,8 @@ internal open class RumViewScope(
         event: RumRawEvent.AddCustomTiming,
         writer: DataWriter<Any>
     ) {
+        if (stopped) return
+
         customTimings[event.name] = max(event.eventTime.nanoTime - startedNanos, 1L)
         sendViewUpdate(event, writer)
     }
@@ -988,6 +990,8 @@ internal open class RumViewScope(
         event: RumRawEvent.AddFeatureFlagEvaluation,
         writer: DataWriter<Any>
     ) {
+        if (stopped) return
+
         featureFlags[event.name] = event.value
         sendViewUpdate(event, writer)
         sendViewChanged()

dd-sdk-android/src/main/kotlin/com/datadog/android/rum/internal/monitor/DatadogRumMonitor.kt

@@ -64,7 +64,8 @@ internal class DatadogRumMonitor(
     frameRateVitalMonitor: VitalMonitor,
     sessionListener: RumSessionListener?,
     contextProvider: ContextProvider,
-    private val executorService: ExecutorService = Executors.newSingleThreadExecutor()
+    private val executorService: ExecutorService = Executors.newSingleThreadExecutor(),
+    sendSdkInit: Boolean = true
 ) : RumMonitor, AdvancedRumMonitor {
 
     internal var rootScope: RumScope = RumApplicationScope(
@@ -95,6 +96,9 @@ internal class DatadogRumMonitor(
 
     init {
         handler.postDelayed(keepAliveRunnable, KEEP_ALIVE_MS)
+        if (sendSdkInit) {
+            sendSdkInitEvent()
+        }
     }
 
     // region RumMonitor
@@ -507,6 +511,12 @@ internal class DatadogRumMonitor(
         }
     }
 
+    private fun sendSdkInitEvent() {
+        handleEvent(
+            RumRawEvent.SdkInit()
+        )
+    }
+
     // endregion
 
     companion object {

dd-sdk-android/src/test/kotlin/com/datadog/android/rum/internal/domain/scope/RumSessionScopeTest.kt

@@ -283,6 +283,23 @@ internal class RumSessionScopeTest {
         assertThat(context.viewId).isEqualTo(fakeParentContext.viewId)
     }
 
+    @Test
+    fun `𝕄 create new session context 𝕎 handleEvent(sdkInit)+getRumContext() {sampling = 100}`() {
+        // Given
+        initializeTestedScope(100f)
+
+        // When
+        val result = testedScope.handleEvent(RumRawEvent.SdkInit(), mockWriter)
+        val context = testedScope.getRumContext()
+
+        // Then
+        assertThat(result).isSameAs(testedScope)
+        assertThat(context.sessionId).isNotEqualTo(RumContext.NULL_UUID)
+        assertThat(context.sessionState).isEqualTo(RumSessionScope.State.TRACKED)
+        assertThat(context.applicationId).isEqualTo(fakeParentContext.applicationId)
+        assertThat(context.viewId).isEqualTo(fakeParentContext.viewId)
+    }
+
     @Test
     fun `𝕄 create new session context 𝕎 handleEvent(view)+getRumContext() {sampling = 100}`(
         forge: Forge

dd-sdk-android/src/test/kotlin/com/datadog/android/rum/internal/domain/scope/RumViewScopeTest.kt

@@ -5563,6 +5563,25 @@ internal class RumViewScopeTest {
         verifyNoMoreInteractions(mockWriter)
     }
 
+    @Test
+    fun `𝕄 not add custom timing 𝕎 handleEvent(AddCustomTiming) on stopped view`(
+        forge: Forge
+    ) {
+        // Given
+        testedScope.stopped = true
+        val fakeTimingKey = forge.anAlphabeticalString()
+
+        // When
+        testedScope.handleEvent(
+            RumRawEvent.AddCustomTiming(fakeTimingKey),
+            mockWriter
+        )
+
+        // Then
+        assertThat(testedScope.customTimings).isEmpty()
+        verifyZeroInteractions(mockWriter)
+    }
+
     // endregion
 
     // region Vitals
@@ -6904,6 +6923,28 @@ internal class RumViewScopeTest {
         }
     }
 
+    @Test
+    fun `M not add feature flag W handleEvent(AddFeatureFlagEvaluation) on stopped view`(
+        @StringForgery flagName: String,
+        @StringForgery flagValue: String
+    ) {
+        // GIVEN
+        testedScope.stopped = true
+
+        // WHEN
+        testedScope.handleEvent(
+            RumRawEvent.AddFeatureFlagEvaluation(
+                name = flagName,
+                value = flagValue
+            ),
+            mockWriter
+        )
+
+        // THEN
+        assertThat(testedScope.featureFlags).isEmpty()
+        verifyZeroInteractions(mockWriter)
+    }
+
     @Test
     fun `M modify flag W handleEvent(AddFeatureFlagEvaluation) on active view { existing feature flag }`(
         @StringForgery flagName: String,

dd-sdk-android/src/test/kotlin/com/datadog/android/rum/internal/monitor/DatadogRumMonitorTest.kt

@@ -159,7 +159,8 @@ internal class DatadogRumMonitorTest {
             mockMemoryVitalMonitor,
             mockFrameRateVitalMonitor,
             mockSessionListener,
-            mockContextProvider
+            mockContextProvider,
+            sendSdkInit = false
         )
         testedMonitor.rootScope = mockScope
     }
@@ -1130,6 +1131,39 @@ internal class DatadogRumMonitorTest {
         }
     }
 
+    @Test
+    fun `M delegate SdkInit event to rootScope W init()`() {
+        // When
+        testedMonitor = DatadogRumMonitor(
+            fakeApplicationId,
+            mockSdkCore,
+            fakeSamplingRate,
+            fakeBackgroundTrackingEnabled,
+            fakeTrackFrustrations,
+            mockWriter,
+            mockHandler,
+            mockTelemetryEventHandler,
+            mockResolver,
+            mockCpuVitalMonitor,
+            mockMemoryVitalMonitor,
+            mockFrameRateVitalMonitor,
+            mockSessionListener,
+            mockContextProvider,
+            sendSdkInit = true
+        )
+        testedMonitor.rootScope = mockScope
+
+        Thread.sleep(PROCESSING_DELAY)
+
+        // Then
+        verify(mockScope).handleEvent(
+            argThat { this is RumRawEvent.SdkInit },
+            same(mockWriter)
+        )
+
+        verifyNoMoreInteractions(mockScope, mockWriter)
+    }
+
     @Test
     fun `delays keep alive runnable on other event`() {
         val mockEvent: RumRawEvent = mock()
@@ -1258,7 +1292,8 @@ internal class DatadogRumMonitorTest {
             mockFrameRateVitalMonitor,
             mockSessionListener,
             mockContextProvider,
-            mockExecutorService
+            mockExecutorService,
+            false
         )
         whenever(mockExecutorService.isShutdown).thenReturn(true)
 
@@ -1570,7 +1605,8 @@ internal class DatadogRumMonitorTest {
             mockFrameRateVitalMonitor,
             mockSessionListener,
             mockContextProvider,
-            executorService = mockExecutorService
+            executorService = mockExecutorService,
+            false
         )
 
         var isMethodOccupied = false