Add battery optimization permission to onboarding (#6095)

* Request battery optimization permission when leaving Location screens

* Remove battery optimization for LocationForSecureConnectionScreen

* Cleanup

* Fix crash on Android 6 with Github icon

* Apply suggestion

Author: TimoPtr

app/src/main/kotlin/io/homeassistant/companion/android/onboarding/locationsharing/LocationSharingScreen.kt

@@ -1,5 +1,7 @@
 package io.homeassistant.companion.android.onboarding.locationsharing
 
+import androidx.activity.compose.rememberLauncherForActivityResult
+import androidx.activity.result.contract.ActivityResultContracts
 import androidx.compose.foundation.Image
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Column
@@ -17,6 +19,7 @@ import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
 import com.google.accompanist.permissions.ExperimentalPermissionsApi
@@ -29,6 +32,7 @@ import io.homeassistant.companion.android.common.compose.theme.HADimens
 import io.homeassistant.companion.android.common.compose.theme.HATextStyle
 import io.homeassistant.companion.android.common.compose.theme.HAThemeForPreview
 import io.homeassistant.companion.android.common.compose.theme.MaxButtonWidth
+import io.homeassistant.companion.android.common.util.createBatteryOptimizationIntent
 import io.homeassistant.companion.android.util.compose.HAPreviews
 import io.homeassistant.companion.android.util.compose.rememberLocationPermission
 
@@ -114,10 +118,20 @@ private fun LocationSharingContent(
 @Composable
 @OptIn(ExperimentalPermissionsApi::class)
 private fun BottomButtons(onGoToNextScreen: () -> Unit, onLocationSharingResponse: (enabled: Boolean) -> Unit) {
+    val context = LocalContext.current
+    val batteryOptimizationLauncher = rememberLauncherForActivityResult(
+        contract = ActivityResultContracts.StartActivityForResult(),
+        onResult = { onGoToNextScreen() },
+    )
     val permissions = rememberLocationPermission(
         onPermissionResult = {
             // We ignore the result and proceed even if the user rejected the permission
-            onGoToNextScreen()
+            val intent = context.createBatteryOptimizationIntent()
+            if (intent != null) {
+                batteryOptimizationLauncher.launch(intent)
+            } else {
+                onGoToNextScreen()
+            }
         },
     )
     Column(

app/src/main/res/drawable/github.xml

@@ -5,6 +5,5 @@
     android:viewportHeight="96">
   <path
       android:pathData="M48.854,0C21.839,0 0,22 0,49.217c0,21.756 13.993,40.172 33.405,46.69 2.427,0.49 3.316,-1.059 3.316,-2.362 0,-1.141 -0.08,-5.052 -0.08,-9.127 -13.59,2.934 -16.42,-5.867 -16.42,-5.867 -2.184,-5.704 -5.42,-7.17 -5.42,-7.17 -4.448,-3.015 0.324,-3.015 0.324,-3.015 4.934,0.326 7.523,5.052 7.523,5.052 4.367,7.496 11.404,5.378 14.235,4.074 0.404,-3.178 1.699,-5.378 3.074,-6.6 -10.839,-1.141 -22.243,-5.378 -22.243,-24.283 0,-5.378 1.94,-9.778 5.014,-13.2 -0.485,-1.222 -2.184,-6.275 0.486,-13.038 0,0 4.125,-1.304 13.426,5.052a46.97,46.97 0,0 1,12.214 -1.63c4.125,0 8.33,0.571 12.213,1.63 9.302,-6.356 13.427,-5.052 13.427,-5.052 2.67,6.763 0.97,11.816 0.485,13.038 3.155,3.422 5.015,7.822 5.015,13.2 0,18.905 -11.404,23.06 -22.324,24.283 1.78,1.548 3.316,4.481 3.316,9.126 0,6.6 -0.08,11.897 -0.08,13.526 0,1.304 0.89,2.853 3.316,2.364 19.412,-6.52 33.405,-24.935 33.405,-46.691C97.707,22 75.788,0 48.854,0z"
-      android:fillColor="#24292f"
-      android:fillType="evenOdd"/>
+      android:fillColor="#24292f" />
 </vector>

app/src/test/kotlin/io/homeassistant/companion/android/onboarding/locationsharing/LocationSharingScreenTest.kt

@@ -41,7 +41,7 @@ class LocationSharingScreenTest {
     val composeTestRule = createAndroidComposeRule<HiltComponentActivity>()
 
     @Test
-    fun `Given screen displayed when clicking on share and granting permission then go to next screen and location response set to true`() {
+    fun `Given screen displayed when clicking on share and granting permission then go to next screen and location response set to true and ask for battery optimization`() {
         composeTestRule.apply {
             testScreen {
                 // Check all elements are displayed
@@ -52,12 +52,13 @@ class LocationSharingScreenTest {
                 assertTrue(locationSharingResponse == true)
                 assertTrue(goToNextScreenClicked)
                 registry.assertLocationPermissionRequested()
+                registry.assertBatteryOptimizationRequested()
             }
         }
     }
 
     @Test
-    fun `Given screen displayed when clicking do not share then go to next screen and location response set to false`() {
+    fun `Given screen displayed when clicking do not share then go to next screen and location response set to false without battery optimization`() {
         composeTestRule.apply {
             testScreen(false) {
                 // Check all elements are displayed
@@ -68,12 +69,13 @@ class LocationSharingScreenTest {
                 assertTrue(locationSharingResponse == false)
                 assertTrue(goToNextScreenClicked)
                 registry.assertLocationPermissionNotRequested()
+                registry.assertBatteryOptimizationNotRequested()
             }
         }
     }
 
     @Test
-    fun `Given screen displayed when clicking on share and not granting permission then go to next screen and location response set to true`() {
+    fun `Given screen displayed when clicking on share and not granting permission then go to next screen and location response set to true and still ask for battery optimization`() {
         composeTestRule.apply {
             testScreen(false) {
                 // Check all elements are displayed
@@ -85,6 +87,8 @@ class LocationSharingScreenTest {
                 assertTrue(goToNextScreenClicked)
                 // background is only requested if foreground is granted
                 registry.assertLocationPermissionRequested(false)
+                // Battery optimization is still requested even when permission is denied
+                registry.assertBatteryOptimizationRequested()
             }
         }
     }

app/src/test/kotlin/io/homeassistant/companion/android/util/LocationPermissionActivityResultRegistry.kt

@@ -1,26 +1,46 @@
 package io.homeassistant.companion.android.util
 
+import android.app.Activity
+import android.content.Intent
+import android.provider.Settings
+import androidx.activity.result.ActivityResult
 import androidx.activity.result.ActivityResultRegistry
 import androidx.activity.result.contract.ActivityResultContract
 import androidx.activity.result.contract.ActivityResultContracts
 import androidx.core.app.ActivityOptionsCompat
 import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Assertions.assertFalse
+import org.junit.jupiter.api.Assertions.assertTrue
 
 /**
  * Fake activity result registry to invoke the callback of rememberLocationPermission
+ * and rememberBatteryOptimizationLauncher.
  */
 class LocationPermissionActivityResultRegistry(val granted: Boolean) : ActivityResultRegistry() {
     val permissionRequested = mutableListOf<String>()
+    var batteryOptimizationRequested = false
+        private set
 
+    @Suppress("UNCHECKED_CAST")
     override fun <I, O> onLaunch(requestCode: Int, contract: ActivityResultContract<I, O>, input: I, options: ActivityOptionsCompat?) {
-        if (contract is ActivityResultContracts.RequestMultiplePermissions) {
-            (input as? Array<String>)?.toList()?.let {
-                permissionRequested.addAll(it)
+        when (contract) {
+            is ActivityResultContracts.RequestMultiplePermissions -> {
+                (input as? Array<String>)?.toList()?.let {
+                    permissionRequested.addAll(it)
+                }
+                dispatchResult(requestCode, mapOf("android.permission.ACCESS_FINE_LOCATION" to granted, "android.permission.ACCESS_COARSE_LOCATION" to granted))
+            }
+            is ActivityResultContracts.RequestPermission -> {
+                permissionRequested.add(input.toString())
+                dispatchResult(requestCode, granted)
+            }
+            is ActivityResultContracts.StartActivityForResult -> {
+                val intent = input as? Intent
+                if (intent?.action == Settings.ACTION_REQUEST_IGNORE_BATTERY_OPTIMIZATIONS) {
+                    batteryOptimizationRequested = true
+                    dispatchResult(requestCode, ActivityResult(Activity.RESULT_OK, null) as O)
+                }
             }
-            dispatchResult(requestCode, mapOf("android.permission.ACCESS_FINE_LOCATION" to granted, "android.permission.ACCESS_COARSE_LOCATION" to granted))
-        } else if (contract is ActivityResultContracts.RequestPermission) {
-            permissionRequested.add(input.toString())
-            dispatchResult(requestCode, granted)
         }
     }
 
@@ -38,4 +58,12 @@ class LocationPermissionActivityResultRegistry(val granted: Boolean) : ActivityR
     fun assertLocationPermissionNotRequested() {
         assertEquals(emptyList<String>(), permissionRequested)
     }
+
+    fun assertBatteryOptimizationRequested() {
+        assertTrue(batteryOptimizationRequested)
+    }
+
+    fun assertBatteryOptimizationNotRequested() {
+        assertFalse(batteryOptimizationRequested)
+    }
 }

app/src/test/kotlin/io/homeassistant/companion/android/webview/addto/EntityAddToActionTest.kt

@@ -5,27 +5,12 @@ import io.homeassistant.companion.android.common.R as commonR
 import io.homeassistant.companion.android.common.util.isAutomotive
 import io.mockk.every
 import io.mockk.mockk
-import io.mockk.mockkStatic
-import io.mockk.unmockkStatic
-import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 
 class EntityAddToActionTest {
 
-    private lateinit var context: Context
-
-    @BeforeEach
-    fun setUp() {
-        context = mockk(relaxed = true)
-        mockkStatic("io.homeassistant.companion.android.common.util.ContextExtKt")
-    }
-
-    @AfterEach
-    fun tearDown() {
-        unmockkStatic("io.homeassistant.companion.android.common.util.ContextExtKt")
-    }
+    private val context: Context = mockk(relaxed = true)
 
     @Test
     fun `Given automotive context when testing AndroidAutoFavorite then return correct attributes`() {

common/src/main/kotlin/io/homeassistant/companion/android/common/util/ContextExt.kt

@@ -1,9 +1,9 @@
 package io.homeassistant.companion.android.common.util
 
+import android.annotation.SuppressLint
 import android.content.Context
 import android.content.Intent
 import android.content.SharedPreferences
-import android.os.Build
 import android.os.PowerManager
 import android.provider.Settings
 import androidx.core.content.getSystemService
@@ -48,12 +48,28 @@ fun Context.isAutomotive(): Boolean {
  */
 fun Context.maybeAskForIgnoringBatteryOptimizations() {
     if (!isIgnoringBatteryOptimizations()) {
-        startActivity(
-            Intent(
-                Settings.ACTION_REQUEST_IGNORE_BATTERY_OPTIMIZATIONS,
-                "package:$packageName".toUri(),
-            ),
+        startActivity(createBatteryOptimizationIntent())
+    }
+}
+
+/**
+ * Creates an [Intent] to request ignoring battery optimizations.
+ *
+ * This intent can be used with an [androidx.activity.result.ActivityResultLauncher] to
+ * wait for the user to respond to the battery optimization dialog before proceeding.
+ *
+ * @return An [Intent] configured to request battery optimization exemption, or `null` if
+ *         the app is already ignoring battery optimizations or not available.
+ */
+@SuppressLint("BatteryLife")
+fun Context.createBatteryOptimizationIntent(): Intent? {
+    return if (!isIgnoringBatteryOptimizations()) {
+        Intent(
+            Settings.ACTION_REQUEST_IGNORE_BATTERY_OPTIMIZATIONS,
+            "package:$packageName".toUri(),
         )
+    } else {
+        null
     }
 }
 
@@ -64,8 +80,7 @@ fun Context.maybeAskForIgnoringBatteryOptimizations() {
  * @return `true` if the app is ignoring battery optimizations, `false` otherwise.
  */
 fun Context.isIgnoringBatteryOptimizations(): Boolean {
-    return Build.VERSION.SDK_INT <= Build.VERSION_CODES.M ||
-        getSystemService<PowerManager>()
-            ?.isIgnoringBatteryOptimizations(packageName ?: "")
-            ?: false
+    return getSystemService<PowerManager>()
+        ?.isIgnoringBatteryOptimizations(packageName ?: "")
+        ?: false
 }