[MS-1299] Sync architecture revamp, part 2

feature/dashboard/src/main/java/com/simprints/feature/dashboard/debug/DebugFragment.kt

@@ -19,9 +19,9 @@ import com.simprints.infra.enrolment.records.repository.EnrolmentRecordRepositor
 import com.simprints.infra.events.EventRepository
 import com.simprints.infra.eventsync.EventSyncManager
 import com.simprints.infra.eventsync.status.models.EventSyncWorkerState
-import com.simprints.infra.sync.SyncCommand
+import com.simprints.infra.sync.OneTime
+import com.simprints.infra.sync.ScheduleCommand
 import com.simprints.infra.sync.SyncOrchestrator
-import com.simprints.infra.sync.usecase.SyncUseCase
 import com.simprints.infra.uibase.view.applySystemBarInsets
 import com.simprints.infra.uibase.viewbinding.viewBinding
 import dagger.hilt.android.AndroidEntryPoint
@@ -35,14 +35,11 @@ import javax.inject.Inject
 @AndroidEntryPoint
 internal class DebugFragment : Fragment(R.layout.fragment_debug) {
     @Inject
-    lateinit var sync: SyncUseCase
+    lateinit var syncOrchestrator: SyncOrchestrator
 
     @Inject
     lateinit var eventSyncManager: EventSyncManager
 
-    @Inject
-    lateinit var syncOrchestrator: SyncOrchestrator
-
     @Inject
     lateinit var authStore: AuthStore
 
@@ -67,7 +64,8 @@ internal class DebugFragment : Fragment(R.layout.fragment_debug) {
         super.onViewCreated(view, savedInstanceState)
         applySystemBarInsets(view)
 
-        sync(eventSync = SyncCommand.ObserveOnly, imageSync = SyncCommand.ObserveOnly)
+        syncOrchestrator
+            .observeSyncState()
             .map {
                 it.eventSyncState
             }.asLiveData()
@@ -87,22 +85,18 @@ internal class DebugFragment : Fragment(R.layout.fragment_debug) {
                 )
 
                 binding.logs.append(ssb)
-            }
+        }
 
         binding.syncStart.setOnClickListener {
-            lifecycleScope.launch(dispatcher) {
-                syncOrchestrator.startEventSync()
-            }
+            syncOrchestrator.executeOneTime(OneTime.Events.start())
         }
 
         binding.syncStop.setOnClickListener {
-            syncOrchestrator.stopEventSync()
+            syncOrchestrator.executeOneTime(OneTime.Events.stop())
         }
 
         binding.syncSchedule.setOnClickListener {
-            lifecycleScope.launch(dispatcher) {
-                syncOrchestrator.rescheduleEventSync()
-            }
+            syncOrchestrator.executeSchedulingCommand(ScheduleCommand.Events.reschedule())
         }
 
         binding.clearFirebaseToken.setOnClickListener {
@@ -127,8 +121,8 @@ internal class DebugFragment : Fragment(R.layout.fragment_debug) {
 
         binding.cleanAll.setOnClickListener {
             lifecycleScope.launch(dispatcher) {
-                syncOrchestrator.stopEventSync()
-                syncOrchestrator.cancelEventSync()
+                syncOrchestrator.executeOneTime(OneTime.Events.stop())
+                syncOrchestrator.executeSchedulingCommand(ScheduleCommand.Events.unschedule())
 
                 eventRepository.deleteAll()
                 eventSyncManager.resetDownSyncInfo()

feature/dashboard/src/main/java/com/simprints/feature/dashboard/logout/LogoutSyncViewModel.kt

@@ -10,8 +10,7 @@ import com.simprints.feature.dashboard.logout.usecase.LogoutUseCase
 import com.simprints.infra.authstore.AuthStore
 import com.simprints.infra.config.store.ConfigRepository
 import com.simprints.infra.config.store.models.SettingsPasswordConfig
-import com.simprints.infra.sync.SyncCommand
-import com.simprints.infra.sync.usecase.SyncUseCase
+import com.simprints.infra.sync.SyncOrchestrator
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.flow.debounce
 import kotlinx.coroutines.flow.distinctUntilChanged
@@ -22,7 +21,7 @@ import javax.inject.Inject
 @HiltViewModel
 internal class LogoutSyncViewModel @Inject constructor(
     private val configRepository: ConfigRepository,
-    sync: SyncUseCase,
+    syncOrchestrator: SyncOrchestrator,
     authStore: AuthStore,
     private val logoutUseCase: LogoutUseCase,
 ) : ViewModel() {
@@ -36,7 +35,8 @@ internal class LogoutSyncViewModel @Inject constructor(
             .asLiveData(viewModelScope.coroutineContext)
 
     val isLogoutWithoutSyncVisibleLiveData: LiveData<Boolean> =
-        sync(eventSync = SyncCommand.ObserveOnly, imageSync = SyncCommand.ObserveOnly)
+        syncOrchestrator
+            .observeSyncState()
             .map { syncStatus ->
                 !syncStatus.eventSyncState.isSyncCompleted() || syncStatus.imageSyncStatus.isSyncing
             }.debounce(timeoutMillis = ANTI_JITTER_DELAY_MILLIS)

feature/dashboard/src/main/java/com/simprints/feature/dashboard/logout/usecase/LogoutUseCase.kt

@@ -4,6 +4,7 @@ import com.simprints.core.DispatcherIO
 import com.simprints.infra.authlogic.AuthManager
 import com.simprints.infra.enrolment.records.repository.EnrolmentRecordRepository
 import com.simprints.infra.enrolment.records.repository.local.migration.RealmToRoomMigrationFlagsStore
+import com.simprints.infra.sync.ScheduleCommand
 import com.simprints.infra.sync.SyncOrchestrator
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.runBlocking
@@ -19,7 +20,7 @@ internal class LogoutUseCase @Inject constructor(
     // To prevent a race between wiping data and navigation, this use case must block the executing thread
     operator fun invoke() = runBlocking(ioDispatcher) {
         // Cancel all background sync
-        syncOrchestrator.cancelBackgroundWork()
+        syncOrchestrator.executeSchedulingCommand(ScheduleCommand.Everything.unschedule())
         syncOrchestrator.deleteEventSyncInfo()
         // sign out the user
         authManager.signOut()

feature/dashboard/src/main/java/com/simprints/feature/dashboard/settings/syncinfo/SyncInfoViewModel.kt

@@ -16,9 +16,8 @@ import com.simprints.infra.config.store.ConfigRepository
 import com.simprints.infra.config.store.models.ProjectState
 import com.simprints.infra.config.store.models.isModuleSelectionAvailable
 import com.simprints.infra.recent.user.activity.RecentUserActivityManager
-import com.simprints.infra.sync.SyncCommand
+import com.simprints.infra.sync.OneTime
 import com.simprints.infra.sync.SyncOrchestrator
-import com.simprints.infra.sync.usecase.SyncUseCase
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.flow.Flow
@@ -43,11 +42,10 @@ import javax.inject.Inject
 internal class SyncInfoViewModel @Inject constructor(
     private val configRepository: ConfigRepository,
     private val authStore: AuthStore,
-    private val syncOrchestrator: SyncOrchestrator,
     private val recentUserActivityManager: RecentUserActivityManager,
     private val timeHelper: TimeHelper,
     observeSyncInfo: ObserveSyncInfoUseCase,
-    private val sync: SyncUseCase,
+    private val syncOrchestrator: SyncOrchestrator,
     private val logoutUseCase: LogoutUseCase,
     @param:DispatcherIO private val ioDispatcher: CoroutineDispatcher,
 ) : ViewModel() {
@@ -57,7 +55,7 @@ internal class SyncInfoViewModel @Inject constructor(
         get() = _loginNavigationEventLiveData
     private val _loginNavigationEventLiveData = MutableLiveData<LoginParams>()
 
-    private val syncStatusFlow = sync(eventSync = SyncCommand.ObserveOnly, imageSync = SyncCommand.ObserveOnly)
+    private val syncStatusFlow = syncOrchestrator.observeSyncState()
     private val eventSyncStateFlow =
         syncStatusFlow.map { it.eventSyncState }
     private val imageSyncStatusFlow =
@@ -146,21 +144,19 @@ internal class SyncInfoViewModel @Inject constructor(
                 }
             }
 
-            syncOrchestrator.stopEventSync()
-
             val isDownSyncAllowed = !isPreLogoutUpSync && configRepository.getProject()?.state == ProjectState.RUNNING
-            syncOrchestrator.startEventSync(isDownSyncAllowed)
+            syncOrchestrator.executeOneTime(OneTime.Events.restart(isDownSyncAllowed))
         }
     }
 
     fun toggleImageSync() {
         viewModelScope.launch {
             val isImageSyncing = imageSyncStatusFlow.firstOrNull()?.isSyncing == true
             if (isImageSyncing) {
-                syncOrchestrator.stopImageSync()
+                syncOrchestrator.executeOneTime(OneTime.Images.stop())
             } else {
                 imageSyncButtonClickFlow.emit(Unit)
-                syncOrchestrator.startImageSync()
+                syncOrchestrator.executeOneTime(OneTime.Images.start())
             }
         }
     }
@@ -218,7 +214,7 @@ internal class SyncInfoViewModel @Inject constructor(
                     .distinctUntilChanged()
                     .collect { isEventSyncCompleted ->
                         if (isEventSyncCompleted) {
-                            syncOrchestrator.startImageSync()
+                            syncOrchestrator.executeOneTime(OneTime.Images.start())
                         }
                     }
             }

feature/dashboard/src/main/java/com/simprints/feature/dashboard/settings/syncinfo/moduleselection/ModuleSelectionViewModel.kt

@@ -15,6 +15,7 @@ import com.simprints.infra.config.store.ConfigRepository
 import com.simprints.infra.config.store.models.SettingsPasswordConfig
 import com.simprints.infra.config.store.models.TokenKeyType
 import com.simprints.infra.config.store.tokenization.TokenizationProcessor
+import com.simprints.infra.sync.OneTime
 import com.simprints.infra.sync.SyncOrchestrator
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.CoroutineScope
@@ -114,8 +115,7 @@ internal class ModuleSelectionViewModel @Inject constructor(
                 module.copy(name = encryptedName)
             }
             moduleRepository.saveModules(modules)
-            syncOrchestrator.stopEventSync()
-            syncOrchestrator.startEventSync()
+            syncOrchestrator.executeOneTime(OneTime.Events.restart())
         }
     }
 

feature/dashboard/src/main/java/com/simprints/feature/dashboard/settings/syncinfo/usecase/ObserveSyncInfoUseCase.kt

@@ -23,9 +23,8 @@ import com.simprints.infra.config.store.models.isSimprintsEventDownSyncAllowed
 import com.simprints.infra.eventsync.permission.CommCarePermissionChecker
 import com.simprints.infra.eventsync.status.models.DownSyncCounts
 import com.simprints.infra.network.ConnectivityTracker
-import com.simprints.infra.sync.SyncCommand
+import com.simprints.infra.sync.SyncOrchestrator
 import com.simprints.infra.sync.usecase.ObserveSyncableCountsUseCase
-import com.simprints.infra.sync.usecase.SyncUseCase
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.Flow
@@ -45,7 +44,7 @@ internal class ObserveSyncInfoUseCase @Inject constructor(
     private val commCarePermissionChecker: CommCarePermissionChecker,
     private val observeConfigurationFlow: ObserveConfigurationChangesUseCase,
     private val observeSyncableCounts: ObserveSyncableCountsUseCase,
-    private val sync: SyncUseCase,
+    private val syncOrchestrator: SyncOrchestrator,
     @param:DispatcherBG private val dispatcher: CoroutineDispatcher,
 ) {
     // Since we are not using distinctUntilChanged any emission from combined flows will trigger the main flow as well
@@ -58,7 +57,7 @@ internal class ObserveSyncInfoUseCase @Inject constructor(
     operator fun invoke(isPreLogoutUpSync: Boolean = false): Flow<SyncInfo> = combine(
         combinedRefreshSignals(),
         authStore.observeSignedInProjectId(),
-        sync(eventSync = SyncCommand.ObserveOnly, imageSync = SyncCommand.ObserveOnly),
+        syncOrchestrator.observeSyncState(),
         observeSyncableCounts(),
         observeConfigurationFlow(),
     ) { isOnline, projectId, (eventSyncState, imageSyncStatus), counts, (isRefreshing, isProjectRunning, moduleCounts, projectConfig) ->

feature/dashboard/src/test/java/com/simprints/feature/dashboard/logout/LogoutSyncViewModelTest.kt

@@ -9,7 +9,7 @@ import com.simprints.infra.config.store.models.SettingsPasswordConfig
 import com.simprints.infra.eventsync.status.models.EventSyncState
 import com.simprints.infra.sync.ImageSyncStatus
 import com.simprints.infra.sync.SyncStatus
-import com.simprints.infra.sync.usecase.SyncUseCase
+import com.simprints.infra.sync.SyncOrchestrator
 import com.simprints.testtools.common.coroutines.TestCoroutineRule
 import com.simprints.testtools.common.livedata.getOrAwaitValue
 import io.mockk.*
@@ -31,7 +31,7 @@ internal class LogoutSyncViewModelTest {
     lateinit var configRepository: ConfigRepository
 
     @MockK
-    lateinit var sync: SyncUseCase
+    lateinit var syncOrchestrator: SyncOrchestrator
 
     @MockK
     lateinit var authStore: AuthStore
@@ -140,12 +140,12 @@ internal class LogoutSyncViewModelTest {
         imageSyncStatus: ImageSyncStatus,
     ) {
         val statusFlow = MutableStateFlow(SyncStatus(eventSyncState = eventSyncState, imageSyncStatus = imageSyncStatus))
-        every { sync.invoke(any(), any()) } returns statusFlow
+        every { syncOrchestrator.observeSyncState() } returns statusFlow
     }
 
     private fun createViewModel() = LogoutSyncViewModel(
         configRepository = configRepository,
-        sync = sync,
+        syncOrchestrator = syncOrchestrator,
         authStore = authStore,
         logoutUseCase = logoutUseCase,
     )

feature/dashboard/src/test/java/com/simprints/feature/dashboard/logout/usecase/LogoutUseCaseTest.kt

@@ -4,11 +4,15 @@ import androidx.arch.core.executor.testing.InstantTaskExecutorRule
 import com.simprints.infra.authlogic.AuthManager
 import com.simprints.infra.enrolment.records.repository.EnrolmentRecordRepository
 import com.simprints.infra.enrolment.records.repository.local.migration.RealmToRoomMigrationFlagsStore
+import com.simprints.infra.sync.ScheduleCommand
 import com.simprints.infra.sync.SyncOrchestrator
 import com.simprints.testtools.common.coroutines.TestCoroutineRule
 import io.mockk.MockKAnnotations
 import io.mockk.coVerify
+import io.mockk.every
 import io.mockk.impl.annotations.MockK
+import io.mockk.verify
+import kotlinx.coroutines.Job
 import kotlinx.coroutines.test.runTest
 import org.junit.Before
 import org.junit.Rule
@@ -37,6 +41,7 @@ class LogoutUseCaseTest {
     @Before
     fun setUp() {
         MockKAnnotations.init(this, relaxed = true)
+        every { syncOrchestrator.executeSchedulingCommand(any()) } returns Job().apply { complete() }
 
         useCase = LogoutUseCase(
             syncOrchestrator = syncOrchestrator,
@@ -51,8 +56,8 @@ class LogoutUseCaseTest {
     fun `Fully logs out when called`() = runTest {
         useCase.invoke()
 
+        verify { syncOrchestrator.executeSchedulingCommand(ScheduleCommand.Everything.unschedule()) }
         coVerify {
-            syncOrchestrator.cancelBackgroundWork()
             syncOrchestrator.deleteEventSyncInfo()
             authManager.signOut()
             flagsStore.clearMigrationFlags()