[CORE-3421] Multi-Factor ID Sync implementation

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

@@ -47,11 +47,13 @@ internal class GetEnrolmentCreationEventForSubjectUseCase @Inject constructor(
     }
 
     private fun Subject.fromSubjectToEnrolmentCreationEvent() = EnrolmentRecordCreationEvent(
-        subjectId,
-        projectId,
-        moduleId,
-        attendantId,
-        EnrolmentRecordCreationEvent.buildBiometricReferences(fingerprintSamples, faceSamples, encoder),
+        subjectId = subjectId,
+        projectId = projectId,
+        moduleId = moduleId,
+        attendantId = attendantId,
+        biometricReferences = EnrolmentRecordCreationEvent.buildBiometricReferences(fingerprintSamples, faceSamples, encoder),
+        // TODO [CORE-3421] Review if EnrolmentRecordCreationEvent should contain List of external credentials, as it currently doesn't make sense
+        externalCredentials = externalCredentials
     )
 
     companion object {

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

@@ -1,5 +1,6 @@
 package com.simprints.feature.enrollast.screen.usecase
 
+import com.simprints.core.domain.externalcredential.ExternalCredential
 import com.simprints.core.domain.face.FaceSample
 import com.simprints.core.domain.fingerprint.FingerprintSample
 import com.simprints.core.domain.fingerprint.IFingerIdentifier
@@ -31,8 +32,14 @@ internal class BuildSubjectUseCase @Inject constructor(
         faceSamples = getFaceCaptureResult(params.steps)
             ?.let { result -> result.results.map { faceSample(result.referenceId, it) } }
             .orEmpty(),
+        externalCredentials = getExternalCredentialResult(params.steps)?.let { listOf(it) } ?: emptyList()
     )
 
+    // TODO [CORE-3421] When an external credential can be extracted from the UI-level steps, extract it here
+    private fun getExternalCredentialResult(steps: List<EnrolLastBiometricStepResult>): ExternalCredential? {
+        return null
+    }
+
     private fun getFingerprintCaptureResult(steps: List<EnrolLastBiometricStepResult>) = steps
         .filterIsInstance<EnrolLastBiometricStepResult.FingerprintCaptureResult>()
         .firstOrNull()

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

@@ -1,5 +1,6 @@
 package com.simprints.feature.orchestrator.usecases.response
 
+import com.simprints.core.domain.externalcredential.ExternalCredential
 import com.simprints.core.domain.response.AppErrorReason
 import com.simprints.face.capture.FaceCaptureResult
 import com.simprints.fingerprint.capture.FingerprintCaptureResult
@@ -25,6 +26,8 @@ internal class CreateEnrolResponseUseCase @Inject constructor(
     ): AppResponse {
         val fingerprintCapture = results.filterIsInstance(FingerprintCaptureResult::class.java).lastOrNull()
         val faceCapture = results.filterIsInstance(FaceCaptureResult::class.java).lastOrNull()
+        // TODO [CORE-3421] When an external credential can be extracted from the UI-level steps, extract it here
+        val externalCredential: ExternalCredential? = null
 
         return try {
             val subject = subjectFactory.buildSubjectFromCaptureResults(
@@ -33,6 +36,7 @@ internal class CreateEnrolResponseUseCase @Inject constructor(
                 moduleId = request.moduleId,
                 fingerprintResponse = fingerprintCapture,
                 faceResponse = faceCapture,
+                externalCredential = externalCredential,
             )
             enrolSubject(subject, project)
 

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

@@ -49,7 +49,14 @@ internal class CreateEnrolResponseUseCaseTest {
     @Test
     fun `Converts correct results to response`() = runTest {
         every {
-            subjectFactory.buildSubjectFromCaptureResults(any(), any(), any(), any(), any())
+            subjectFactory.buildSubjectFromCaptureResults(
+                projectId = any(),
+                attendantId = any(),
+                moduleId = any(),
+                fingerprintResponse = any(),
+                faceResponse = any(),
+                externalCredential = any()
+            )
         } returns mockk { every { subjectId } returns "guid" }
 
         assertThat(
@@ -68,7 +75,14 @@ internal class CreateEnrolResponseUseCaseTest {
     @Test
     fun `Returns error if no valid response`() = runTest {
         every {
-            subjectFactory.buildSubjectFromCaptureResults(any(), any(), any(), null, null)
+            subjectFactory.buildSubjectFromCaptureResults(
+                projectId = any(),
+                attendantId = any(),
+                moduleId = any(),
+                fingerprintResponse = null,
+                faceResponse = null,
+                externalCredential = null
+            )
         } throws MissingCaptureException()
 
         assertThat(useCase(action, emptyList(), project)).isInstanceOf(AppErrorResponse::class.java)

infra/auth-logic/src/test/java/com/simprints/infra/authlogic/authenticator/ProjectAuthenticatorTest.kt

@@ -164,9 +164,9 @@ class ProjectAuthenticatorTest {
         } returns Token("", "", "", "")
 
         coEvery { configManager.getProjectConfiguration() } returns ProjectConfiguration(
-            "id",
-            PROJECT_ID,
-            "",
+            id = "id",
+            projectId = PROJECT_ID,
+            updatedAt = "",
             general = GeneralConfiguration(
                 modalities = mockk(),
                 matchingModalities = mockk(),
@@ -176,12 +176,13 @@ class ProjectAuthenticatorTest {
                 duplicateBiometricEnrolmentCheck = false,
                 settingsPassword = mockk(),
             ),
-            mockk(),
-            mockk(),
-            mockk(),
-            mockk(),
-            mockk(),
-            mockk(),
+            face = mockk(),
+            fingerprint = mockk(),
+            consent = mockk(),
+            identification = mockk(),
+            synchronization = mockk(),
+            multifactorId = mockk(),
+            custom = mockk(),
         )
         coEvery { configManager.getPrivacyNotice(any(), any()) } returns emptyFlow()
 

infra/auth-logic/src/test/java/com/simprints/infra/authlogic/authenticator/SignerManagerTest.kt

@@ -227,16 +227,17 @@ internal class SignerManagerTest {
                         tokenizationKeys = emptyMap(),
                     ),
                     ProjectConfiguration(
-                        "id",
-                        DEFAULT_PROJECT_ID,
-                        "",
-                        mockk(),
-                        mockk(),
-                        mockk(),
-                        mockk(),
-                        mockk(),
-                        mockk(),
-                        null,
+                        id = "id",
+                        projectId = DEFAULT_PROJECT_ID,
+                        updatedAt = "",
+                        general = mockk(),
+                        face = mockk(),
+                        fingerprint = mockk(),
+                        consent = mockk(),
+                        identification = mockk(),
+                        synchronization = mockk(),
+                        multifactorId = mockk(),
+                        custom = mockk(),
                     ),
                 ),
             )

infra/config-store/src/main/java/com/simprints/infra/config/store/local/ConfigLocalDataSourceImpl.kt

@@ -238,6 +238,7 @@ internal class ConfigLocalDataSourceImpl @Inject constructor(
                     ),
                 ),
                 custom = null,
+                multifactorId = null
             ).toProto()
         val defaultDeviceConfiguration: ProtoDeviceConfiguration = DeviceConfiguration(
             language = "",

infra/config-store/src/main/java/com/simprints/infra/config/store/local/migrations/models/OldProjectConfig.kt

@@ -75,6 +75,7 @@ internal data class OldProjectConfig(
         consent = consentConfiguration(),
         identification = identificationConfiguration(),
         synchronization = synchronizationConfiguration(),
+        multifactorId = null,
         custom = null,
     )
 

infra/config-store/src/main/java/com/simprints/infra/config/store/local/models/ExternalCredentialType.kt

@@ -0,0 +1,18 @@
+package com.simprints.infra.config.store.local.models
+
+import com.simprints.core.domain.externalcredential.ExternalCredentialType
+import com.simprints.infra.config.store.exceptions.InvalidProtobufEnumException
+
+internal fun ExternalCredentialType.toProto(): ProtoExternalCredentialType = when(this){
+    ExternalCredentialType.NHISCard -> ProtoExternalCredentialType.NHIS_CARD
+    ExternalCredentialType.GhanaIdCard -> ProtoExternalCredentialType.GHANA_ID_CARD
+    ExternalCredentialType.QRCode -> ProtoExternalCredentialType.QR_CODE
+}
+
+internal fun ProtoExternalCredentialType.toDomain(): ExternalCredentialType = when(this){
+    ProtoExternalCredentialType.UNRECOGNIZED,
+    ProtoExternalCredentialType.EXTERNAL_CREDENTIAL_TYPE_UNSPECIFIED -> throw InvalidProtobufEnumException("invalid External credential $name")
+    ProtoExternalCredentialType.NHIS_CARD -> ExternalCredentialType.NHISCard
+    ProtoExternalCredentialType.GHANA_ID_CARD -> ExternalCredentialType.GhanaIdCard
+    ProtoExternalCredentialType.QR_CODE -> ExternalCredentialType.QRCode
+}

infra/config-store/src/main/java/com/simprints/infra/config/store/local/models/MutliFactorIdConfiguration.kt

@@ -0,0 +1,12 @@
+package com.simprints.infra.config.store.local.models
+
+import com.simprints.infra.config.store.models.MultiFactorIdConfiguration
+
+internal fun MultiFactorIdConfiguration.toProto(): ProtoMultiFactorIdConfiguration = ProtoMultiFactorIdConfiguration
+    .newBuilder()
+    .addAllAllowedExternalCredentials(allowedExternalCredentials.map { it.toProto() })
+    .build()
+
+internal fun ProtoMultiFactorIdConfiguration.toDomain(): MultiFactorIdConfiguration = MultiFactorIdConfiguration(
+    allowedExternalCredentials = allowedExternalCredentialsList.map { it.toDomain() }
+)

infra/config-store/src/main/java/com/simprints/infra/config/store/local/models/ProjectConfiguration.kt

@@ -15,6 +15,7 @@ internal fun ProjectConfiguration.toProto(): ProtoProjectConfiguration = ProtoPr
     .also {
         if (face != null) it.face = face.toProto()
         if (fingerprint != null) it.fingerprint = fingerprint.toProto()
+        if (multifactorId != null) it.multiFactorId = multifactorId.toProto()
     }.also {
         if (custom != null) {
             try {
@@ -28,16 +29,17 @@ internal fun ProjectConfiguration.toProto(): ProtoProjectConfiguration = ProtoPr
     }.build()
 
 internal fun ProtoProjectConfiguration.toDomain(): ProjectConfiguration = ProjectConfiguration(
-    id,
-    projectId,
-    updatedAt,
-    general.toDomain(),
-    hasFace().let { if (it) face.toDomain() else null },
-    hasFingerprint().let { if (it) fingerprint.toDomain() else null },
-    consent.toDomain(),
-    identification.toDomain(),
-    synchronization.toDomain(),
-    customJson?.takeIf { it.isNotBlank() }?.let {
+    id = id,
+    projectId = projectId,
+    updatedAt = updatedAt,
+    general = general.toDomain(),
+    face = hasFace().let { if (it) face.toDomain() else null },
+    fingerprint = hasFingerprint().let { if (it) fingerprint.toDomain() else null },
+    consent = consent.toDomain(),
+    identification = identification.toDomain(),
+    synchronization = synchronization.toDomain(),
+    multifactorId = multiFactorId?.toDomain(),
+    custom = customJson?.takeIf { it.isNotBlank() }?.let {
         try {
             JsonHelper.fromJson(it)
         } catch (_: Exception) {

infra/config-store/src/main/java/com/simprints/infra/config/store/models/MultiFactorIdConfiguration.kt

@@ -0,0 +1,7 @@
+package com.simprints.infra.config.store.models
+
+import com.simprints.core.domain.externalcredential.ExternalCredentialType
+
+data class MultiFactorIdConfiguration(
+    val allowedExternalCredentials: List<ExternalCredentialType>
+)

infra/config-store/src/main/java/com/simprints/infra/config/store/models/Project.kt

@@ -14,5 +14,6 @@ data class Project(
 enum class TokenKeyType {
     AttendantId,
     ModuleId,
+    ExternalCredential,
     Unknown,
 }

infra/config-store/src/main/java/com/simprints/infra/config/store/models/ProjectConfiguration.kt

@@ -10,6 +10,7 @@ data class ProjectConfiguration(
     val consent: ConsentConfiguration,
     val identification: IdentificationConfiguration,
     val synchronization: SynchronizationConfiguration,
+    val multifactorId: MultiFactorIdConfiguration?,
     val custom: Map<String, Any>?,
 )
 

infra/config-store/src/main/java/com/simprints/infra/config/store/remote/models/ApiMultiFactorIdConfiguration.kt

@@ -0,0 +1,25 @@
+package com.simprints.infra.config.store.remote.models
+
+import androidx.annotation.Keep
+import com.simprints.core.domain.externalcredential.ExternalCredentialType
+import com.simprints.infra.config.store.models.MultiFactorIdConfiguration
+
+@Keep
+internal data class ApiMultiFactorIdConfiguration(
+    val allowedExternalCredentials: List<ApiExternalCredentialType>
+) {
+    fun toDomain(): MultiFactorIdConfiguration = MultiFactorIdConfiguration(
+        allowedExternalCredentials = allowedExternalCredentials.map { it.toDomain() }
+    )
+}
+
+@Keep
+enum class ApiExternalCredentialType {
+    NHISCard, GhanaIdCard, QRCode;
+
+    fun toDomain(): ExternalCredentialType = when (this) {
+        NHISCard -> ExternalCredentialType.NHISCard
+        GhanaIdCard -> ExternalCredentialType.GhanaIdCard
+        QRCode -> ExternalCredentialType.QRCode
+    }
+}

infra/config-store/src/main/java/com/simprints/infra/config/store/remote/models/ApiProjectConfiguration.kt

@@ -14,18 +14,20 @@ internal data class ApiProjectConfiguration(
     val consent: ApiConsentConfiguration,
     val identification: ApiIdentificationConfiguration,
     val synchronization: ApiSynchronizationConfiguration,
+    val multiFactorId: ApiMultiFactorIdConfiguration?,
     val custom: Map<String, Any>?,
 ) {
     fun toDomain(): ProjectConfiguration = ProjectConfiguration(
-        id,
-        projectId,
-        updatedAt,
-        general.toDomain(),
-        face?.toDomain(),
-        fingerprint?.toDomain(),
-        consent.toDomain(),
-        identification.toDomain(),
-        synchronization.toDomain(),
-        custom,
+        id = id,
+        projectId = projectId,
+        updatedAt = updatedAt,
+        general = general.toDomain(),
+        face = face?.toDomain(),
+        fingerprint = fingerprint?.toDomain(),
+        consent = consent.toDomain(),
+        identification = identification.toDomain(),
+        synchronization = synchronization.toDomain(),
+        multifactorId = multiFactorId?.toDomain(),
+        custom = custom,
     )
 }

infra/config-store/src/main/proto/project_config.proto

@@ -14,6 +14,18 @@ message ProtoProjectConfiguration {
     string updated_at = 8;
     optional string customJson = 9;
     string id = 10;
+    optional ProtoMultiFactorIdConfiguration multiFactorId = 11;
+}
+
+enum ProtoExternalCredentialType {
+    EXTERNAL_CREDENTIAL_TYPE_UNSPECIFIED = 0;
+    NHIS_CARD = 1;
+    GHANA_ID_CARD = 2;
+    QR_CODE = 3;
+}
+
+message ProtoMultiFactorIdConfiguration {
+    repeated ProtoExternalCredentialType allowed_external_credentials = 1;
 }
 
 message ProtoGeneralConfiguration {

infra/config-store/src/test/java/com/simprints/infra/config/store/local/ConfigLocalDataSourceImplTest.kt

@@ -17,6 +17,7 @@ import com.simprints.infra.config.store.testtools.consentConfiguration
 import com.simprints.infra.config.store.testtools.faceConfiguration
 import com.simprints.infra.config.store.testtools.generalConfiguration
 import com.simprints.infra.config.store.testtools.identificationConfiguration
+import com.simprints.infra.config.store.testtools.multiFactorIdConfiguration
 import com.simprints.infra.config.store.testtools.project
 import com.simprints.infra.config.store.testtools.projectConfiguration
 import com.simprints.infra.config.store.testtools.synchronizationConfiguration
@@ -173,16 +174,17 @@ class ConfigLocalDataSourceImplTest {
     fun `should save the project configuration and update the device configuration correctly with an empty list of fingersToCollect if fingerprint config is missing`() =
         runTest {
             val projectConfigurationToSave = ProjectConfiguration(
-                "id",
-                "projectId",
-                "updatedAt",
-                generalConfiguration,
-                faceConfiguration,
-                null,
-                consentConfiguration,
-                identificationConfiguration,
-                synchronizationConfiguration,
-                null,
+                id = "id",
+                projectId = "projectId",
+                updatedAt = "updatedAt",
+                general = generalConfiguration,
+                face = faceConfiguration,
+                fingerprint = null,
+                consent = consentConfiguration,
+                identification = identificationConfiguration,
+                synchronization = synchronizationConfiguration,
+                multifactorId = multiFactorIdConfiguration,
+                custom = null,
             )
 
             configLocalDataSourceImpl.saveProjectConfiguration(projectConfigurationToSave)