Skip to content

MS-1135 Combine per-modality duplication code #1466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
luhmirin-s merged 6 commits into from
Nov 20, 2025
Merged

MS-1135 Combine per-modality duplication code #1466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
095b95e
MS-1135 Simplify per-modality logic based on the configuration in orc…
luhmirin-s Sep 4, 2025
d228af3
MS-1135 Simplify the local record repo interface by combining methods
luhmirin-s Sep 10, 2025
38ebae0
MS-1135 Combine modality sample lists in the subject model
luhmirin-s Sep 29, 2025
17784e9
MS-1135 Combine probe lists in matcher params
luhmirin-s Oct 9, 2025
e04f020
MS-1135 Combine per-modality parameters in external credentials modul…
luhmirin-s Oct 16, 2025
f628d6d
MS-1135 Move AgeGroup to core domain
luhmirin-s Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...va/com/simprints/feature/clientapi/usecases/GetEnrolmentCreationEventForSubjectUseCase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ internal class GetEnrolmentCreationEventForSubjectUseCase @Inject constructor(
projectId = projectId,
moduleId = moduleId,
attendantId = attendantId,
biometricReferences = EnrolmentRecordCreationEvent.buildBiometricReferences(fingerprintSamples, faceSamples, encoder),
biometricReferences = EnrolmentRecordCreationEvent.buildBiometricReferences(samples, encoder),
externalCredentials = externalCredentials,
)

Expand Down
5 changes: 1 addition & 4 deletions ...etric/src/main/java/com/simprints/feature/enrollast/screen/usecase/BuildSubjectUseCase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package com.simprints.feature.enrollast.screen.usecase

import com.simprints.core.domain.common.Modality
import com.simprints.core.domain.sample.CaptureSample
import com.simprints.core.domain.sample.Sample
import com.simprints.core.tools.time.TimeHelper
Expand Down Expand Up @@ -31,16 +30,14 @@ internal class BuildSubjectUseCase @Inject constructor(
val captureResult = params.steps
.filterIsInstance<EnrolLastBiometricStepResult.CaptureResult>()
.flatMap { result -> result.results.map { toSample(result.referenceId, it) } }
.groupBy { it.modality }

return subjectFactory.buildSubject(
subjectId = subjectId,
projectId = params.projectId,
attendantId = params.userId,
moduleId = params.moduleId,
createdAt = Date(timeHelper.now().ms),
fingerprintSamples = captureResult[Modality.FINGERPRINT].orEmpty(),
faceSamples = captureResult[Modality.FACE].orEmpty(),
samples = captureResult,
externalCredentials = externalCredentials,
)
}
Expand Down
46 changes: 13 additions & 33 deletions ...java/com/simprints/feature/enrollast/screen/usecase/CheckForDuplicateEnrolmentsUseCase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@ package com.simprints.feature.enrollast.screen.usecase

import com.simprints.feature.enrollast.EnrolLastBiometricStepResult
import com.simprints.feature.enrollast.screen.EnrolLastState
import com.simprints.infra.config.store.models.FaceConfiguration
import com.simprints.infra.config.store.models.FingerprintConfiguration
import com.simprints.infra.config.store.models.ProjectConfiguration
import com.simprints.infra.config.store.models.getModalitySdkConfig
import com.simprints.infra.logging.LoggingConstants.CrashReportTag.ENROLMENT
import com.simprints.infra.logging.Simber
import javax.inject.Inject
Expand All @@ -15,12 +14,10 @@ internal class CheckForDuplicateEnrolmentsUseCase @Inject constructor() {
steps: List<EnrolLastBiometricStepResult>,
): EnrolLastState.ErrorType? {
if (!projectConfig.general.duplicateBiometricEnrolmentCheck) return null

val fingerprintResponse = getFingerprintMatchResult(steps)
val faceResponse = getFaceMatchResult(steps)
val matchResults = getFingerprintMatchResult(steps)

return when {
fingerprintResponse == null && faceResponse == null -> {
matchResults.isEmpty() -> {
Simber.e(
"No match response. Must be either fingerprint, face or both",
MissingMatchResultException(),
Expand All @@ -29,7 +26,7 @@ internal class CheckForDuplicateEnrolmentsUseCase @Inject constructor() {
EnrolLastState.ErrorType.NO_MATCH_RESULTS
}

isAnyResponseWithHighConfidence(projectConfig, fingerprintResponse, faceResponse) -> {
isAnyResponseWithHighConfidence(projectConfig, matchResults) -> {
Simber.i("There is a subject with confidence score above the high confidence level", tag = ENROLMENT)
EnrolLastState.ErrorType.DUPLICATE_ENROLMENTS
}
Expand All @@ -40,35 +37,18 @@ internal class CheckForDuplicateEnrolmentsUseCase @Inject constructor() {

private fun getFingerprintMatchResult(steps: List<EnrolLastBiometricStepResult>) = steps
.filterIsInstance<EnrolLastBiometricStepResult.MatchResult>()
.lastOrNull { it.sdk is FingerprintConfiguration.BioSdk }

private fun getFaceMatchResult(steps: List<EnrolLastBiometricStepResult>) = steps
.filterIsInstance<EnrolLastBiometricStepResult.MatchResult>()
.lastOrNull { it.sdk is FaceConfiguration.BioSdk }

private fun isAnyResponseWithHighConfidence(
configuration: ProjectConfiguration,
fingerprintResponse: EnrolLastBiometricStepResult.MatchResult?,
faceResponse: EnrolLastBiometricStepResult.MatchResult?,
): Boolean {
val fingerprintThreshold = fingerprintResponse?.let {
configuration.fingerprint
?.getSdkConfiguration(fingerprintResponse.sdk)
?.decisionPolicy
?.high
?.toFloat()
} ?: Float.MAX_VALUE

val faceThreshold = faceResponse?.let {
configuration.face
?.getSdkConfiguration(faceResponse.sdk)
?.decisionPolicy
?.high
?.toFloat()
} ?: Float.MAX_VALUE

return fingerprintResponse?.results?.any { it.confidence >= fingerprintThreshold } == true ||
faceResponse?.results?.any { it.confidence >= faceThreshold } == true
responses: List<EnrolLastBiometricStepResult.MatchResult>,
): Boolean = responses.any { result ->
val threshold = configuration
.getModalitySdkConfig(result.sdk)
?.decisionPolicy
?.high
?.toFloat() ?: Float.MAX_VALUE

result.results.any { it.confidence >= threshold }
}

private class MissingMatchResultException : IllegalStateException("No match response in duplicate check.")
Expand Down
18 changes: 8 additions & 10 deletions ...c/src/test/java/com/simprints/feature/enrollast/screen/usecase/BuildSubjectUseCaseTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ class BuildSubjectUseCaseTest {
fun `has no samples if no steps provided`() {
val result = useCase(createParams(steps = emptyList(), scannedCredential = scannedCredential), isAddingCredential = false)

assertThat(result.fingerprintSamples).isEmpty()
assertThat(result.faceSamples).isEmpty()
assertThat(result.samples).isEmpty()
}

@Test
Expand All @@ -63,8 +62,7 @@ class BuildSubjectUseCaseTest {
isAddingCredential = false,
)

assertThat(result.fingerprintSamples).isEmpty()
assertThat(result.faceSamples).isEmpty()
assertThat(result.samples).isEmpty()
}

@Test
Expand All @@ -87,8 +85,8 @@ class BuildSubjectUseCaseTest {
isAddingCredential = false,
)

assertThat(result.fingerprintSamples).isNotEmpty()
assertThat(result.fingerprintSamples.first().identifier).isEqualTo(SampleIdentifier.RIGHT_THUMB)
assertThat(result.samples).isNotEmpty()
assertThat(result.samples.first().identifier).isEqualTo(SampleIdentifier.RIGHT_THUMB)
}

@Test
Expand Down Expand Up @@ -117,8 +115,8 @@ class BuildSubjectUseCaseTest {
isAddingCredential = false,
)

assertThat(result.fingerprintSamples).isNotEmpty()
assertThat(result.fingerprintSamples.size).isEqualTo(10)
assertThat(result.samples).isNotEmpty()
assertThat(result.samples.size).isEqualTo(10)
}

@Test
Expand All @@ -135,8 +133,8 @@ class BuildSubjectUseCaseTest {
isAddingCredential = false,
)

assertThat(result.faceSamples).isNotEmpty()
assertThat(result.faceSamples.first().format).isEqualTo("first")
assertThat(result.samples).isNotEmpty()
assertThat(result.samples.first().format).isEqualTo("first")
}

@Test
Expand Down
6 changes: 4 additions & 2 deletions ...m/simprints/feature/enrollast/screen/usecase/CheckDuplicateEnrolmentsErrorsUseCaseTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,12 @@ class CheckDuplicateEnrolmentsErrorsUseCaseTest {
): ProjectConfiguration = mockk(relaxed = true) {
every { general.duplicateBiometricEnrolmentCheck } returns checkEnabled
// cannot mock Int? directly due to Java inter-op issues, so mocking decision policy instead
every { fingerprint?.getSdkConfiguration(any())?.decisionPolicy } returns highConfidence?.let {
every { fingerprint?.secugenSimMatcher?.decisionPolicy } returns highConfidence?.let {
DecisionPolicy(0, 0, it)
}
every { face?.rankOne?.decisionPolicy } returns highConfidence?.let {
DecisionPolicy(0, 0, it)
}
every { face?.getSdkConfiguration(any())?.decisionPolicy } returns highConfidence?.let { DecisionPolicy(0, 0, it) }
}

private fun matchResult(confidence: Float) = MatchComparisonResult("subjectId", confidence)
Expand Down
9 changes: 4 additions & 5 deletions ...tial/src/main/java/com/simprints/feature/externalcredential/ExternalCredentialContract.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
package com.simprints.feature.externalcredential

import com.simprints.core.ExcludedFromGeneratedTestCoverageReports
import com.simprints.core.domain.common.AgeGroup
import com.simprints.core.domain.common.FlowType
import com.simprints.core.domain.common.Modality
import com.simprints.core.domain.sample.CaptureSample
import com.simprints.feature.externalcredential.model.ExternalCredentialParams
import com.simprints.infra.config.store.models.AgeGroup

@ExcludedFromGeneratedTestCoverageReports("Navigation class")
object ExternalCredentialContract {
Expand All @@ -15,14 +16,12 @@ object ExternalCredentialContract {
flowType: FlowType,
ageGroup: AgeGroup?,
probeReferenceId: String? = null,
faceSamples: List<CaptureSample> = emptyList(),
fingerprintSamples: List<CaptureSample> = emptyList(),
samples: Map<Modality, List<CaptureSample>> = emptyMap(),
) = ExternalCredentialParams(
subjectId = subjectId,
flowType = flowType,
ageGroup = ageGroup,
probeReferenceId = probeReferenceId,
faceSamples = faceSamples,
fingerprintSamples = fingerprintSamples,
samples = samples,
)
}
6 changes: 2 additions & 4 deletions ...redential/src/main/java/com/simprints/feature/externalcredential/model/CredentialMatch.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,18 @@ package com.simprints.feature.externalcredential.model

import androidx.annotation.Keep
import com.simprints.core.ExcludedFromGeneratedTestCoverageReports
import com.simprints.core.domain.common.ModalitySdkType
import com.simprints.core.domain.sample.MatchComparisonResult
import com.simprints.core.domain.step.StepResult
import com.simprints.core.domain.tokenization.TokenizableString
import com.simprints.infra.config.store.models.FaceConfiguration
import com.simprints.infra.config.store.models.FingerprintConfiguration

@Keep
@ExcludedFromGeneratedTestCoverageReports("Data class")
data class CredentialMatch(
val credential: TokenizableString.Tokenized,
val matchResult: MatchComparisonResult,
val verificationThreshold: Float,
val faceBioSdk: FaceConfiguration.BioSdk?,
val fingerprintBioSdk: FingerprintConfiguration.BioSdk?,
val bioSdk: ModalitySdkType,
) : StepResult {
val isVerificationSuccessful = matchResult.confidence >= verificationThreshold
}
6 changes: 3 additions & 3 deletions .../src/main/java/com/simprints/feature/externalcredential/model/ExternalCredentialParams.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ package com.simprints.feature.externalcredential.model

import androidx.annotation.Keep
import com.simprints.core.ExcludedFromGeneratedTestCoverageReports
import com.simprints.core.domain.common.AgeGroup
import com.simprints.core.domain.common.FlowType
import com.simprints.core.domain.common.Modality
import com.simprints.core.domain.sample.CaptureSample
import com.simprints.core.domain.step.StepParams
import com.simprints.infra.config.store.models.AgeGroup

@Keep
@ExcludedFromGeneratedTestCoverageReports("Data class")
Expand All @@ -14,6 +15,5 @@ data class ExternalCredentialParams(
val flowType: FlowType,
val ageGroup: AgeGroup?,
val probeReferenceId: String?,
val faceSamples: List<CaptureSample>,
val fingerprintSamples: List<CaptureSample>,
val samples: Map<Modality, List<CaptureSample>>,
Copy link
Copy Markdown
Contributor

@BurningAXE BurningAXE Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be better if we had a dedicated model ModalitySamples with explicit properties instead of a Map?

Copy link
Copy Markdown
Contributor Author

@luhmirin-s luhmirin-s Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We would lose the ability to look up by modality key, which is used in several places.
I cannot think of a benefit other than a shorter declaration.

) : StepParams
46 changes: 13 additions & 33 deletions ...m/simprints/feature/externalcredential/screens/search/usecase/CreateMatchParamsUseCase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
package com.simprints.feature.externalcredential.screens.search.usecase

import com.simprints.core.domain.common.AgeGroup
import com.simprints.core.domain.common.FlowType
import com.simprints.core.domain.common.Modality
import com.simprints.core.domain.sample.CaptureSample
import com.simprints.infra.config.store.models.AgeGroup
import com.simprints.infra.config.store.models.ProjectConfiguration
import com.simprints.infra.config.store.models.determineFaceSDKs
import com.simprints.infra.config.store.models.determineFingerprintSDKs
import com.simprints.infra.config.store.models.getSdkListForAgeGroup
import com.simprints.infra.enrolment.records.repository.domain.models.BiometricDataSource
import com.simprints.infra.enrolment.records.repository.domain.models.SubjectQuery
import com.simprints.infra.matching.MatchParams
Expand All @@ -18,39 +17,20 @@ internal class CreateMatchParamsUseCase @Inject constructor() {
flowType: FlowType,
probeReferenceId: String?,
projectConfiguration: ProjectConfiguration,
faceSamples: List<CaptureSample>,
fingerprintSamples: List<CaptureSample>,
samples: Map<Modality, List<CaptureSample>>,
ageGroup: AgeGroup?,
): List<MatchParams> = projectConfiguration.general.matchingModalities
.map { modality ->
when (modality) {
Modality.FACE ->
projectConfiguration
.determineFaceSDKs(ageGroup)
.map {
MatchParams(
probeReferenceId = probeReferenceId.orEmpty(),
flowType = flowType,
queryForCandidates = SubjectQuery(subjectId = candidateSubjectId),
bioSdk = it,
probeFaceSamples = faceSamples,
biometricDataSource = BiometricDataSource.Simprints, // [MS-1167] No CoSync in initial MF-ID implementation
)
}

Modality.FINGERPRINT ->
projectConfiguration
.determineFingerprintSDKs(ageGroup)
.map {
MatchParams(
probeReferenceId = probeReferenceId.orEmpty(),
flowType = flowType,
queryForCandidates = SubjectQuery(subjectId = candidateSubjectId),
bioSdk = it,
probeFingerprintSamples = fingerprintSamples,
biometricDataSource = BiometricDataSource.Simprints, // [MS-1167] No CoSync in initial MF-ID implementation
)
}
val modalityProbes = samples[modality].orEmpty()
projectConfiguration.getSdkListForAgeGroup(modality, ageGroup).map {
MatchParams(
probeReferenceId = probeReferenceId.orEmpty(),
flowType = flowType,
queryForCandidates = SubjectQuery(subjectId = candidateSubjectId),
bioSdk = it,
probeSamples = modalityProbes,
biometricDataSource = BiometricDataSource.Simprints, // [MS-1167] No CoSync in initial MF-ID implementation
)
}
}.flatten()
}
Loading