Remove Scaffold from top level screens

Author: dturner

app/src/androidTest/java/com/google/samples/apps/nowinandroid/ui/NavigationTest.kt

@@ -21,6 +21,7 @@ import androidx.compose.ui.test.assertIsOn
 import androidx.compose.ui.test.assertIsSelected
 import androidx.compose.ui.test.junit4.createAndroidComposeRule
 import androidx.compose.ui.test.onAllNodesWithText
+import androidx.compose.ui.test.onLast
 import androidx.compose.ui.test.onNodeWithContentDescription
 import androidx.compose.ui.test.onNodeWithText
 import androidx.compose.ui.test.performClick
@@ -168,13 +169,13 @@ class NavigationTest {
             // Verify that the top bar contains the app name on the first screen.
             onNodeWithText(appName).assertExists()
 
-            // Go to the bookmarks tab, verify that the top bar contains the app name.
+            // Go to the saved tab, verify that the top bar contains "saved". This means
+            // we'll have 2 elements with the text "saved" on screen. One in the top bar, and
+            // one in the bottom navigation.
             onNodeWithText(saved).performClick()
-            onNodeWithText(appName).assertExists()
+            onAllNodesWithText(saved).assertCountEquals(2)
 
-            // Go to the interests tab, verify that the top bar contains "Interests". This means
-            // we'll have 2 elements with the text "Interests" on screen. One in the top bar, and
-            // one in the bottom navigation.
+            // As above but for the interests tab.
             onNodeWithText(interests).performClick()
             onAllNodesWithText(interests).assertCountEquals(2)
         }
@@ -214,7 +215,7 @@ class NavigationTest {
             onNodeWithText(ok).performClick()
 
             // Check that the saved screen is still visible and selected.
-            onNodeWithText(saved).assertIsSelected()
+            onAllNodesWithText(saved).onLast().assertIsSelected()
         }
     }
 

app/src/androidTest/java/com/google/samples/apps/nowinandroid/ui/NiaAppStateTest.kt

@@ -30,9 +30,19 @@ import androidx.navigation.compose.ComposeNavigator
 import androidx.navigation.compose.composable
 import androidx.navigation.createGraph
 import androidx.navigation.testing.TestNavHostController
+import com.google.samples.apps.nowinandroid.core.testing.util.MainDispatcherRule
+import com.google.samples.apps.nowinandroid.core.testing.util.TestNetworkMonitor
+import kotlinx.coroutines.cancel
+import kotlinx.coroutines.flow.collect
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.test.TestScope
+import kotlinx.coroutines.test.UnconfinedTestDispatcher
+import kotlinx.coroutines.test.runTest
+import org.junit.After
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertFalse
 import org.junit.Assert.assertTrue
+import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 
@@ -45,21 +55,43 @@ import org.junit.Test
 @OptIn(ExperimentalMaterial3WindowSizeClassApi::class)
 class NiaAppStateTest {
 
+    @get:Rule
+    val mainDispatcherRule = MainDispatcherRule()
+
     @get:Rule
     val composeTestRule = createComposeRule()
 
+    // Create the test dependencies.
+    private lateinit var testScope: TestScope
+    private val networkMonitor = TestNetworkMonitor()
+
+    // Subject under test.
     private lateinit var state: NiaAppState
 
+    @Before
+    fun setup() {
+        // We use the Unconfined dispatcher to ensure that coroutines are executed sequentially in
+        // tests.
+        testScope = TestScope(UnconfinedTestDispatcher())
+    }
+
+    @After
+    fun cleanup() {
+        testScope.cancel()
+    }
+
     @Test
-    fun niaAppState_currentDestination() {
+    fun niaAppState_currentDestination() = runTest {
         var currentDestination: String? = null
 
         composeTestRule.setContent {
             val navController = rememberTestNavController()
             state = remember(navController) {
                 NiaAppState(
                     windowSizeClass = getCompactWindowClass(),
-                    navController = navController
+                    navController = navController,
+                    networkMonitor = networkMonitor,
+                    coroutineScope = testScope
                 )
             }
 
@@ -76,9 +108,12 @@ class NiaAppStateTest {
     }
 
     @Test
-    fun niaAppState_destinations() {
+    fun niaAppState_destinations() = runTest {
         composeTestRule.setContent {
-            state = rememberNiaAppState(getCompactWindowClass())
+            state = rememberNiaAppState(
+                windowSizeClass = getCompactWindowClass(),
+                networkMonitor = networkMonitor
+            )
         }
 
         assertEquals(3, state.topLevelDestinations.size)
@@ -93,19 +128,22 @@ class NiaAppStateTest {
             val navController = rememberTestNavController()
             state = rememberNiaAppState(
                 windowSizeClass = getCompactWindowClass(),
-                navController = navController
+                navController = navController,
+                networkMonitor = networkMonitor
             )
 
             // Do nothing - we should already be
         }
     }
 
     @Test
-    fun niaAppState_showBottomBar_compact() {
+    fun niaAppState_showBottomBar_compact() = runTest {
         composeTestRule.setContent {
             state = NiaAppState(
                 windowSizeClass = getCompactWindowClass(),
-                navController = NavHostController(LocalContext.current)
+                navController = NavHostController(LocalContext.current),
+                networkMonitor = networkMonitor,
+                coroutineScope = testScope
             )
         }
 
@@ -114,11 +152,13 @@ class NiaAppStateTest {
     }
 
     @Test
-    fun niaAppState_showNavRail_medium() {
+    fun niaAppState_showNavRail_medium() = runTest {
         composeTestRule.setContent {
             state = NiaAppState(
                 windowSizeClass = WindowSizeClass.calculateFromSize(DpSize(800.dp, 800.dp)),
-                navController = NavHostController(LocalContext.current)
+                navController = NavHostController(LocalContext.current),
+                networkMonitor = networkMonitor,
+                coroutineScope = testScope
             )
         }
 
@@ -127,18 +167,45 @@ class NiaAppStateTest {
     }
 
     @Test
-    fun niaAppState_showNavRail_large() {
+    fun niaAppState_showNavRail_large() = runTest {
+
         composeTestRule.setContent {
             state = NiaAppState(
                 windowSizeClass = WindowSizeClass.calculateFromSize(DpSize(900.dp, 1200.dp)),
-                navController = NavHostController(LocalContext.current)
+                navController = NavHostController(LocalContext.current),
+                networkMonitor = networkMonitor,
+                coroutineScope = testScope
             )
         }
 
         assertTrue(state.shouldShowNavRail)
         assertFalse(state.shouldShowBottomBar)
     }
 
+    @Test
+    fun stateIsOfflineWhenNetworkMonitorIsOffline() = runTest {
+
+        composeTestRule.setContent {
+            state = NiaAppState(
+                windowSizeClass = WindowSizeClass.calculateFromSize(DpSize(900.dp, 1200.dp)),
+                navController = NavHostController(LocalContext.current),
+                networkMonitor = networkMonitor,
+                coroutineScope = testScope
+            )
+        }
+
+        val collectJob = testScope.launch { state.isOffline.collect() }
+
+        networkMonitor.setConnected(false)
+
+        assertEquals(
+            true,
+            state.isOffline.value
+        )
+
+        collectJob.cancel()
+    }
+
     private fun getCompactWindowClass() = WindowSizeClass.calculateFromSize(DpSize(500.dp, 300.dp))
 }
 

app/src/main/java/com/google/samples/apps/nowinandroid/MainActivity.kt

@@ -37,6 +37,7 @@ import androidx.metrics.performance.JankStats
 import com.google.accompanist.systemuicontroller.rememberSystemUiController
 import com.google.samples.apps.nowinandroid.MainActivityUiState.Loading
 import com.google.samples.apps.nowinandroid.MainActivityUiState.Success
+import com.google.samples.apps.nowinandroid.core.data.util.NetworkMonitor
 import com.google.samples.apps.nowinandroid.core.designsystem.theme.NiaTheme
 import com.google.samples.apps.nowinandroid.core.model.data.DarkThemeConfig
 import com.google.samples.apps.nowinandroid.core.model.data.ThemeBrand
@@ -57,6 +58,9 @@ class MainActivity : ComponentActivity() {
     @Inject
     lateinit var lazyStats: dagger.Lazy<JankStats>
 
+    @Inject
+    lateinit var networkMonitor: NetworkMonitor
+
     val viewModel: MainActivityViewModel by viewModels()
 
     override fun onCreate(savedInstanceState: Bundle?) {
@@ -105,6 +109,7 @@ class MainActivity : ComponentActivity() {
                 androidTheme = shouldUseAndroidTheme(uiState)
             ) {
                 NiaApp(
+                    networkMonitor = networkMonitor,
                     windowSizeClass = calculateWindowSizeClass(this),
                 )
             }

app/src/main/java/com/google/samples/apps/nowinandroid/ui/NiaApp.kt

@@ -31,19 +31,28 @@ import androidx.compose.material3.ExperimentalMaterial3Api
 import androidx.compose.material3.Icon
 import androidx.compose.material3.MaterialTheme
 import androidx.compose.material3.Scaffold
+import androidx.compose.material3.SnackbarDuration.Indefinite
+import androidx.compose.material3.SnackbarHost
+import androidx.compose.material3.SnackbarHostState
 import androidx.compose.material3.Text
 import androidx.compose.material3.TopAppBarDefaults
 import androidx.compose.material3.windowsizeclass.WindowSizeClass
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.remember
 import androidx.compose.ui.ExperimentalComposeUiApi
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.semantics.semantics
 import androidx.compose.ui.semantics.testTagsAsResourceId
+import androidx.lifecycle.compose.ExperimentalLifecycleComposeApi
+import androidx.lifecycle.compose.collectAsStateWithLifecycle
 import androidx.navigation.NavDestination
 import androidx.navigation.NavDestination.Companion.hierarchy
+import com.google.samples.apps.nowinandroid.core.data.util.NetworkMonitor
 import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaBackground
 import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaGradientBackground
 import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaNavigationBar
@@ -61,12 +70,16 @@ import com.google.samples.apps.nowinandroid.navigation.TopLevelDestination
 @OptIn(
     ExperimentalMaterial3Api::class,
     ExperimentalLayoutApi::class,
-    ExperimentalComposeUiApi::class
+    ExperimentalComposeUiApi::class, ExperimentalLifecycleComposeApi::class
 )
 @Composable
 fun NiaApp(
     windowSizeClass: WindowSizeClass,
-    appState: NiaAppState = rememberNiaAppState(windowSizeClass)
+    networkMonitor: NetworkMonitor,
+    appState: NiaAppState = rememberNiaAppState(
+        networkMonitor = networkMonitor,
+        windowSizeClass = windowSizeClass
+    ),
 ) {
     val background: @Composable (@Composable () -> Unit) -> Unit =
         when (appState.currentDestination?.route) {
@@ -75,26 +88,32 @@ fun NiaApp(
         }
 
     background {
+
+        val snackbarHostState = remember { SnackbarHostState() }
+
         Scaffold(
             modifier = Modifier.semantics {
                 testTagsAsResourceId = true
             },
             containerColor = Color.Transparent,
             contentColor = MaterialTheme.colorScheme.onBackground,
             contentWindowInsets = WindowInsets(0, 0, 0, 0),
+            snackbarHost = { SnackbarHost(snackbarHostState) },
             topBar = {
-                val destination = appState.topLevelDestinations[appState.currentDestination?.route]
-                if (appState.shouldShowTopBar && destination != null) {
+                // Show the top app bar on top level destinations.
+                val topLevelDestination =
+                    appState.topLevelDestinations[appState.currentDestination?.route]
+                if (topLevelDestination != null) {
                     NiaTopAppBar(
-                        titleRes = destination.titleTextId,
+                        titleRes = topLevelDestination.titleTextId,
                         actionIcon = NiaIcons.Settings,
                         actionIconContentDescription = stringResource(
                             id = settingsR.string.top_app_bar_action_icon_description
                         ),
                         colors = TopAppBarDefaults.centerAlignedTopAppBarColors(
                             containerColor = Color.Transparent
                         ),
-                        onActionClick = { /*openAccountDialog = true*/ }
+                        onActionClick = { appState.toggleSettingsDialog(true) }
                     )
                 }
             },
@@ -108,6 +127,24 @@ fun NiaApp(
                 }
             }
         ) { padding ->
+
+            val isOffline by appState.isOffline.collectAsStateWithLifecycle()
+
+            // If user is not connected to the internet show a snack bar to inform them.
+            val notConnected = stringResource(R.string.for_you_not_connected)
+            LaunchedEffect(isOffline) {
+                if (isOffline) snackbarHostState.showSnackbar(
+                    message = notConnected,
+                    duration = Indefinite
+                )
+            }
+
+            if (appState.shouldShowSettingsDialog) {
+                SettingsDialog(
+                    onDismiss = { appState.toggleSettingsDialog(false) }
+                )
+            }
+
             Row(
                 Modifier
                     .fillMaxSize()
@@ -134,6 +171,9 @@ fun NiaApp(
                         .padding(padding)
                         .consumedWindowInsets(padding)
                 )
+
+                // TODO: We may want to add padding or spacer when the snackbar is shown so that
+                //  content doesn't display behind it.
             }
         }
     }