-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[JetNews] Implement SavedStateHandle for selectedPostId persistence #1621
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
[JetNews] Implement SavedStateHandle for selectedPostId persistence #1621
Conversation
Summary of ChangesHello @xingarr, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the JetNews application by ensuring the selectedPostId state is reliably preserved across Android process deaths and configuration changes. By integrating SavedStateHandle into the HomeViewModel, the application prevents users from losing their selected article when the Android system reclaims memory or during device rotations, thereby providing a more robust and seamless user experience. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request successfully implements SavedStateHandle to persist the selectedPostId, which is a great improvement for state preservation across process death. The modernization of the ViewModelProvider.Factory using the viewModelFactory DSL is also a welcome change that improves code clarity. However, I've found a significant bug in the implementation related to how the isArticleOpen state is handled. The current logic causes the article detail screen to be shown incorrectly after a configuration change or process restart, even if the user had navigated back to the feed. My review includes a detailed comment with a suggested fix to ensure the UI state is restored correctly.
| viewModelScope.launch { | ||
| selectedPostIdState.collect { selectedPostId -> | ||
| viewModelState.update { | ||
| it.copy( | ||
| selectedPostId = selectedPostId, | ||
| isArticleOpen = selectedPostId != null, | ||
| ) | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This collector introduces a bug where the UI state for isArticleOpen is not correctly restored after a configuration change or process death. By deriving isArticleOpen solely from selectedPostId != null, it incorrectly forces the article to be displayed even if the user had previously closed it and returned to the feed.
To fix this, the isArticleOpen state must also be persisted in SavedStateHandle. This requires a more comprehensive change across the ViewModel. Here's a step-by-step guide:
-
Define a new key for
isArticleOpenin thecompanion object:private const val IS_ARTICLE_OPEN_KEY = "isArticleOpen"
-
Create a
StateFlowforisArticleOpenfromSavedStateHandle, right belowselectedPostIdState:private val isArticleOpenState: StateFlow<Boolean> = savedStateHandle.getStateFlow( key = IS_ARTICLE_OPEN_KEY, initialValue = preSelectedPostId != null )
-
Update
viewModelStateinitialization (around line 135) to use the new flow's value:private val viewModelState = MutableStateFlow( HomeViewModelState( isLoading = true, selectedPostId = selectedPostIdState.value, isArticleOpen = isArticleOpenState.value ) )
-
Update
interactedWithArticleDetails()(around line 237) to set both states inSavedStateHandle:fun interactedWithArticleDetails(postId: String) { savedStateHandle[SELECTED_POST_ID_KEY] = postId savedStateHandle[IS_ARTICLE_OPEN_KEY] = true }
-
Update
interactedWithFeed()to also write toSavedStateHandle. Note: This function is not part of the PR changes, but it's a necessary part of the fix.fun interactedWithFeed() { savedStateHandle[IS_ARTICLE_OPEN_KEY] = false }
-
Replace this collector with two separate collectors, one for each state flow, to correctly update
viewModelState.
// Observe selectedPostId changes from SavedStateHandle
viewModelScope.launch {
selectedPostIdState.collect { selectedPostId ->
viewModelState.update { it.copy(selectedPostId = selectedPostId) }
}
}
// Observe isArticleOpen changes from SavedStateHandle
viewModelScope.launch {
isArticleOpenState.collect { isArticleOpen ->
viewModelState.update { it.copy(isArticleOpen = isArticleOpen) }
}
}
Description
This PR addresses the TODO comment in HomeViewModel.kt by implementing
SavedStateHandleto persist theselectedPostIdacross process death and configuration changes.Problem
Previously, the
selectedPostIdwas stored only in memory within HomeViewModelState. When Android's system killed the app process to reclaim memory (process death), this state would be lost, causing users to lose their selected article when returning to the app.Solution
Implemented
SavedStateHandleto persist theselectedPostId, following Android's recommended architecture patterns for state preservation.Changes Made
HomeViewModel.kt
SavedStateHandleas a constructor parameterStateFlowbacked bySavedStateHandlefor persistent storageSavedStateHandlechangesSavedStateHandleviewModelFactoryDSLKey Implementation Details