MS-871 Record update support

build-logic/build_properties.gradle.kts

@@ -16,8 +16,9 @@ extra.apply {
      * Dev version >= 2024.2.1 is required for receiving biometric sdk age restrictions
      * Dev version >= 2024.2.2 is required for float quality thresholds
      * Dev version >= 2024.3.0 is required to receive configuration ID
+     * Dev version >= 2025.2.0 is required to support enrolment record updates
      */
-    set("VERSION_NAME", "2025.1.0")
+    set("VERSION_NAME", "2025.2.0")
 
     /**
      * Build type. The version code describes which build type was used for the build.

face/capture/src/main/java/com/simprints/face/capture/FaceCaptureResult.kt

@@ -6,6 +6,7 @@ import java.io.Serializable
 
 @Keep
 data class FaceCaptureResult(
+    val referenceId: String,
     val results: List<Item>,
 ) : Serializable {
     @Keep

face/capture/src/main/java/com/simprints/face/capture/screens/FaceCaptureViewModel.kt

@@ -36,6 +36,7 @@ import kotlinx.coroutines.flow.last
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
+import java.util.UUID
 import java.util.concurrent.atomic.AtomicBoolean
 import javax.inject.Inject
 
@@ -184,8 +185,10 @@ internal class FaceCaptureViewModel @Inject constructor(
                     ),
                 )
             }
+            val referenceId = UUID.randomUUID().toString()
+            eventReporter.addBiometricReferenceCreationEvents(referenceId, items.mapNotNull { it.captureEventId })
 
-            _finishFlowEvent.send(FaceCaptureResult(items))
+            _finishFlowEvent.send(FaceCaptureResult(referenceId, items))
         }
     }
 

face/capture/src/main/java/com/simprints/face/capture/usecases/SimpleCaptureEventReporter.kt

@@ -5,6 +5,7 @@ import com.simprints.core.tools.time.TimeHelper
 import com.simprints.core.tools.time.Timestamp
 import com.simprints.core.tools.utils.EncodingUtils
 import com.simprints.face.capture.models.FaceDetection
+import com.simprints.infra.events.event.domain.models.BiometricReferenceCreationEvent
 import com.simprints.infra.events.event.domain.models.face.FaceCaptureBiometricsEvent
 import com.simprints.infra.events.event.domain.models.face.FaceCaptureConfirmationEvent
 import com.simprints.infra.events.event.domain.models.face.FaceCaptureConfirmationEvent.FaceCaptureConfirmationPayload.Result
@@ -100,4 +101,18 @@ internal class SimpleCaptureEventReporter @Inject constructor(
             it.format,
         )
     }!!
+
+    fun addBiometricReferenceCreationEvents(
+        referenceId: String,
+        captureIds: List<String>,
+    ) = sessionCoroutineScope.launch {
+        eventRepository.addOrUpdateEvent(
+            BiometricReferenceCreationEvent(
+                startTime = timeHelper.now(),
+                referenceId = referenceId,
+                modality = BiometricReferenceCreationEvent.BiometricReferenceModality.FACE,
+                captureIds = captureIds,
+            ),
+        )
+    }
 }

face/capture/src/test/java/com/simprints/face/capture/screens/FaceCaptureViewModelTest.kt

@@ -122,6 +122,15 @@ class FaceCaptureViewModelTest {
         coVerify(atLeast = 1) { faceImageUseCase.invoke(any(), any()) }
     }
 
+    @Test
+    fun `Save biometric reference creation when flow finishes`() {
+        viewModel.captureFinished(faceDetections)
+        viewModel.flowFinished()
+        coVerify(atLeast = 1) {
+            eventReporter.addBiometricReferenceCreationEvents(any(), any())
+        }
+    }
+
     @Test
     fun `Recapture requests clears capture list`() {
         viewModel.captureFinished(faceDetections)

face/capture/src/test/java/com/simprints/face/capture/usecases/SimpleCaptureEventReporterTest.kt

@@ -7,6 +7,8 @@ import com.simprints.core.tools.time.Timestamp
 import com.simprints.core.tools.utils.EncodingUtils
 import com.simprints.face.capture.models.FaceDetection
 import com.simprints.face.infra.basebiosdk.detection.Face
+import com.simprints.infra.events.event.domain.models.BiometricReferenceCreationEvent
+import com.simprints.infra.events.event.domain.models.BiometricReferenceCreationEvent.BiometricReferenceCreationPayload
 import com.simprints.infra.events.event.domain.models.face.FaceCaptureBiometricsEvent
 import com.simprints.infra.events.event.domain.models.face.FaceCaptureConfirmationEvent
 import com.simprints.infra.events.event.domain.models.face.FaceCaptureEvent
@@ -73,8 +75,9 @@ class SimpleCaptureEventReporterTest {
             eventRepository.addOrUpdateEvent(
                 withArg {
                     assertThat(it).isInstanceOf(FaceCaptureConfirmationEvent::class.java)
-                    assertThat((it.payload as FaceCaptureConfirmationEvent.FaceCaptureConfirmationPayload).result)
-                        .isEqualTo(FaceCaptureConfirmationEvent.FaceCaptureConfirmationPayload.Result.CONTINUE)
+                    assertThat((it.payload as FaceCaptureConfirmationEvent.FaceCaptureConfirmationPayload).result).isEqualTo(
+                        FaceCaptureConfirmationEvent.FaceCaptureConfirmationPayload.Result.CONTINUE,
+                    )
                 },
             )
         }
@@ -87,8 +90,9 @@ class SimpleCaptureEventReporterTest {
             eventRepository.addOrUpdateEvent(
                 withArg {
                     assertThat(it).isInstanceOf(FaceCaptureConfirmationEvent::class.java)
-                    assertThat((it.payload as FaceCaptureConfirmationEvent.FaceCaptureConfirmationPayload).result)
-                        .isEqualTo(FaceCaptureConfirmationEvent.FaceCaptureConfirmationPayload.Result.RECAPTURE)
+                    assertThat((it.payload as FaceCaptureConfirmationEvent.FaceCaptureConfirmationPayload).result).isEqualTo(
+                        FaceCaptureConfirmationEvent.FaceCaptureConfirmationPayload.Result.RECAPTURE,
+                    )
                 },
             )
         }
@@ -182,6 +186,20 @@ class SimpleCaptureEventReporterTest {
         }
     }
 
+    @Test
+    fun `Adds reference creation event`() = runTest {
+        reporter.addBiometricReferenceCreationEvents("id", listOf("id1", "id2", "id3"))
+        coVerify {
+            eventRepository.addOrUpdateEvent(
+                withArg {
+                    assertThat(it).isInstanceOf(BiometricReferenceCreationEvent::class.java)
+                    assertThat((it.payload as BiometricReferenceCreationPayload).modality)
+                        .isEqualTo(BiometricReferenceCreationEvent.BiometricReferenceModality.FACE)
+                },
+            )
+        }
+    }
+
     private fun getDetection(status: FaceDetection.Status) =
         FaceDetection(mockk(), getFace(), status, mockk(), Timestamp(1L), false, "id", Timestamp(1L))
 

feature/enrol-last-biometric/src/main/java/com/simprints/feature/enrollast/EnrolLastBiometricParams.kt

@@ -39,12 +39,14 @@ sealed class EnrolLastBiometricStepResult : Parcelable {
     @Keep
     @Parcelize
     data class FingerprintCaptureResult(
+        val referenceId: String,
         val results: List<FingerTemplateCaptureResult>,
     ) : EnrolLastBiometricStepResult()
 
     @Keep
     @Parcelize
     data class FaceCaptureResult(
+        val referenceId: String,
         val results: List<FaceTemplateCaptureResult>,
     ) : EnrolLastBiometricStepResult()
 }

feature/enrol-last-biometric/src/main/java/com/simprints/feature/enrollast/screen/EnrolLastBiometricViewModel.kt

@@ -17,8 +17,8 @@ import com.simprints.infra.config.sync.ConfigManager
 import com.simprints.infra.enrolment.records.repository.EnrolmentRecordRepository
 import com.simprints.infra.enrolment.records.repository.domain.models.Subject
 import com.simprints.infra.enrolment.records.repository.domain.models.SubjectAction
-import com.simprints.infra.events.event.domain.models.EnrolmentEventV2
-import com.simprints.infra.events.event.domain.models.PersonCreationEvent
+import com.simprints.infra.events.event.domain.models.BiometricReferenceCreationEvent
+import com.simprints.infra.events.event.domain.models.EnrolmentEventV4
 import com.simprints.infra.events.session.SessionEventRepository
 import com.simprints.infra.logging.LoggingConstants.CrashReportTag.ENROLMENT
 import com.simprints.infra.logging.Simber
@@ -85,20 +85,20 @@ internal class EnrolLastBiometricViewModel @Inject constructor(
     private suspend fun registerEvent(subject: Subject) {
         Simber.d("Register events for enrolments", tag = ENROLMENT)
 
-        val personCreationEvent = eventRepository
+        val biometricReferenceIds = eventRepository
             .getEventsInCurrentSession()
-            .filterIsInstance<PersonCreationEvent>()
+            .filterIsInstance<BiometricReferenceCreationEvent>()
             .sortedByDescending { it.payload.createdAt }
-            .first()
+            .map { it.payload.id }
 
         eventRepository.addOrUpdateEvent(
-            EnrolmentEventV2(
+            EnrolmentEventV4(
                 timeHelper.now(),
                 subject.subjectId,
                 subject.projectId,
                 subject.moduleId,
                 subject.attendantId,
-                personCreationEvent.id,
+                biometricReferenceIds,
             ),
         )
     }

feature/enrol-last-biometric/src/main/java/com/simprints/feature/enrollast/screen/usecase/BuildSubjectUseCase.kt

@@ -26,26 +26,30 @@ internal class BuildSubjectUseCase @Inject constructor(
         params.moduleId,
         createdAt = Date(timeHelper.now().ms),
         fingerprintSamples = getFingerprintCaptureResult(params.steps)
-            ?.map(::fingerprintSample)
+            ?.let { result -> result.results.map { fingerprintSample(result.referenceId, it) } }
+            .orEmpty(),
+        faceSamples = getFaceCaptureResult(params.steps)
+            ?.let { result -> result.results.map { faceSample(result.referenceId, it) } }
             .orEmpty(),
-        faceSamples = getFaceCaptureResult(params.steps)?.map(::faceSample).orEmpty(),
     )
 
     private fun getFingerprintCaptureResult(steps: List<EnrolLastBiometricStepResult>) = steps
         .filterIsInstance<EnrolLastBiometricStepResult.FingerprintCaptureResult>()
         .firstOrNull()
-        ?.results
 
     private fun getFaceCaptureResult(steps: List<EnrolLastBiometricStepResult>) = steps
         .filterIsInstance<EnrolLastBiometricStepResult.FaceCaptureResult>()
         .firstOrNull()
-        ?.results
 
-    private fun fingerprintSample(it: FingerTemplateCaptureResult) = FingerprintSample(
-        fromDomainToModuleApi(it.finger),
-        it.template,
-        it.templateQualityScore,
-        it.format,
+    private fun fingerprintSample(
+        referenceId: String,
+        result: FingerTemplateCaptureResult,
+    ) = FingerprintSample(
+        fromDomainToModuleApi(result.finger),
+        result.template,
+        result.templateQualityScore,
+        result.format,
+        referenceId,
     )
 
     private fun fromDomainToModuleApi(finger: Finger) = when (finger) {
@@ -61,5 +65,8 @@ internal class BuildSubjectUseCase @Inject constructor(
         Finger.LEFT_5TH_FINGER -> IFingerIdentifier.LEFT_5TH_FINGER
     }
 
-    private fun faceSample(it: FaceTemplateCaptureResult) = FaceSample(it.template, it.format)
+    private fun faceSample(
+        referenceId: String,
+        result: FaceTemplateCaptureResult,
+    ) = FaceSample(result.template, result.format, referenceId)
 }

feature/enrol-last-biometric/src/test/java/com/simprints/feature/enrollast/screen/EnrolLastBiometricViewModelTest.kt

@@ -14,9 +14,10 @@ import com.simprints.infra.config.store.models.ProjectConfiguration
 import com.simprints.infra.config.sync.ConfigManager
 import com.simprints.infra.enrolment.records.repository.EnrolmentRecordRepository
 import com.simprints.infra.enrolment.records.repository.domain.models.Subject
-import com.simprints.infra.events.event.domain.models.EnrolmentEventV2
+import com.simprints.infra.events.event.domain.models.BiometricReferenceCreationEvent
+import com.simprints.infra.events.event.domain.models.BiometricReferenceCreationEvent.BiometricReferenceCreationPayload
+import com.simprints.infra.events.event.domain.models.EnrolmentEventV4
 import com.simprints.infra.events.event.domain.models.PersonCreationEvent
-import com.simprints.infra.events.event.domain.models.PersonCreationEvent.PersonCreationPayload
 import com.simprints.infra.events.session.SessionEventRepository
 import com.simprints.testtools.common.coroutines.TestCoroutineRule
 import io.mockk.MockKAnnotations
@@ -213,30 +214,36 @@ internal class EnrolLastBiometricViewModelTest {
     }
 
     @Test
-    fun `Uses latest PersonCreationEvent for Enrolment event`() = runTest {
-        val personCreationEvent1 = mockk<PersonCreationEvent> {
-            every { id } returns "personCreationEventId1"
-            every { payload } returns mockk<PersonCreationPayload> {
+    fun `Uses all BiometricReferenceCreationEvent for Enrolment event`() = runTest {
+        val biometricReferenceCreationEvent1 = mockk<BiometricReferenceCreationEvent> {
+            every { id } returns "biometricReferenceCreationEventId1"
+            every { payload } returns mockk<BiometricReferenceCreationPayload> {
                 every { createdAt } returns Timestamp(1)
+                every { id } returns "referenceId1"
             }
         }
-        val personCreationId2 = "personCreationEventId2"
-        val personCreationEvent2 = mockk<PersonCreationEvent> {
-            every { id } returns personCreationId2
-            every { payload } returns mockk<PersonCreationPayload> {
+        val biometricReferenceCreationEvent2 = mockk<BiometricReferenceCreationEvent> {
+            every { id } returns "biometricReferenceCreationEventId2"
+            every { payload } returns mockk<BiometricReferenceCreationPayload> {
                 every { createdAt } returns Timestamp(2)
+                every { id } returns "referenceId2"
             }
         }
+
         coEvery { eventRepository.getEventsInCurrentSession() } returns listOf(
-            personCreationEvent1,
-            personCreationEvent2,
+            biometricReferenceCreationEvent2,
+            biometricReferenceCreationEvent1,
         )
 
         viewModel.enrolBiometric(createParams(listOf()))
 
         coVerify {
             eventRepository.addOrUpdateEvent(
-                match { it is EnrolmentEventV2 && it.payload.personCreationEventId == personCreationId2 },
+                withArg {
+                    assertThat(it).isInstanceOf(EnrolmentEventV4::class.java)
+                    assertThat((it.payload as EnrolmentEventV4.EnrolmentPayload).biometricReferenceIds)
+                        .containsExactly("referenceId1", "referenceId2")
+                },
             )
         }
     }

feature/enrol-last-biometric/src/test/java/com/simprints/feature/enrollast/screen/usecase/BuildSubjectUseCaseTest.kt

@@ -68,8 +68,14 @@ class BuildSubjectUseCaseTest {
             createParams(
                 listOf(
                     EnrolLastBiometricStepResult.FingerprintMatchResult(emptyList(), mockk()),
-                    EnrolLastBiometricStepResult.FingerprintCaptureResult(listOf(mockFingerprintResults(Finger.RIGHT_THUMB))),
-                    EnrolLastBiometricStepResult.FingerprintCaptureResult(listOf(mockFingerprintResults(Finger.LEFT_THUMB))),
+                    EnrolLastBiometricStepResult.FingerprintCaptureResult(
+                        REFERENCE_ID,
+                        listOf(mockFingerprintResults(Finger.RIGHT_THUMB)),
+                    ),
+                    EnrolLastBiometricStepResult.FingerprintCaptureResult(
+                        REFERENCE_ID,
+                        listOf(mockFingerprintResults(Finger.LEFT_THUMB)),
+                    ),
                 ),
             ),
         )
@@ -84,6 +90,7 @@ class BuildSubjectUseCaseTest {
             createParams(
                 listOf(
                     EnrolLastBiometricStepResult.FingerprintCaptureResult(
+                        REFERENCE_ID,
                         listOf(
                             mockFingerprintResults(Finger.RIGHT_5TH_FINGER),
                             mockFingerprintResults(Finger.RIGHT_4TH_FINGER),
@@ -111,8 +118,8 @@ class BuildSubjectUseCaseTest {
             createParams(
                 listOf(
                     EnrolLastBiometricStepResult.FaceMatchResult(emptyList()),
-                    EnrolLastBiometricStepResult.FaceCaptureResult(mockFaceResultsList("first")),
-                    EnrolLastBiometricStepResult.FaceCaptureResult(mockFaceResultsList("second")),
+                    EnrolLastBiometricStepResult.FaceCaptureResult(REFERENCE_ID, mockFaceResultsList("first")),
+                    EnrolLastBiometricStepResult.FaceCaptureResult(REFERENCE_ID, mockFaceResultsList("second")),
                 ),
             ),
         )
@@ -133,6 +140,8 @@ class BuildSubjectUseCaseTest {
     private fun mockFaceResultsList(format: String) = listOf(FaceTemplateCaptureResult(byteArrayOf(), format))
 
     companion object {
+        private const val REFERENCE_ID = "referenceId"
+
         private const val PROJECT_ID = "projectId"
         private val USER_ID = "userId".asTokenizableRaw()
         private val MODULE_ID = "moduleId".asTokenizableRaw()

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

@@ -10,11 +10,10 @@ internal class StartBackgroundSyncUseCase @Inject constructor(
     private val configManager: ConfigManager,
 ) {
     suspend operator fun invoke() {
-        syncOrchestrator.scheduleBackgroundWork()
-
         val frequency = configManager.getProjectConfiguration().synchronization.frequency
-        if (frequency == SynchronizationConfiguration.Frequency.PERIODICALLY_AND_ON_SESSION_START) {
-            syncOrchestrator.startEventSync()
-        }
+
+        syncOrchestrator.scheduleBackgroundWork(
+            withDelay = frequency != SynchronizationConfiguration.Frequency.PERIODICALLY_AND_ON_SESSION_START,
+        )
     }
 }

feature/login-check/src/test/java/com/simprints/feature/logincheck/usecases/StartBackgroundSyncUseCaseTest.kt

@@ -7,7 +7,6 @@ import io.mockk.MockKAnnotations
 import io.mockk.coEvery
 import io.mockk.coVerify
 import io.mockk.impl.annotations.MockK
-import io.mockk.verify
 import kotlinx.coroutines.test.runTest
 import org.junit.Before
 import org.junit.Test
@@ -38,9 +37,7 @@ class StartBackgroundSyncUseCaseTest {
 
         useCase.invoke()
 
-        coVerify {
-            syncOrchestrator.scheduleBackgroundWork()
-        }
+        coVerify { syncOrchestrator.scheduleBackgroundWork(any()) }
     }
 
     @Test
@@ -50,7 +47,7 @@ class StartBackgroundSyncUseCaseTest {
 
         useCase.invoke()
 
-        verify { syncOrchestrator.startEventSync() }
+        coVerify { syncOrchestrator.scheduleBackgroundWork(eq(false)) }
     }
 
     @Test
@@ -60,6 +57,6 @@ class StartBackgroundSyncUseCaseTest {
 
         useCase.invoke()
 
-        verify(exactly = 0) { syncOrchestrator.startEventSync() }
+        coVerify { syncOrchestrator.scheduleBackgroundWork(eq(true)) }
     }
 }