feat: [ANDROAPP-7605] Add granular sync use-case for teis (#4955)

Author: Balcan

sync/src/androidMain/kotlin/org/dhis2/mobile/sync/data/SyncTeiRepositoryImpl.kt

@@ -0,0 +1,64 @@
+package org.dhis2.mobile.sync.data
+
+import org.dhis2.mobile.sync.model.EnrollmentInfo
+import org.hisp.dhis.android.core.D2
+
+internal class SyncTeiRepositoryImpl(
+    private val d2: D2,
+) : SyncTeiRepository {
+    override suspend fun getEnrollmentInfo(enrollmentUid: String): EnrollmentInfo {
+        val enrollment =
+            d2
+                .enrollmentModule()
+                .enrollments()
+                .uid(enrollmentUid)
+                .blockingGet() ?: throw IllegalStateException("Enrollment does not exist")
+
+        return EnrollmentInfo(
+            uid = enrollmentUid,
+            teiUid =
+                enrollment.trackedEntityInstance() ?: throw IllegalStateException(
+                    "Missing tei uid for enrollment %s".format(
+                        enrollmentUid,
+                    ),
+                ),
+            programUid =
+                enrollment.program() ?: throw IllegalStateException(
+                    "Missing program uid for enrollment %s".format(
+                        enrollmentUid,
+                    ),
+                ),
+        )
+    }
+
+    override suspend fun uploadTei(enrollmentInfo: EnrollmentInfo) {
+        d2
+            .trackedEntityModule()
+            .trackedEntityInstances()
+            .byUid()
+            .eq(enrollmentInfo.teiUid)
+            .byProgramUids(listOf(enrollmentInfo.programUid))
+            .blockingUpload()
+    }
+
+    override suspend fun downloadTei(enrollmentInfo: EnrollmentInfo) {
+        d2
+            .trackedEntityModule()
+            .trackedEntityInstanceDownloader()
+            .byUid()
+            .eq(enrollmentInfo.teiUid)
+            .byProgramUid(enrollmentInfo.programUid)
+            .blockingDownload()
+    }
+
+    override suspend fun downloadFileResources(enrollmentInfo: EnrollmentInfo) {
+        d2
+            .fileResourceModule()
+            .fileResourceDownloader()
+            .byTrackedEntityUid()
+            .eq(enrollmentInfo.teiUid)
+            .byProgramUid()
+            .eq(enrollmentInfo.programUid)
+            .blockingDownload()
+    }
+}

sync/src/commonMain/kotlin/org/dhis2/mobile/sync/data/SyncTeiRepository.kt

@@ -0,0 +1,13 @@
+package org.dhis2.mobile.sync.data
+
+import org.dhis2.mobile.sync.model.EnrollmentInfo
+
+internal interface SyncTeiRepository {
+    suspend fun getEnrollmentInfo(enrollmentUid: String): EnrollmentInfo
+
+    suspend fun uploadTei(enrollmentInfo: EnrollmentInfo)
+
+    suspend fun downloadTei(enrollmentInfo: EnrollmentInfo)
+
+    suspend fun downloadFileResources(enrollmentInfo: EnrollmentInfo)
+}

sync/src/commonMain/kotlin/org/dhis2/mobile/sync/domain/SyncTei.kt

@@ -0,0 +1,21 @@
+package org.dhis2.mobile.sync.domain
+
+import org.dhis2.mobile.commons.domain.UseCase
+import org.dhis2.mobile.sync.data.SyncTeiRepository
+
+internal typealias EnrollmentUid = String
+
+internal class SyncTei(
+    private val syncTeiRepository: SyncTeiRepository,
+) : UseCase<String, Unit> {
+    override suspend fun invoke(input: EnrollmentUid): Result<Unit> =
+        try {
+            val enrollmentInfo = syncTeiRepository.getEnrollmentInfo(input)
+            syncTeiRepository.uploadTei(enrollmentInfo)
+            syncTeiRepository.downloadTei(enrollmentInfo)
+            syncTeiRepository.downloadFileResources(enrollmentInfo)
+            Result.success(Unit)
+        } catch (e: Exception) {
+            Result.failure(e)
+        }
+}

sync/src/commonMain/kotlin/org/dhis2/mobile/sync/model/EnrollmentInfo.kt

@@ -0,0 +1,7 @@
+package org.dhis2.mobile.sync.model
+
+internal data class EnrollmentInfo(
+    val uid: String,
+    val teiUid: String,
+    val programUid: String,
+)

sync/src/commonTest/kotlin/org/dhis2/mobile/sync/domain/SyncTeiTest.kt

@@ -0,0 +1,82 @@
+package org.dhis2.mobile.sync.domain
+
+import kotlinx.coroutines.runBlocking
+import org.dhis2.mobile.sync.data.SyncTeiRepository
+import org.dhis2.mobile.sync.model.EnrollmentInfo
+import org.junit.Test
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.verify
+import org.mockito.kotlin.whenever
+import kotlin.test.assertTrue
+
+class SyncTeiTest {
+    private val repository: SyncTeiRepository = mock()
+    private val useCase = SyncTei(repository)
+
+    private val enrollmentUid = "enrollmentUid"
+    private val enrollmentInfo =
+        EnrollmentInfo(
+            uid = enrollmentUid,
+            teiUid = "teiUid",
+            programUid = "programUid",
+        )
+
+    @Test
+    fun `should return success and call all repository methods in order`() =
+        runBlocking {
+            whenever(repository.getEnrollmentInfo(enrollmentUid)).thenReturn(enrollmentInfo)
+
+            val result = useCase(enrollmentUid)
+
+            assertTrue(result.isSuccess)
+            verify(repository).getEnrollmentInfo(enrollmentUid)
+            verify(repository).uploadTei(enrollmentInfo)
+            verify(repository).downloadTei(enrollmentInfo)
+            verify(repository).downloadFileResources(enrollmentInfo)
+        }
+
+    @Test
+    fun `should return failure when getEnrollmentInfo throws`() =
+        runBlocking {
+            whenever(repository.getEnrollmentInfo(enrollmentUid))
+                .thenThrow(RuntimeException("enrollment error"))
+
+            val result = useCase(enrollmentUid)
+
+            assertTrue(result.isFailure)
+        }
+
+    @Test
+    fun `should return failure when uploadTei throws`() =
+        runBlocking {
+            whenever(repository.getEnrollmentInfo(enrollmentUid)).thenReturn(enrollmentInfo)
+            whenever(repository.uploadTei(enrollmentInfo)).thenThrow(RuntimeException("upload error"))
+
+            val result = useCase(enrollmentUid)
+
+            assertTrue(result.isFailure)
+        }
+
+    @Test
+    fun `should return failure when downloadTei throws`() =
+        runBlocking {
+            whenever(repository.getEnrollmentInfo(enrollmentUid)).thenReturn(enrollmentInfo)
+            whenever(repository.downloadTei(enrollmentInfo)).thenThrow(RuntimeException("download error"))
+
+            val result = useCase(enrollmentUid)
+
+            assertTrue(result.isFailure)
+        }
+
+    @Test
+    fun `should return failure when downloadFileResources throws`() =
+        runBlocking {
+            whenever(repository.getEnrollmentInfo(enrollmentUid)).thenReturn(enrollmentInfo)
+            whenever(repository.downloadFileResources(enrollmentInfo))
+                .thenThrow(RuntimeException("file resources error"))
+
+            val result = useCase(enrollmentUid)
+
+            assertTrue(result.isFailure)
+        }
+}