Skip to content
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

Jump to bottom

Using debounce - Search #107

Merged
merged 2 commits into from
Feb 1, 2024
Merged

Using debounce - Search #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72b1f2c
Creating a debounce component to avoid flooding the server
gabrielbmoro Jan 30, 2024
cb627fe
Moving to be a variable the debounce delay
gabrielbmoro Jan 30, 2024
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
9 changes: 3 additions & 6 deletions ...re_search/src/main/java/com/gabrielbmoro/moviedb/search/ui/screens/search/SearchScreen.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,9 @@ fun SearchScreen(
title = {
SearchInputText(
currentValue = uiState.value.searchQuery,
onValueChanged = {
viewModel.onSearchQueryChanged(it)
},
onClearText = {
viewModel.onClearSearchQuery()
},
onQueryChanged = viewModel::onQueryChanged,
onSearchBy = viewModel::onSearchBy,
onClearText = viewModel::onClearSearchQuery,
modifier = Modifier.fillMaxWidth(),
focusRequester = focusRequester
)
Expand Down
22 changes: 12 additions & 10 deletions ...search/src/main/java/com/gabrielbmoro/moviedb/search/ui/screens/search/SearchViewModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import com.gabrielbmoro.moviedb.search.domain.SearchMovieUseCase
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.async
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.SharingStarted
import kotlinx.coroutines.flow.stateIn
import kotlinx.coroutines.flow.update
import kotlinx.coroutines.launch
import javax.inject.Inject

@HiltViewModel
Expand All @@ -25,16 +25,8 @@ class SearchViewModel @Inject constructor(
_uiState.value
)

fun onSearchQueryChanged(searchQuery: TextFieldValue) = viewModelScope.async {
fun onQueryChanged(searchQuery: TextFieldValue) {
_uiState.update { it.copy(searchQuery = searchQuery) }

searchMovieUseCase.invoke(searchQuery.text).collect { movies ->
_uiState.update {
it.copy(
results = movies
)
}
}
}

fun onClearSearchQuery() {
Expand All @@ -45,4 +37,14 @@ class SearchViewModel @Inject constructor(
)
}
}

fun onSearchBy(query: String) {
viewModelScope.launch {
searchMovieUseCase(query).collect { movies ->
_uiState.update {
it.copy(results = movies)
}
}
}
}
}
42 changes: 39 additions & 3 deletions ...eature_search/src/main/java/com/gabrielbmoro/moviedb/search/ui/widgets/SearchInputText.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ import androidx.compose.material3.Text
import androidx.compose.material3.TextField
import androidx.compose.material3.TextFieldDefaults
import androidx.compose.runtime.Composable
import androidx.compose.runtime.LaunchedEffect
import androidx.compose.runtime.remember
import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.ui.Modifier
import androidx.compose.ui.focus.FocusRequester
import androidx.compose.ui.focus.focusRequester
Expand All @@ -20,15 +23,29 @@ import androidx.compose.ui.unit.dp
import com.gabrielbmoro.moviedb.core.ui.theme.MovieDBAppTheme
import com.gabrielbmoro.moviedb.core.ui.theme.ThemePreviews
import com.gabrielbmoro.moviedb.feature.search.R
import kotlinx.coroutines.FlowPreview
import kotlinx.coroutines.flow.MutableSharedFlow
import kotlinx.coroutines.flow.debounce
import kotlinx.coroutines.launch
import timber.log.Timber

private const val SEARCH_DEBOUNCE_DELAY_IN_MS = 600L

@OptIn(FlowPreview::class)
@Composable
fun SearchInputText(
currentValue: TextFieldValue,
onValueChanged: ((TextFieldValue) -> Unit),
onQueryChanged: ((TextFieldValue) -> Unit),
onSearchBy: (String) -> Unit,
onClearText: (() -> Unit),
focusRequester: FocusRequester,
modifier: Modifier = Modifier
) {
val searchFlow = remember {
MutableSharedFlow<String>()
}
val coroutineScope = rememberCoroutineScope()

val trailingIcon: @Composable (() -> Unit)? = if (currentValue.text.isNotEmpty()) {
{
IconButton(
Expand All @@ -50,7 +67,15 @@ fun SearchInputText(
TextField(
value = currentValue,
textStyle = MaterialTheme.typography.titleMedium,
onValueChange = onValueChanged,
onValueChange = {
onQueryChanged(it)

Timber.d("Search --> typing ${it.text}")

coroutineScope.launch {
searchFlow.emit(it.text)
}
},
placeholder = {
Text(
stringResource(id = R.string.search_movie_placeholder),
Expand All @@ -65,6 +90,16 @@ fun SearchInputText(
maxLines = 1,
modifier = modifier.focusRequester(focusRequester)
)

LaunchedEffect(
key1 = Unit,
block = {
searchFlow.debounce(SEARCH_DEBOUNCE_DELAY_IN_MS).collect { query ->
Timber.d("Search --> by $query")
onSearchBy(query)
}
},
)
}

@ThemePreviews
Expand All @@ -73,7 +108,8 @@ fun SearchInputTextPreview() {
MovieDBAppTheme {
SearchInputText(
currentValue = TextFieldValue(text = "teste"),
onValueChanged = {},
onQueryChanged = {},
onSearchBy = {},
focusRequester = FocusRequester(),
onClearText = {}
)
Expand Down
28 changes: 19 additions & 9 deletions ...ch/src/test/java/com/gabrielbmoro/moviedb/search/ui/screens/search/SearchViewModelTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,12 @@ class SearchViewModelTest {
val viewModel = SearchViewModel(searchMovieUseCase)

// act
viewModel.onSearchQueryChanged(searchQuery).await()
viewModel.onSearchBy(searchQuery.text)

// assert
viewModel.viewModelScope.async { }.await()
Truth.assertThat(viewModel.uiState.value.results)
.contains(Movie.mockChuckNorrisVsVandammeMovie())
Truth.assertThat(viewModel.uiState.value.searchQuery).isEqualTo(
searchQuery
)
}

@Test
Expand All @@ -73,13 +71,11 @@ class SearchViewModelTest {
val viewModel = SearchViewModel(searchMovieUseCase)

// act
viewModel.onSearchQueryChanged(searchQuery).await()
viewModel.onSearchBy(searchQuery.text)

// assert
viewModel.viewModelScope.async { }.await()
Truth.assertThat(viewModel.uiState.value.results).isEmpty()
Truth.assertThat(viewModel.uiState.value.searchQuery).isEqualTo(
searchQuery
)
}

@Test
Expand All @@ -88,7 +84,6 @@ class SearchViewModelTest {
val resultFlow: Flow<List<Movie>> = flow { emit(emptyList()) }
every { searchMovieUseCase(any()) }.returns(resultFlow)
val viewModel = SearchViewModel(searchMovieUseCase)
viewModel.onSearchQueryChanged(TextFieldValue("searchQuery")).await()

// act
viewModel.onClearSearchQuery()
Expand All @@ -98,4 +93,19 @@ class SearchViewModelTest {
Truth.assertThat(viewModel.uiState.value.searchQuery.text).isEmpty()
Truth.assertThat(viewModel.uiState.value.results).isNull()
}

@Test
fun `should be able to update the search query - search query changed`() = runTest {
// arrange
val resultFlow: Flow<List<Movie>> = flow { emit(emptyList()) }
every { searchMovieUseCase(any()) }.returns(resultFlow)
val viewModel = SearchViewModel(searchMovieUseCase)

// act
viewModel.onQueryChanged(TextFieldValue("searchQuery"))

// assert
viewModel.viewModelScope.async { }.await()
Truth.assertThat(viewModel.uiState.value.searchQuery.text).isEqualTo("searchQuery")
}
}