From 365d33b3aa12323b50b36b9eb45381b5c05e6701 Mon Sep 17 00:00:00 2001 From: Florina Muntenescu Date: Sat, 1 Feb 2020 22:31:10 +0000 Subject: [PATCH 01/12] Migrating to Paging 3.0 --- .../paging/data/GithubPagingSource.kt | 29 +++++++++++++ .../codelabs/paging/data/GithubRepository.kt | 14 +++++-- .../codelabs/paging/ui/ReposAdapter.kt | 9 ++-- .../paging/ui/SearchRepositoriesActivity.kt | 33 ++++++++------- .../paging/ui/SearchRepositoriesViewModel.kt | 41 +++++++------------ 5 files changed, 79 insertions(+), 47 deletions(-) create mode 100644 app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt diff --git a/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt b/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt new file mode 100644 index 00000000..59585cb6 --- /dev/null +++ b/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt @@ -0,0 +1,29 @@ +package com.example.android.codelabs.paging.data + +import androidx.paging.PagingSource +import com.example.android.codelabs.paging.api.GithubService +import com.example.android.codelabs.paging.api.searchRepos +import com.example.android.codelabs.paging.model.Repo +import com.example.android.codelabs.paging.model.RepoSearchResult +import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.FlowPreview + +@ExperimentalCoroutinesApi +@FlowPreview +class GithubPagingSource( + private val service: GithubService, + private val query: String +) : PagingSource() { + override suspend fun load(params: LoadParams): LoadResult { + val position = params.key ?: 0 + val apiResponse = searchRepos(service, query, position, GithubRepository.NETWORK_PAGE_SIZE) + return when(apiResponse){ + is RepoSearchResult.Success -> LoadResult.Page( + data = apiResponse.data, + prevKey = position, + nextKey = position + 1 + ) + is RepoSearchResult.Error -> LoadResult.Error(apiResponse.error) + } + } +} \ No newline at end of file diff --git a/app/src/main/java/com/example/android/codelabs/paging/data/GithubRepository.kt b/app/src/main/java/com/example/android/codelabs/paging/data/GithubRepository.kt index a652f039..c1a841a9 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/data/GithubRepository.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/data/GithubRepository.kt @@ -17,6 +17,9 @@ package com.example.android.codelabs.paging.data import android.util.Log +import androidx.paging.PagingConfig +import androidx.paging.PagingData +import androidx.paging.PagingDataFlow import com.example.android.codelabs.paging.api.GithubService import com.example.android.codelabs.paging.api.IN_QUALIFIER import com.example.android.codelabs.paging.model.Repo @@ -55,12 +58,17 @@ class GithubRepository(private val service: GithubService) { * Search repositories whose names match the query, exposed as a stream of data that will emit * every time we get more data from the network. */ - suspend fun getSearchResultStream(query: String): Flow { + suspend fun getSearchResultStream(query: String): Flow> { Log.d("GithubRepository", "New query: $query") lastRequestedPage = 1 requestAndSaveData(query) - return searchResults.asFlow() + val pagedList = PagingDataFlow( + config = PagingConfig(pageSize = NETWORK_PAGE_SIZE), + pagingSourceFactory = { GithubPagingSource(service, query) } + ) + + return pagedList } suspend fun requestMore(query: String) { @@ -121,6 +129,6 @@ class GithubRepository(private val service: GithubService) { } companion object { - private const val NETWORK_PAGE_SIZE = 50 + const val NETWORK_PAGE_SIZE = 50 } } diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt index d959d265..6a3440bf 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt @@ -17,20 +17,23 @@ package com.example.android.codelabs.paging.ui import android.view.ViewGroup +import androidx.paging.PagingDataAdapter import androidx.recyclerview.widget.DiffUtil import androidx.recyclerview.widget.ListAdapter +import androidx.recyclerview.widget.RecyclerView +import androidx.recyclerview.widget.RecyclerView.ViewHolder import com.example.android.codelabs.paging.model.Repo /** * Adapter for the list of repositories. */ -class ReposAdapter : ListAdapter(REPO_COMPARATOR) { +class ReposAdapter : PagingDataAdapter(REPO_COMPARATOR) { - override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): androidx.recyclerview.widget.RecyclerView.ViewHolder { + override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder { return RepoViewHolder.create(parent) } - override fun onBindViewHolder(holder: androidx.recyclerview.widget.RecyclerView.ViewHolder, position: Int) { + override fun onBindViewHolder(holder: ViewHolder, position: Int) { val repoItem = getItem(position) if (repoItem != null) { (holder as RepoViewHolder).bind(repoItem) diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt index 79cbee73..d7e56737 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt @@ -32,7 +32,6 @@ import androidx.recyclerview.widget.RecyclerView import androidx.recyclerview.widget.RecyclerView.OnScrollListener import com.example.android.codelabs.paging.Injection import com.example.android.codelabs.paging.databinding.ActivitySearchRepositoriesBinding -import com.example.android.codelabs.paging.model.RepoSearchResult import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.FlowPreview @@ -77,19 +76,22 @@ class SearchRepositoriesActivity : AppCompatActivity() { loadStateAdapter ) viewModel.repoResult.observe(this) { result -> - when (result) { - is RepoSearchResult.Success -> { - showEmptyList(result.data.isEmpty()) - adapter.submitList(result.data) - } - is RepoSearchResult.Error -> { - Toast.makeText( - this, - "\uD83D\uDE28 Wooops $result.message}", - Toast.LENGTH_LONG - ).show() - } - } + //adapter.collectFrom(result) + // TODO how to handle empty list? + // TODO how to handle error? +// when (result) { +// is RepoSearchResult.Success -> { +// showEmptyList(result.data.isEmpty()) +// +// } +// is RepoSearchResult.Error -> { +// Toast.makeText( +// this, +// "\uD83D\uDE28 Wooops $result.message}", +// Toast.LENGTH_LONG +// ).show() +// } +// } } viewModel.repoLoadStatus.observe(this) { loadState -> @@ -124,7 +126,8 @@ class SearchRepositoriesActivity : AppCompatActivity() { if (it.isNotEmpty()) { binding.list.scrollToPosition(0) viewModel.searchRepo(it.toString()) - adapter.submitList(null) + // TODO how to clear the list +// adapter.submitList(null) } } } diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt index a755594e..8ced6b0a 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt @@ -16,9 +16,17 @@ package com.example.android.codelabs.paging.ui -import androidx.lifecycle.* +import androidx.lifecycle.LiveData +import androidx.lifecycle.MutableLiveData +import androidx.lifecycle.ViewModel +import androidx.lifecycle.asLiveData +import androidx.lifecycle.liveData +import androidx.lifecycle.switchMap +import androidx.lifecycle.viewModelScope +import androidx.paging.PagingData +import androidx.paging.cachedIn import com.example.android.codelabs.paging.data.GithubRepository -import com.example.android.codelabs.paging.model.RepoSearchResult +import com.example.android.codelabs.paging.model.Repo import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.FlowPreview @@ -35,22 +43,13 @@ class SearchRepositoriesViewModel(private val repository: GithubRepository) : Vi private const val VISIBLE_THRESHOLD = 5 } - private val _repoLoadStatus = MutableLiveData() - val repoLoadStatus: LiveData - get() = _repoLoadStatus.distinctUntilChanged() - private val queryLiveData = MutableLiveData() - val repoResult: LiveData = queryLiveData.switchMap { queryString -> + val repoResult: LiveData> = queryLiveData.switchMap { queryString -> liveData { - val repos = repository.getSearchResultStream(queryString).asLiveData(Dispatchers.Main) + val repos = repository.getSearchResultStream(queryString) + .cachedIn(viewModelScope) + .asLiveData(Dispatchers.Main) emitSource(repos) - }.map { - // update the load status based on the result type - when (it) { - is RepoSearchResult.Success -> _repoLoadStatus.value = LoadState.Done - is RepoSearchResult.Error -> _repoLoadStatus.value = LoadState.Error(it.error) - } - it } } @@ -65,20 +64,10 @@ class SearchRepositoriesViewModel(private val repository: GithubRepository) : Vi if (visibleItemCount + lastVisibleItemPosition + VISIBLE_THRESHOLD >= totalItemCount) { val immutableQuery = queryLiveData.value if (immutableQuery != null) { - _repoLoadStatus.postValue(LoadState.Loading) viewModelScope.launch { repository.requestMore(immutableQuery) } } } } - - fun retry() { - queryLiveData.value?.let { query -> - _repoLoadStatus.value = LoadState.Loading - viewModelScope.launch { - repository.retry(query) - } - } - } -} +} \ No newline at end of file From ebd56215d27ef873dd542a183c1d6ebc867e19fc Mon Sep 17 00:00:00 2001 From: Florina Muntenescu Date: Tue, 25 Feb 2020 17:34:23 +0000 Subject: [PATCH 02/12] Removing LiveData usages --- .../paging/ui/SearchRepositoriesActivity.kt | 71 +++++++++---------- .../paging/ui/SearchRepositoriesViewModel.kt | 26 ++++--- 2 files changed, 46 insertions(+), 51 deletions(-) diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt index d7e56737..2b563664 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt @@ -24,16 +24,22 @@ import android.view.inputmethod.EditorInfo import android.widget.Toast import androidx.appcompat.app.AppCompatActivity import androidx.lifecycle.ViewModelProvider +import androidx.lifecycle.lifecycleScope import androidx.lifecycle.observe +import androidx.paging.LoadState +import androidx.paging.LoadType +import androidx.paging.PagingData import androidx.recyclerview.widget.DividerItemDecoration import androidx.recyclerview.widget.LinearLayoutManager -import androidx.recyclerview.widget.MergeAdapter import androidx.recyclerview.widget.RecyclerView import androidx.recyclerview.widget.RecyclerView.OnScrollListener import com.example.android.codelabs.paging.Injection import com.example.android.codelabs.paging.databinding.ActivitySearchRepositoriesBinding import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.FlowPreview +import kotlinx.coroutines.Job +import kotlinx.coroutines.launch +import kotlinx.coroutines.flow.collect @ExperimentalCoroutinesApi class SearchRepositoriesActivity : AppCompatActivity() { @@ -41,7 +47,7 @@ class SearchRepositoriesActivity : AppCompatActivity() { private lateinit var binding: ActivitySearchRepositoriesBinding private lateinit var viewModel: SearchRepositoriesViewModel private val adapter = ReposAdapter() - private lateinit var loadStateAdapter: ReposLoadStateAdapter + private var searchJob: Job? = null override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) @@ -58,9 +64,19 @@ class SearchRepositoriesActivity : AppCompatActivity() { binding.list.addItemDecoration(decoration) setupScrollListener() - initAdapter() + binding.list.adapter = adapter + adapter.addLoadStateListener { loadType, loadState -> + Log.d("SearchRepositoriesActivity", "adapter load: type = $loadType state = $loadState") + if(loadState is LoadState.Error){ + Toast.makeText( + this, + "\uD83D\uDE28 Wooops $loadState.message}", + Toast.LENGTH_LONG + ).show() + } + } val query = savedInstanceState?.getString(LAST_SEARCH_QUERY) ?: DEFAULT_QUERY - viewModel.searchRepo(query) + search(query) initSearch(query) } @@ -69,37 +85,6 @@ class SearchRepositoriesActivity : AppCompatActivity() { outState.putString(LAST_SEARCH_QUERY, binding.searchRepo.text.trim().toString()) } - private fun initAdapter() { - loadStateAdapter = ReposLoadStateAdapter { viewModel.retry() } - binding.list.adapter = MergeAdapter( - adapter, - loadStateAdapter - ) - viewModel.repoResult.observe(this) { result -> - //adapter.collectFrom(result) - // TODO how to handle empty list? - // TODO how to handle error? -// when (result) { -// is RepoSearchResult.Success -> { -// showEmptyList(result.data.isEmpty()) -// -// } -// is RepoSearchResult.Error -> { -// Toast.makeText( -// this, -// "\uD83D\uDE28 Wooops $result.message}", -// Toast.LENGTH_LONG -// ).show() -// } -// } - } - - viewModel.repoLoadStatus.observe(this) { loadState -> - Log.d("SearchRepositoriesActivity", "load state $loadState") - loadStateAdapter.loadState = loadState - } - } - private fun initSearch(query: String) { binding.searchRepo.setText(query) @@ -125,9 +110,21 @@ class SearchRepositoriesActivity : AppCompatActivity() { binding.searchRepo.text.trim().let { if (it.isNotEmpty()) { binding.list.scrollToPosition(0) - viewModel.searchRepo(it.toString()) + search(it.toString()) // TODO how to clear the list -// adapter.submitList(null) + // might not need it because of how Paging works +// adapter.collectFrom(PagingData.empty()) + } + } + } + + private fun search(query: String) { + searchJob?.cancel() + searchJob = lifecycleScope.launch { + val result = viewModel.searchRepo(query) + result.collect { + Log.d("SearchRepositoriesActivity", "query: $query, collecting $it") + adapter.collectFrom(it) } } } diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt index 8ced6b0a..f93f7110 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt @@ -27,9 +27,9 @@ import androidx.paging.PagingData import androidx.paging.cachedIn import com.example.android.codelabs.paging.data.GithubRepository import com.example.android.codelabs.paging.model.Repo -import kotlinx.coroutines.Dispatchers import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.FlowPreview +import kotlinx.coroutines.flow.Flow import kotlinx.coroutines.launch /** @@ -43,26 +43,19 @@ class SearchRepositoriesViewModel(private val repository: GithubRepository) : Vi private const val VISIBLE_THRESHOLD = 5 } - private val queryLiveData = MutableLiveData() - val repoResult: LiveData> = queryLiveData.switchMap { queryString -> - liveData { - val repos = repository.getSearchResultStream(queryString) - .cachedIn(viewModelScope) - .asLiveData(Dispatchers.Main) - emitSource(repos) - } - } - + private var lastQueryValue: String? = null /** * Search a repository based on a query string. */ - fun searchRepo(queryString: String) { - queryLiveData.postValue(queryString) + suspend fun searchRepo(queryString: String): Flow> { + lastQueryValue = queryString + return repository.getSearchResultStream(queryString) + .cachedIn(viewModelScope) } fun listScrolled(visibleItemCount: Int, lastVisibleItemPosition: Int, totalItemCount: Int) { if (visibleItemCount + lastVisibleItemPosition + VISIBLE_THRESHOLD >= totalItemCount) { - val immutableQuery = queryLiveData.value + val immutableQuery = lastQueryValue() if (immutableQuery != null) { viewModelScope.launch { repository.requestMore(immutableQuery) @@ -70,4 +63,9 @@ class SearchRepositoriesViewModel(private val repository: GithubRepository) : Vi } } } + + /** + * Get the last query value. + */ + fun lastQueryValue(): String? = lastQueryValue } \ No newline at end of file From df1b96e9717c2f6d6b513a0aa09db9e72b633ea5 Mon Sep 17 00:00:00 2001 From: Florina Muntenescu Date: Thu, 27 Feb 2020 15:13:49 +0000 Subject: [PATCH 03/12] Remove code no longer needed due to paging --- .../paging/data/GithubPagingSource.kt | 27 +++--- .../codelabs/paging/data/GithubRepository.kt | 88 +------------------ .../codelabs/paging/model/RepoSearchResult.kt | 28 ------ .../paging/ui/SearchRepositoriesActivity.kt | 29 +----- .../paging/ui/SearchRepositoriesViewModel.kt | 35 +++----- 5 files changed, 35 insertions(+), 172 deletions(-) delete mode 100644 app/src/main/java/com/example/android/codelabs/paging/model/RepoSearchResult.kt diff --git a/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt b/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt index 59585cb6..77f6cb68 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt @@ -2,11 +2,14 @@ package com.example.android.codelabs.paging.data import androidx.paging.PagingSource import com.example.android.codelabs.paging.api.GithubService -import com.example.android.codelabs.paging.api.searchRepos +import com.example.android.codelabs.paging.api.IN_QUALIFIER import com.example.android.codelabs.paging.model.Repo -import com.example.android.codelabs.paging.model.RepoSearchResult import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.FlowPreview +import java.io.IOException + +// GitHub page API is 1 based: https://developer.github.com/v3/#pagination +private const val GITHUB_STARTING_PAGE_INDEX = 1 @ExperimentalCoroutinesApi @FlowPreview @@ -15,15 +18,19 @@ class GithubPagingSource( private val query: String ) : PagingSource() { override suspend fun load(params: LoadParams): LoadResult { - val position = params.key ?: 0 - val apiResponse = searchRepos(service, query, position, GithubRepository.NETWORK_PAGE_SIZE) - return when(apiResponse){ - is RepoSearchResult.Success -> LoadResult.Page( - data = apiResponse.data, - prevKey = position, - nextKey = position + 1 + val position = params.key ?: GITHUB_STARTING_PAGE_INDEX + val apiQuery = query + IN_QUALIFIER + val apiResponse = service.searchRepos(apiQuery, position, GithubRepository.NETWORK_PAGE_SIZE) + return if (apiResponse.isSuccessful) { + val repos = apiResponse.body()?.items ?: emptyList() + LoadResult.Page( + data = repos, + prevKey = if (position == GITHUB_STARTING_PAGE_INDEX) null else -1, + // if we don't get any results, we consider that we're at the last page + nextKey = if (repos.isEmpty()) null else position + 1 ) - is RepoSearchResult.Error -> LoadResult.Error(apiResponse.error) + } else { + LoadResult.Error(IOException(apiResponse.message())) } } } \ No newline at end of file diff --git a/app/src/main/java/com/example/android/codelabs/paging/data/GithubRepository.kt b/app/src/main/java/com/example/android/codelabs/paging/data/GithubRepository.kt index c1a841a9..bdeb1903 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/data/GithubRepository.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/data/GithubRepository.kt @@ -21,19 +21,9 @@ import androidx.paging.PagingConfig import androidx.paging.PagingData import androidx.paging.PagingDataFlow import com.example.android.codelabs.paging.api.GithubService -import com.example.android.codelabs.paging.api.IN_QUALIFIER import com.example.android.codelabs.paging.model.Repo -import com.example.android.codelabs.paging.model.RepoSearchResult import kotlinx.coroutines.ExperimentalCoroutinesApi -import kotlinx.coroutines.FlowPreview -import kotlinx.coroutines.channels.ConflatedBroadcastChannel import kotlinx.coroutines.flow.Flow -import kotlinx.coroutines.flow.asFlow -import retrofit2.HttpException -import java.io.IOException - -// GitHub page API is 1 based: https://developer.github.com/v3/#pagination -private const val GITHUB_STARTING_PAGE_INDEX = 1 /** * Repository class that works with local and remote data sources. @@ -41,91 +31,17 @@ private const val GITHUB_STARTING_PAGE_INDEX = 1 @ExperimentalCoroutinesApi class GithubRepository(private val service: GithubService) { - // keep the list of all results received - private val inMemoryCache = mutableListOf() - - // keep channel of results. The channel allows us to broadcast updates so - // the subscriber will have the latest data - private val searchResults = ConflatedBroadcastChannel() - - // keep the last requested page. When the request is successful, increment the page number. - private var lastRequestedPage = GITHUB_STARTING_PAGE_INDEX - - // avoid triggering multiple requests in the same time - private var isRequestInProgress = false - /** * Search repositories whose names match the query, exposed as a stream of data that will emit * every time we get more data from the network. */ - suspend fun getSearchResultStream(query: String): Flow> { + fun getSearchResultStream(query: String): Flow> { Log.d("GithubRepository", "New query: $query") - lastRequestedPage = 1 - requestAndSaveData(query) - val pagedList = PagingDataFlow( + return PagingDataFlow( config = PagingConfig(pageSize = NETWORK_PAGE_SIZE), pagingSourceFactory = { GithubPagingSource(service, query) } ) - - return pagedList - } - - suspend fun requestMore(query: String) { - if (isRequestInProgress) return - val successful = requestAndSaveData(query) - if (successful) { - lastRequestedPage++ - } - } - - suspend fun retry(query: String) { - if (isRequestInProgress) return - requestAndSaveData(query) - } - - private suspend fun requestAndSaveData(query: String): Boolean { - isRequestInProgress = true - var successful = false - - val apiQuery = query + IN_QUALIFIER - try { - val response = service.searchRepos(apiQuery, lastRequestedPage, NETWORK_PAGE_SIZE) - Log.d("GithubRepository", "response $response") - if (response.isSuccessful) { - if (response.isSuccessful) { - val repos = response.body()?.items ?: emptyList() - inMemoryCache.addAll(repos) - val reposByName = reposByName(query) - searchResults.offer(RepoSearchResult.Success(reposByName)) - successful = true - } else { - Log.d("GithubRepository", "fail to get data") - searchResults.offer(RepoSearchResult.Error(IOException(response.message() - ?: "Unknown error"))) - } - } else { - Log.d("GithubRepository", "fail to get data") - searchResults.offer(RepoSearchResult.Error(IOException(response.message() - ?: "Unknown error"))) - } - } catch (exception: IOException) { - searchResults.offer(RepoSearchResult.Error(exception)) - } catch (exception: HttpException) { - searchResults.offer(RepoSearchResult.Error(exception)) - } - - isRequestInProgress = false - return successful - } - - private fun reposByName(query: String): List { - // from the in memory cache select only the repos whose name or description matches - // the query. Then order the results. - return inMemoryCache.filter { - it.name.contains(query, true) || - (it.description != null && it.description.contains(query, true)) - }.sortedWith(compareByDescending { it.stars }.thenBy { it.name }) } companion object { diff --git a/app/src/main/java/com/example/android/codelabs/paging/model/RepoSearchResult.kt b/app/src/main/java/com/example/android/codelabs/paging/model/RepoSearchResult.kt deleted file mode 100644 index d00c1f07..00000000 --- a/app/src/main/java/com/example/android/codelabs/paging/model/RepoSearchResult.kt +++ /dev/null @@ -1,28 +0,0 @@ -/* - * Copyright (C) 2018 The Android Open Source Project - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.example.android.codelabs.paging.model - -import java.lang.Exception - -/** - * RepoSearchResult from a search, which contains List holding query data, - * and a String of network error state. - */ -sealed class RepoSearchResult { - data class Success(val data: List) : RepoSearchResult() - data class Error(val error: Exception) : RepoSearchResult() -} diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt index 2b563664..da4354f6 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt @@ -25,21 +25,15 @@ import android.widget.Toast import androidx.appcompat.app.AppCompatActivity import androidx.lifecycle.ViewModelProvider import androidx.lifecycle.lifecycleScope -import androidx.lifecycle.observe import androidx.paging.LoadState -import androidx.paging.LoadType -import androidx.paging.PagingData import androidx.recyclerview.widget.DividerItemDecoration -import androidx.recyclerview.widget.LinearLayoutManager -import androidx.recyclerview.widget.RecyclerView -import androidx.recyclerview.widget.RecyclerView.OnScrollListener import com.example.android.codelabs.paging.Injection import com.example.android.codelabs.paging.databinding.ActivitySearchRepositoriesBinding import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.FlowPreview import kotlinx.coroutines.Job -import kotlinx.coroutines.launch import kotlinx.coroutines.flow.collect +import kotlinx.coroutines.launch @ExperimentalCoroutinesApi class SearchRepositoriesActivity : AppCompatActivity() { @@ -62,12 +56,11 @@ class SearchRepositoriesActivity : AppCompatActivity() { // add dividers between RecyclerView's row items val decoration = DividerItemDecoration(this, DividerItemDecoration.VERTICAL) binding.list.addItemDecoration(decoration) - setupScrollListener() binding.list.adapter = adapter adapter.addLoadStateListener { loadType, loadState -> Log.d("SearchRepositoriesActivity", "adapter load: type = $loadType state = $loadState") - if(loadState is LoadState.Error){ + if (loadState is LoadState.Error) { Toast.makeText( this, "\uD83D\uDE28 Wooops $loadState.message}", @@ -119,10 +112,10 @@ class SearchRepositoriesActivity : AppCompatActivity() { } private fun search(query: String) { + // Make sure we cancel the previous job before creating a new one searchJob?.cancel() searchJob = lifecycleScope.launch { - val result = viewModel.searchRepo(query) - result.collect { + viewModel.searchRepo(query).collect { Log.d("SearchRepositoriesActivity", "query: $query, collecting $it") adapter.collectFrom(it) } @@ -139,20 +132,6 @@ class SearchRepositoriesActivity : AppCompatActivity() { } } - private fun setupScrollListener() { - val layoutManager = binding.list.layoutManager as LinearLayoutManager - binding.list.addOnScrollListener(object : OnScrollListener() { - override fun onScrolled(recyclerView: RecyclerView, dx: Int, dy: Int) { - super.onScrolled(recyclerView, dx, dy) - val totalItemCount = layoutManager.itemCount - val visibleItemCount = layoutManager.childCount - val lastVisibleItem = layoutManager.findLastVisibleItemPosition() - - viewModel.listScrolled(visibleItemCount, lastVisibleItem, totalItemCount) - } - }) - } - companion object { private const val LAST_SEARCH_QUERY: String = "last_search_query" private const val DEFAULT_QUERY = "Android" diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt index f93f7110..ad101469 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt @@ -30,7 +30,6 @@ import com.example.android.codelabs.paging.model.Repo import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.FlowPreview import kotlinx.coroutines.flow.Flow -import kotlinx.coroutines.launch /** * ViewModel for the [SearchRepositoriesActivity] screen. @@ -39,33 +38,23 @@ import kotlinx.coroutines.launch @ExperimentalCoroutinesApi class SearchRepositoriesViewModel(private val repository: GithubRepository) : ViewModel() { - companion object { - private const val VISIBLE_THRESHOLD = 5 - } - + @Volatile private var lastQueryValue: String? = null + @Volatile + private var lastSearchResult: Flow>? = null + /** * Search a repository based on a query string. */ - suspend fun searchRepo(queryString: String): Flow> { + fun searchRepo(queryString: String): Flow> { + val result = lastSearchResult + if(queryString == lastQueryValue && result != null){ + return result + } lastQueryValue = queryString - return repository.getSearchResultStream(queryString) + val newResult = repository.getSearchResultStream(queryString) .cachedIn(viewModelScope) + lastSearchResult = newResult + return newResult } - - fun listScrolled(visibleItemCount: Int, lastVisibleItemPosition: Int, totalItemCount: Int) { - if (visibleItemCount + lastVisibleItemPosition + VISIBLE_THRESHOLD >= totalItemCount) { - val immutableQuery = lastQueryValue() - if (immutableQuery != null) { - viewModelScope.launch { - repository.requestMore(immutableQuery) - } - } - } - } - - /** - * Get the last query value. - */ - fun lastQueryValue(): String? = lastQueryValue } \ No newline at end of file From 44abae632ee0edc7cd21df31b2c7a7e36df5d5ed Mon Sep 17 00:00:00 2001 From: Florina Muntenescu Date: Wed, 4 Mar 2020 16:47:15 +0000 Subject: [PATCH 04/12] Removing RepoSearchResult and updating paging to latest version --- .../codelabs/paging/data/GithubPagingSource.kt | 18 +++++++++++++++++- .../paging/ui/SearchRepositoriesActivity.kt | 2 +- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt b/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt index 77f6cb68..3d941400 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt @@ -1,3 +1,19 @@ +/* + * Copyright (C) 2018 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package com.example.android.codelabs.paging.data import androidx.paging.PagingSource @@ -33,4 +49,4 @@ class GithubPagingSource( LoadResult.Error(IOException(apiResponse.message())) } } -} \ No newline at end of file +} diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt index da4354f6..e1733a53 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt @@ -117,7 +117,7 @@ class SearchRepositoriesActivity : AppCompatActivity() { searchJob = lifecycleScope.launch { viewModel.searchRepo(query).collect { Log.d("SearchRepositoriesActivity", "query: $query, collecting $it") - adapter.collectFrom(it) + adapter.presentData(it) } } } From a0aa24bb7d4648dc05cc8dde6ee07d5715a36ef6 Mon Sep 17 00:00:00 2001 From: Florina Muntenescu Date: Thu, 5 Mar 2020 15:24:23 +0000 Subject: [PATCH 05/12] Improving the ReposAdapter based on review comments --- .../codelabs/paging/ui/ReposAdapter.kt | 13 ++++++------- .../paging/ui/SearchRepositoriesViewModel.kt | 19 +++++++------------ 2 files changed, 13 insertions(+), 19 deletions(-) diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt index 6a3440bf..778678d5 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt @@ -27,17 +27,16 @@ import com.example.android.codelabs.paging.model.Repo /** * Adapter for the list of repositories. */ -class ReposAdapter : PagingDataAdapter(REPO_COMPARATOR) { +class ReposAdapter : PagingDataAdapter(REPO_COMPARATOR) { - override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder { + override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RepoViewHolder { return RepoViewHolder.create(parent) } - override fun onBindViewHolder(holder: ViewHolder, position: Int) { - val repoItem = getItem(position) - if (repoItem != null) { - (holder as RepoViewHolder).bind(repoItem) - } + override fun onBindViewHolder(holder: RepoViewHolder, position: Int) { + // placeholders are not enabled, so items will never be null + val repoItem = getItem(position)!! + holder.bind(repoItem) } companion object { diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt index ad101469..cf5f25de 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt @@ -16,12 +16,7 @@ package com.example.android.codelabs.paging.ui -import androidx.lifecycle.LiveData -import androidx.lifecycle.MutableLiveData import androidx.lifecycle.ViewModel -import androidx.lifecycle.asLiveData -import androidx.lifecycle.liveData -import androidx.lifecycle.switchMap import androidx.lifecycle.viewModelScope import androidx.paging.PagingData import androidx.paging.cachedIn @@ -39,22 +34,22 @@ import kotlinx.coroutines.flow.Flow class SearchRepositoriesViewModel(private val repository: GithubRepository) : ViewModel() { @Volatile - private var lastQueryValue: String? = null + private var currentQueryValue: String? = null @Volatile - private var lastSearchResult: Flow>? = null + private var currentSearchResult: Flow>? = null /** * Search a repository based on a query string. */ fun searchRepo(queryString: String): Flow> { - val result = lastSearchResult - if(queryString == lastQueryValue && result != null){ - return result + val lastResult = currentSearchResult + if(queryString == currentQueryValue && lastResult != null){ + return lastResult } - lastQueryValue = queryString + currentQueryValue = queryString val newResult = repository.getSearchResultStream(queryString) .cachedIn(viewModelScope) - lastSearchResult = newResult + currentSearchResult = newResult return newResult } } \ No newline at end of file From ff279142f838d23b2dd50ba245a42c132ef3389e Mon Sep 17 00:00:00 2001 From: Florina Muntenescu Date: Wed, 4 Mar 2020 16:47:15 +0000 Subject: [PATCH 06/12] Removing RepoSearchResult and updating paging to latest version --- .../codelabs/paging/api/RepoSearchResponse.kt | 29 ------------------- 1 file changed, 29 deletions(-) delete mode 100644 app/src/main/java/com/example/android/codelabs/paging/api/RepoSearchResponse.kt diff --git a/app/src/main/java/com/example/android/codelabs/paging/api/RepoSearchResponse.kt b/app/src/main/java/com/example/android/codelabs/paging/api/RepoSearchResponse.kt deleted file mode 100644 index b48f15ab..00000000 --- a/app/src/main/java/com/example/android/codelabs/paging/api/RepoSearchResponse.kt +++ /dev/null @@ -1,29 +0,0 @@ -/* - * Copyright (C) 2018 The Android Open Source Project - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package com.example.android.codelabs.paging.api - -import com.example.android.codelabs.paging.model.Repo -import com.google.gson.annotations.SerializedName - -/** - * Data class to hold repo responses from searchRepo API calls. - */ -data class RepoSearchResponse( - @SerializedName("total_count") val total: Int = 0, - @SerializedName("items") val items: List = emptyList(), - val nextPage: Int? = null -) From 833eaab76baf2d175422befcc83450111ea8b594 Mon Sep 17 00:00:00 2001 From: Florina Muntenescu Date: Fri, 28 Feb 2020 09:02:57 +0000 Subject: [PATCH 07/12] Adding separators to list of repositories --- .../codelabs/paging/api/RepoSearchResponse.kt | 29 ++++++++++++ .../codelabs/paging/ui/ReposAdapter.kt | 47 +++++++++++++------ .../paging/ui/SearchRepositoriesViewModel.kt | 35 ++++++++++++-- .../codelabs/paging/ui/SeparatorViewHolder.kt | 40 ++++++++++++++++ .../main/res/layout/separator_view_item.xml | 34 ++++++++++++++ 5 files changed, 167 insertions(+), 18 deletions(-) create mode 100644 app/src/main/java/com/example/android/codelabs/paging/api/RepoSearchResponse.kt create mode 100644 app/src/main/java/com/example/android/codelabs/paging/ui/SeparatorViewHolder.kt create mode 100644 app/src/main/res/layout/separator_view_item.xml diff --git a/app/src/main/java/com/example/android/codelabs/paging/api/RepoSearchResponse.kt b/app/src/main/java/com/example/android/codelabs/paging/api/RepoSearchResponse.kt new file mode 100644 index 00000000..b48f15ab --- /dev/null +++ b/app/src/main/java/com/example/android/codelabs/paging/api/RepoSearchResponse.kt @@ -0,0 +1,29 @@ +/* + * Copyright (C) 2018 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.example.android.codelabs.paging.api + +import com.example.android.codelabs.paging.model.Repo +import com.google.gson.annotations.SerializedName + +/** + * Data class to hold repo responses from searchRepo API calls. + */ +data class RepoSearchResponse( + @SerializedName("total_count") val total: Int = 0, + @SerializedName("items") val items: List = emptyList(), + val nextPage: Int? = null +) diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt index 778678d5..3b7c9bbe 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposAdapter.kt @@ -19,32 +19,51 @@ package com.example.android.codelabs.paging.ui import android.view.ViewGroup import androidx.paging.PagingDataAdapter import androidx.recyclerview.widget.DiffUtil -import androidx.recyclerview.widget.ListAdapter -import androidx.recyclerview.widget.RecyclerView import androidx.recyclerview.widget.RecyclerView.ViewHolder -import com.example.android.codelabs.paging.model.Repo +import com.example.android.codelabs.paging.R /** * Adapter for the list of repositories. */ -class ReposAdapter : PagingDataAdapter(REPO_COMPARATOR) { +class ReposAdapter : PagingDataAdapter(UIMODEL_COMPARATOR) { - override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RepoViewHolder { - return RepoViewHolder.create(parent) + override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder { + return if(viewType == R.layout.repo_view_item) { + RepoViewHolder.create(parent) + } else { + SeparatorViewHolder.create(parent) + } } - override fun onBindViewHolder(holder: RepoViewHolder, position: Int) { - // placeholders are not enabled, so items will never be null - val repoItem = getItem(position)!! - holder.bind(repoItem) + override fun getItemViewType(position: Int): Int { + return when(getItem(position)){ + is UiModel.RepoItem -> R.layout.repo_view_item + is UiModel.SeparatorItem -> R.layout.separator_view_item + null -> 0 + } + } + + override fun onBindViewHolder(holder: ViewHolder, position: Int) { + val uiModel = getItem(position) + uiModel.let { + when(uiModel){ + is UiModel.RepoItem -> (holder as RepoViewHolder).bind(uiModel.repo) + is UiModel.SeparatorItem -> (holder as SeparatorViewHolder).bind(uiModel.description) + } + } } companion object { - private val REPO_COMPARATOR = object : DiffUtil.ItemCallback() { - override fun areItemsTheSame(oldItem: Repo, newItem: Repo): Boolean = - oldItem.fullName == newItem.fullName + private val UIMODEL_COMPARATOR = object : DiffUtil.ItemCallback() { + override fun areItemsTheSame(oldItem: UiModel, newItem: UiModel): Boolean { + return if (oldItem is UiModel.RepoItem && newItem is UiModel.RepoItem) { + oldItem.repo.fullName == newItem.repo.fullName + } else { + false + } + } - override fun areContentsTheSame(oldItem: Repo, newItem: Repo): Boolean = + override fun areContentsTheSame(oldItem: UiModel, newItem: UiModel): Boolean = oldItem == newItem } } diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt index cf5f25de..e29c432a 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt @@ -16,6 +16,7 @@ package com.example.android.codelabs.paging.ui +import android.util.Log import androidx.lifecycle.ViewModel import androidx.lifecycle.viewModelScope import androidx.paging.PagingData @@ -25,6 +26,7 @@ import com.example.android.codelabs.paging.model.Repo import kotlinx.coroutines.ExperimentalCoroutinesApi import kotlinx.coroutines.FlowPreview import kotlinx.coroutines.flow.Flow +import kotlinx.coroutines.flow.map /** * ViewModel for the [SearchRepositoriesActivity] screen. @@ -36,20 +38,45 @@ class SearchRepositoriesViewModel(private val repository: GithubRepository) : Vi @Volatile private var currentQueryValue: String? = null @Volatile - private var currentSearchResult: Flow>? = null + private var currentSearchResult: Flow>? = null /** * Search a repository based on a query string. */ - fun searchRepo(queryString: String): Flow> { + fun searchRepo(queryString: String): Flow> { val lastResult = currentSearchResult if(queryString == currentQueryValue && lastResult != null){ return lastResult } currentQueryValue = queryString - val newResult = repository.getSearchResultStream(queryString) + val newResult: Flow> = repository.getSearchResultStream(queryString) + .map { pagingData -> pagingData.map { UiModel.RepoItem(it) as UiModel } } + .map { + it.insertSeparators { before, after -> + if (before == null && after is UiModel.RepoItem) { + Log.d("ViewModel", "-> adding null separator") + UiModel.SeparatorItem("${after.repo.stars / 10_000}0.000+ stars") + } + if (before is UiModel.RepoItem && after is UiModel.RepoItem + && before.repo.stars / 10_000 > after.repo.stars / 10_000) { + if (after.repo.stars >= 10_000) { + UiModel.SeparatorItem("${after.repo.stars / 10_000}0.000+ stars") + } else { + UiModel.SeparatorItem("< 10.000+ stars") + } + } else { + // no separator + null + } + } + } .cachedIn(viewModelScope) currentSearchResult = newResult return newResult } -} \ No newline at end of file +} + +sealed class UiModel { + data class RepoItem(val repo: Repo) : UiModel() + data class SeparatorItem(val description: String) : UiModel() +} diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SeparatorViewHolder.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SeparatorViewHolder.kt new file mode 100644 index 00000000..07a490cb --- /dev/null +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SeparatorViewHolder.kt @@ -0,0 +1,40 @@ +package com.example.android.codelabs.paging.ui + +/* + * Copyright (C) 2018 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import android.view.LayoutInflater +import android.view.View +import android.view.ViewGroup +import android.widget.TextView +import androidx.recyclerview.widget.RecyclerView +import com.example.android.codelabs.paging.R + +class SeparatorViewHolder(view: View) : RecyclerView.ViewHolder(view) { + private val description: TextView = view.findViewById(R.id.separator_description) + + fun bind(separatorText: String) { + description.text = separatorText + } + + companion object { + fun create(parent: ViewGroup): SeparatorViewHolder { + val view = LayoutInflater.from(parent.context) + .inflate(R.layout.separator_view_item, parent, false) + return SeparatorViewHolder(view) + } + } +} diff --git a/app/src/main/res/layout/separator_view_item.xml b/app/src/main/res/layout/separator_view_item.xml new file mode 100644 index 00000000..fdae76f4 --- /dev/null +++ b/app/src/main/res/layout/separator_view_item.xml @@ -0,0 +1,34 @@ + + + + + \ No newline at end of file From 4b6de331fbe78c4d9d9a12319fa6f5c3e9b66a75 Mon Sep 17 00:00:00 2001 From: Florina Muntenescu Date: Wed, 11 Mar 2020 17:34:35 +0000 Subject: [PATCH 08/12] Fixing first separator not showing and making the project AS 3.6 compatible --- .../codelabs/paging/ui/SearchRepositoriesViewModel.kt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt index e29c432a..018d3fc9 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesViewModel.kt @@ -20,7 +20,9 @@ import android.util.Log import androidx.lifecycle.ViewModel import androidx.lifecycle.viewModelScope import androidx.paging.PagingData +import androidx.paging.PagingData.Companion.insertSeparators import androidx.paging.cachedIn +import androidx.paging.insertSeparators import com.example.android.codelabs.paging.data.GithubRepository import com.example.android.codelabs.paging.model.Repo import kotlinx.coroutines.ExperimentalCoroutinesApi @@ -45,19 +47,18 @@ class SearchRepositoriesViewModel(private val repository: GithubRepository) : Vi */ fun searchRepo(queryString: String): Flow> { val lastResult = currentSearchResult - if(queryString == currentQueryValue && lastResult != null){ + if (queryString == currentQueryValue && lastResult != null) { return lastResult } currentQueryValue = queryString val newResult: Flow> = repository.getSearchResultStream(queryString) - .map { pagingData -> pagingData.map { UiModel.RepoItem(it) as UiModel } } + .map { pagingData -> pagingData.map { UiModel.RepoItem(it) } } .map { - it.insertSeparators { before, after -> + it.insertSeparators { before, after -> if (before == null && after is UiModel.RepoItem) { Log.d("ViewModel", "-> adding null separator") UiModel.SeparatorItem("${after.repo.stars / 10_000}0.000+ stars") - } - if (before is UiModel.RepoItem && after is UiModel.RepoItem + } else if (before is UiModel.RepoItem && after is UiModel.RepoItem && before.repo.stars / 10_000 > after.repo.stars / 10_000) { if (after.repo.stars >= 10_000) { UiModel.SeparatorItem("${after.repo.stars / 10_000}0.000+ stars") From 8daf1578a552631de8019422e79e12719da5a3bc Mon Sep 17 00:00:00 2001 From: Florina Muntenescu Date: Thu, 12 Mar 2020 13:46:08 +0000 Subject: [PATCH 09/12] Adding header and footer to the app and showing progress bar / retry button for new queries --- .../paging/data/GithubPagingSource.kt | 26 +++++----- .../paging/ui/ReposLoadStateAdapter.kt | 49 +++---------------- .../paging/ui/ReposLoadStateViewHolder.kt | 3 +- .../paging/ui/SearchRepositoriesActivity.kt | 31 +++++++----- .../layout/activity_search_repositories.xml | 31 +++++++----- 5 files changed, 62 insertions(+), 78 deletions(-) diff --git a/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt b/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt index 3d941400..a260fa9d 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/data/GithubPagingSource.kt @@ -36,17 +36,21 @@ class GithubPagingSource( override suspend fun load(params: LoadParams): LoadResult { val position = params.key ?: GITHUB_STARTING_PAGE_INDEX val apiQuery = query + IN_QUALIFIER - val apiResponse = service.searchRepos(apiQuery, position, GithubRepository.NETWORK_PAGE_SIZE) - return if (apiResponse.isSuccessful) { - val repos = apiResponse.body()?.items ?: emptyList() - LoadResult.Page( - data = repos, - prevKey = if (position == GITHUB_STARTING_PAGE_INDEX) null else -1, - // if we don't get any results, we consider that we're at the last page - nextKey = if (repos.isEmpty()) null else position + 1 - ) - } else { - LoadResult.Error(IOException(apiResponse.message())) + try { + val apiResponse = service.searchRepos(apiQuery, position, GithubRepository.NETWORK_PAGE_SIZE) + return if (apiResponse.isSuccessful) { + val repos = apiResponse.body()?.items ?: emptyList() + LoadResult.Page( + data = repos, + prevKey = if (position == GITHUB_STARTING_PAGE_INDEX) null else -1, + // if we don't get any results, we consider that we're at the last page + nextKey = if (repos.isEmpty()) null else position + 1 + ) + } else { + LoadResult.Error(IOException(apiResponse.message())) + } + } catch (exception: Exception) { + return LoadResult.Error(exception) } } } diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposLoadStateAdapter.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposLoadStateAdapter.kt index fb47c226..dd04ddcf 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposLoadStateAdapter.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposLoadStateAdapter.kt @@ -13,56 +13,19 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - package com.example.android.codelabs.paging.ui import android.view.ViewGroup -import androidx.recyclerview.widget.RecyclerView - -class ReposLoadStateAdapter(private val retry: () -> Unit) : RecyclerView.Adapter() { - - /** - * LoadState to present in the adapter. - * - * Changing this property will immediately notify the Adapter to change the item it's - * presenting. - */ - var loadState: LoadState = LoadState.Done - set(loadState) { - if (field != loadState) { - val displayOldItem = displayLoadStateAsItem(field) - val displayNewItem = displayLoadStateAsItem(loadState) - - if (displayOldItem && !displayNewItem) { - notifyItemRemoved(0) - } else if (displayNewItem && !displayOldItem) { - notifyItemInserted(0) - } else if (displayOldItem && displayNewItem) { - notifyItemChanged(0) - } - field = loadState - } - } +import androidx.paging.LoadState +import androidx.paging.LoadStateAdapter - override fun onBindViewHolder(holder: ReposLoadStateViewHolder, position: Int) { +class ReposLoadStateAdapter(private val retry: () -> Unit) : LoadStateAdapter() { + override fun onBindViewHolder(holder: ReposLoadStateViewHolder, loadState: LoadState) { holder.bind(loadState) } - override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ReposLoadStateViewHolder { + override fun onCreateViewHolder(parent: ViewGroup, loadState: LoadState): ReposLoadStateViewHolder { return ReposLoadStateViewHolder.create(parent, retry) } - override fun getItemViewType(position: Int): Int = 0 - - override fun getItemCount(): Int = if (displayLoadStateAsItem(loadState)) 1 else 0 - - /** - * Returns true if the LoadState should be displayed as a list item when active. - * - * [LoadState.Loading] and [LoadState.Error] present as list items, - * [LoadState.Done] is not. - */ - private fun displayLoadStateAsItem(loadState: LoadState): Boolean { - return loadState is LoadState.Loading || loadState is LoadState.Error - } -} +} \ No newline at end of file diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposLoadStateViewHolder.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposLoadStateViewHolder.kt index cad644fb..19d806f6 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/ReposLoadStateViewHolder.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/ReposLoadStateViewHolder.kt @@ -22,6 +22,7 @@ import android.view.ViewGroup import android.widget.Button import android.widget.ProgressBar import android.widget.TextView +import androidx.paging.LoadState import androidx.recyclerview.widget.RecyclerView import com.example.android.codelabs.paging.R import com.example.android.codelabs.paging.databinding.ReposLoadStateHeaderViewItemBinding @@ -60,4 +61,4 @@ class ReposLoadStateViewHolder( return ReposLoadStateViewHolder(binding, retry) } } -} \ No newline at end of file +} diff --git a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt index e1733a53..06f13a50 100644 --- a/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt +++ b/app/src/main/java/com/example/android/codelabs/paging/ui/SearchRepositoriesActivity.kt @@ -26,6 +26,7 @@ import androidx.appcompat.app.AppCompatActivity import androidx.lifecycle.ViewModelProvider import androidx.lifecycle.lifecycleScope import androidx.paging.LoadState +import androidx.paging.LoadType import androidx.recyclerview.widget.DividerItemDecoration import com.example.android.codelabs.paging.Injection import com.example.android.codelabs.paging.databinding.ActivitySearchRepositoriesBinding @@ -57,9 +58,21 @@ class SearchRepositoriesActivity : AppCompatActivity() { val decoration = DividerItemDecoration(this, DividerItemDecoration.VERTICAL) binding.list.addItemDecoration(decoration) - binding.list.adapter = adapter + binding.list.adapter = adapter.withLoadStateHeaderAndFooter( + header = ReposLoadStateAdapter { adapter.retry() }, + footer = ReposLoadStateAdapter { adapter.retry() } + ) adapter.addLoadStateListener { loadType, loadState -> Log.d("SearchRepositoriesActivity", "adapter load: type = $loadType state = $loadState") + if (loadType == LoadType.REFRESH) { + binding.list.visibility = View.GONE + binding.progressBar.visibility = toVisibility(loadState == LoadState.Loading) + binding.retryButton.visibility = toVisibility(loadState is LoadState.Error) + } else { + binding.list.visibility = View.VISIBLE + binding.progressBar.visibility = View.GONE + binding.retryButton.visibility = View.GONE + } if (loadState is LoadState.Error) { Toast.makeText( this, @@ -71,6 +84,7 @@ class SearchRepositoriesActivity : AppCompatActivity() { val query = savedInstanceState?.getString(LAST_SEARCH_QUERY) ?: DEFAULT_QUERY search(query) initSearch(query) + binding.retryButton.setOnClickListener { adapter.retry() } } override fun onSaveInstanceState(outState: Bundle) { @@ -104,9 +118,6 @@ class SearchRepositoriesActivity : AppCompatActivity() { if (it.isNotEmpty()) { binding.list.scrollToPosition(0) search(it.toString()) - // TODO how to clear the list - // might not need it because of how Paging works -// adapter.collectFrom(PagingData.empty()) } } } @@ -122,14 +133,10 @@ class SearchRepositoriesActivity : AppCompatActivity() { } } - private fun showEmptyList(show: Boolean) { - if (show) { - binding.emptyList.visibility = View.VISIBLE - binding.list.visibility = View.GONE - } else { - binding.emptyList.visibility = View.GONE - binding.list.visibility = View.VISIBLE - } + private fun toVisibility(constraint: Boolean): Int = if (constraint) { + View.VISIBLE + } else { + View.GONE } companion object { diff --git a/app/src/main/res/layout/activity_search_repositories.xml b/app/src/main/res/layout/activity_search_repositories.xml index 738040a3..5695d150 100644 --- a/app/src/main/res/layout/activity_search_repositories.xml +++ b/app/src/main/res/layout/activity_search_repositories.xml @@ -59,16 +59,25 @@ app:layout_constraintTop_toBottomOf="@+id/input_layout" tools:ignore="UnusedAttribute"/> - + + +