#1918 auto start system bridge when upgrading to version 4 and shizuku is started

Author: sds100

base/src/main/java/io/github/sds100/keymapper/base/promode/SystemBridgeAutoStarter.kt

@@ -5,6 +5,7 @@ import android.os.Build
 import androidx.annotation.RequiresApi
 import androidx.core.app.NotificationCompat
 import io.github.sds100.keymapper.base.BaseMainActivity
+import io.github.sds100.keymapper.base.BuildConfig
 import io.github.sds100.keymapper.base.R
 import io.github.sds100.keymapper.base.system.notifications.NotificationController.Companion.CHANNEL_SETUP_ASSISTANT
 import io.github.sds100.keymapper.base.system.notifications.NotificationController.Companion.ID_SYSTEM_BRIDGE_STATUS
@@ -16,7 +17,6 @@ import io.github.sds100.keymapper.common.utils.Constants
 import io.github.sds100.keymapper.data.Keys
 import io.github.sds100.keymapper.data.PreferenceDefaults
 import io.github.sds100.keymapper.data.repositories.PreferenceRepository
-import io.github.sds100.keymapper.sysbridge.BuildConfig
 import io.github.sds100.keymapper.sysbridge.manager.SystemBridgeConnectionManager
 import io.github.sds100.keymapper.sysbridge.manager.SystemBridgeConnectionState
 import io.github.sds100.keymapper.sysbridge.manager.isConnected
@@ -188,19 +188,39 @@ class SystemBridgeAutoStarter @Inject constructor(
 
     private suspend fun handleAutoStartFromPreVersion4() {
         @Suppress("DEPRECATION")
-        val upgradedFromPreVersion4 = preferences.get(Keys.hasRootPermissionLegacy).first() != null
+        val upgradedFromPreVersion4 = preferences.get(Keys.handledUpgradeToProMode).first() == null
+
+        if (!upgradedFromPreVersion4) {
+            return
+        }
 
         val isRooted: Boolean = withTimeoutOrNull(1000) {
             suAdapter.isRootGranted.filterNotNull().first()
         } ?: false
 
-        if (upgradedFromPreVersion4 && isRooted) {
+        if (isRooted) {
             Timber.i(
                 "Auto starting system bridge because upgraded from pre version 4.0 and was rooted",
             )
 
             autoStart(AutoStartType.ROOT)
-            preferences.set(Keys.handledRootToProModeUpgrade, true)
+            preferences.set(Keys.handledUpgradeToProMode, true)
+            preferences.set(Keys.keyEventActionsUseSystemBridge, true)
+            return
+        }
+
+        // Try Shizuku after the root check because root is more reliable.
+        val isShizukuStarted: Boolean = shizukuAdapter.isStarted.value
+
+        if (isShizukuStarted) {
+            Timber.i(
+                "Auto starting system bridge because upgraded from pre version 4.0 and Shizuku was started",
+            )
+
+            autoStart(AutoStartType.SHIZUKU)
+            preferences.set(Keys.handledUpgradeToProMode, true)
+            preferences.set(Keys.keyEventActionsUseSystemBridge, true)
+            return
         }
     }
 

base/src/main/java/io/github/sds100/keymapper/base/settings/SettingsScreen.kt

@@ -359,7 +359,7 @@ private fun Content(
             modifier = Modifier
                 .fillMaxWidth()
                 .padding(horizontal = 16.dp),
-            isProModeSelected = state.keyEventActionsUseSystemBridege,
+            isProModeSelected = state.keyEventActionsUseSystemBridge,
             onSelected = onKeyEventActionMethodSelected,
         )
 

base/src/main/java/io/github/sds100/keymapper/base/settings/SettingsViewModel.kt

@@ -67,7 +67,7 @@ class SettingsViewModel @Inject constructor(
             forceVibrate = values[3] as Boolean? ?: false,
             hideHomeScreenAlerts = values[4] as Boolean? ?: false,
             showDeviceDescriptors = values[5] as Boolean? ?: false,
-            keyEventActionsUseSystemBridege = values[6] as Boolean? ?: false,
+            keyEventActionsUseSystemBridge = values[6] as Boolean? ?: false,
         )
     }.stateIn(viewModelScope, SharingStarted.Lazily, MainSettingsState())
 
@@ -360,7 +360,7 @@ data class MainSettingsState(
     val loggingEnabled: Boolean = false,
     val hideHomeScreenAlerts: Boolean = false,
     val showDeviceDescriptors: Boolean = false,
-    val keyEventActionsUseSystemBridege: Boolean = false,
+    val keyEventActionsUseSystemBridge: Boolean = false,
 )
 
 data class DefaultSettingsState(

base/src/test/java/io/github/sds100/keymapper/base/promode/SystemBridgeAutoStarterTest.kt

@@ -221,13 +221,53 @@ class SystemBridgeAutoStarterTest {
         runTest(testDispatcher) {
             isRootGrantedFlow.value = true
             fakePreferences.set(Keys.isSystemBridgeUsed, null)
-            fakePreferences.set(Keys.hasRootPermissionLegacy, true)
+            fakePreferences.set(Keys.handledUpgradeToProMode, null)
 
             systemBridgeAutoStarter.init()
             advanceUntilIdle()
 
             verify(mockConnectionManager).startWithRoot()
-            assertThat(fakePreferences.get(Keys.handledRootToProModeUpgrade).first(), `is`(true))
+        }
+
+    @Test
+    fun `auto start from pre version 4 when shizuku is started and it was never used before`() =
+        runTest(testDispatcher) {
+            shizukuIsStartedFlow.value = true
+            shizukuPermissionGrantedFlow.value = true
+            fakePreferences.set(Keys.isSystemBridgeUsed, null)
+            fakePreferences.set(Keys.handledUpgradeToProMode, null)
+
+            systemBridgeAutoStarter.init()
+            advanceUntilIdle()
+
+            verify(mockConnectionManager).startWithShizuku()
+        }
+
+    @Test
+    fun `set key event actions to use system bridge when upgrading to version 4 and rooted`() =
+        runTest(testDispatcher) {
+            isRootGrantedFlow.value = true
+            fakePreferences.set(Keys.isSystemBridgeUsed, null)
+            fakePreferences.set(Keys.handledUpgradeToProMode, null)
+
+            systemBridgeAutoStarter.init()
+            advanceUntilIdle()
+
+            assertThat(fakePreferences.get(Keys.keyEventActionsUseSystemBridge).first(), `is`(true))
+        }
+
+    @Test
+    fun `set key event actions to use system bridge when upgrading to version 4 and shizuku is started`() =
+        runTest(testDispatcher) {
+            shizukuIsStartedFlow.value = true
+            shizukuPermissionGrantedFlow.value = true
+            fakePreferences.set(Keys.isSystemBridgeUsed, null)
+            fakePreferences.set(Keys.handledUpgradeToProMode, null)
+
+            systemBridgeAutoStarter.init()
+            advanceUntilIdle()
+
+            assertThat(fakePreferences.get(Keys.keyEventActionsUseSystemBridge).first(), `is`(true))
         }
 
     @Test
@@ -274,6 +314,7 @@ class SystemBridgeAutoStarterTest {
     fun `do not auto start when emergency killed`() = runTest(testDispatcher) {
         isRootGrantedFlow.value = true
         fakePreferences.set(Keys.isSystemBridgeEmergencyKilled, true)
+        fakePreferences.set(Keys.handledUpgradeToProMode, true)
 
         systemBridgeAutoStarter.init()
         advanceUntilIdle()
@@ -345,6 +386,7 @@ class SystemBridgeAutoStarterTest {
     @Test
     fun `do not auto start when auto start is disabled`() = runTest(testDispatcher) {
         fakePreferences.set(Keys.isSystemBridgeKeepAliveEnabled, false)
+        fakePreferences.set(Keys.handledUpgradeToProMode, true)
         isRootGrantedFlow.value = true
 
         systemBridgeAutoStarter.init()
@@ -611,6 +653,7 @@ class SystemBridgeAutoStarterTest {
     fun `do not auto start with Shizuku on launch if it was never used before`() =
         runTest(testDispatcher) {
             fakePreferences.set(Keys.isSystemBridgeUsed, null)
+            fakePreferences.set(Keys.handledUpgradeToProMode, true)
             shizukuIsStartedFlow.value = true
             shizukuPermissionGrantedFlow.value = true
 

data/src/main/java/io/github/sds100/keymapper/data/Keys.kt

@@ -157,10 +157,10 @@ object Keys {
     val shellCommandScriptText = stringPreferencesKey("key_shell_command_script_text")
 
     /**
-     * This is stored as true when PRO Mode has been auto started after upgrading
-     * to 4.0 on a rooted device.
+     * This is stored as true when PRO Mode has been auto started after updating
+     * to 4.0 and Key Mapper previously had root or shizuku permission.
      */
-    val handledRootToProModeUpgrade = booleanPreferencesKey("key_handled_root_to_pro_mode_upgrade")
+    val handledUpgradeToProMode = booleanPreferencesKey("key_handled_upgrade_to_pro_mode")
 
     val handledMigrateScreenOffKeyMapsNotification =
         booleanPreferencesKey("key_handled_migrate_screen_off_key_maps_notification")