[MS-1346] Identification response now contains scanned external credential data

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

@@ -148,6 +148,7 @@ class ClientApiViewModel @Inject internal constructor(
                     sessionId = currentSessionId,
                     identifications = identifyResponse.identifications,
                     isMultiFactorIdEnabled = identifyResponse.isMultiFactorIdEnabled,
+                    scannedCredential = identifyResponse.scannedCredential,
                 ),
             ),
         )

feature/client-api/src/main/java/com/simprints/feature/clientapi/mappers/response/LibSimprintsResponseMapper.kt

@@ -73,7 +73,7 @@ internal class LibSimprintsResponseMapper @Inject constructor(
                         .toJson(),
                 )
             }
-        }
+        }.appendExternalCredential(response.scannedCredential.takeIf { response.isMultiFactorIdEnabled })
 
         is ActionResponse.ConfirmActionResponse -> {
             bundleOf(

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

@@ -177,6 +177,7 @@ internal class ClientApiViewModelTest {
             mockk {
                 every { identifications } returns emptyList()
                 every { isMultiFactorIdEnabled } returns false
+                every { scannedCredential } returns null
             },
         )
 

feature/client-api/src/test/java/com/simprints/feature/clientapi/mappers/response/CommCareResponseMapperTest.kt

@@ -61,6 +61,7 @@ class CommCareResponseMapperTest {
                     ),
                 ),
                 isMultiFactorIdEnabled = false,
+                scannedCredential = null,
             ),
         )
 

feature/client-api/src/test/java/com/simprints/feature/clientapi/mappers/response/LibSimprintsResponseMapperTest.kt

@@ -1,5 +1,6 @@
 package com.simprints.feature.clientapi.mappers.response
 
+import android.os.Bundle
 import androidx.test.ext.junit.runners.*
 import com.google.common.truth.Truth.*
 import com.simprints.core.domain.externalcredential.ExternalCredentialType
@@ -16,6 +17,7 @@ import com.simprints.feature.clientapi.mappers.response.LibSimprintsResponseMapp
 import com.simprints.feature.clientapi.mappers.response.LibSimprintsResponseMapper.Companion.SCANNED_CREDENTIAL_TYPE
 import com.simprints.feature.clientapi.mappers.response.LibSimprintsResponseMapper.Companion.SCANNED_CREDENTIAL_VALUE
 import com.simprints.infra.orchestration.data.ActionResponse
+import com.simprints.infra.orchestration.data.responses.AppExternalCredential
 import com.simprints.infra.orchestration.data.responses.AppMatchResult
 import com.simprints.libsimprints.Constants
 import com.simprints.libsimprints.contracts.VersionsList
@@ -93,6 +95,7 @@ class LibSimprintsResponseMapperTest {
                     ),
                 ),
                 isMultiFactorIdEnabled = false,
+                scannedCredential = null,
             ),
         )
 
@@ -121,6 +124,7 @@ class LibSimprintsResponseMapperTest {
                     ),
                 ),
                 isMultiFactorIdEnabled = false,
+                scannedCredential = null,
             ),
         )
 
@@ -469,6 +473,7 @@ class LibSimprintsResponseMapperTest {
                 sessionId = "sessionId",
                 identifications = listOf(identification1, identification2),
                 isMultiFactorIdEnabled = true,
+                scannedCredential = null,
             ),
         )
 
@@ -496,6 +501,7 @@ class LibSimprintsResponseMapperTest {
                     ),
                 ),
                 isMultiFactorIdEnabled = true,
+                scannedCredential = null,
             ),
         )
 
@@ -523,6 +529,7 @@ class LibSimprintsResponseMapperTest {
                     ),
                 ),
                 isMultiFactorIdEnabled = false,
+                scannedCredential = null,
             ),
         )
 
@@ -531,6 +538,76 @@ class LibSimprintsResponseMapperTest {
         )
     }
 
+    @Test
+    fun `when MFID is enabled, identify response contains scanned credential`() {
+        val expectedValue = "expectedValue".asTokenizableRaw()
+        val expectedType = ExternalCredentialType.NHISCard
+        val expectedJson = "{\"$SCANNED_CREDENTIAL_VALUE\":\"$expectedValue\",\"$SCANNED_CREDENTIAL_TYPE\":\"$expectedType\"}"
+        val scannedCredential = mockk<AppExternalCredential> {
+            every { value } returns expectedValue
+            every { type } returns expectedType
+        }
+
+        val extras = mapper(
+            createIdentifyActionResponse(
+                isMultiFactorIdEnabled = true,
+                scannedCredential = scannedCredential,
+            ),
+        )
+
+        assertCommonMfidIdentifyFields(extras)
+        assertThat(extras.getString(SCANNED_CREDENTIAL)).isEqualTo(expectedJson)
+    }
+
+    @Test
+    fun `when MFID is disabled, identify response does not contain credential`() {
+        val expectedValue = "expectedValue".asTokenizableRaw()
+        val expectedType = ExternalCredentialType.NHISCard
+        val scannedCredential = mockk<AppExternalCredential> {
+            every { value } returns expectedValue
+            every { type } returns expectedType
+        }
+
+        val extras = mapper(
+            createIdentifyActionResponse(
+                isMultiFactorIdEnabled = false,
+                scannedCredential = scannedCredential,
+            ),
+        )
+
+        assertCommonMfidIdentifyFields(extras)
+        assertThat(extras.keySet()).doesNotContain(SCANNED_CREDENTIAL)
+    }
+
+    // Helper functions
+    private fun createIdentifyActionResponse(
+        sessionId: String = "sessionId",
+        isMultiFactorIdEnabled: Boolean,
+        scannedCredential: AppExternalCredential? = null,
+        identifications: List<AppMatchResult> = listOf(
+            AppMatchResult(
+                guid = "guid-1",
+                confidenceScore = 100,
+                matchConfidence = AppMatchConfidence.MEDIUM,
+                isLinkedToScannedCredential = true,
+                isCredentialVerified = true,
+            ),
+        ),
+    ) = ActionResponse.IdentifyActionResponse(
+        actionIdentifier = IdentifyRequestActionFactory.getIdentifier(),
+        sessionId = sessionId,
+        identifications = identifications,
+        isMultiFactorIdEnabled = isMultiFactorIdEnabled,
+        scannedCredential = scannedCredential,
+    )
+
+    private fun assertCommonMfidIdentifyFields(extras: Bundle) {
+        assertThat(extras.getString(Constants.SIMPRINTS_SESSION_ID)).isEqualTo("sessionId")
+        assertThat(extras.getString(Constants.SIMPRINTS_DEVICE_ID)).isEqualTo("deviceId")
+        assertThat(extras.getString(Constants.SIMPRINTS_APP_VERSION_NAME)).isEqualTo("appVersionName")
+        assertThat(extras.getBoolean(Constants.SIMPRINTS_BIOMETRICS_COMPLETE_CHECK)).isTrue()
+    }
+
     private fun AppMatchResult.toResponseJson(): String {
         val jsonBuilder = StringBuilder()
         jsonBuilder.append("{\"guid\":\"$guid\"")

feature/client-api/src/test/java/com/simprints/feature/clientapi/mappers/response/OdkResponseMapperTest.kt

@@ -55,6 +55,7 @@ class OdkResponseMapperTest {
                     ),
                 ),
                 isMultiFactorIdEnabled = false,
+                scannedCredential = null,
             ),
         )
 
@@ -75,6 +76,7 @@ class OdkResponseMapperTest {
                 sessionId = "sessionId",
                 identifications = listOf(),
                 isMultiFactorIdEnabled = false,
+                scannedCredential = null,
             ),
         )
 

feature/orchestrator/src/main/java/com/simprints/feature/orchestrator/usecases/MapRefusalOrErrorResultUseCase.kt

@@ -59,7 +59,14 @@ internal class MapRefusalOrErrorResultUseCase @Inject constructor(
         is ValidateSubjectPoolResult ->
             result
                 .takeUnless { it.isValid }
-                ?.let { AppIdentifyResponse(emptyList(), eventRepository.getCurrentSessionScope().id, isMultiFactorIdEnabled = false) }
+                ?.let {
+                    AppIdentifyResponse(
+                        identifications = emptyList(),
+                        sessionId = eventRepository.getCurrentSessionScope().id,
+                        isMultiFactorIdEnabled = false,
+                        scannedCredential = null,
+                    )
+                }
 
         is SelectSubjectAgeGroupResult ->
             result

feature/orchestrator/src/main/java/com/simprints/feature/orchestrator/usecases/response/CreateIdentifyResponseUseCase.kt

@@ -1,12 +1,14 @@
 package com.simprints.feature.orchestrator.usecases.response
 
 import com.simprints.feature.externalcredential.ExternalCredentialSearchResult
+import com.simprints.feature.externalcredential.screens.search.model.ScannedCredential
 import com.simprints.infra.config.store.models.DecisionPolicy
 import com.simprints.infra.config.store.models.ProjectConfiguration
 import com.simprints.infra.events.session.SessionEventRepository
 import com.simprints.infra.matching.FaceMatchResult
 import com.simprints.infra.matching.FingerprintMatchResult
 import com.simprints.infra.matching.MatchResultItem
+import com.simprints.infra.orchestration.data.responses.AppExternalCredential
 import com.simprints.infra.orchestration.data.responses.AppIdentifyResponse
 import com.simprints.infra.orchestration.data.responses.AppMatchResult
 import com.simprints.infra.orchestration.data.responses.AppResponse
@@ -45,10 +47,25 @@ internal class CreateIdentifyResponseUseCase @Inject constructor(
             .distinctBy(AppMatchResult::guid)
             .take(projectConfiguration.identification.maxNbOfReturnedCandidates)
 
+        val externalCredential = results
+            .filterIsInstance(ExternalCredentialSearchResult::class.java)
+            .lastOrNull()
+            ?.scannedCredential
+            .toAppExternalCredential()
+
         return AppIdentifyResponse(
             sessionId = currentSessionId,
             isMultiFactorIdEnabled = isMultiFactorIdEnabled,
             identifications = identifications,
+            scannedCredential = externalCredential,
+        )
+    }
+
+    private fun ScannedCredential?.toAppExternalCredential(): AppExternalCredential? = this?.let { scannedCredential ->
+        AppExternalCredential(
+            id = scannedCredential.credentialScanId,
+            value = scannedCredential.scannedValue,
+            type = scannedCredential.credentialType,
         )
     }
 

feature/orchestrator/src/test/java/com/simprints/feature/orchestrator/usecases/AddCallbackEventUseCaseTest.kt

@@ -71,6 +71,7 @@ class AddCallbackEventUseCaseTest {
                 listOf(AppMatchResult("guid", 0, AppMatchConfidence.HIGH)),
                 "sessionId",
                 isMultiFactorIdEnabled = false,
+                scannedCredential = null,
             ),
         )
 

feature/orchestrator/src/test/java/com/simprints/feature/orchestrator/usecases/UpdateDailyActivityUseCaseTest.kt

@@ -59,7 +59,7 @@ class UpdateDailyActivityUseCaseTest {
 
     @Test
     fun `Update daily activity on identify response`() = runTest {
-        useCase(AppIdentifyResponse(emptyList(), "guid", isMultiFactorIdEnabled = false))
+        useCase(AppIdentifyResponse(emptyList(), "guid", isMultiFactorIdEnabled = false, scannedCredential = null))
 
         coVerify { recentUserActivityManager.updateRecentUserActivity(any()) }
     }

feature/orchestrator/src/test/java/com/simprints/feature/orchestrator/usecases/response/CreateIdentifyResponseUseCaseTest.kt

@@ -259,6 +259,7 @@ class CreateIdentifyResponseUseCaseTest {
             results = listOf(
                 mockk<ExternalCredentialSearchResult> {
                     every { matchResults } returns fingerprintMatches + faceMatches
+                    every { scannedCredential } returns null
                 },
             ),
         )
@@ -304,6 +305,7 @@ class CreateIdentifyResponseUseCaseTest {
             results = listOf(
                 mockk<ExternalCredentialSearchResult> {
                     every { matchResults } returns credentialFaceMatches
+                    every { scannedCredential } returns null
                 },
                 FaceMatchResult(
                     listOf(
@@ -355,6 +357,7 @@ class CreateIdentifyResponseUseCaseTest {
             results = listOf(
                 mockk<ExternalCredentialSearchResult> {
                     every { matchResults } returns credentialFingerprintMatches
+                    every { scannedCredential } returns null
                 },
                 FingerprintMatchResult(
                     listOf(
@@ -430,6 +433,7 @@ class CreateIdentifyResponseUseCaseTest {
             results = listOf(
                 mockk<ExternalCredentialSearchResult> {
                     every { matchResults } returns credentialFaceMatches
+                    every { scannedCredential } returns null
                 },
                 faceMatchResults,
             ),

infra/orchestrator-data/src/main/java/com/simprints/infra/orchestration/data/ActionResponse.kt

@@ -25,6 +25,7 @@ sealed class ActionResponse(
         override val sessionId: String,
         val identifications: List<AppMatchResult>,
         val isMultiFactorIdEnabled: Boolean,
+        val scannedCredential: AppExternalCredential?,
     ) : ActionResponse(actionIdentifier, sessionId)
 
     @ExcludedFromGeneratedTestCoverageReports("Data struct")

infra/orchestrator-data/src/main/java/com/simprints/infra/orchestration/data/responses/AppIdentifyResponse.kt

@@ -11,4 +11,5 @@ data class AppIdentifyResponse(
     val identifications: List<AppMatchResult>,
     val sessionId: String,
     val isMultiFactorIdEnabled: Boolean,
+    val scannedCredential: AppExternalCredential?,
 ) : AppResponse()