[MS-1052] CoDownSync Phase 2 - Handle diffs with CommCare

[BurningAXE]

JIRA ticket
Will be released in: 2025.3.0

Notable changes

• Added CommCareSyncCache that tracks which cases (and their respective GUIDs) have been synced
• Upon successful sync of a case, subsequent syncs only sync it again if its LAST_MODIFIED date is later than the last sync date
• New cases are synced
• Previously synced cases that are no longer present are deleted (along with their associated enrolment records)
• To ensure the cache is updated only after enrolment record events are actually processed and not just sent for processing (which might be interrupted by an exception that cancels the worker), a new callback onEventsProcessed() is added.

Testing guidance

• Install CommCare and log in with an user that has access to cases with biometric data
• Configure a project with CommCare sync
• Sync! -> Verify all cases are synced
• Add a new case with biometric data and sync again -> Verify it's synced
• Modify a previously synced case -> Verify it's synced again
• Delete a previously synced case -> Verify its ER is deleted

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)

[Copilot]

Pull Request Overview

This PR implements CommCare sync phase 2 functionality to handle differential syncing by tracking synced cases and their modification timestamps. The implementation introduces a caching mechanism to sync only new or modified cases while cleaning up deleted ones.

Key changes:

• Added CommCare sync cache to track case IDs, their corresponding Simprints IDs, and last sync timestamps
• Implemented differential sync logic that only processes cases modified after the last sync
• Added support for generating deletion events for cases no longer present in CommCare

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
CommCareSyncCache.kt	New cache implementation for tracking synced CommCare cases
CommCareSyncDao.kt	Database access object for CommCare sync cache operations
CommCareSyncDatabase.kt	Room database configuration for the sync cache
SyncedCaseEntity.kt	Entity representing cached case data with timestamps
CommCareEventDataSource.kt	Enhanced to implement differential sync logic and cache management
BaseEventDownSyncTask.kt	Modified callback mechanism from actions to events
CommCareEventSyncTask.kt	Simplified to delegate cache operations to data source
SimprintsEventDownSyncTask.kt	Removed unused cleanup method
EventSyncModule.kt	Added dependency injection for CommCare cache components
EventSyncManagerImpl.kt	Added cache clearing to sync reset operations
Test files	Comprehensive test coverage for new functionality

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[luhmirin-s]

It seems that you only need the caseId and lastModified values, so it could be more memory efficient to use `Map<String, Long> instead. You can filter by key later when removing cases.

[BurningAXE]

Yes but then you need to pass the full SyncedCaseEntity to generateEnrolmentRecordDeletionEvent() because it uses its simprintsId. So, in the end we do need the full 'cases'.

[sonarqubecloud]

Quality Gate passed

Issues
5 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud