2025.2.0 Backport

feature/client-api/src/main/java/com/simprints/feature/clientapi/usecases/DeleteSessionEventsIfNeededUseCase.kt

@@ -1,6 +1,8 @@
 package com.simprints.feature.clientapi.usecases
 
 import com.simprints.core.SessionCoroutineScope
+import com.simprints.infra.authstore.AuthStore
+import com.simprints.infra.config.store.models.ProjectState
 import com.simprints.infra.config.store.models.canSyncDataToSimprints
 import com.simprints.infra.config.sync.ConfigManager
 import com.simprints.infra.events.EventRepository
@@ -9,12 +11,16 @@ import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 internal class DeleteSessionEventsIfNeededUseCase @Inject constructor(
+    private val authStore: AuthStore,
     private val configManager: ConfigManager,
     private val eventRepository: EventRepository,
     @SessionCoroutineScope private val sessionCoroutineScope: CoroutineScope,
 ) {
     operator fun invoke(sessionId: String) = sessionCoroutineScope.launch {
-        if (!configManager.getProjectConfiguration().canSyncDataToSimprints()) {
+        val projectNotRunning = configManager.getProject(authStore.signedInProjectId).state != ProjectState.RUNNING
+        val simprintsDataSyncDisabled = !configManager.getProjectConfiguration().canSyncDataToSimprints()
+
+        if (simprintsDataSyncDisabled || projectNotRunning) {
             eventRepository.deleteEventScope(sessionId)
         }
     }

feature/client-api/src/test/java/com/simprints/feature/clientapi/usecases/DeleteSessionEventsIfNeededUseCaseTest.kt

@@ -1,14 +1,16 @@
 package com.simprints.feature.clientapi.usecases
 
+import com.simprints.infra.authstore.AuthStore
+import com.simprints.infra.config.store.models.ProjectState
 import com.simprints.infra.config.store.models.UpSynchronizationConfiguration
 import com.simprints.infra.config.sync.ConfigManager
 import com.simprints.infra.events.EventRepository
 import com.simprints.testtools.common.coroutines.TestCoroutineRule
 import io.mockk.MockKAnnotations
 import io.mockk.coEvery
 import io.mockk.coVerify
+import io.mockk.every
 import io.mockk.impl.annotations.MockK
-import io.mockk.mockk
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.test.runTest
 import org.junit.Before
@@ -19,6 +21,9 @@ class DeleteSessionEventsIfNeededUseCaseTest {
     @get:Rule
     val testCoroutineRule = TestCoroutineRule()
 
+    @MockK
+    private lateinit var authStore: AuthStore
+
     @MockK
     private lateinit var configManager: ConfigManager
 
@@ -31,29 +36,80 @@ class DeleteSessionEventsIfNeededUseCaseTest {
     fun setUp() {
         MockKAnnotations.init(this, relaxed = true)
 
+        every { authStore.signedInProjectId } returns "projectId"
+
         deleteUseCase = DeleteSessionEventsIfNeededUseCase(
+            authStore,
             configManager,
             eventRepository,
             CoroutineScope(testCoroutineRule.testCoroutineDispatcher),
         )
     }
 
     @Test
-    fun `deletes session events if data sync disabled`() = runTest {
-        coEvery { configManager.getProjectConfiguration() } returns mockk {
-            coEvery { synchronization.up.simprints.kind } returns UpSynchronizationConfiguration.UpSynchronizationKind.NONE
-        }
+    fun `deletes session events if project paused`() = runTest {
+        coEvery { configManager.getProject(any()).state } returns ProjectState.PROJECT_PAUSED
+        coEvery {
+            configManager
+                .getProjectConfiguration()
+                .synchronization.up.simprints.kind
+        } returns UpSynchronizationConfiguration.UpSynchronizationKind.ALL
+
+        deleteUseCase("sessionId")
+
+        coVerify { eventRepository.deleteEventScope("sessionId") }
+    }
+
+    @Test
+    fun `deletes session events if project ending`() = runTest {
+        coEvery { configManager.getProject(any()).state } returns ProjectState.PROJECT_ENDING
+        coEvery {
+            configManager
+                .getProjectConfiguration()
+                .synchronization.up.simprints.kind
+        } returns UpSynchronizationConfiguration.UpSynchronizationKind.ALL
+
+        deleteUseCase("sessionId")
+
+        coVerify { eventRepository.deleteEventScope("sessionId") }
+    }
+
+    @Test
+    fun `deletes session events if project ended`() = runTest {
+        coEvery { configManager.getProject(any()).state } returns ProjectState.PROJECT_ENDED
+        coEvery {
+            configManager
+                .getProjectConfiguration()
+                .synchronization.up.simprints.kind
+        } returns UpSynchronizationConfiguration.UpSynchronizationKind.ALL
+
+        deleteUseCase("sessionId")
+
+        coVerify { eventRepository.deleteEventScope("sessionId") }
+    }
+
+    @Test
+    fun `deletes session events if data sync disabled in running project`() = runTest {
+        coEvery { configManager.getProject(any()).state } returns ProjectState.RUNNING
+        coEvery {
+            configManager
+                .getProjectConfiguration()
+                .synchronization.up.simprints.kind
+        } returns UpSynchronizationConfiguration.UpSynchronizationKind.NONE
 
         deleteUseCase("sessionId")
 
         coVerify { eventRepository.deleteEventScope("sessionId") }
     }
 
     @Test
-    fun `does not delete session events if data sync enabled`() = runTest {
-        coEvery { configManager.getProjectConfiguration() } returns mockk {
-            coEvery { synchronization.up.simprints.kind } returns UpSynchronizationConfiguration.UpSynchronizationKind.ALL
-        }
+    fun `does not delete session events if data sync enabled in running project`() = runTest {
+        coEvery { configManager.getProject(any()).state } returns ProjectState.RUNNING
+        coEvery {
+            configManager
+                .getProjectConfiguration()
+                .synchronization.up.simprints.kind
+        } returns UpSynchronizationConfiguration.UpSynchronizationKind.ALL
 
         deleteUseCase("sessionId")
 

feature/login-check/src/main/java/com/simprints/feature/logincheck/usecases/ReportActionRequestEventsUseCase.kt

@@ -78,7 +78,13 @@ internal class ReportActionRequestEventsUseCase @Inject constructor(
                     metadata,
                     BiometricDataSource.fromString(biometricDataSource),
                 )
-                is ActionRequest.ConfirmIdentityActionRequest -> ConfirmationCalloutEventV3(startTime, projectId, selectedGuid, sessionId)
+                is ActionRequest.ConfirmIdentityActionRequest -> ConfirmationCalloutEventV3(
+                    startTime,
+                    projectId,
+                    selectedGuid,
+                    sessionId,
+                    metadata,
+                )
                 is ActionRequest.EnrolLastBiometricActionRequest -> EnrolmentLastBiometricsCalloutEventV3(
                     startTime,
                     projectId,

feature/troubleshooting/src/main/java/com/simprints/feature/troubleshooting/overview/OverviewFragment.kt

@@ -1,9 +1,11 @@
 package com.simprints.feature.troubleshooting.overview
 
 import android.content.Intent
+import android.os.Build
 import android.os.Bundle
 import android.view.View
 import androidx.core.content.FileProvider
+import androidx.core.view.isVisible
 import androidx.fragment.app.Fragment
 import androidx.fragment.app.viewModels
 import com.simprints.feature.troubleshooting.R
@@ -68,6 +70,9 @@ internal class OverviewFragment : Fragment(R.layout.fragment_troubleshooting_ove
         binding.troubleshootOverviewPing.setOnClickListener {
             viewModel.pingServer()
         }
+
+        // Log export is only Available starting from Android 8
+        binding.troubleshootOverviewExportLogsBlock.isVisible = Build.VERSION.SDK_INT >= Build.VERSION_CODES.O
         binding.troubleshootOverviewExportLogs.setOnClickListener { v ->
             viewModel.exportLogs()
         }

feature/troubleshooting/src/main/java/com/simprints/feature/troubleshooting/recordsmigration/RealmToRoomRecordsMigrationViewModel.kt

@@ -5,6 +5,7 @@ import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import com.simprints.feature.troubleshooting.adapter.TroubleshootingItemViewData
+import com.simprints.infra.authstore.AuthStore
 import com.simprints.infra.enrolment.records.repository.EnrolmentRecordRepository
 import com.simprints.infra.enrolment.records.repository.local.migration.RealmToRoomMigrationFlagsStore
 import dagger.hilt.android.lifecycle.HiltViewModel
@@ -15,6 +16,7 @@ import javax.inject.Inject
 internal class RealmToRoomRecordsMigrationViewModel @Inject constructor(
     private val flagStore: RealmToRoomMigrationFlagsStore,
     private val enrolmentRecordRepository: EnrolmentRecordRepository,
+    private val authStore: AuthStore,
 ) : ViewModel() {
     private val _logs = MutableLiveData<List<TroubleshootingItemViewData>>(emptyList())
     val logs: LiveData<List<TroubleshootingItemViewData>>
@@ -30,7 +32,11 @@ internal class RealmToRoomRecordsMigrationViewModel @Inject constructor(
                     ),
                     TroubleshootingItemViewData(
                         title = "Local db info",
-                        body = enrolmentRecordRepository.getLocalDBInfo(),
+                        body = if (authStore.signedInProjectId.isNotEmpty()) {
+                            enrolmentRecordRepository.getLocalDBInfo()
+                        } else {
+                            "No local db info available for logged out users."
+                        },
                     ),
                 ),
             )

feature/troubleshooting/src/main/res/layout/fragment_troubleshooting_overview.xml

@@ -127,6 +127,7 @@
             android:textIsSelectable="true" />
 
         <LinearLayout
+            android:id="@+id/troubleshootOverviewExportLogsBlock"
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:layout_marginVertical="16dp"

feature/troubleshooting/src/test/java/com/simprints/feature/troubleshooting/reordsmigration/RealmToRoomRecordsMigrationViewModelTest.kt

@@ -1,15 +1,15 @@
 package com.simprints.feature.troubleshooting.reordsmigration
 
 import androidx.arch.core.executor.testing.InstantTaskExecutorRule
-import com.google.common.truth.Truth.assertThat
+import com.google.common.truth.Truth.*
 import com.simprints.feature.troubleshooting.recordsmigration.RealmToRoomRecordsMigrationViewModel
+import com.simprints.infra.authstore.AuthStore
 import com.simprints.infra.enrolment.records.repository.EnrolmentRecordRepository
 import com.simprints.infra.enrolment.records.repository.local.migration.RealmToRoomMigrationFlagsStore
 import com.simprints.testtools.common.coroutines.TestCoroutineRule
 import com.simprints.testtools.common.livedata.getOrAwaitValue
-import io.mockk.MockKAnnotations
-import io.mockk.coEvery
-import io.mockk.impl.annotations.*
+import io.mockk.*
+import io.mockk.impl.annotations.MockK
 import kotlinx.coroutines.test.runTest
 import org.junit.Before
 import org.junit.Rule
@@ -28,12 +28,15 @@ class RealmToRoomRecordsMigrationViewModelTest {
     @MockK
     private lateinit var enrolmentRecordRepository: EnrolmentRecordRepository
 
+    @MockK
+    private lateinit var authStore: AuthStore
+
     private lateinit var viewModel: RealmToRoomRecordsMigrationViewModel
 
     @Before
     fun setup() {
         MockKAnnotations.init(this, relaxed = true)
-        viewModel = RealmToRoomRecordsMigrationViewModel(flagStore, enrolmentRecordRepository)
+        viewModel = RealmToRoomRecordsMigrationViewModel(flagStore, enrolmentRecordRepository, authStore)
     }
 
     @Test
@@ -42,6 +45,7 @@ class RealmToRoomRecordsMigrationViewModelTest {
         val mockFlagState = "flags: ENABLED"
         val mockDbInfo = "Database Version: 1"
 
+        every { authStore.signedInProjectId } returns "project_id"
         coEvery { flagStore.getStoreStateAsString() } returns mockFlagState
         coEvery { enrolmentRecordRepository.getLocalDBInfo() } returns mockDbInfo
 
@@ -58,4 +62,29 @@ class RealmToRoomRecordsMigrationViewModelTest {
         assertThat(logs[1].title).isEqualTo("Local db info")
         assertThat(logs[1].body).isEqualTo(mockDbInfo)
     }
+
+    @Test
+    fun `collectData should post no local DB info when user is logged out`() = runTest {
+        // Given
+        val mockFlagState = "flags: ENABLED"
+        val mockDbInfo = "Database Version: 1"
+
+        every { authStore.signedInProjectId } returns ""
+        coEvery { flagStore.getStoreStateAsString() } returns mockFlagState
+        coEvery { enrolmentRecordRepository.getLocalDBInfo() } returns mockDbInfo
+
+        // When
+        viewModel.collectData()
+
+        // Then
+        val logs = viewModel.logs.getOrAwaitValue()
+
+        assertThat(logs).hasSize(2)
+        assertThat(logs[0].title).isEqualTo("Realm to Room migration flags:")
+        assertThat(logs[0].body).isEqualTo(mockFlagState)
+
+        assertThat(logs[1].title).isEqualTo("Local db info")
+        assertThat(logs[1].body).isEqualTo("No local db info available for logged out users.")
+        coVerify(exactly = 0) { enrolmentRecordRepository.getLocalDBInfo() }
+    }
 }

infra/enrolment-records/repository/src/main/java/com/simprints/infra/enrolment/records/repository/local/RealmEnrolmentRecordLocalDataSource.kt

@@ -80,7 +80,9 @@ internal class RealmEnrolmentRecordLocalDataSource @Inject constructor(
                     mapper = { dbSubject ->
                         FaceIdentity(
                             subjectId = dbSubject.subjectId.toString(),
-                            faces = dbSubject.faceSamples.map { it.toDomain() },
+                            faces = dbSubject.faceSamples
+                                .filter { it.format == query.faceSampleFormat }
+                                .map { it.toDomain() },
                         )
                     },
                     onCandidateLoaded = onCandidateLoaded,
@@ -109,7 +111,9 @@ internal class RealmEnrolmentRecordLocalDataSource @Inject constructor(
                     mapper = { dbSubject ->
                         FingerprintIdentity(
                             subjectId = dbSubject.subjectId.toString(),
-                            fingerprints = dbSubject.fingerprintSamples.map { it.toDomain() },
+                            fingerprints = dbSubject.fingerprintSamples
+                                .filter { it.format == query.fingerprintSampleFormat }
+                                .map { it.toDomain() },
                         )
                     },
                     onCandidateLoaded = onCandidateLoaded,

infra/enrolment-records/repository/src/main/java/com/simprints/infra/enrolment/records/repository/remote/models/face/ApiFaceReference.kt

@@ -1,15 +1,22 @@
 package com.simprints.infra.enrolment.records.repository.remote.models.face
 
 import androidx.annotation.Keep
+import com.fasterxml.jackson.annotation.JsonTypeInfo
+import com.simprints.core.ExcludedFromGeneratedTestCoverageReports
 import com.simprints.core.domain.face.FaceSample
 import com.simprints.core.tools.utils.EncodingUtils
 import com.simprints.infra.enrolment.records.repository.remote.models.ApiBiometricReference
 
 @Keep
+@ExcludedFromGeneratedTestCoverageReports("API model")
 internal data class ApiFaceReference(
     val id: String,
     val templates: List<ApiFaceTemplate>,
     val format: String,
+    // [MS-1076] The parent 'ApiBiometricReference' class should have its JsonSubTypes annotation updated to
+    // @JsonSubTypes.Type([...], looseHandling = true) once we update to SDK => 25 and Jackson => 2.16.0.
+    // Then, this annotation should be removed
+    @JsonTypeInfo(use = JsonTypeInfo.Id.NONE)
     val metadata: HashMap<String, String>? = null,
 ) : ApiBiometricReference(ApiBiometricReferenceType.FaceReference)
 

infra/enrolment-records/repository/src/main/java/com/simprints/infra/enrolment/records/repository/remote/models/fingerprint/ApiFingerprintReference.kt

@@ -1,15 +1,22 @@
 package com.simprints.infra.enrolment.records.repository.remote.models.fingerprint
 
 import androidx.annotation.Keep
+import com.fasterxml.jackson.annotation.JsonTypeInfo
+import com.simprints.core.ExcludedFromGeneratedTestCoverageReports
 import com.simprints.core.domain.fingerprint.FingerprintSample
 import com.simprints.core.tools.utils.EncodingUtils
 import com.simprints.infra.enrolment.records.repository.remote.models.ApiBiometricReference
 
 @Keep
+@ExcludedFromGeneratedTestCoverageReports("API model")
 internal data class ApiFingerprintReference(
     val id: String,
     val templates: List<ApiFingerprintTemplate>,
     val format: String,
+    // [MS-1076] The parent 'ApiBiometricReference' class should have its JsonSubTypes annotation updated to
+    // @JsonSubTypes.Type([...], looseHandling = true) once we update to SDK => 25 and Jackson => 2.16.0.
+    // Then, this annotation should be removed
+    @JsonTypeInfo(use = JsonTypeInfo.Id.NONE)
     val metadata: HashMap<String, String>? = null,
 ) : ApiBiometricReference(ApiBiometricReferenceType.FingerprintReference)
 

infra/event-sync/src/main/java/com/simprints/infra/eventsync/event/remote/models/callout/ApiCalloutPayloadV2.kt

@@ -55,6 +55,7 @@ internal data class ApiCalloutPayloadV2(
         ApiConfirmationCalloutV2(
             domainPayload.selectedGuid,
             domainPayload.sessionId,
+            domainPayload.metadata,
         ),
     )