Bug 1864071 - Add debug drawer fab to an app-wide Composable overlay

app/src/androidTest/java/org/mozilla/fenix/ui/robots/ComposeTopSitesRobot.kt

@@ -13,7 +13,6 @@ import androidx.compose.ui.test.junit4.ComposeTestRule
 import androidx.compose.ui.test.longClick
 import androidx.compose.ui.test.onAllNodesWithTag
 import androidx.compose.ui.test.onFirst
-import androidx.compose.ui.test.onNodeWithTag
 import androidx.compose.ui.test.performClick
 import androidx.compose.ui.test.performScrollTo
 import androidx.compose.ui.test.performTouchInput
@@ -33,8 +32,10 @@ import org.mozilla.fenix.home.topsites.TopSitesTestTag
  */
 class ComposeTopSitesRobot(private val composeTestRule: HomeActivityComposeTestRule) {
 
-    fun verifyExistingTopSitesList() =
-        composeTestRule.onNodeWithTag(TopSitesTestTag.topSites).assertExists()
+    @OptIn(ExperimentalTestApi::class)
+    fun verifyExistingTopSitesList() {
+        composeTestRule.waitUntilExactlyOneExists(hasTestTag(TopSitesTestTag.topSites), timeoutMillis = waitingTime)
+    }
 
     @OptIn(ExperimentalTestApi::class)
     fun verifyExistingTopSiteItem(vararg titles: String) {

app/src/main/java/org/mozilla/fenix/HomeActivity.kt

@@ -46,6 +46,7 @@ import kotlinx.coroutines.Dispatchers.Main
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.MainScope
 import kotlinx.coroutines.delay
+import kotlinx.coroutines.flow.distinctUntilChanged
 import kotlinx.coroutines.launch
 import mozilla.appservices.places.BookmarkRoot
 import mozilla.components.browser.state.action.ContentAction
@@ -100,6 +101,9 @@ import org.mozilla.fenix.components.metrics.BreadcrumbsRecorder
 import org.mozilla.fenix.components.metrics.GrowthDataWorker
 import org.mozilla.fenix.components.metrics.fonts.FontEnumerationWorker
 import org.mozilla.fenix.databinding.ActivityHomeBinding
+import org.mozilla.fenix.debugsettings.data.debugDrawerEnabled
+import org.mozilla.fenix.debugsettings.data.debugSettings
+import org.mozilla.fenix.debugsettings.ui.DebugOverlay
 import org.mozilla.fenix.exceptions.trackingprotection.TrackingProtectionExceptionsFragmentDirections
 import org.mozilla.fenix.experiments.ResearchSurfaceDialogFragment
 import org.mozilla.fenix.ext.alreadyOnDestination
@@ -158,6 +162,8 @@ import org.mozilla.fenix.tabhistory.TabHistoryDialogFragment
 import org.mozilla.fenix.tabstray.TabsTrayFragment
 import org.mozilla.fenix.tabstray.TabsTrayFragmentDirections
 import org.mozilla.fenix.theme.DefaultThemeManager
+import org.mozilla.fenix.theme.FirefoxTheme
+import org.mozilla.fenix.theme.Theme
 import org.mozilla.fenix.theme.ThemeManager
 import org.mozilla.fenix.trackingprotection.TrackingProtectionPanelDialogFragmentDirections
 import org.mozilla.fenix.utils.Settings
@@ -278,6 +284,31 @@ open class HomeActivity : LocaleAwareAppCompatActivity(), NavHostActivity {
         window.decorView.layoutDirection = TextUtils.getLayoutDirectionFromLocale(Locale.getDefault())
 
         binding = ActivityHomeBinding.inflate(layoutInflater)
+
+        if (Config.channel.isNightlyOrDebug) {
+            lifecycleScope.launch {
+                debugSettings.debugDrawerEnabled
+                    .distinctUntilChanged()
+                    .collect { enabled ->
+                        with(binding.debugOverlay) {
+                            if (enabled) {
+                                visibility = View.VISIBLE
+
+                                setContent {
+                                    FirefoxTheme(theme = Theme.getTheme(allowPrivateTheme = false)) {
+                                        DebugOverlay()
+                                    }
+                                }
+                            } else {
+                                setContent {}
+
+                                visibility = View.GONE
+                            }
+                        }
+                    }
+            }
+        }
+
         setContentView(binding.root)
         ProfilerMarkers.addListenerForOnGlobalLayout(components.core.engine, this, binding.root)
 

app/src/main/java/org/mozilla/fenix/debugsettings/ui/DebugOverlay.kt

@@ -0,0 +1,74 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package org.mozilla.fenix.debugsettings.ui
+
+import androidx.compose.foundation.background
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.foundation.layout.padding
+import androidx.compose.material.Snackbar
+import androidx.compose.material.SnackbarHost
+import androidx.compose.material.SnackbarHostState
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.rememberCoroutineScope
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.painterResource
+import androidx.compose.ui.unit.dp
+import kotlinx.coroutines.launch
+import org.mozilla.fenix.R
+import org.mozilla.fenix.compose.annotation.LightDarkPreview
+import org.mozilla.fenix.compose.button.FloatingActionButton
+import org.mozilla.fenix.theme.FirefoxTheme
+
+/**
+ * Overlay for presenting Fenix-wide debugging content.
+ */
+@Composable
+fun DebugOverlay() {
+    val snackbarState = remember { SnackbarHostState() }
+    val scope = rememberCoroutineScope()
+
+    Box(
+        modifier = Modifier.fillMaxSize(),
+    ) {
+        FloatingActionButton(
+            icon = painterResource(R.drawable.ic_new),
+            modifier = Modifier
+                .align(Alignment.CenterStart)
+                .padding(start = 16.dp),
+            onClick = {
+                scope.launch {
+                    snackbarState.showSnackbar("Show debug drawer")
+                }
+            },
+        )
+
+        // This must be the last element in the Box
+        SnackbarHost(
+            hostState = snackbarState,
+            modifier = Modifier.align(Alignment.BottomCenter),
+        ) { snackbarData ->
+            Snackbar(
+                snackbarData = snackbarData,
+            )
+        }
+    }
+}
+
+@Composable
+@LightDarkPreview
+private fun DebugOverlayPreview() {
+    FirefoxTheme {
+        Box(
+            modifier = Modifier
+                .fillMaxSize()
+                .background(color = FirefoxTheme.colors.layer1),
+        ) {
+            DebugOverlay()
+        }
+    }
+}

app/src/main/res/layout/activity_home.xml

@@ -18,12 +18,24 @@
         android:layout_width="match_parent"
         android:layout_height="56dp" />
 
-    <!--The navGraph is set dynamically in NavGraphProvider -->
-    <androidx.fragment.app.FragmentContainerView
-        android:id="@+id/container"
-        android:name="androidx.navigation.fragment.NavHostFragment"
+    <FrameLayout
         android:layout_width="match_parent"
-        android:layout_height="match_parent"
-        app:defaultNavHost="true"
-        app:navGraph="@navigation/nav_graph" />
+        android:layout_height="match_parent">
+
+        <!--The navGraph is set dynamically in NavGraphProvider -->
+        <androidx.fragment.app.FragmentContainerView
+            android:id="@+id/container"
+            android:name="androidx.navigation.fragment.NavHostFragment"
+            android:layout_width="match_parent"
+            android:layout_height="match_parent"
+            app:defaultNavHost="true"
+            app:navGraph="@navigation/nav_graph" />
+
+        <androidx.compose.ui.platform.ComposeView
+            android:id="@+id/debugOverlay"
+            android:layout_width="match_parent"
+            android:layout_height="match_parent"
+            android:visibility="gone" />
+
+    </FrameLayout>
 </org.mozilla.fenix.perf.HomeActivityRootLinearLayout>