feat: Show dialog if Expert mode fails to start after 60 seconds instead of waiting indefinitely

Author: sds100

CHANGELOG.md

@@ -8,6 +8,7 @@
 - #2025 add report bug button to home screen menu.
 - #2027 Make the key map sorting feature easier to understand.
 - #2016 Show a warning when repeating a key code action less than 20 ms with expert mode triggers.
+- Show dialog if Expert mode fails to start after 60 seconds instead of waiting indefinitely.
 
 ## Fixed
 

base/src/main/java/io/github/sds100/keymapper/base/actions/ConfigActionsViewModel.kt

@@ -30,6 +30,7 @@ import io.github.sds100.keymapper.common.utils.mapData
 import io.github.sds100.keymapper.common.utils.onFailure
 import io.github.sds100.keymapper.system.SystemError
 import io.github.sds100.keymapper.system.permissions.Permission
+import javax.inject.Inject
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
@@ -42,7 +43,6 @@ import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.stateIn
 import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.launch
-import javax.inject.Inject
 
 @HiltViewModel
 class ConfigActionsViewModel @Inject constructor(

base/src/main/java/io/github/sds100/keymapper/base/expertmode/ExpertModeScreen.kt

@@ -38,6 +38,7 @@ import androidx.compose.material.icons.rounded.Numbers
 import androidx.compose.material.icons.rounded.RestartAlt
 import androidx.compose.material.icons.rounded.Usb
 import androidx.compose.material.icons.rounded.WarningAmber
+import androidx.compose.material3.AlertDialog
 import androidx.compose.material3.BottomAppBar
 import androidx.compose.material3.ButtonDefaults
 import androidx.compose.material3.CardDefaults
@@ -87,6 +88,12 @@ fun ExpertModeScreen(modifier: Modifier = Modifier, viewModel: ExpertModeViewMod
     val expertModeWarningState by viewModel.warningState.collectAsStateWithLifecycle()
     val expertModeState by viewModel.state.collectAsStateWithLifecycle()
 
+    if (viewModel.showStartErrorDialog) {
+        SystemBridgeStartErrorDialog(
+            onDismissRequest = viewModel::dismissStartErrorDialog,
+        )
+    }
+
     ExpertModeScreen(
         modifier = modifier,
         onBackClick = viewModel::onBackClick,
@@ -1074,6 +1081,39 @@ private fun PreviewUsbDebuggingSecuritySettingsCard() {
     }
 }
 
+@Composable
+private fun SystemBridgeStartErrorDialog(
+    modifier: Modifier = Modifier,
+    onDismissRequest: () -> Unit,
+) {
+    AlertDialog(
+        modifier = modifier,
+        onDismissRequest = onDismissRequest,
+        title = {
+            Text(stringResource(R.string.expert_mode_start_error_dialog_title))
+        },
+        text = {
+            Text(
+                stringResource(R.string.expert_mode_start_error_dialog_message),
+                style = MaterialTheme.typography.bodyMedium,
+            )
+        },
+        confirmButton = {
+            TextButton(onClick = onDismissRequest) {
+                Text(stringResource(R.string.pos_ok))
+            }
+        },
+    )
+}
+
+@Preview
+@Composable
+private fun PreviewSystemBridgeStartErrorDialog() {
+    KeyMapperTheme {
+        SystemBridgeStartErrorDialog(onDismissRequest = {})
+    }
+}
+
 @Preview
 @Composable
 private fun PreviewShellStartCard() {

base/src/main/java/io/github/sds100/keymapper/base/expertmode/ExpertModeViewModel.kt

@@ -70,6 +70,21 @@ class ExpertModeViewModel @Inject constructor(
             }
         }.stateIn(viewModelScope, SharingStarted.Eagerly, State.Loading)
 
+    var showStartErrorDialog by mutableStateOf(false)
+        private set
+
+    init {
+        viewModelScope.launch {
+            useCase.showStartError.collect {
+                showStartErrorDialog = true
+            }
+        }
+    }
+
+    fun dismissStartErrorDialog() {
+        showStartErrorDialog = false
+    }
+
     var showInfoCard by mutableStateOf(!useCase.isInfoDismissed())
         private set
 

base/src/main/java/io/github/sds100/keymapper/base/expertmode/SystemBridgeSetupUseCase.kt

@@ -107,6 +107,9 @@ class SystemBridgeSetupUseCaseImpl @Inject constructor(
     override val isSystemBridgeStarting: Flow<Boolean> =
         systemBridgeSetupController.isStarting
 
+    override val showStartError: Flow<Unit> =
+        systemBridgeSetupController.showStartError
+
     override val isNotificationPermissionGranted: Flow<Boolean> =
         permissionAdapter.isGrantedFlow(Permission.POST_NOTIFICATIONS)
 
@@ -325,6 +328,7 @@ interface SystemBridgeSetupUseCase {
 
     val isSystemBridgeConnected: Flow<Boolean>
     val isSystemBridgeStarting: Flow<Boolean>
+    val showStartError: Flow<Unit>
     val nextSetupStep: Flow<SystemBridgeSetupStep>
 
     val isRootGranted: Flow<Boolean>

base/src/main/res/values/strings.xml

@@ -1693,6 +1693,8 @@
     <string name="expert_mode_shell_start_get_command">Get command</string>
     <string name="expert_mode_shell_start_retry">Retry</string>
     <string name="expert_mode_shell_start_error">Failed to get command. Please try again.</string>
+    <string name="expert_mode_start_error_dialog_title">Failed to start Expert Mode</string>
+    <string name="expert_mode_start_error_dialog_message">The system bridge could not be started. Please try again or contact the developer at contact@keymapper.app if the problem persists.</string>
     <string name="expert_mode_shell_start_clipboard_label">System Bridge Start Command</string>
     <string name="expert_mode_shell_start_copy_content_description">Copy command to clipboard</string>
 

sysbridge/src/main/java/io/github/sds100/keymapper/sysbridge/manager/SystemBridgeConnectionManager.kt

@@ -99,7 +99,7 @@ class SystemBridgeConnectionManagerImpl @Inject constructor(
             try {
                 starter.refreshStarterScript()
             } catch (e: Exception) {
-                Timber.e("Failed to refresh system bridge starter script", e)
+                Timber.e("Failed to refresh system bridge starter script. $e")
             }
         }
     }
@@ -282,7 +282,7 @@ class SystemBridgeConnectionManagerImpl @Inject constructor(
         starter.startWithRoot()
     }
 
-    override fun startWithShizuku() {
+    override suspend fun startWithShizuku() {
         starter.startWithShizuku()
     }
 
@@ -304,7 +304,7 @@ interface SystemBridgeConnectionManager {
 
     suspend fun startWithRoot()
 
-    fun startWithShizuku()
+    suspend fun startWithShizuku()
 
     suspend fun startWithAdb()
 

sysbridge/src/main/java/io/github/sds100/keymapper/sysbridge/service/SystemBridgeSetupController.kt

@@ -23,6 +23,7 @@ import io.github.sds100.keymapper.sysbridge.adb.AdbManager
 import io.github.sds100.keymapper.sysbridge.manager.SystemBridgeConnectionManager
 import io.github.sds100.keymapper.sysbridge.manager.SystemBridgeConnectionState
 import io.github.sds100.keymapper.sysbridge.manager.awaitConnected
+import io.github.sds100.keymapper.sysbridge.service.SystemBridgeSetupControllerImpl.Companion.START_TIMEOUT_MS
 import javax.inject.Inject
 import javax.inject.Singleton
 import kotlinx.coroutines.CoroutineScope
@@ -54,6 +55,7 @@ class SystemBridgeSetupControllerImpl @Inject constructor(
     companion object {
         private const val DEVELOPER_OPTIONS_SETTING = "development_settings_enabled"
         private const val ADB_WIRELESS_SETTING = "adb_wifi_enabled"
+        private const val START_TIMEOUT_MS = 60_000L
     }
 
     private val activityManager: ActivityManager by lazy { ctx.getSystemService()!! }
@@ -62,6 +64,9 @@ class SystemBridgeSetupControllerImpl @Inject constructor(
     override val isStarting: StateFlow<Boolean> = _isStarting
     private var startJob: Job? = null
 
+    private val _showStartError: MutableSharedFlow<Unit> = MutableSharedFlow()
+    override val showStartError: Flow<Unit> = _showStartError
+
     override val isDeveloperOptionsEnabled: MutableStateFlow<Boolean> =
         MutableStateFlow(getDeveloperOptionsEnabled())
 
@@ -107,48 +112,30 @@ class SystemBridgeSetupControllerImpl @Inject constructor(
     }
 
     override fun startWithRoot() {
-        if (startJob?.isActive == true) {
-            Timber.i("System Bridge is already starting")
-            return
-        }
-
-        startJob = coroutineScope.launch {
-            _isStarting.value = true
-            try {
-                connectionManager.startWithRoot()
-                // Wait for the service to bind and start system bridge
-                withTimeoutOrNull(10000L) {
-                    connectionManager.awaitConnected()
-                }
-            } finally {
-                _isStarting.value = false
-            }
+        launchStartJob {
+            connectionManager.startWithRoot()
         }
     }
 
     override fun startWithShizuku() {
-        if (startJob?.isActive == true) {
-            Timber.i("System Bridge is already starting")
-            return
-        }
-
-        startJob = coroutineScope.launch {
-            _isStarting.value = true
-            try {
-                connectionManager.startWithShizuku()
-
-                // Wait for the service to bind and start system bridge
-                withTimeoutOrNull(10000L) {
-                    connectionManager.awaitConnected()
-                }
-            } finally {
-                _isStarting.value = false
-            }
+        launchStartJob {
+            connectionManager.startWithShizuku()
         }
     }
 
     @RequiresApi(Build.VERSION_CODES.R)
     override fun startWithAdb() {
+        launchStartJob {
+            connectionManager.startWithAdb()
+        }
+    }
+
+    /**
+     * Launch a start job that runs [start], then waits up to [START_TIMEOUT_MS] for the
+     * system bridge to connect. If it does not connect in time, an error is emitted
+     * via [showStartError].
+     */
+    private fun launchStartJob(start: suspend () -> Unit) {
         if (startJob?.isActive == true) {
             Timber.i("System Bridge is already starting")
             return
@@ -157,11 +144,17 @@ class SystemBridgeSetupControllerImpl @Inject constructor(
         startJob = coroutineScope.launch {
             _isStarting.value = true
             try {
-                connectionManager.startWithAdb()
+                start()
+
                 // Wait for the service to bind and start system bridge
-                withTimeoutOrNull(10000L) {
+                val connected = withTimeoutOrNull(START_TIMEOUT_MS) {
                     connectionManager.awaitConnected()
                 }
+
+                if (connected == null) {
+                    Timber.e("System Bridge failed to start within ${START_TIMEOUT_MS}ms")
+                    _showStartError.emit(Unit)
+                }
             } finally {
                 _isStarting.value = false
             }
@@ -422,6 +415,7 @@ class SystemBridgeSetupControllerImpl @Inject constructor(
 interface SystemBridgeSetupController {
     val setupAssistantStep: Flow<SystemBridgeSetupStep?>
     val isStarting: StateFlow<Boolean>
+    val showStartError: Flow<Unit>
 
     val isDeveloperOptionsEnabled: Flow<Boolean>
     fun enableDeveloperOptions()