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)

composeApp/src/commonMain/kotlin/org/ooni/probe/ui/onboarding/OnboardingScreen.kt

@@ -25,6 +25,7 @@ import androidx.compose.foundation.pager.rememberPagerState
 import androidx.compose.foundation.rememberScrollState
 import androidx.compose.foundation.shape.CircleShape
 import androidx.compose.foundation.verticalScroll
+import androidx.compose.material3.AlertDialog
 import androidx.compose.material3.Button
 import androidx.compose.material3.ButtonDefaults
 import androidx.compose.material3.LocalContentColor
@@ -48,6 +49,7 @@ import androidx.compose.ui.layout.ContentScale
 import androidx.compose.ui.platform.testTag
 import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.unit.dp
+import androidx.compose.ui.window.DialogProperties
 import co.touchlab.kermit.Logger
 import dev.icerock.moko.permissions.DeniedAlwaysException
 import dev.icerock.moko.permissions.DeniedException
@@ -58,8 +60,11 @@ import dev.icerock.moko.permissions.compose.PermissionsControllerFactory
 import dev.icerock.moko.permissions.compose.rememberPermissionsControllerFactory
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
+import ooniprobe.composeapp.generated.resources.Modal_Autorun_BatteryOptimization
+import ooniprobe.composeapp.generated.resources.Modal_Cancel
 import ooniprobe.composeapp.generated.resources.Modal_EnableNotifications_Paragraph
 import ooniprobe.composeapp.generated.resources.Modal_EnableNotifications_Title
+import ooniprobe.composeapp.generated.resources.Modal_OK
 import ooniprobe.composeapp.generated.resources.Onboarding_AutomatedTesting_Paragraph
 import ooniprobe.composeapp.generated.resources.Onboarding_AutomatedTesting_Title
 import ooniprobe.composeapp.generated.resources.Onboarding_Crash_Button_No
@@ -97,9 +102,9 @@ fun OnboardingScreen(
     state: OnboardingViewModel.State,
     onEvent: (OnboardingViewModel.Event) -> Unit,
 ) {
-    val pagerState = rememberPagerState(0, pageCount = { state.stepList.size })
+    val pagerState = rememberPagerState(0, pageCount = { state.totalSteps })
     LaunchedEffect(state.stepIndex) {
-        pagerState.animateScrollToPage(state.stepIndex)
+        pagerState.scrollToPage(state.stepIndex)
     }
     var showQuiz by remember { mutableStateOf(false) }
 
@@ -108,10 +113,9 @@ fun OnboardingScreen(
             state = pagerState,
             userScrollEnabled = false,
             modifier = Modifier.fillMaxSize(),
-        ) { stepIndex ->
-            val step = state.stepList[state.stepIndex]
+        ) {
             Surface(
-                color = step.surfaceColor,
+                color = state.step.surfaceColor,
                 contentColor = LocalCustomColors.current.onOnboarding,
             ) {
                 Column(
@@ -120,7 +124,7 @@ fun OnboardingScreen(
                         .padding(WindowInsets.navigationBars.asPaddingValues())
                         .padding(bottom = 48.dp),
                 ) {
-                    when (state.stepList[stepIndex]) {
+                    when (state.step) {
                         OnboardingViewModel.Step.WhatIs ->
                             WhatIsStep(onEvent)
 
@@ -130,8 +134,8 @@ fun OnboardingScreen(
                                 onShowQuiz = { showQuiz = true },
                             )
 
-                        OnboardingViewModel.Step.AutomatedTesting ->
-                            AutomatedTestingStep(onEvent)
+                        is OnboardingViewModel.Step.AutomatedTesting ->
+                            AutomatedTestingStep(state.step.showBatteryOptimizationDialog, onEvent)
 
                         OnboardingViewModel.Step.CrashReporting ->
                             CrashReportingStep(onEvent)
@@ -245,7 +249,10 @@ fun ColumnScope.HeadsUpStep(
 }
 
 @Composable
-fun ColumnScope.AutomatedTestingStep(onEvent: (OnboardingViewModel.Event) -> Unit) {
+fun ColumnScope.AutomatedTestingStep(
+    showBatteryOptimizationDialog: Boolean,
+    onEvent: (OnboardingViewModel.Event) -> Unit,
+) {
     OnboardingImage(OrganizationConfig.onboardingImages.image3)
     OnboardingTitle(Res.string.Onboarding_AutomatedTesting_Title)
     Column(
@@ -263,15 +270,37 @@ fun ColumnScope.AutomatedTestingStep(onEvent: (OnboardingViewModel.Event) -> Uni
             onClick = { onEvent(OnboardingViewModel.Event.AutoTestNoClicked) },
             modifier = Modifier
                 .padding(horizontal = 8.dp)
-                .weight(1f),
+                .weight(1f)
+                .testTag("No-AutoTest"),
         )
         OnboardingMainButton(
             text = Res.string.Onboarding_Crash_Button_Yes,
             onClick = { onEvent(OnboardingViewModel.Event.AutoTestYesClicked) },
             modifier = Modifier
                 .padding(horizontal = 8.dp)
-                .weight(1f)
-                .testTag("Yes-AutoTest"),
+                .weight(1f),
+        )
+    }
+
+    if (showBatteryOptimizationDialog) {
+        AlertDialog(
+            onDismissRequest = { },
+            text = { Text(stringResource(Res.string.Modal_Autorun_BatteryOptimization)) },
+            confirmButton = {
+                TextButton(onClick = {
+                    onEvent(OnboardingViewModel.Event.BatteryOptimizationOkClicked)
+                }) {
+                    Text(stringResource(Res.string.Modal_OK))
+                }
+            },
+            dismissButton = {
+                TextButton(onClick = {
+                    onEvent(OnboardingViewModel.Event.BatteryOptimizationCancelClicked)
+                }) {
+                    Text(stringResource(Res.string.Modal_Cancel))
+                }
+            },
+            properties = DialogProperties(dismissOnClickOutside = false, dismissOnBackPress = false),
         )
     }
 }