Fix modal contents overlapping screen lock pin #2692

app/src/main/kotlin/io/element/android/x/MainActivity.kt

@@ -32,20 +32,26 @@
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.platform.LocalUriHandler
 import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
+import androidx.lifecycle.Lifecycle
+import androidx.lifecycle.lifecycleScope
+import androidx.lifecycle.repeatOnLifecycle
 import com.bumble.appyx.core.integration.NodeHost
 import com.bumble.appyx.core.integrationpoint.NodeActivity
 import com.bumble.appyx.core.plugin.NodeReadyObserver
 import io.element.android.compound.theme.ElementTheme
 import io.element.android.compound.theme.Theme
 import io.element.android.compound.theme.isDark
 import io.element.android.compound.theme.mapToTheme
+import io.element.android.features.lockscreen.api.LockScreenEntryPoint
+import io.element.android.features.lockscreen.api.LockScreenLockState
+import io.element.android.features.lockscreen.api.LockScreenService
 import io.element.android.features.lockscreen.api.handleSecureFlag
-import io.element.android.features.lockscreen.api.isLocked
 import io.element.android.libraries.architecture.bindings
 import io.element.android.libraries.core.log.logger.LoggerTag
 import io.element.android.libraries.designsystem.utils.snackbar.LocalSnackbarDispatcher
 import io.element.android.x.di.AppBindings
 import io.element.android.x.intent.SafeUriHandler
+import kotlinx.coroutines.launch
 import timber.log.Timber
 
 private val loggerTag = LoggerTag("MainActivity")
@@ -59,27 +65,13 @@
         installSplashScreen()
         super.onCreate(savedInstanceState)
         appBindings = bindings()
-        appBindings.lockScreenService().handleSecureFlag(this)
+        setupLockManagement(appBindings.lockScreenService(), appBindings.lockScreenEntryPoint())
         enableEdgeToEdge()
         setContent {
             MainContent(appBindings)
         }
     }
 
-    @Deprecated("")
-    override fun onBackPressed() {
-        // If the app is locked, we need to intercept onBackPressed before it goes to OnBackPressedDispatcher.
-        // Indeed, otherwise we would need to trick Appyx backstack management everywhere.
-        // Without this trick, we would get pop operations on the hidden backstack.
-        if (appBindings.lockScreenService().isLocked) {
-            // Do not kill the app in this case, just go to background.
-            moveTaskToBack(false)
-        } else {
-            @Suppress("DEPRECATION")
-            super.onBackPressed()
-        }
-    }
-
     @Composable
     private fun MainContent(appBindings: AppBindings) {
         val theme by remember {
@@ -96,8 +88,8 @@
             ) {
                 Box(
                     modifier = Modifier
-                        .fillMaxSize()
-                        .background(MaterialTheme.colorScheme.background),
+                            .fillMaxSize()
+                            .background(MaterialTheme.colorScheme.background),
                 ) {
                     if (migrationState.migrationAction.isSuccess()) {
                         MainNodeHost()
@@ -131,6 +123,22 @@
         }
     }
 
+    private fun setupLockManagement(
+        lockScreenService: LockScreenService,
+        lockScreenEntryPoint: LockScreenEntryPoint
+    ) {
+        lockScreenService.handleSecureFlag(this)
+        lifecycleScope.launch {
+            repeatOnLifecycle(Lifecycle.State.RESUMED) {
+                lockScreenService.lockState.collect { state ->
+                    if (state == LockScreenLockState.Locked) {
+                        startActivity(lockScreenEntryPoint.pinUnlockIntent(this@MainActivity))
+                    }
+                }
+            }
+        }
+    }
+
     /**
      * Called when:
      * - the launcher icon is clicked (if the app is already running);

app/src/main/kotlin/io/element/android/x/di/AppBindings.kt

@@ -18,6 +18,7 @@ package io.element.android.x.di
 
 import com.squareup.anvil.annotations.ContributesTo
 import io.element.android.features.api.MigrationEntryPoint
+import io.element.android.features.lockscreen.api.LockScreenEntryPoint
 import io.element.android.features.lockscreen.api.LockScreenService
 import io.element.android.features.preferences.api.store.AppPreferencesStore
 import io.element.android.features.rageshake.api.reporter.BugReporter
@@ -38,4 +39,6 @@ interface AppBindings {
     fun preferencesStore(): AppPreferencesStore
 
     fun migrationEntryPoint(): MigrationEntryPoint
+
+    fun lockScreenEntryPoint(): LockScreenEntryPoint
 }

appnav/src/main/kotlin/io/element/android/appnav/LoggedInFlowNode.kt

@@ -47,9 +47,6 @@ import io.element.android.features.createroom.api.CreateRoomEntryPoint
 import io.element.android.features.ftue.api.FtueEntryPoint
 import io.element.android.features.ftue.api.state.FtueService
 import io.element.android.features.ftue.api.state.FtueState
-import io.element.android.features.lockscreen.api.LockScreenEntryPoint
-import io.element.android.features.lockscreen.api.LockScreenLockState
-import io.element.android.features.lockscreen.api.LockScreenService
 import io.element.android.features.networkmonitor.api.NetworkMonitor
 import io.element.android.features.networkmonitor.api.NetworkStatus
 import io.element.android.features.preferences.api.PreferencesEntryPoint
@@ -100,8 +97,6 @@ class LoggedInFlowNode @AssistedInject constructor(
     private val coroutineScope: CoroutineScope,
     private val networkMonitor: NetworkMonitor,
     private val ftueService: FtueService,
-    private val lockScreenEntryPoint: LockScreenEntryPoint,
-    private val lockScreenStateService: LockScreenService,
     private val roomDirectoryEntryPoint: RoomDirectoryEntryPoint,
     private val matrixClient: MatrixClient,
     snackbarDispatcher: SnackbarDispatcher,
@@ -111,7 +106,7 @@ class LoggedInFlowNode @AssistedInject constructor(
         savedStateMap = buildContext.savedStateMap,
     ),
     permanentNavModel = PermanentNavModel(
-        navTargets = setOf(NavTarget.LoggedInPermanent, NavTarget.LockPermanent),
+        navTargets = setOf(NavTarget.LoggedInPermanent),
         savedStateMap = buildContext.savedStateMap,
     ),
     buildContext = buildContext,
@@ -189,9 +184,6 @@ class LoggedInFlowNode @AssistedInject constructor(
         @Parcelize
         data object LoggedInPermanent : NavTarget
 
-        @Parcelize
-        data object LockPermanent : NavTarget
-
         @Parcelize
         data object RoomList : NavTarget
 
@@ -235,11 +227,6 @@ class LoggedInFlowNode @AssistedInject constructor(
             NavTarget.LoggedInPermanent -> {
                 createNode<LoggedInNode>(buildContext)
             }
-            NavTarget.LockPermanent -> {
-                lockScreenEntryPoint.nodeBuilder(this, buildContext)
-                    .target(LockScreenEntryPoint.Target.Unlock)
-                    .build()
-            }
             NavTarget.RoomList -> {
                 val callback = object : RoomListEntryPoint.Callback {
                     override fun onRoomClicked(roomId: RoomId) {
@@ -430,15 +417,11 @@ class LoggedInFlowNode @AssistedInject constructor(
     @Composable
     override fun View(modifier: Modifier) {
         Box(modifier = modifier) {
-            val lockScreenState by lockScreenStateService.lockState.collectAsState()
             val ftueState by ftueService.state.collectAsState()
             BackstackView()
             if (ftueState is FtueState.Complete) {
                 PermanentChild(permanentNavModel = permanentNavModel, navTarget = NavTarget.LoggedInPermanent)
             }
-            if (lockScreenState == LockScreenLockState.Locked) {
-                PermanentChild(permanentNavModel = permanentNavModel, navTarget = NavTarget.LockPermanent)
-            }
         }
     }
 

changelog.d/2692.bugfix

@@ -0,0 +1 @@
+Fix modal contents overlapping screen lock pin.

features/ftue/impl/src/main/kotlin/io/element/android/features/ftue/impl/FtueFlowNode.kt

@@ -132,9 +132,8 @@ class FtueFlowNode @AssistedInject constructor(
                         lifecycleScope.launch { moveToNextStep() }
                     }
                 }
-                lockScreenEntryPoint.nodeBuilder(this, buildContext)
+                lockScreenEntryPoint.nodeBuilder(this, buildContext, LockScreenEntryPoint.Target.Setup)
                     .callback(callback)
-                    .target(LockScreenEntryPoint.Target.Setup)
                     .build()
             }
         }

features/lockscreen/api/src/main/kotlin/io/element/android/features/lockscreen/api/LockScreenEntryPoint.kt

@@ -16,17 +16,19 @@
 
 package io.element.android.features.lockscreen.api
 
+import android.content.Context
+import android.content.Intent
 import com.bumble.appyx.core.modality.BuildContext
 import com.bumble.appyx.core.node.Node
 import com.bumble.appyx.core.plugin.Plugin
 import io.element.android.libraries.architecture.FeatureEntryPoint
 
 interface LockScreenEntryPoint : FeatureEntryPoint {
-    fun nodeBuilder(parentNode: Node, buildContext: BuildContext): NodeBuilder
+    fun nodeBuilder(parentNode: Node, buildContext: BuildContext, navTarget: Target): NodeBuilder
+    fun pinUnlockIntent(context: Context): Intent
 
     interface NodeBuilder {
         fun callback(callback: Callback): NodeBuilder
-        fun target(target: Target): NodeBuilder
         fun build(): Node
     }
 
@@ -37,6 +39,5 @@ interface LockScreenEntryPoint : FeatureEntryPoint {
     enum class Target {
         Settings,
         Setup,
-        Unlock
     }
 }

features/lockscreen/impl/src/main/AndroidManifest.xml

@@ -0,0 +1,25 @@
+<!--
+  ~ Copyright (c) 2024 New Vector Ltd
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <application>
+        <activity
+            android:name="io.element.android.features.lockscreen.impl.unlock.activity.PinUnlockActivity"
+            android:configChanges="screenSize|screenLayout|orientation|keyboardHidden|keyboard|navigation|uiMode"/>
+    </application>
+
+</manifest>

features/lockscreen/impl/src/main/kotlin/io/element/android/features/lockscreen/impl/DefaultLockScreenEntryPoint.kt

@@ -16,18 +16,20 @@
 
 package io.element.android.features.lockscreen.impl
 
+import android.content.Context
+import android.content.Intent
 import com.bumble.appyx.core.modality.BuildContext
 import com.bumble.appyx.core.node.Node
 import com.squareup.anvil.annotations.ContributesBinding
 import io.element.android.features.lockscreen.api.LockScreenEntryPoint
+import io.element.android.features.lockscreen.impl.unlock.activity.PinUnlockActivity
 import io.element.android.libraries.architecture.createNode
 import io.element.android.libraries.di.AppScope
 import javax.inject.Inject
 
 @ContributesBinding(AppScope::class)
 class DefaultLockScreenEntryPoint @Inject constructor() : LockScreenEntryPoint {
-    override fun nodeBuilder(parentNode: Node, buildContext: BuildContext): LockScreenEntryPoint.NodeBuilder {
-        var innerTarget: LockScreenEntryPoint.Target = LockScreenEntryPoint.Target.Unlock
+    override fun nodeBuilder(parentNode: Node, buildContext: BuildContext, navTarget: LockScreenEntryPoint.Target): LockScreenEntryPoint.NodeBuilder {
         val callbacks = mutableListOf<LockScreenEntryPoint.Callback>()
 
         return object : LockScreenEntryPoint.NodeBuilder {
@@ -36,15 +38,9 @@
                 return this
             }
 
-            override fun target(target: LockScreenEntryPoint.Target): LockScreenEntryPoint.NodeBuilder {
-                innerTarget = target
-                return this
-            }
-
             override fun build(): Node {
                 val inputs = LockScreenFlowNode.Inputs(
-                    when (innerTarget) {
-                        LockScreenEntryPoint.Target.Unlock -> LockScreenFlowNode.NavTarget.Unlock
+                    when (navTarget) {
                         LockScreenEntryPoint.Target.Setup -> LockScreenFlowNode.NavTarget.Setup
                         LockScreenEntryPoint.Target.Settings -> LockScreenFlowNode.NavTarget.Settings
                     }
@@ -54,4 +50,8 @@
             }
         }
     }
+
+    override fun pinUnlockIntent(context: Context): Intent {
+        return PinUnlockActivity.newIntent(context)
+    }
 }

features/lockscreen/impl/src/main/kotlin/io/element/android/features/lockscreen/impl/LockScreenFlowNode.kt

@@ -30,7 +30,6 @@ import io.element.android.anvilannotations.ContributesNode
 import io.element.android.features.lockscreen.api.LockScreenEntryPoint
 import io.element.android.features.lockscreen.impl.settings.LockScreenSettingsFlowNode
 import io.element.android.features.lockscreen.impl.setup.LockScreenSetupFlowNode
-import io.element.android.features.lockscreen.impl.unlock.PinUnlockNode
 import io.element.android.libraries.architecture.BackstackView
 import io.element.android.libraries.architecture.BaseFlowNode
 import io.element.android.libraries.architecture.NodeInputs
@@ -44,20 +43,17 @@ class LockScreenFlowNode @AssistedInject constructor(
     @Assisted plugins: List<Plugin>,
 ) : BaseFlowNode<LockScreenFlowNode.NavTarget>(
     backstack = BackStack(
-        initialElement = plugins.filterIsInstance(Inputs::class.java).first().initialNavTarget,
+        initialElement = plugins.filterIsInstance<Inputs>().first().initialNavTarget,
         savedStateMap = buildContext.savedStateMap,
     ),
     buildContext = buildContext,
     plugins = plugins,
 ) {
     data class Inputs(
-        val initialNavTarget: NavTarget = NavTarget.Unlock,
+        val initialNavTarget: NavTarget,
     ) : NodeInputs
 
     sealed interface NavTarget : Parcelable {
-        @Parcelize
-        data object Unlock : NavTarget
-
         @Parcelize
         data object Setup : NavTarget
 
@@ -75,10 +71,6 @@ class LockScreenFlowNode @AssistedInject constructor(
 
     override fun resolve(navTarget: NavTarget, buildContext: BuildContext): Node {
         return when (navTarget) {
-            NavTarget.Unlock -> {
-                val inputs = PinUnlockNode.Inputs(isInAppUnlock = false)
-                createNode<PinUnlockNode>(buildContext, plugins = listOf(inputs))
-            }
             NavTarget.Setup -> {
                 val callback = OnSetupDoneCallback(plugins())
                 createNode<LockScreenSetupFlowNode>(buildContext, plugins = listOf(callback))

features/lockscreen/impl/src/main/kotlin/io/element/android/features/lockscreen/impl/settings/LockScreenSettingsFlowNode.kt

@@ -103,13 +103,12 @@ class LockScreenSettingsFlowNode @AssistedInject constructor(
     override fun resolve(navTarget: NavTarget, buildContext: BuildContext): Node {
         return when (navTarget) {
             NavTarget.Unlock -> {
-                val inputs = PinUnlockNode.Inputs(isInAppUnlock = true)
                 val callback = object : PinUnlockNode.Callback {
                     override fun onUnlock() {
                         backstack.newRoot(NavTarget.Settings)
                     }
                 }
-                createNode<PinUnlockNode>(buildContext, plugins = listOf(inputs, callback))
+                createNode<PinUnlockNode>(buildContext, plugins = listOf(callback))
             }
             NavTarget.SetupPin -> {
                 createNode<SetupPinNode>(buildContext)

features/lockscreen/impl/src/main/kotlin/io/element/android/features/lockscreen/impl/unlock/PinUnlockNode.kt

@@ -26,8 +26,6 @@ import com.bumble.appyx.core.plugin.plugins
 import dagger.assisted.Assisted
 import dagger.assisted.AssistedInject
 import io.element.android.anvilannotations.ContributesNode
-import io.element.android.libraries.architecture.NodeInputs
-import io.element.android.libraries.architecture.inputs
 import io.element.android.libraries.di.SessionScope
 
 @ContributesNode(SessionScope::class)
@@ -40,12 +38,6 @@ class PinUnlockNode @AssistedInject constructor(
         fun onUnlock()
     }
 
-    data class Inputs(
-        val isInAppUnlock: Boolean
-    ) : NodeInputs
-
-    private val inputs: Inputs = inputs()
-
     private fun onUnlock() {
         plugins<Callback>().forEach {
             it.onUnlock()
@@ -62,7 +54,9 @@ class PinUnlockNode @AssistedInject constructor(
         }
         PinUnlockView(
             state = state,
-            isInAppUnlock = inputs.isInAppUnlock,
+            // UnlockNode is only used for in-app unlock, so we can safely set isInAppUnlock to true.
+            // It's set to false in PinUnlockActivity.
+            isInAppUnlock = true,
             modifier = modifier
         )
     }