Fix message when writer is NoOp

DataDog · Apr 3, 2024 · acf1e06 · acf1e06
1 parent a107d7c
commit acf1e06
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 11 deletions.
diff --git a/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/utils/SdkCoreExt.kt b/features/dd-sdk-android-rum/src/main/kotlin/com/datadog/android/rum/utils/SdkCoreExt.kt
@@ -11,6 +11,7 @@ import com.datadog.android.api.context.DatadogContext
 import com.datadog.android.api.feature.Feature
 import com.datadog.android.api.feature.FeatureSdkCore
 import com.datadog.android.api.storage.DataWriter
+import com.datadog.android.api.storage.NoOpDataWriter
 import com.datadog.android.rum.GlobalRumMonitor
 import com.datadog.android.rum.internal.monitor.AdvancedRumMonitor
 
@@ -44,20 +45,28 @@ internal class WriteOperation(
     fun submit() {
         sdkCore.getFeature(Feature.RUM_FEATURE_NAME)
             ?.withWriteContext { datadogContext, eventBatchWriter ->
-                try {
-                    val event = eventSource(datadogContext)
+                if (rumDataWriter is NoOpDataWriter) {
+                    sdkCore.internalLogger.log(
+                        level = InternalLogger.Level.INFO,
+                        target = InternalLogger.Target.USER,
+                        messageBuilder = { WRITE_OPERATION_IGNORED }
+                    )
+                } else {
+                    try {
+                        val event = eventSource(datadogContext)
 
-                    @Suppress("ThreadSafety") // called in a worker thread context
-                    val isSuccess = rumDataWriter.write(eventBatchWriter, event)
-                    if (isSuccess) {
-                        advancedRumMonitor?.let {
-                            onSuccess(it)
+                        @Suppress("ThreadSafety") // called in a worker thread context
+                        val isSuccess = rumDataWriter.write(eventBatchWriter, event)
+                        if (isSuccess) {
+                            advancedRumMonitor?.let {
+                                onSuccess(it)
+                            }
+                        } else {
+                            notifyEventWriteFailure()
                         }
-                    } else {
-                        notifyEventWriteFailure()
+                    } catch (@Suppress("TooGenericExceptionCaught") e: Exception) {
+                        notifyEventWriteFailure(e)
                     }
-                } catch (@Suppress("TooGenericExceptionCaught") e: Exception) {
-                    notifyEventWriteFailure(e)
                 }
             }
     }
@@ -88,6 +97,7 @@ internal class WriteOperation(
     }
 
     internal companion object {
+        const val WRITE_OPERATION_IGNORED = "Write operation ignored, session is expired or RUM feature is disabled."
         const val WRITE_OPERATION_FAILED_ERROR = "Write operation failed."
         const val NO_ERROR_CALLBACK_PROVIDED_WARNING =
             "Write operation failed, but no onError callback was provided."

diff --git a/features/dd-sdk-android-rum/src/test/kotlin/com/datadog/android/rum/utils/SdkCoreExtTest.kt b/features/dd-sdk-android-rum/src/test/kotlin/com/datadog/android/rum/utils/SdkCoreExtTest.kt
@@ -6,6 +6,7 @@ import com.datadog.android.api.feature.Feature
 import com.datadog.android.api.feature.FeatureScope
 import com.datadog.android.api.storage.DataWriter
 import com.datadog.android.api.storage.EventBatchWriter
+import com.datadog.android.api.storage.NoOpDataWriter
 import com.datadog.android.rum.utils.config.GlobalRumMonitorTestConfiguration
 import com.datadog.android.rum.utils.forge.Configurator
 import com.datadog.tools.unit.annotations.TestConfigurationsProvider
@@ -22,6 +23,7 @@ import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.extension.ExtendWith
 import org.junit.jupiter.api.extension.Extensions
 import org.mockito.Mock
+import org.mockito.Mockito.mock
 import org.mockito.junit.jupiter.MockitoExtension
 import org.mockito.junit.jupiter.MockitoSettings
 import org.mockito.kotlin.any
@@ -218,6 +220,27 @@ internal class SdkCoreExtTest {
         )
     }
 
+    @Test
+    fun `𝕄 do nothing 𝕎 submit() { noop writer}`(
+        forge: Forge
+    ) {
+        // Given
+        val fakeEvent = Any()
+        mockWriter = mock<NoOpDataWriter<Any>>()
+
+        // When
+        mockSdkCore.newRumEventWriteOperation(mockWriter) { fakeEvent }
+            .submit()
+
+        // Then
+        mockInternalLogger.verifyLog(
+            level = InternalLogger.Level.INFO,
+            target = InternalLogger.Target.USER,
+            message = WriteOperation.WRITE_OPERATION_IGNORED
+        )
+        verifyNoInteractions(mockWriter)
+    }
+
     companion object {
         val rumMonitor = GlobalRumMonitorTestConfiguration()