MS-988 Adding SimFace integration by luhmirin-s · Pull Request #1202 · Simprints/Android-Simprints-ID

luhmirin-s · 2025-05-28T12:02:37Z

JIRA ticket
Will be released in: 2025.2.0

Notable changes

Added SimFace SDK as a module.
Routed all calls to face configuration to the appropriate SDK configuration.
Added SDK parameter to face capture and matching flows similar to how it was already set up for fingerprint SDKs.
There is no need to add any additional flags since the SimFace configuration will only be provided to the projects in the dev-us deployment. For staging and prod projects, nothing changes.

Testing guidance

Once Vulcan has been updated, configure a project to use SimFace SDK for face modality capture. Run the usual biometric flows with the new SDK.

Additional work checklist

Effect on other features and security has been considered
Design document marked as "In development" (if applicable)
External (Gitbook) and internal (Confluence) Documentation is up to date (or ticket created)
Test cases in Testiny are up to date (or ticket created)
Other teams notified about the changes (if applicable)

BurningAXE · 2025-06-03T13:49:46Z

     * 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
+     * Dev version >= 2025.2.0 is required to support enrolment record updates and biometric sdk age restrictions to receive SimFace configuration


"biometric sdk age restrictions" - copy-paste?

🤦🏻 yep

BurningAXE · 2025-06-03T14:05:02Z

+            candidate.faces.map { face ->
+                val baseScore = simFace.verificationScore(probeTemplate, face.template)
+                // TODO: remove the adjustment after we find out why the returned range is biased towards [0.5;1]
+                (baseScore - 0.5).coerceAtLeast(0.0).toFloat() * 200f


Not commenting on the "fix" itself :D but shouldn't this at least be inside the SDK?

It could be inside, but it is "simpler" to adjust it on the caller side as it does not require re-publishing of the AAR. Ideally, we find the reason for the bias and fix it on the model level (there is a plan on the biometrics team side). For now, this should be enough, tho.

BurningAXE · 2025-06-03T14:09:26Z

        Simber.i("Initialising matcher", tag = crashReportTag)
-        val bioSdk = resolveFaceBioSdk()
+        if (matchParams.faceSDK == null) {
+            send(MatcherState.Success(emptyList(), 0, ""))


Should we log a Simber.e() here (and in fingerprint's copy) as this would indicate a code error somewhere?

I will add Simber.w since there is no exception to log with .e().

meladRaouf · 2025-06-03T14:28:54Z

+        val faces = simFace.detectFaceBlocking(bitmap)
+        val face = faces.getOrNull(0) ?: return@runBlocking null
+        // Skip the obviously bad images, but leave the rest to be determined by the caller
+        if (face.quality < 0.1) return@runBlocking null


Would be better if declared 0.1 in constants

meladRaouf · 2025-06-03T14:30:07Z

+
+dependencies {
+    implementation(project(":face:infra:base-bio-sdk"))
+    api(libs.simface)


can you use implementation to avoid exposing the libs.simface outside this module ?

Unfortunately, no - we need to provide the regular "SimFace" to the matcher's constructor.

BurningAXE · 2025-06-03T14:49:20Z

+                licenseRepository.deleteCachedLicense(Vendor.RankOne)
+                _invalidLicense.send()
+            }
+            saveLicenseCheckEvent(licenseVendor, licenseStatus)


Maybe in the future we can abstract all this logic in the license repo, so that it takes the SDK as param and returns whatever license is appropriate and the call here is the same regardless of the SDK.

I vote for removing the license module altogether. :D

Made a ticket for it: https://simprints.atlassian.net/browse/MS-1011

BurningAXE · 2025-06-03T14:55:18Z

+class SimFaceBioSdk @Inject constructor(
+    override val initializer: SimFaceInitializer,
+    override val detector: SimFaceDetector,
+    private val simFace: SimFace,


It's a little weird to have SimFace* and just SimFace. However, the latter comes from the lib so don't have a concrete suggestion at the moment.

This is only due to the matchers being created dynamically for the probe list.

BurningAXE

LGTM

sonarqubecloud · 2025-06-03T15:33:20Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
81.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

cla-bot Bot added the ... label May 28, 2025

luhmirin-s force-pushed the feature/MS-988-simface-integration branch 2 times, most recently from 9684518 to b286120 Compare May 28, 2025 13:12

luhmirin-s requested a review from a team May 29, 2025 12:18

luhmirin-s marked this pull request as ready for review May 29, 2025 12:18

luhmirin-s requested review from BurningAXE, TristramN, alex-vt, alexandr-simprints, meladRaouf and ybourgery and removed request for a team May 29, 2025 12:18

luhmirin-s changed the title ~~[WIP] MS-988 Adding SimFace integration~~ MS-988 Adding SimFace integration May 29, 2025

alex-vt approved these changes Jun 3, 2025

View reviewed changes

Comment thread face/infra/simface/src/main/java/com/simprints/face/infra/simface/detection/SimFaceDetector.kt Outdated

Comment thread .../config-store/src/test/java/com/simprints/infra/config/store/models/FaceConfigurationTest.kt Outdated

luhmirin-s force-pushed the feature/MS-988-simface-integration branch 2 times, most recently from 6167762 to 76fc303 Compare June 3, 2025 10:18

BurningAXE reviewed Jun 3, 2025

View reviewed changes

luhmirin-s force-pushed the feature/MS-988-simface-integration branch from 76fc303 to 7f07880 Compare June 3, 2025 13:53

BurningAXE reviewed Jun 3, 2025

View reviewed changes

meladRaouf approved these changes Jun 3, 2025

View reviewed changes

BurningAXE reviewed Jun 3, 2025

View reviewed changes

BurningAXE approved these changes Jun 3, 2025

View reviewed changes

luhmirin-s added 6 commits June 3, 2025 18:17

MS-988 Add SimFace as a module

c839ca4

MS-988 Add SimFace to configuration store

3be32e2

MS-988 Use the configuration depending on the Face SDK configured

cd7c7a0

MS-988 Add SimFace to the face bio sdk resolver

9baa81a

MS-988 Update dev build version name

1bddb12

MS-988 Add simface modules to pr checks

be324d3

luhmirin-s force-pushed the feature/MS-988-simface-integration branch from 7f07880 to be324d3 Compare June 3, 2025 15:17

luhmirin-s merged commit 2683264 into main Jun 4, 2025
12 checks passed

luhmirin-s deleted the feature/MS-988-simface-integration branch June 4, 2025 06:29

Conversation

luhmirin-s commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notable changes

Testing guidance

Additional work checklist

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BurningAXE left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Jun 3, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

luhmirin-s commented May 28, 2025 •

edited

Loading