[MS-951]: Feature/add room module by meladRaouf · Pull Request #1161 · Simprints/Android-Simprints-ID

meladRaouf · 2025-04-10T11:02:42Z

JIRA ticket
Will be released in: 2025.2.0

Notable changes

The changes include the definition of database entities (DbSubject, DbBiometricTemplate), Data Access Objects (SubjectDao), and the local data source implementation (RoomEnrolmentRecordLocalDataSource) to manage subject and biometric data.

Database Entities:
- Added DbSubject entity
- Added DbBiometricTemplate entity to store individual biometric samples (face, fingerprints) linked to a DbSubject.
SubjectDao (Data Access Object):
- Created SubjectDao interface with methods for:
  - Inserting, updating, and deleting DbSubject, DbBiometricTemplate records.
  - Querying subjects (getSubject, loadSubjects via RawQuery).
  - Counting subjects with various filter combinations (countSubjects for specific formats or general counts).
  - Loading biometric samples (loadSamples) with filtering (format, project, subject, attendant, module) and pagination (limit, offset), returning a map of subject IDs to their templates.
RoomEnrolmentRecordLocalDataSource:
- Implemented the local data source using SubjectDao to interact with the Room database.
- Custom SQL building was used in the data source instead of relying solely on DAO queries to gain more control over dynamic query generation, especially for complex filtering scenarios. This approach avoids performance pitfalls commonly introduced by OR conditions in Room queries—conditions that make indexing ineffective. For example, a clause like (:projectId IS NULL OR s.projectId = :projectId) disables the use of an index on projectId, because the database must evaluate both sides of the OR for every row. By building SQL manually, we include only the active filters (e.g., s.projectId = :projectId when projectId is not null), which ensures the query remains index-friendly. This approach leads to more efficient execution plans and significantly better performance on large datasets.

Testing guidance

Test all DB operations Add, delete and update.
All DB retrieval scenarios count subjects and list face or fingerprint templates using verify or identify flows

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)

luhmirin-s

Amazing job! I must admit that I just skimmed on THE test file :D

I have couple of small to mid-size concerns in the comments, the general approach LGTM.

luhmirin-s · 2025-05-08T07:15:53Z

+    suspend fun getSubject(subjectId: String): SubjectBiometrics?
+
+    @RawQuery
+    suspend fun loadSubjects(query: SupportSQLiteQuery): List<SubjectBiometrics>


It is a bit concerning that query building is disjointed from the returning model definition; sooner or later, a bug will be caused by changing one place and forgetting another.

I am not sure what would be the best way to fix it, tho.

BurningAXE

Great job! 🥇

BurningAXE · 2025-06-05T13:48:36Z

    ): List<MatchResult> {
        val simAfisCandidates = candidates.map { it.toSimAfisPerson() }

-        println("Matching ${simAfisCandidates.size} candidates using all ${jniLibAfis.getNbCores()} cores")


Why did you delete this?

I don't like using the println, but I reverted it back

BurningAXE · 2025-06-05T13:58:02Z

                onCandidateLoaded = {
                    loadedCandidates.incrementAndGet()
-                    this.trySend(MatcherState.CandidateLoaded)
+                    runBlocking {


Do we really need this to be blocking?

Found and implemented a better solution to suspend the reader

BurningAXE · 2025-06-05T13:59:51Z

            .query(caseDataUri, null, null, null, null)
            ?.use { caseDataCursor ->
                val subjectActions = getSubjectActionsValue(caseDataCursor)
-                Simber.d(subjectActions)


This is often useful

Reverted back

…he desugar_jdk_libs dependency.

… schema for Room integration

… order by clause methods

…oved query handling and clarity

…ipeline And ensure all DB reads happen in the IO dispatcher

…se single consumer

…calDataSource

…oaded callbacks

sonarqubecloud · 2025-06-09T04:04:14Z

Quality Gate passed

Issues
8 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

cla-bot Bot added the ... label Apr 10, 2025

meladRaouf force-pushed the feature/add-room-module branch 2 times, most recently from 40d5442 to 9830fbd Compare April 10, 2025 11:39

meladRaouf force-pushed the feature/add-room-module branch 11 times, most recently from 25aa5d9 to e56bd19 Compare May 6, 2025 21:17

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

meladRaouf marked this pull request as ready for review May 7, 2025 05:26

BurningAXE reviewed May 7, 2025

View reviewed changes

Comment thread infra/core/src/main/java/com/simprints/core/domain/face/FaceSample.kt

luhmirin-s reviewed May 8, 2025

View reviewed changes