Skip to content

[MS-929] Fix 1:N pool count for CoSync #1128

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
BurningAXE merged 2 commits into from
Mar 6, 2025
Merged

[MS-929] Fix 1:N pool count for CoSync #1128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd1a4ba
[MS-929] Count the number of loaded candidates to provide an accurate…
BurningAXE Mar 5, 2025
c496c93
[MS-929] Move onCandidateLoaded() callback after filtering to provide…
BurningAXE Mar 5, 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
17 changes: 11 additions & 6 deletions feature/matcher/src/main/java/com/simprints/matcher/usecases/FaceMatcherUseCase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,23 @@ internal class FaceMatcherUseCase @Inject constructor(
val queryWithSupportedFormat = matchParams.queryForCandidates.copy(
faceSampleFormat = faceMatcher.supportedTemplateFormat,
)
val totalCandidates = enrolmentRecordRepository.count(
val expectedCandidates = enrolmentRecordRepository.count(
queryWithSupportedFormat,
dataSource = matchParams.biometricDataSource,
)
if (totalCandidates == 0) {
if (expectedCandidates == 0) {
send(MatcherState.Success(emptyList(), 0, faceMatcher.matcherName))
return@channelFlow
}

Simber.i("Matching candidates", tag = crashReportTag)
send(MatcherState.LoadingStarted(totalCandidates))
send(MatcherState.LoadingStarted(expectedCandidates))
// When using local DB loadedCandidates = expectedCandidates
// However, when using CommCare as data source, loadedCandidates < expectedCandidates
// as it's count function does not take into account filtering criteria
var loadedCandidates = 0
val resultItems = coroutineScope {
createRanges(totalCandidates)
createRanges(expectedCandidates)
.map { range ->
async(dispatcher) {
val batchCandidates = getCandidates(
Expand All @@ -67,6 +71,7 @@ internal class FaceMatcherUseCase @Inject constructor(
dataSource = matchParams.biometricDataSource,
) {
// When a candidate is loaded
loadedCandidates++
trySend(MatcherState.CandidateLoaded)
}
match(batchCandidates, samples)
Expand All @@ -76,9 +81,9 @@ internal class FaceMatcherUseCase @Inject constructor(
.toList()
}

Simber.i("Matched $totalCandidates candidates", tag = crashReportTag)
Simber.i("Matched $loadedCandidates candidates", tag = crashReportTag)

send(MatcherState.Success(resultItems, totalCandidates, faceMatcher.matcherName))
send(MatcherState.Success(resultItems, loadedCandidates, faceMatcher.matcherName))
Comment thread
BurningAXE marked this conversation as resolved.
}

private fun mapSamples(probes: List<MatchParams.FaceSample>) = probes.map { FaceSample(it.faceId, it.template) }
Expand Down
17 changes: 11 additions & 6 deletions feature/matcher/src/main/java/com/simprints/matcher/usecases/FingerprintMatcherUseCase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,24 @@ internal class FingerprintMatcherUseCase @Inject constructor(
matchParams.queryForCandidates.copy(
fingerprintSampleFormat = bioSdkWrapper.supportedTemplateFormat,
)
val totalCandidates = enrolmentRecordRepository.count(queryWithSupportedFormat, dataSource = matchParams.biometricDataSource)
if (totalCandidates == 0) {
val expectedCandidates = enrolmentRecordRepository.count(queryWithSupportedFormat, dataSource = matchParams.biometricDataSource)
if (expectedCandidates == 0) {
send(MatcherState.Success(emptyList(), 0, bioSdkWrapper.matcherName))
return@channelFlow
}

Simber.i("Matching candidates", tag = crashReportTag)
send(MatcherState.LoadingStarted(totalCandidates))
val resultItems = createRanges(totalCandidates)
send(MatcherState.LoadingStarted(expectedCandidates))
// When using local DB loadedCandidates = expectedCandidates
// However, when using CommCare as data source, loadedCandidates < expectedCandidates
// as it's count function does not take into account filtering criteria
var loadedCandidates = 0
val resultItems = createRanges(expectedCandidates)
.map { range ->
async(dispatcher) {
val batchCandidates = getCandidates(queryWithSupportedFormat, range, matchParams.biometricDataSource, project) {
// When a candidate is loaded
loadedCandidates++
trySend(MatcherState.CandidateLoaded)
}
match(samples, batchCandidates, matchParams.flowType, bioSdkWrapper, bioSdk = matchParams.fingerprintSDK)
Expand All @@ -77,8 +82,8 @@ internal class FingerprintMatcherUseCase @Inject constructor(
.reduce { acc, subSet -> acc.addAll(subSet) }
.toList()

Simber.i("Matched $totalCandidates candidates", tag = crashReportTag)
send(MatcherState.Success(resultItems, totalCandidates, bioSdkWrapper.matcherName))
Simber.i("Matched $loadedCandidates candidates", tag = crashReportTag)
send(MatcherState.Success(resultItems, loadedCandidates, bioSdkWrapper.matcherName))
}

private fun mapSamples(probes: List<MatchParams.FingerprintSample>) = probes
Expand Down
94 changes: 52 additions & 42 deletions feature/matcher/src/test/java/com/simprints/matcher/usecases/FaceMatcherUseCaseTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,92 +63,102 @@ internal class FaceMatcherUseCaseTest {
fun `Skips matching if there are no probes`() = runTest {
coEvery { faceMatcher.getHighestComparisonScoreForCandidate(any(), any()) } returns 1f

val results = useCase.invoke(
MatchParams(
probeReferenceId = "referenceId",
flowType = FlowType.VERIFY,
queryForCandidates = SubjectQuery(),
biometricDataSource = BiometricDataSource.Simprints,
),
project
).toList()
val results = useCase
.invoke(
MatchParams(
probeReferenceId = "referenceId",
flowType = FlowType.VERIFY,
queryForCandidates = SubjectQuery(),
biometricDataSource = BiometricDataSource.Simprints,
),
project,
).toList()

coVerify(exactly = 0) { faceMatcher.getHighestComparisonScoreForCandidate(any(), any()) }

assertThat(results).containsExactly(
MatcherUseCase.MatcherState.Success(
matchResultItems = emptyList(),
totalCandidates = 0,
matcherName = ""
)
matcherName = "",
),
)
}

@Test
fun `Skips matching if there are no candidates`() = runTest {
coEvery { enrolmentRecordRepository.count(any()) } returns 0

val results = useCase.invoke(
MatchParams(
probeReferenceId = "referenceId",
probeFaceSamples = listOf(
MatchParams.FaceSample("faceId", byteArrayOf(1, 2, 3)),
val results = useCase
.invoke(
MatchParams(
probeReferenceId = "referenceId",
probeFaceSamples = listOf(
MatchParams.FaceSample("faceId", byteArrayOf(1, 2, 3)),
),
flowType = FlowType.VERIFY,
queryForCandidates = SubjectQuery(),
biometricDataSource = BiometricDataSource.Simprints,
),
flowType = FlowType.VERIFY,
queryForCandidates = SubjectQuery(),
biometricDataSource = BiometricDataSource.Simprints,
),
project
).toList()
project,
).toList()

coVerify(exactly = 0) { faceMatcher.getHighestComparisonScoreForCandidate(any(), any()) }

assertThat(results).containsExactly(
MatcherUseCase.MatcherState.Success(
matchResultItems = emptyList(),
totalCandidates = 0,
matcherName = ""
)
matcherName = "",
),
)
}

@Test
fun `Correctly calls SDK matcher`() = runTest {
val totalCandidates = 100
val totalCandidates = 1
val faceIdentities = listOf(
FaceIdentity(
"subjectId",
listOf(FaceSample(byteArrayOf(1, 2, 3), "format", "faceTemplate")),
)
),
)
coEvery { enrolmentRecordRepository.count(any(), any()) } returns 100
coEvery { enrolmentRecordRepository.count(any(), any()) } returns 1
coEvery { createRangesUseCase(any()) } returns listOf(0..99)
coEvery { enrolmentRecordRepository.loadFaceIdentities(any(), any(), any(), any(), any()) } returns faceIdentities
coEvery { enrolmentRecordRepository.loadFaceIdentities(any(), any(), any(), any(), any()) } coAnswers {
// Call the onCandidateLoaded callback (5th parameter)
val onCandidateLoaded = arg<() -> Unit>(4)
onCandidateLoaded()

// Return the face identities
faceIdentities
}
coEvery { faceMatcher.getHighestComparisonScoreForCandidate(any(), any()) } returns 42f


val results = useCase.invoke(
matchParams = MatchParams(
probeReferenceId = "referenceId",
probeFaceSamples = listOf(
MatchParams.FaceSample("faceId", byteArrayOf(1, 2, 3)),
val results = useCase
.invoke(
matchParams = MatchParams(
probeReferenceId = "referenceId",
probeFaceSamples = listOf(
MatchParams.FaceSample("faceId", byteArrayOf(1, 2, 3)),
),
flowType = FlowType.VERIFY,
queryForCandidates = SubjectQuery(),
biometricDataSource = BiometricDataSource.Simprints,
),
flowType = FlowType.VERIFY,
queryForCandidates = SubjectQuery(),
biometricDataSource = BiometricDataSource.Simprints,
),
project
).toList()
project,
).toList()

coVerify { faceMatcher.getHighestComparisonScoreForCandidate(any(), any()) }

assertThat(results).containsExactly(
MatcherUseCase.MatcherState.LoadingStarted(totalCandidates),
MatcherUseCase.MatcherState.CandidateLoaded,
MatcherUseCase.MatcherState.Success(
matchResultItems = listOf(FaceMatchResult.Item("subjectId", 42f)),
totalCandidates = totalCandidates,
matcherName = ""
)
matcherName = "",
),
)
}
}
8 changes: 4 additions & 4 deletions ...a/com/simprints/infra/enrolment/records/repository/commcare/CommCareIdentityDataSource.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,11 @@ internal class CommCareIdentityDataSource @Inject constructor(
project: Project,
onCandidateLoaded: () -> Unit,
): List<FingerprintIdentity> = withContext(dispatcher) {
loadEnrolmentRecordCreationEvents(range, dataSource.callerPackageName(), query, project, onCandidateLoaded)
loadEnrolmentRecordCreationEvents(range, dataSource.callerPackageName(), query, project)
.filter { erce ->
erce.payload.biometricReferences.any { it is FingerprintReference && it.format == query.fingerprintSampleFormat }
}.map {
onCandidateLoaded()
FingerprintIdentity(
it.payload.subjectId,
it.payload.biometricReferences
Expand All @@ -80,7 +81,6 @@ internal class CommCareIdentityDataSource @Inject constructor(
callerPackageName: String,
query: SubjectQuery,
project: Project,
onCandidateLoaded: () -> Unit,
): List<EnrolmentRecordCreationEvent> {
val enrolmentRecordCreationEvents: MutableList<EnrolmentRecordCreationEvent> = mutableListOf()
try {
Expand All @@ -103,7 +103,6 @@ internal class CommCareIdentityDataSource @Inject constructor(
enrolmentRecordCreationEvents.addAll(
loadEnrolmentRecordCreationEvents(caseId, callerPackageName, query, project),
)
onCandidateLoaded()
}
} while (caseMetadataCursor.moveToNext() && caseMetadataCursor.position < range.last)
}
Expand Down Expand Up @@ -132,10 +131,11 @@ internal class CommCareIdentityDataSource @Inject constructor(
project: Project,
onCandidateLoaded: () -> Unit,
): List<FaceIdentity> = withContext(dispatcher) {
loadEnrolmentRecordCreationEvents(range, dataSource.callerPackageName(), query, project, onCandidateLoaded)
loadEnrolmentRecordCreationEvents(range, dataSource.callerPackageName(), query, project)
.filter { erce ->
erce.payload.biometricReferences.any { it is FaceReference && it.format == query.faceSampleFormat }
}.map {
onCandidateLoaded()
FaceIdentity(
it.payload.subjectId,
it.payload.biometricReferences
Expand Down