Skip to content

Update architecture docs for user news resource flow #2120

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.

Sign up for GitHub

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

Open
ShubhamWorks02 wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

Update architecture docs for user news resource flow #2120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/ArchitectureLearningJourney.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ Here's what's happening in each step. The easiest way to find the associated cod
<tr>
<td>2
</td>
<td>The <code>ForYouViewModel</code> calls <code>GetUserNewsResourcesUseCase</code> to obtain a stream of news resources with their bookmarked/saved state. No items will be emitted into this stream until both the user and news repositories emit an item. While waiting, the feed state is set to <code>Loading</code>.
<td>The <code>ForYouViewModel</code> calls <code>UserNewsResourceRepository.observeAllForFollowedTopics</code> to obtain a stream of news resources with their bookmarked/saved state. The repository implementation combines news resources from <code>NewsRepository</code> with user data from <code>UserDataRepository</code>. While waiting, the feed state is set to <code>Loading</code>.
</td>
<td>Search for usages of <code>NewsFeedUiState.Loading</code>
<td><code>ForYouViewModel.feedState</code>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -144,9 +144,9 @@ Here's what's happening in each step. The easiest way to find the associated cod
<tr>
<td>11
</td>
<td><code>GetUserNewsResourcesUseCase</code> combines the list of news resources with the user data to emit a list of <code>UserNewsResource</code>s.
<td><code>CompositeUserNewsResourceRepository</code> combines the list of news resources with the user data to emit a list of <code>UserNewsResource</code>s.
</td>
<td><code>GetUserNewsResourcesUseCase.invoke</code>
<td><code>CompositeUserNewsResourceRepository.observeAll</code>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -256,7 +256,7 @@ The [domain layer](https://developer.android.com/topic/architecture/domain-layer

These use cases are used to simplify and remove duplicate logic from ViewModels. They typically combine and transform data from repositories.

For example, `GetUserNewsResourcesUseCase` combines a stream (implemented using `Flow`) of `NewsResource`s from a `NewsRepository` with a stream of `UserData` objects from a `UserDataRepository` to create a stream of `UserNewsResource`s. This stream is used by various ViewModels to display news resources on screen with their bookmarked state.
For example, `GetFollowableTopicsUseCase` combines a stream (implemented using `Flow`) of `List<Topic>` from a `TopicsRepository` with a stream of `UserData` objects from a `UserDataRepository` to create a stream of `List<FollowableTopic>`. This stream is used by various ViewModels to display topics on screen with their followed state.

Notably, the domain layer in Now in Android _does not_ (for now) contain any use cases for event handling. Events are handled by the UI layer calling methods on repositories directly.

Expand Down