#1819 feat: refactor dialogs for setting up the accessibility service

Author: sds100

CHANGELOG.md

@@ -15,6 +15,7 @@
 - #1335 Intent API to enable/disable/toggle a key map.
 - #114 action to force stop app, and an action to clear an app from recents
 - #727 Actions to send SMS messages: "Send SMS" and "Compose SMS"
+- #1819 Explain how to enable the accessibility service restricted setting
 
 ## Removed
 

app/src/main/java/io/github/sds100/keymapper/MainFragment.kt

@@ -37,6 +37,7 @@ import io.github.sds100.keymapper.base.home.HomeKeyMapListScreen
 import io.github.sds100.keymapper.base.keymaps.ConfigKeyMapScreen
 import io.github.sds100.keymapper.base.keymaps.ConfigKeyMapViewModel
 import io.github.sds100.keymapper.base.keymaps.KeyMapOptionsScreen
+import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegateImpl
 import io.github.sds100.keymapper.base.utils.navigation.NavDestination
 import io.github.sds100.keymapper.base.utils.navigation.NavigationProviderImpl
 import io.github.sds100.keymapper.base.utils.navigation.SetupNavigation
@@ -54,6 +55,9 @@ class MainFragment : Fragment() {
     @Inject
     lateinit var navigationProvider: NavigationProviderImpl
 
+    @Inject
+    lateinit var setupAccessibilityServiceDelegate: SetupAccessibilityServiceDelegateImpl
+
     private lateinit var composeView: ComposeView
 
     private lateinit var navController: NavHostController
@@ -104,6 +108,7 @@ class MainFragment : Fragment() {
                                     .add(WindowInsets.displayCutout.only(sides = WindowInsetsSides.Horizontal)),
                             ),
                         navController = navController,
+                        setupAccessibilityServiceDelegate = setupAccessibilityServiceDelegate,
                         composableDestinations = {
                             composableDestinations(navController)
                         },
@@ -130,6 +135,7 @@ class MainFragment : Fragment() {
     private fun NavGraphBuilder.composableDestinations(navController: NavController) {
         composable<NavDestination.Home> {
             val snackbarState = remember { SnackbarHostState() }
+
             val viewModel: HomeViewModel = hiltViewModel()
 
             HomeKeyMapListScreen(

app/src/main/java/io/github/sds100/keymapper/home/HomeViewModel.kt

@@ -8,6 +8,7 @@ import io.github.sds100.keymapper.base.home.ListKeyMapsUseCase
 import io.github.sds100.keymapper.base.home.ShowHomeScreenAlertsUseCase
 import io.github.sds100.keymapper.base.keymaps.PauseKeyMapsUseCase
 import io.github.sds100.keymapper.base.onboarding.OnboardingUseCase
+import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegate
 import io.github.sds100.keymapper.base.sorting.SortKeyMapsUseCase
 import io.github.sds100.keymapper.base.system.inputmethod.ShowInputMethodPickerUseCase
 import io.github.sds100.keymapper.base.utils.navigation.NavigationProvider
@@ -25,6 +26,7 @@ class HomeViewModel @Inject constructor(
     resourceProvider: ResourceProvider,
     private val sortKeyMaps: SortKeyMapsUseCase,
     private val showInputMethodPickerUseCase: ShowInputMethodPickerUseCase,
+    val setupAccessibilityServiceDelegate: SetupAccessibilityServiceDelegate,
     fixKeyEventActionDelegate: FixKeyEventActionDelegate,
     navigationProvider: NavigationProvider,
     dialogProvider: DialogProvider,
@@ -37,6 +39,7 @@ class HomeViewModel @Inject constructor(
     resourceProvider,
     sortKeyMaps,
     showInputMethodPickerUseCase,
+    setupAccessibilityServiceDelegate,
     fixKeyEventActionDelegate,
     navigationProvider,
     dialogProvider,

app/src/main/java/io/github/sds100/keymapper/trigger/ConfigTriggerViewModel.kt

@@ -6,6 +6,7 @@ import io.github.sds100.keymapper.base.keymaps.DisplayKeyMapUseCase
 import io.github.sds100.keymapper.base.keymaps.FingerprintGesturesSupportedUseCase
 import io.github.sds100.keymapper.base.onboarding.OnboardingTipDelegate
 import io.github.sds100.keymapper.base.onboarding.OnboardingUseCase
+import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegate
 import io.github.sds100.keymapper.base.shortcuts.CreateKeyMapShortcutUseCase
 import io.github.sds100.keymapper.base.trigger.BaseConfigTriggerViewModel
 import io.github.sds100.keymapper.base.trigger.ConfigTriggerUseCase
@@ -26,6 +27,7 @@ class ConfigTriggerViewModel @Inject constructor(
     private val createKeyMapShortcut: CreateKeyMapShortcutUseCase,
     private val displayKeyMap: DisplayKeyMapUseCase,
     private val fingerprintGesturesSupported: FingerprintGesturesSupportedUseCase,
+    setupAccessibilityServiceDelegate: SetupAccessibilityServiceDelegate,
     onboardingTipDelegate: OnboardingTipDelegate,
     triggerSetupDelegate: TriggerSetupDelegate,
     resourceProvider: ResourceProvider,
@@ -38,6 +40,7 @@ class ConfigTriggerViewModel @Inject constructor(
     createKeyMapShortcut = createKeyMapShortcut,
     displayKeyMap = displayKeyMap,
     fingerprintGesturesSupported = fingerprintGesturesSupported,
+    setupAccessibilityServiceDelegate = setupAccessibilityServiceDelegate,
     onboardingTipDelegate = onboardingTipDelegate,
     triggerSetupDelegate = triggerSetupDelegate,
     resourceProvider = resourceProvider,

base/src/main/java/io/github/sds100/keymapper/base/ActivityViewModel.kt

@@ -3,17 +3,18 @@ package io.github.sds100.keymapper.base
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import dagger.hilt.android.lifecycle.HiltViewModel
+import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegate
 import io.github.sds100.keymapper.base.utils.navigation.NavDestination
 import io.github.sds100.keymapper.base.utils.navigation.NavigationProvider
 import io.github.sds100.keymapper.base.utils.navigation.navigate
 import io.github.sds100.keymapper.base.utils.ui.DialogProvider
 import io.github.sds100.keymapper.base.utils.ui.ResourceProvider
-import io.github.sds100.keymapper.base.utils.ui.ViewModelHelper
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 @HiltViewModel
 class ActivityViewModel @Inject constructor(
+    private val setupAccessibilityServiceDelegate: SetupAccessibilityServiceDelegate,
     resourceProvider: ResourceProvider,
     dialogProvider: DialogProvider,
     navigationProvider: NavigationProvider,
@@ -25,12 +26,7 @@ class ActivityViewModel @Inject constructor(
     var previousNightMode: Int? = null
 
     fun onCantFindAccessibilitySettings() {
-        viewModelScope.launch {
-            ViewModelHelper.handleCantFindAccessibilitySettings(
-                resourceProvider = this@ActivityViewModel,
-                dialogProvider = this@ActivityViewModel,
-            )
-        }
+        setupAccessibilityServiceDelegate.showCantFindAccessibilitySettingsDialog()
     }
 
     fun launchProModeSetup() {

base/src/main/java/io/github/sds100/keymapper/base/BaseMainNavHost.kt

@@ -23,6 +23,8 @@ import io.github.sds100.keymapper.base.actions.uielement.InteractUiElementViewMo
 import io.github.sds100.keymapper.base.constraints.ChooseConstraintScreen
 import io.github.sds100.keymapper.base.constraints.ChooseConstraintViewModel
 import io.github.sds100.keymapper.base.logging.LogScreen
+import io.github.sds100.keymapper.base.onboarding.HandleAccessibilityServiceDialogs
+import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegateImpl
 import io.github.sds100.keymapper.base.promode.ProModeScreen
 import io.github.sds100.keymapper.base.promode.ProModeSetupScreen
 import io.github.sds100.keymapper.base.settings.AutomaticChangeImeSettingsScreen
@@ -37,8 +39,11 @@ import kotlinx.serialization.json.Json
 fun BaseMainNavHost(
     modifier: Modifier = Modifier,
     navController: NavHostController,
+    setupAccessibilityServiceDelegate: SetupAccessibilityServiceDelegateImpl,
     composableDestinations: NavGraphBuilder.() -> Unit = {},
 ) {
+    HandleAccessibilityServiceDialogs(setupAccessibilityServiceDelegate)
+
     NavHost(
         modifier = modifier,
         navController = navController,

base/src/main/java/io/github/sds100/keymapper/base/BaseSingletonHiltModule.kt

@@ -28,6 +28,8 @@ import io.github.sds100.keymapper.base.keymaps.PauseKeyMapsUseCase
 import io.github.sds100.keymapper.base.keymaps.PauseKeyMapsUseCaseImpl
 import io.github.sds100.keymapper.base.onboarding.OnboardingUseCase
 import io.github.sds100.keymapper.base.onboarding.OnboardingUseCaseImpl
+import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegate
+import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegateImpl
 import io.github.sds100.keymapper.base.system.accessibility.AccessibilityServiceAdapterImpl
 import io.github.sds100.keymapper.base.system.accessibility.ControlAccessibilityServiceUseCase
 import io.github.sds100.keymapper.base.system.accessibility.ControlAccessibilityServiceUseCaseImpl
@@ -170,4 +172,8 @@ abstract class BaseSingletonHiltModule {
     @Binds
     @Singleton
     abstract fun bindEnableKeyMapsUseCase(impl: EnableKeyMapsUseCaseImpl): EnableKeyMapsUseCase
+
+    @Binds
+    @Singleton
+    abstract fun bindSetupAccessibilityServiceDelegate(impl: SetupAccessibilityServiceDelegateImpl): SetupAccessibilityServiceDelegate
 }

base/src/main/java/io/github/sds100/keymapper/base/BaseViewModelHiltModule.kt

@@ -168,4 +168,5 @@ abstract class BaseViewModelHiltModule {
     @Binds
     @ViewModelScoped
     abstract fun bindFixKeyEventActionDelegate(impl: FixKeyEventActionDelegateImpl): FixKeyEventActionDelegate
+
 }

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

@@ -7,6 +7,7 @@ import io.github.sds100.keymapper.base.R
 import io.github.sds100.keymapper.base.actions.keyevent.FixKeyEventActionDelegate
 import io.github.sds100.keymapper.base.keymaps.KeyMap
 import io.github.sds100.keymapper.base.keymaps.ShortcutModel
+import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegate
 import io.github.sds100.keymapper.base.utils.getFullMessage
 import io.github.sds100.keymapper.base.utils.isFixable
 import io.github.sds100.keymapper.base.utils.navigation.NavDestination
@@ -17,6 +18,7 @@ import io.github.sds100.keymapper.base.utils.ui.LinkType
 import io.github.sds100.keymapper.base.utils.ui.ResourceProvider
 import io.github.sds100.keymapper.base.utils.ui.ViewModelHelper
 import io.github.sds100.keymapper.base.utils.ui.compose.ComposeIconInfo
+import io.github.sds100.keymapper.common.utils.AccessibilityServiceError
 import io.github.sds100.keymapper.common.utils.KMError
 import io.github.sds100.keymapper.common.utils.State
 import io.github.sds100.keymapper.common.utils.dataOrNull
@@ -44,12 +46,14 @@ class ConfigActionsViewModel @Inject constructor(
     private val createAction: CreateActionUseCase,
     private val testAction: TestActionUseCase,
     private val config: ConfigActionsUseCase,
+    setupAccessibilityServiceDelegate: SetupAccessibilityServiceDelegate,
     fixKeyEventActionDelegate: FixKeyEventActionDelegate,
     resourceProvider: ResourceProvider,
     navigationProvider: NavigationProvider,
     dialogProvider: DialogProvider,
 ) : ViewModel(),
     ActionOptionsBottomSheetCallback,
+    SetupAccessibilityServiceDelegate by setupAccessibilityServiceDelegate,
     ResourceProvider by resourceProvider,
     DialogProvider by dialogProvider,
     NavigationProvider by navigationProvider,
@@ -248,21 +252,8 @@ class ConfigActionsViewModel @Inject constructor(
 
     private suspend fun attemptTestAction(actionData: ActionData) {
         testAction.invoke(actionData).onFailure { error ->
-
-            if (error is KMError.AccessibilityServiceDisabled) {
-                ViewModelHelper.handleAccessibilityServiceStoppedDialog(
-                    resourceProvider = this,
-                    dialogProvider = this,
-                    startService = displayAction::startAccessibilityService,
-                )
-            }
-
-            if (error is KMError.AccessibilityServiceCrashed) {
-                ViewModelHelper.handleAccessibilityServiceCrashedDialog(
-                    resourceProvider = this,
-                    dialogProvider = this,
-                    restartService = displayAction::restartAccessibilityService,
-                )
+            if (error is AccessibilityServiceError) {
+                showFixAccessibilityServiceDialog(error)
             }
         }
     }

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

@@ -2,6 +2,7 @@ package io.github.sds100.keymapper.base.actions.keyevent
 
 import android.os.Build
 import dagger.hilt.android.scopes.ViewModelScoped
+import io.github.sds100.keymapper.base.onboarding.SetupAccessibilityServiceDelegate
 import io.github.sds100.keymapper.base.system.accessibility.ControlAccessibilityServiceUseCase
 import io.github.sds100.keymapper.base.trigger.ProModeStatus
 import io.github.sds100.keymapper.base.trigger.SetupInputMethodUseCase
@@ -10,7 +11,6 @@ import io.github.sds100.keymapper.base.utils.navigation.NavigationProvider
 import io.github.sds100.keymapper.base.utils.navigation.navigate
 import io.github.sds100.keymapper.base.utils.ui.DialogProvider
 import io.github.sds100.keymapper.base.utils.ui.ResourceProvider
-import io.github.sds100.keymapper.base.utils.ui.ViewModelHelper
 import io.github.sds100.keymapper.common.utils.Constants
 import io.github.sds100.keymapper.common.utils.onFailure
 import io.github.sds100.keymapper.data.Keys
@@ -26,7 +26,6 @@ import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.combine
-import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.flow.flatMapLatest
 import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.flow.map
@@ -44,6 +43,7 @@ class FixKeyEventActionDelegateImpl @Inject constructor(
     val systemBridgeConnectionManager: SystemBridgeConnectionManager,
     val setupInputMethodUseCase: SetupInputMethodUseCase,
     val preferenceRepository: PreferenceRepository,
+    val setupAccessibilityServiceDelegate: SetupAccessibilityServiceDelegate,
     resourceProvider: ResourceProvider,
     dialogProvider: DialogProvider,
     navigationProvider: NavigationProvider,
@@ -128,21 +128,7 @@ class FixKeyEventActionDelegateImpl @Inject constructor(
 
     override fun onEnableAccessibilityServiceClick() {
         viewModelScope.launch {
-            val state = controlAccessibilityServiceUseCase.serviceState.first()
-
-            if (state == AccessibilityServiceState.DISABLED) {
-                ViewModelHelper.handleAccessibilityServiceStoppedDialog(
-                    resourceProvider = this@FixKeyEventActionDelegateImpl,
-                    dialogProvider = this@FixKeyEventActionDelegateImpl,
-                    startService = controlAccessibilityServiceUseCase::startService,
-                )
-            } else if (state == AccessibilityServiceState.CRASHED) {
-                ViewModelHelper.handleAccessibilityServiceCrashedDialog(
-                    resourceProvider = this@FixKeyEventActionDelegateImpl,
-                    dialogProvider = this@FixKeyEventActionDelegateImpl,
-                    restartService = controlAccessibilityServiceUseCase::restartService,
-                )
-            }
+            setupAccessibilityServiceDelegate.showEnableAccessibilityServiceDialog()
         }
     }