feat: only auto-update descriptors if installed (#655)

Author: aanorbel

composeApp/src/androidMain/kotlin/org/ooni/probe/AndroidApplication.kt

@@ -55,6 +55,7 @@ class AndroidApplication : Application() {
             startSingleRunInner = appWorkerManager::startSingleRun,
             configureAutoRun = appWorkerManager::configureAutoRun,
             configureDescriptorAutoUpdate = appWorkerManager::configureDescriptorAutoUpdate,
+            cancelDescriptorAutoUpdate = appWorkerManager::cancelDescriptorAutoUpdate,
             startDescriptorsUpdate = appWorkerManager::startDescriptorsUpdate,
             launchAction = ::launchAction,
             batteryOptimization = batteryOptimization,

composeApp/src/androidMain/kotlin/org/ooni/probe/background/AppWorkerManager.kt

@@ -53,6 +53,13 @@ class AppWorkerManager(
         }
     }
 
+    suspend fun cancelDescriptorAutoUpdate(): Boolean {
+        return withContext(backgroundDispatcher) {
+            workManager.cancelUniqueWork(DescriptorUpdateWorker.AutoUpdateWorkerName)
+            true
+        }
+    }
+
     suspend fun configureDescriptorAutoUpdate(): Boolean {
         return withContext(backgroundDispatcher) {
             val request = PeriodicWorkRequestBuilder<DescriptorUpdateWorker>(1, TimeUnit.DAYS)

composeApp/src/commonMain/kotlin/org/ooni/probe/App.kt

@@ -98,10 +98,11 @@ fun App(
     LaunchedEffect(Unit) {
         dependencies.bootstrapTestDescriptors()
         dependencies.bootstrapPreferences()
-        dependencies.configureDescriptorAutoUpdate()
-        dependencies.startDescriptorsUpdate(null)
         dependencies.startSingleRunInner(RunSpecification.OnlyUploadMissingResults)
     }
+    LaunchedEffect(Unit) {
+        dependencies.observeAndConfigureAutoUpdate()
+    }
     LaunchedEffect(Unit) {
         dependencies.finishInProgressData()
     }

composeApp/src/commonMain/kotlin/org/ooni/probe/di/Dependencies.kt

@@ -61,6 +61,7 @@ import org.ooni.probe.domain.GetSettings
 import org.ooni.probe.domain.GetStorageUsed
 import org.ooni.probe.domain.MarkJustFinishedTestAsSeen
 import org.ooni.probe.domain.ObserveAndConfigureAutoRun
+import org.ooni.probe.domain.ObserveAndConfigureAutoUpdate
 import org.ooni.probe.domain.RunBackgroundStateManager
 import org.ooni.probe.domain.RunDescriptors
 import org.ooni.probe.domain.RunNetTest
@@ -119,6 +120,7 @@ class Dependencies(
     val startSingleRunInner: (RunSpecification) -> Unit,
     private val configureAutoRun: suspend (AutoRunParameters) -> Unit,
     val configureDescriptorAutoUpdate: suspend () -> Boolean,
+    val cancelDescriptorAutoUpdate: suspend () -> Boolean,
     val startDescriptorsUpdate: suspend (List<InstalledTestDescriptorModel>?) -> Unit,
     val localeDirection: (() -> LayoutDirection)? = null,
     private val isWebViewAvailable: () -> Boolean,
@@ -347,6 +349,17 @@ class Dependencies(
             getAutoRunSettings = getAutoRunSettings::invoke,
         )
     }
+
+    val observeAndConfigureAutoUpdate by lazy {
+        ObserveAndConfigureAutoUpdate(
+            backgroundContext = backgroundContext,
+            listAllInstalledTestDescriptors = testDescriptorRepository::listAll,
+            configureDescriptorAutoUpdate = configureDescriptorAutoUpdate,
+            cancelDescriptorAutoUpdate = cancelDescriptorAutoUpdate,
+            startDescriptorsUpdate = startDescriptorsUpdate,
+        )
+    }
+
     private val rejectDescriptorUpdate by lazy {
         RejectDescriptorUpdate(
             updateDescriptorRejectedRevision = testDescriptorRepository::updateRejectedRevision,

composeApp/src/commonMain/kotlin/org/ooni/probe/domain/ObserveAndConfigureAutoUpdate.kt

@@ -0,0 +1,32 @@
+package org.ooni.probe.domain
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.distinctUntilChanged
+import kotlinx.coroutines.flow.launchIn
+import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.onEach
+import org.ooni.probe.data.models.InstalledTestDescriptorModel
+import kotlin.coroutines.CoroutineContext
+
+class ObserveAndConfigureAutoUpdate(
+    private val backgroundContext: CoroutineContext,
+    private val listAllInstalledTestDescriptors: () -> Flow<List<InstalledTestDescriptorModel>>,
+    private val configureDescriptorAutoUpdate: suspend () -> Boolean,
+    private val cancelDescriptorAutoUpdate: suspend () -> Boolean,
+    private val startDescriptorsUpdate: suspend (List<InstalledTestDescriptorModel>?) -> Unit,
+) {
+    operator fun invoke() =
+        listAllInstalledTestDescriptors()
+            .map { it.isNotEmpty() }
+            .distinctUntilChanged()
+            .onEach { enabled ->
+                if (enabled) {
+                    configureDescriptorAutoUpdate()
+                    startDescriptorsUpdate(null)
+                } else {
+                    cancelDescriptorAutoUpdate()
+                }
+            }
+            .launchIn(CoroutineScope(backgroundContext))
+}

composeApp/src/desktopMain/kotlin/org/ooni/probe/BuildDependencies.kt

@@ -43,6 +43,7 @@ val dependencies = Dependencies(
     startSingleRunInner = ::startSingleRun,
     configureAutoRun = ::configureAutoRun,
     configureDescriptorAutoUpdate = ::configureDescriptorAutoUpdate,
+    cancelDescriptorAutoUpdate = ::cancelDescriptorAutoUpdate,
     startDescriptorsUpdate = ::startDescriptorsUpdate,
     launchAction = ::launchAction,
     batteryOptimization = object : BatteryOptimization {},
@@ -93,6 +94,11 @@ private fun configureDescriptorAutoUpdate(): Boolean {
     return true
 }
 
+private fun cancelDescriptorAutoUpdate(): Boolean {
+    // TODO: Desktop - background running
+    return true
+}
+
 private fun startDescriptorsUpdate(descriptors: List<InstalledTestDescriptorModel>?) {
     // TODO: Desktop - background running
     CoroutineScope(Dispatchers.IO).launch {

composeApp/src/iosMain/kotlin/org/ooni/probe/SetupDependencies.kt

@@ -88,6 +88,7 @@ class SetupDependencies(
         startSingleRunInner = ::startSingleRun,
         configureAutoRun = ::configureAutoRun,
         configureDescriptorAutoUpdate = ::configureDescriptorAutoUpdate,
+        cancelDescriptorAutoUpdate = ::cancelDescriptorAutoUpdate,
         startDescriptorsUpdate = ::startDescriptorsUpdate,
         localeDirection = ::localeDirection,
         launchAction = ::launchAction,
@@ -294,6 +295,17 @@ class SetupDependencies(
         } ?: false
     }
 
+    private fun cancelDescriptorAutoUpdate(): Boolean {
+        Logger.d("Cancelling descriptor auto update")
+        return try {
+            BGTaskScheduler.sharedScheduler.cancelTaskRequestWithIdentifier(OrganizationConfig.updateDescriptorTaskId)
+            true
+        } catch (e: Exception) {
+            Logger.e(e) { "Failed to cancel descriptor auto update" }
+            false
+        }
+    }
+
     private fun configureDescriptorAutoUpdate(): Boolean {
         Logger.d("Configuring descriptor auto update")
         return BGTaskScheduler.sharedScheduler.submitTaskRequest(