MS-801 Add data export button to alert screen

feature/alert/build.gradle.kts

@@ -9,4 +9,5 @@ android {
 
 dependencies {
     implementation(project(":infra:events"))
+    implementation(project(":infra:auth-store"))
 }

feature/alert/src/main/java/com/simprints/feature/alert/screen/AlertFragment.kt

@@ -3,6 +3,7 @@ package com.simprints.feature.alert.screen
 import android.os.Bundle
 import android.view.View
 import android.widget.TextView
+import android.widget.Toast
 import androidx.activity.addCallback
 import androidx.core.content.res.ResourcesCompat
 import androidx.core.view.isVisible
@@ -20,6 +21,7 @@ import com.simprints.feature.alert.databinding.FragmentAlertBinding
 import com.simprints.infra.logging.LoggingConstants.CrashReportTag.ALERT
 import com.simprints.infra.logging.Simber
 import com.simprints.infra.uibase.navigation.setResult
+import com.simprints.infra.uibase.system.Clipboard
 import com.simprints.infra.uibase.view.setTextWithFallbacks
 import com.simprints.infra.uibase.viewbinding.viewBinding
 import dagger.hilt.android.AndroidEntryPoint
@@ -61,13 +63,19 @@ internal class AlertFragment : Fragment(R.layout.fragment_alert) {
             binding.alertRightButton.setupButton(config.rightButton, config.appErrorReason)
         }
 
+
         requireActivity().onBackPressedDispatcher.addCallback(viewLifecycleOwner) {
             Simber.tag(ALERT.name).i("Alert back button clicked")
             setPressedButtonResult(AlertContract.ALERT_BUTTON_PRESSED_BACK, config.appErrorReason)
             findNavController().popBackStack()
         }
         config.eventType?.let { vm.saveAlertEvent(it) }
 
+        binding.alertExportButton.setOnClickListener {
+            Clipboard.copyToClipboard(requireContext(), vm.collectExportData())
+            Toast.makeText(requireContext(), IDR.string.alert_export_copied, Toast.LENGTH_SHORT).show()
+        }
+
         Simber.tag(ALERT.name).i("${binding.alertTitle.text}")
     }
 

feature/alert/src/main/java/com/simprints/feature/alert/screen/AlertViewModel.kt

@@ -1,25 +1,49 @@
 package com.simprints.feature.alert.screen
 
 import androidx.lifecycle.ViewModel
+import com.simprints.core.DeviceID
 import com.simprints.core.ExternalScope
 import com.simprints.core.tools.time.TimeHelper
+import com.simprints.infra.authstore.AuthStore
 import com.simprints.infra.events.SessionEventRepository
 import com.simprints.infra.events.event.domain.models.AlertScreenEvent
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
+import kotlinx.coroutines.runBlocking
 import javax.inject.Inject
 
 @HiltViewModel
 internal class AlertViewModel @Inject constructor(
+    @DeviceID private val deviceId: String,
     private val timeHelper: TimeHelper,
     private val eventRepository: SessionEventRepository,
-    @ExternalScope private val ioScope: CoroutineScope,
+    private val authStore: AuthStore,
+    @ExternalScope private val externalScope: CoroutineScope,
 ) : ViewModel() {
 
+    private lateinit var cachedAlertEvent: AlertScreenEvent
+
     fun saveAlertEvent(type: AlertScreenEvent.AlertScreenPayload.AlertScreenEventType) {
-        ioScope.launch {
-            eventRepository.addOrUpdateEvent(AlertScreenEvent(timeHelper.now(), type))
+        externalScope.launch {
+            val event = AlertScreenEvent(timeHelper.now(), type)
+            eventRepository.addOrUpdateEvent(event)
+            // Preserving the alert event to be able to export its data if requested by user
+            cachedAlertEvent = event
         }
     }
+
+    fun collectExportData(): String = runBlocking {
+        val sessionId = eventRepository.getCurrentSessionScope().id
+
+        """
+            Event ID:   ${cachedAlertEvent.id}
+            Timestamp:  ${cachedAlertEvent.payload.createdAt.ms}
+            Project ID: ${authStore.signedInProjectId}
+            User ID:    ${authStore.signedInUserId?.value}
+            Device ID:  $deviceId
+            Session ID: $sessionId
+            Alert type: ${cachedAlertEvent.payload.alertType}
+        """.trimIndent()
+    }
 }

feature/alert/src/main/res/layout/fragment_alert.xml

@@ -6,6 +6,26 @@
     android:layout_height="match_parent"
     android:background="@color/simprints_blue">
 
+    <TextView
+        android:id="@+id/alertExportButton"
+        style="@style/Text.Caption.White"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_gravity="center"
+        android:layout_marginTop="8dp"
+        android:layout_marginEnd="8dp"
+        android:layout_marginBottom="24dp"
+        android:drawablePadding="4dp"
+        android:gravity="center"
+        android:maxLines="2"
+        android:paddingHorizontal="8dp"
+        android:paddingVertical="16dp"
+        android:textAllCaps="true"
+        android:text="@string/alert_export_data"
+        app:drawableStartCompat="@drawable/ic_copy"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintTop_toTopOf="parent" />
+
     <TextView
         android:id="@+id/alertTitle"
         style="@style/Text.Headline5.White.Bold"

feature/alert/src/test/java/com/simprints/feature/alert/screen/AlertViewModelTest.kt

@@ -2,24 +2,30 @@ package com.simprints.feature.alert.screen
 
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
 import com.google.common.truth.Truth.assertThat
+import com.simprints.core.domain.tokenization.TokenizableString
 import com.simprints.core.tools.time.TimeHelper
 import com.simprints.core.tools.time.Timestamp
+import com.simprints.infra.authstore.AuthStore
 import com.simprints.infra.events.SessionEventRepository
 import com.simprints.infra.events.event.domain.models.AlertScreenEvent
 import com.simprints.infra.events.event.domain.models.AlertScreenEvent.AlertScreenPayload.AlertScreenEventType
 import com.simprints.infra.events.event.domain.models.EventType
 import com.simprints.testtools.common.coroutines.TestCoroutineRule
 import io.mockk.MockKAnnotations
+import io.mockk.coEvery
+import io.mockk.coJustRun
 import io.mockk.coVerify
 import io.mockk.every
 import io.mockk.impl.annotations.MockK
+import io.mockk.justRun
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.test.runTest
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 
 internal class AlertViewModelTest {
+
     @get:Rule
     val rule = InstantTaskExecutorRule()
 
@@ -32,21 +38,26 @@ internal class AlertViewModelTest {
     @MockK
     lateinit var eventRepository: SessionEventRepository
 
+    @MockK
+    lateinit var authStore: AuthStore
+
     lateinit var alertViewModel: AlertViewModel
 
     @Before
     fun setUp() {
         MockKAnnotations.init(this, relaxed = true)
 
         alertViewModel = AlertViewModel(
+            DEVICE_ID,
             timeHelper,
             eventRepository,
+            authStore,
             CoroutineScope(testCoroutineRule.testCoroutineDispatcher),
         )
     }
 
     @Test
-    fun saveAlertEvent() = runTest {
+    fun `alert event reported correctly`() = runTest {
         every { timeHelper.now() } returns Timestamp(42)
 
         alertViewModel.saveAlertEvent(AlertScreenEventType.DISCONNECTED)
@@ -61,4 +72,31 @@ internal class AlertViewModelTest {
             })
         }
     }
+
+    @Test
+    fun `exported data contains all the correct data`() = runTest {
+        every { timeHelper.now() } returns Timestamp(42)
+        every { authStore.signedInProjectId } returns PROJECT_ID
+        every { authStore.signedInUserId } returns TokenizableString.Raw(USER_ID)
+        coJustRun { eventRepository.addOrUpdateEvent(any()) }
+        coEvery { eventRepository.getCurrentSessionScope().id } returns SCOPE_ID
+
+        alertViewModel.saveAlertEvent(AlertScreenEventType.DISCONNECTED)
+        val exportData = alertViewModel.collectExportData()
+
+        assertThat(exportData).contains("42")
+        assertThat(exportData).contains(DEVICE_ID)
+        assertThat(exportData).contains(PROJECT_ID)
+        assertThat(exportData).contains(USER_ID)
+        assertThat(exportData).contains(SCOPE_ID)
+        assertThat(exportData).contains(AlertScreenEventType.DISCONNECTED.name)
+    }
+
+    companion object {
+
+        private const val DEVICE_ID = "device-id"
+        private const val PROJECT_ID = "project-id"
+        private const val USER_ID = "user-id"
+        private const val SCOPE_ID = "scope-id"
+    }
 }

infra/resources/src/main/res/drawable/ic_copy.xml

@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="21dp"
+    android:height="21dp"
+    android:viewportWidth="21"
+    android:viewportHeight="21">
+    <path
+        android:fillColor="#ffffff"
+        android:fillType="evenOdd"
+        android:pathData="M13.833,1.333H3.833C2.916,1.333 2.166,2.083 2.166,3V14.667H3.833V3H13.833V1.333ZM16.333,4.667H7.166C6.249,4.667 5.499,5.417 5.499,6.333V18C5.499,18.917 6.249,19.667 7.166,19.667H16.333C17.249,19.667 17.999,18.917 17.999,18V6.333C17.999,5.417 17.249,4.667 16.333,4.667ZM16.333,18H7.166V6.333H16.333V18Z" />
+</vector>

infra/resources/src/main/res/values/strings.xml

@@ -4,6 +4,8 @@
     <!-- Alert -->
     <string name="alert_title_fallback">Alert</string>
     <string name="alert_button_close">Close</string>
+    <string name="alert_export_data">Copy details</string>
+    <string name="alert_export_copied">Copied data to clipboard</string>
 
     <!-- Consent -->
     <string name="consent_general_title">General Consent</string>