Update feature ViewModels and tests

Author: claraf3

app/build.gradle.kts

@@ -103,10 +103,8 @@ dependencies {
     implementation(libs.androidx.compose.runtime.tracing)
     implementation(libs.androidx.core.ktx)
     implementation(libs.androidx.core.splashscreen)
-    implementation(libs.androidx.hilt.navigation.compose)
     implementation(libs.androidx.lifecycle.runtimeCompose)
     implementation(libs.androidx.lifecycle.viewModel.navigation3)
-    implementation(libs.androidx.navigation.compose)
     implementation(libs.androidx.profileinstaller)
     implementation(libs.androidx.tracing.ktx)
     implementation(libs.androidx.window.core)

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

@@ -18,6 +18,7 @@ package com.google.samples.apps.nowinandroid.ui
 
 import androidx.compose.ui.semantics.SemanticsActions.ScrollBy
 import androidx.compose.ui.test.assertCountEquals
+import androidx.compose.ui.test.assertIsDisplayed
 import androidx.compose.ui.test.assertIsOn
 import androidx.compose.ui.test.assertIsSelected
 import androidx.compose.ui.test.hasTestTag
@@ -39,11 +40,13 @@ import com.google.samples.apps.nowinandroid.core.data.repository.NewsRepository
 import com.google.samples.apps.nowinandroid.core.data.repository.TopicsRepository
 import com.google.samples.apps.nowinandroid.core.model.data.Topic
 import com.google.samples.apps.nowinandroid.core.rules.GrantPostNotificationsPermissionRule
+import com.google.samples.apps.nowinandroid.feature.interests.impl.LIST_PANE_TEST_TAG
 import dagger.hilt.android.testing.HiltAndroidRule
 import dagger.hilt.android.testing.HiltAndroidTest
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.runBlocking
 import org.junit.Before
+import org.junit.Ignore
 import org.junit.Rule
 import org.junit.Test
 import javax.inject.Inject
@@ -85,10 +88,10 @@ class NavigationTest {
     // The strings used for matching in these tests
     private val navigateUp by composeTestRule.stringResource(FeatureForyouR.string.feature_foryou_api_navigate_up)
     private val forYou by composeTestRule.stringResource(FeatureForyouR.string.feature_foryou_api_title)
-    private val interests by composeTestRule.stringResource(FeatureSearchR.string.feature_search_interests)
+    private val interests by composeTestRule.stringResource(FeatureSearchR.string.feature_search_api_interests)
     private val sampleTopic = "Headlines"
     private val appName by composeTestRule.stringResource(R.string.app_name)
-    private val saved by composeTestRule.stringResource(BookmarksR.string.feature_bookmarks_title)
+    private val saved by composeTestRule.stringResource(BookmarksR.string.feature_bookmarks_api_title)
     private val settings by composeTestRule.stringResource(SettingsR.string.feature_settings_top_app_bar_action_icon_description)
     private val brand by composeTestRule.stringResource(SettingsR.string.feature_settings_brand_android)
     private val ok by composeTestRule.stringResource(SettingsR.string.feature_settings_dismiss_dialog_button_text)
@@ -252,6 +255,9 @@ class NavigationTest {
         }
     }
 
+    // TODO decide if backStack should preserve previous stacks when navigating back to home tab (ForYou)
+    // https://github.com/android/nowinandroid/issues/1937
+    @Ignore
     @Test
     fun navigationBar_multipleBackStackInterests() {
         composeTestRule.apply {
@@ -261,12 +267,14 @@ class NavigationTest {
             val topic = runBlocking {
                 topicsRepository.getTopics().first().sortedBy(Topic::name).last()
             }
-            onNodeWithTag("interests:topics").performScrollToNode(hasText(topic.name))
+            onNodeWithTag(LIST_PANE_TEST_TAG).performScrollToNode(hasText(topic.name))
             onNodeWithText(topic.name).performClick()
 
+            // Verify the topic is still shown
+            onNodeWithTag("topic:${topic.id}").assertIsDisplayed()
+
             // Switch tab
             onNodeWithText(forYou).performClick()
-
             // Come back to Interests
             onNodeWithText(interests).performClick()
 

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

@@ -42,8 +42,8 @@ import com.google.samples.apps.nowinandroid.core.data.util.NetworkMonitor
 import com.google.samples.apps.nowinandroid.core.data.util.TimeZoneMonitor
 import com.google.samples.apps.nowinandroid.core.designsystem.theme.NiaTheme
 import com.google.samples.apps.nowinandroid.core.ui.LocalTimeZone
-import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStack
-import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStackKey
+import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStackViewModel
+import com.google.samples.apps.nowinandroid.core.navigation.NiaNavKey
 import com.google.samples.apps.nowinandroid.ui.NiaApp
 import com.google.samples.apps.nowinandroid.ui.rememberNiaAppState
 import com.google.samples.apps.nowinandroid.util.isSystemInDarkTheme
@@ -77,11 +77,10 @@ class MainActivity : ComponentActivity() {
     lateinit var userNewsResourceRepository: UserNewsResourceRepository
     private val viewModel: MainActivityViewModel by viewModels()
 
-    @Inject
-    lateinit var niaBackStack: NiaBackStack
+    private val backStackViewModel: NiaBackStackViewModel by viewModels()
 
     @Inject
-    lateinit var entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaBackStackKey>.() -> Unit>
+    lateinit var entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaNavKey>.() -> Unit>
 
     override fun onCreate(savedInstanceState: Bundle?) {
         val splashScreen = installSplashScreen()
@@ -145,7 +144,7 @@ class MainActivity : ComponentActivity() {
                 networkMonitor = networkMonitor,
                 userNewsResourceRepository = userNewsResourceRepository,
                 timeZoneMonitor = timeZoneMonitor,
-                niaBackStack = niaBackStack,
+                niaBackStack = backStackViewModel.niaBackStack,
             )
 
             val currentTimeZone by appState.currentTimeZone.collectAsStateWithLifecycle()

app/src/main/kotlin/com/google/samples/apps/nowinandroid/di/BackStackProvider.kt

@@ -17,12 +17,16 @@
 package com.google.samples.apps.nowinandroid.di
 
 import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStack
+import com.google.samples.apps.nowinandroid.core.navigation.NiaNavKey
 import com.google.samples.apps.nowinandroid.navigation.TopLevelDestination
 import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn
-import javax.inject.Singleton
 import dagger.hilt.components.SingletonComponent
+import kotlinx.serialization.modules.PolymorphicModuleBuilder
+import kotlinx.serialization.modules.SerializersModule
+import kotlinx.serialization.modules.polymorphic
+import javax.inject.Singleton
 
 @Module
 @InstallIn(SingletonComponent::class)
@@ -31,4 +35,14 @@ object BackStackProvider {
     @Singleton
     fun provideNiaBackStack(): NiaBackStack =
         NiaBackStack(startKey = TopLevelDestination.FOR_YOU.key)
+
+    @Provides
+    @Singleton
+    fun provideSerializersModule(
+        polymorphicModuleBuilders: Set<@JvmSuppressWildcards PolymorphicModuleBuilder<NiaNavKey>.() -> Unit>
+    ) : SerializersModule = SerializersModule {
+        polymorphic(NiaNavKey::class) {
+            polymorphicModuleBuilders.forEach { it() }
+        }
+    }
 }

app/src/main/kotlin/com/google/samples/apps/nowinandroid/navigation/NiaNavDisplay.kt

@@ -19,23 +19,22 @@ package com.google.samples.apps.nowinandroid.navigation
 import androidx.compose.material3.adaptive.ExperimentalMaterial3AdaptiveApi
 import androidx.compose.material3.adaptive.navigation3.rememberListDetailSceneStrategy
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.compositionLocalOf
 import androidx.lifecycle.viewmodel.navigation3.rememberViewModelStoreNavEntryDecorator
 import androidx.navigation3.runtime.EntryProviderBuilder
 import androidx.navigation3.runtime.entryProvider
 import androidx.navigation3.runtime.rememberSavedStateNavEntryDecorator
 import androidx.navigation3.ui.NavDisplay
 import androidx.navigation3.ui.rememberSceneSetupNavEntryDecorator
 import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStack
-import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStackKey
+import com.google.samples.apps.nowinandroid.core.navigation.NiaNavKey
 
 @OptIn(ExperimentalMaterial3AdaptiveApi::class)
 @Composable
 fun NiaNavDisplay(
     niaBackStack: NiaBackStack,
-    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaBackStackKey>.() -> Unit>,
+    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaNavKey>.() -> Unit>,
 ) {
-    val listDetailStrategy = rememberListDetailSceneStrategy<NiaBackStackKey>()
+    val listDetailStrategy = rememberListDetailSceneStrategy<NiaNavKey>()
 
     NavDisplay(
         backStack = niaBackStack.backStack,

app/src/main/kotlin/com/google/samples/apps/nowinandroid/navigation/NiaNavHost.kt

@@ -20,12 +20,12 @@ import androidx.annotation.StringRes
 import androidx.compose.ui.graphics.vector.ImageVector
 import com.google.samples.apps.nowinandroid.R
 import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
-import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStackKey
+import com.google.samples.apps.nowinandroid.core.navigation.NiaNavKey
 import com.google.samples.apps.nowinandroid.feature.bookmarks.api.navigation.BookmarksRoute
 import com.google.samples.apps.nowinandroid.feature.foryou.api.navigation.ForYouRoute
 import com.google.samples.apps.nowinandroid.feature.interests.api.navigation.InterestsRoute
 import kotlin.reflect.KClass
-import com.google.samples.apps.nowinandroid.feature.bookmarks.impl.R as bookmarksR
+import com.google.samples.apps.nowinandroid.feature.bookmarks.api.R as bookmarksR
 import com.google.samples.apps.nowinandroid.feature.foryou.api.R as forYouR
 import com.google.samples.apps.nowinandroid.feature.search.api.R as searchR
 
@@ -49,7 +49,7 @@ enum class TopLevelDestination(
     @StringRes val iconTextId: Int,
     @StringRes val titleTextId: Int,
     val route: KClass<*>,
-    val key: NiaBackStackKey
+    val key: NiaNavKey
 ) {
     FOR_YOU(
         selectedIcon = NiaIcons.Upcoming,
@@ -62,8 +62,8 @@ enum class TopLevelDestination(
     BOOKMARKS(
         selectedIcon = NiaIcons.Bookmarks,
         unselectedIcon = NiaIcons.BookmarksBorder,
-        iconTextId = bookmarksR.string.feature_bookmarks_impl_title,
-        titleTextId = bookmarksR.string.feature_bookmarks_impl_title,
+        iconTextId = bookmarksR.string.feature_bookmarks_api_title,
+        titleTextId = bookmarksR.string.feature_bookmarks_api_title,
         route = BookmarksRoute::class,
         key = BookmarksRoute
     ),

app/src/main/kotlin/com/google/samples/apps/nowinandroid/navigation/TopLevelDestination.kt

@@ -59,9 +59,6 @@ import androidx.compose.ui.semantics.semantics
 import androidx.compose.ui.semantics.testTagsAsResourceId
 import androidx.compose.ui.unit.dp
 import androidx.lifecycle.compose.collectAsStateWithLifecycle
-import androidx.navigation.NavDestination
-import androidx.navigation.NavDestination.Companion.hasRoute
-import androidx.navigation.NavDestination.Companion.hierarchy
 import androidx.navigation3.runtime.EntryProviderBuilder
 import com.google.samples.apps.nowinandroid.R
 import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaBackground
@@ -71,19 +68,18 @@ import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaTopAp
 import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
 import com.google.samples.apps.nowinandroid.core.designsystem.theme.GradientColors
 import com.google.samples.apps.nowinandroid.core.designsystem.theme.LocalGradientColors
-import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStackKey
+import com.google.samples.apps.nowinandroid.core.navigation.NiaNavKey
 import com.google.samples.apps.nowinandroid.feature.bookmarks.impl.navigation.LocalSnackbarHostState
 import com.google.samples.apps.nowinandroid.feature.search.api.navigation.navigateToSearch
 import com.google.samples.apps.nowinandroid.feature.settings.api.SettingsDialog
 import com.google.samples.apps.nowinandroid.navigation.NiaNavDisplay
 import com.google.samples.apps.nowinandroid.navigation.TopLevelDestination
-import kotlin.reflect.KClass
 import com.google.samples.apps.nowinandroid.feature.settings.api.R as settingsR
 
 @Composable
 fun NiaApp(
     appState: NiaAppState,
-    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaBackStackKey>.() -> Unit>,
+    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaNavKey>.() -> Unit>,
     modifier: Modifier = Modifier,
     windowAdaptiveInfo: WindowAdaptiveInfo = currentWindowAdaptiveInfo(),
 ) {
@@ -134,7 +130,7 @@ fun NiaApp(
 )
 internal fun NiaApp(
     appState: NiaAppState,
-    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaBackStackKey>.() -> Unit>,
+    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaNavKey>.() -> Unit>,
     showSettingsDialog: Boolean,
     onSettingsDismissed: () -> Unit,
     onTopAppBarActionClick: () -> Unit,
@@ -145,7 +141,6 @@ internal fun NiaApp(
         .collectAsStateWithLifecycle()
     val currentTopLevelKey = appState.currentTopLevelDestination!!.key
 
-
     if (showSettingsDialog) {
         SettingsDialog(
             onDismiss = { onSettingsDismissed() },
@@ -161,7 +156,7 @@ internal fun NiaApp(
                 val selected = destination.key == currentTopLevelKey
                 item(
                     selected = selected,
-                    onClick = { appState.navigateToTopLevelDestination(destination) },
+                    onClick = { appState.niaBackStack.navigate(destination.key) },
                     icon = {
                         Icon(
                             imageVector = destination.unselectedIcon,
@@ -246,10 +241,6 @@ internal fun NiaApp(
                         },
                     ),
                 ) {
-//                    NiaNavHost(
-//                        appState = appState,
-//                        onShowSnackbar = onShowSnackbar,
-//                    )
                     NiaNavDisplay(
                         niaBackStack = appState.niaBackStack,
                         entryProviderBuilders,
@@ -280,9 +271,4 @@ private fun Modifier.notificationDot(): Modifier =
                 ),
             )
         }
-    }
-
-private fun NavDestination?.isRouteInHierarchy(route: KClass<*>) =
-    this?.hierarchy?.any {
-        it.hasRoute(route)
-    } ?: false
+    }