Merge pull request #186 from ooni/battery-optimizations

Request to ignore battery optimizations

composeApp/build.gradle.kts

@@ -53,7 +53,6 @@ kotlin {
             // This makes instrumented tests depend on commonTest and androidUnitTest sources
             sourceSetTree.set(KotlinSourceSetTree.test)
         }
-        instrumentedTestVariant { }
     }
 
     iosX64()

composeApp/src/androidInstrumentedTest/kotlin/org/ooni/probe/uitesting/OnboardingTest.kt

@@ -46,7 +46,7 @@ class OnboardingTest {
                 clickOnText("True")
 
                 wait { onNodeWithText("Automated testing").isDisplayed() }
-                clickOnTag("Yes-AutoTest")
+                clickOnTag("No-AutoTest")
 
                 wait { onNodeWithText("Crash Reporting").isDisplayed() }
                 clickOnTag("Yes-CrashReporting")
@@ -63,7 +63,7 @@ class OnboardingTest {
             }
 
             assertEquals(
-                true,
+                false,
                 preferences.getValueByKey(SettingsKey.AUTOMATED_TESTING_ENABLED).first(),
             )
             assertEquals(true, preferences.getValueByKey(SettingsKey.SEND_CRASH).first())

composeApp/src/androidMain/AndroidManifest.xml

@@ -6,6 +6,7 @@
     <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
+    <uses-permission android:name="android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS" />
 
     <application
         android:name=".AndroidApplication"

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

@@ -12,6 +12,7 @@ import android.net.Uri
 import android.os.BatteryManager
 import android.os.Build
 import android.os.LocaleList
+import android.os.PowerManager
 import androidx.core.content.FileProvider
 import androidx.datastore.core.DataStore
 import androidx.datastore.preferences.SharedPreferencesMigration
@@ -25,6 +26,7 @@ import okio.Path.Companion.toPath
 import org.ooni.engine.AndroidNetworkTypeFinder
 import org.ooni.engine.AndroidOonimkallBridge
 import org.ooni.probe.background.AppWorkerManager
+import org.ooni.probe.config.AndroidBatteryOptimization
 import org.ooni.probe.data.models.FileSharing
 import org.ooni.probe.di.Dependencies
 import org.ooni.probe.shared.Platform
@@ -53,9 +55,12 @@ class AndroidApplication : Application() {
             configureDescriptorAutoUpdate = appWorkerManager::configureDescriptorAutoUpdate,
             fetchDescriptorUpdate = appWorkerManager::fetchDescriptorUpdate,
             shareFile = ::shareFile,
+            batteryOptimization = batteryOptimization,
         )
     }
 
+    private val mainActivityLifecycleCallbacks = MainActivityLifecycleCallbacks()
+
     override fun onCreate() {
         super.onCreate()
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
@@ -65,6 +70,7 @@ class AndroidApplication : Application() {
                 LocaleList.forLanguageTags(getString(R.string.supported_languages)),
             )
         }
+        registerActivityLifecycleCallbacks(mainActivityLifecycleCallbacks)
     }
 
     private val platformInfo by lazy {
@@ -194,4 +200,14 @@ class AndroidApplication : Application() {
             false
         }
     }
+
+    private val batteryOptimization by lazy {
+        AndroidBatteryOptimization(
+            powerManager = getSystemService(PowerManager::class.java),
+            packageName = packageName,
+            requestCall = { callback ->
+                mainActivityLifecycleCallbacks.activity?.requestIgnoreBatteryOptimization(callback)
+            },
+        )
+    }
 }

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

@@ -1,10 +1,15 @@
 package org.ooni.probe
 
+import android.annotation.SuppressLint
+import android.content.Context
 import android.content.Intent
+import android.net.Uri
 import android.os.Bundle
+import android.provider.Settings
 import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
 import androidx.activity.enableEdgeToEdge
+import androidx.activity.result.contract.ActivityResultContract
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.getValue
@@ -60,4 +65,28 @@ class MainActivity : ComponentActivity() {
             }
         }
     }
+
+    // Battery Optimization
+
+    private var ignoreBatteryOptimizationCallback: (() -> Unit)? = null
+
+    private val ignoreBatteryOptimizationContract =
+        registerForActivityResult(object : ActivityResultContract<Unit, Unit>() {
+            @SuppressLint("BatteryLife")
+            override fun createIntent(
+                context: Context,
+                input: Unit,
+            ) = Intent(Settings.ACTION_REQUEST_IGNORE_BATTERY_OPTIMIZATIONS)
+                .setData(Uri.parse("package:$packageName"))
+
+            override fun parseResult(
+                resultCode: Int,
+                intent: Intent?,
+            ) {}
+        }) { ignoreBatteryOptimizationCallback?.invoke() }
+
+    fun requestIgnoreBatteryOptimization(callback: () -> Unit) {
+        ignoreBatteryOptimizationCallback = callback
+        ignoreBatteryOptimizationContract.launch(Unit)
+    }
 }

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

@@ -0,0 +1,34 @@
+package org.ooni.probe
+
+import android.app.Activity
+import android.app.Application.ActivityLifecycleCallbacks
+import android.os.Bundle
+
+class MainActivityLifecycleCallbacks : ActivityLifecycleCallbacks {
+    var activity: MainActivity? = null
+        private set
+
+    override fun onActivityCreated(
+        activity: Activity,
+        savedInstanceState: Bundle?,
+    ) {
+        this.activity = activity as? MainActivity
+    }
+
+    override fun onActivityStarted(activity: Activity) {}
+
+    override fun onActivityResumed(activity: Activity) {}
+
+    override fun onActivityPaused(activity: Activity) {}
+
+    override fun onActivityStopped(activity: Activity) {}
+
+    override fun onActivitySaveInstanceState(
+        activity: Activity,
+        outState: Bundle,
+    ) {}
+
+    override fun onActivityDestroyed(activity: Activity) {
+        this.activity = null
+    }
+}

composeApp/src/androidMain/kotlin/org/ooni/probe/config/AndroidBatteryOptimization.kt

@@ -0,0 +1,20 @@
+package org.ooni.probe.config
+
+import android.os.PowerManager
+
+class AndroidBatteryOptimization(
+    private val powerManager: PowerManager,
+    private val packageName: String,
+    private val requestCall: (() -> Unit) -> Unit,
+) : BatteryOptimization {
+    override val isSupported = true
+
+    override val isIgnoring: Boolean
+        get() = powerManager.isIgnoringBatteryOptimizations(packageName)
+
+    override fun requestIgnore(onResponse: (Boolean) -> Unit) {
+        requestCall {
+            onResponse(isIgnoring)
+        }
+    }
+}

composeApp/src/commonMain/composeResources/values/strings-common.xml

@@ -224,6 +224,8 @@
     <string name="Modal_CustomURL_Title_NotSaved">Are you sure?</string>
     <string name="Modal_CustomURL_NotSaved">Your URLs will not be saved when you leave this screen. Are you sure you want to leave this screen?</string>
 
+    <string name="Modal_Autorun_BatteryOptimization">OONI Probe cannot run automatically without battery optimization. Do you want to try again?</string>
+
     <!-- New Strings -->
     <string name="back">Back</string>
     <string name="refresh">refresh</string>

composeApp/src/commonMain/kotlin/org/ooni/probe/config/BatteryOptimization.kt

@@ -0,0 +1,12 @@
+package org.ooni.probe.config
+
+interface BatteryOptimization {
+    val isSupported: Boolean get() = false
+
+    val isIgnoring: Boolean
+        get() = throw IllegalStateException("Battery Optimization not supported")
+
+    fun requestIgnore(onResponse: (Boolean) -> Unit) {
+        throw IllegalStateException("Battery Optimization not supported")
+    }
+}

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

@@ -22,6 +22,7 @@ import org.ooni.engine.NetworkTypeFinder
 import org.ooni.engine.OonimkallBridge
 import org.ooni.engine.TaskEventMapper
 import org.ooni.probe.Database
+import org.ooni.probe.config.BatteryOptimization
 import org.ooni.probe.data.disk.DeleteFiles
 import org.ooni.probe.data.disk.DeleteFilesOkio
 import org.ooni.probe.data.disk.ReadFile
@@ -111,6 +112,7 @@ class Dependencies(
     val fetchDescriptorUpdate: suspend (List<InstalledTestDescriptorModel>?) -> Unit,
     val localeDirection: (() -> LayoutDirection)? = null,
     private val shareFile: (FileSharing) -> Boolean,
+    private val batteryOptimization: BatteryOptimization,
 ) {
     // Common
 
@@ -426,6 +428,7 @@ class Dependencies(
         platformInfo = platformInfo,
         preferenceRepository = preferenceRepository,
         launchUrl = { launchUrl(it, null) },
+        batteryOptimization = batteryOptimization,
     )
 
     fun proxyViewModel(onBack: () -> Unit) = ProxyViewModel(onBack, preferenceRepository)