From 2be24e32ad97c6df9eab205ebe1256d149d3c71f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gabriel=20Font=C3=A1n?= <gabilessto@gmail.com>
Date: Thu, 15 Aug 2024 18:05:37 +0200
Subject: [PATCH] fix/Spotify: App crashes when there's no internet connection
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Added a loading state for the Spotify track search.
- Updated the Spotify search service to handle pagination.
- Added error handling for Spotify track search.

Signed-off-by: Gabriel Fontán <gabilessto@gmail.com>
---
 .idea/gradle.xml                              |  1 +
 .../spotify/data/remote/SpotifyServiceImpl.kt |  3 +-
 .../remote/search/SpotifySearchServiceImpl.kt | 24 +++++
 .../data/repository/SearchRepositoryImpl.kt   | 16 ++-
 .../services/search/SpotifySearchService.kt   |  7 ++
 .../tageditor/spotify/MetadataBsVM.kt         | 55 +++++------
 .../spotify/stages/SpMetadataBsSearch.kt      | 98 +++++++++++++------
 app/src/main/res/values/strings.xml           |  1 +
 .../ui/components/state/LoadingState.kt       | 37 +++++++
 9 files changed, 167 insertions(+), 75 deletions(-)
 create mode 100644 app/ui/src/main/java/com/bobbyesp/ui/components/state/LoadingState.kt

diff --git a/.idea/gradle.xml b/.idea/gradle.xml
index 0fda7b4..5fc23f8 100644
--- a/.idea/gradle.xml
+++ b/.idea/gradle.xml
@@ -4,6 +4,7 @@
   <component name="GradleSettings">
     <option name="linkedExternalProjectsSettings">
       <GradleProjectSettings>
+        <option name="testRunner" value="CHOOSE_PER_TEST" />
         <option name="externalProjectPath" value="$PROJECT_DIR$" />
         <option name="gradleJvm" value="#GRADLE_LOCAL_JAVA_HOME" />
         <option name="modules">
diff --git a/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/remote/SpotifyServiceImpl.kt b/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/remote/SpotifyServiceImpl.kt
index efb5ef7..4718271 100644
--- a/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/remote/SpotifyServiceImpl.kt
+++ b/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/remote/SpotifyServiceImpl.kt
@@ -23,7 +23,8 @@ class SpotifyServiceImpl @Inject constructor(
         if (api == null) {
             buildApi()
         }
-        return api ?: throw IllegalStateException("Spotify API is null")
+        return api
+            ?: throw IllegalStateException("The connection to the Spotify API was not established. This may be due to a network error or a servers outage")
     }
 
     override suspend fun getSpotifyToken(): Token {
diff --git a/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/remote/search/SpotifySearchServiceImpl.kt b/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/remote/search/SpotifySearchServiceImpl.kt
index 540313d..31011e7 100644
--- a/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/remote/search/SpotifySearchServiceImpl.kt
+++ b/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/remote/search/SpotifySearchServiceImpl.kt
@@ -1,8 +1,12 @@
 package com.bobbyesp.metadator.features.spotify.data.remote.search
 
+import androidx.paging.Pager
+import androidx.paging.PagingConfig
 import com.adamratzman.spotify.endpoints.pub.SearchApi
 import com.adamratzman.spotify.models.SearchFilter
 import com.adamratzman.spotify.models.SpotifySearchResult
+import com.adamratzman.spotify.models.Track
+import com.bobbyesp.metadator.features.spotify.domain.pagination.TracksPagingSource
 import com.bobbyesp.metadator.features.spotify.domain.services.SpotifyService
 import com.bobbyesp.metadator.features.spotify.domain.services.search.SpotifySearchService
 import javax.inject.Inject
@@ -18,4 +22,24 @@ class SpotifySearchServiceImpl @Inject constructor(
         val api = spotifyService.getSpotifyApi()
         return api.search.search(query = query, searchTypes = searchTypes, filters = filters)
     }
+
+    override suspend fun searchPaginatedTracks(
+        query: String,
+        filters: List<SearchFilter>
+    ): Pager<Int, Track> {
+        val api = spotifyService.getSpotifyApi()
+        return Pager(
+            config = PagingConfig(
+                pageSize = 20,
+                enablePlaceholders = false,
+                initialLoadSize = 40,
+            ),
+            pagingSourceFactory = {
+                TracksPagingSource(
+                    spotifyApi = api,
+                    query = query,
+                )
+            }
+        )
+    }
 }
\ No newline at end of file
diff --git a/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/repository/SearchRepositoryImpl.kt b/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/repository/SearchRepositoryImpl.kt
index f629e5e..2bc9509 100644
--- a/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/repository/SearchRepositoryImpl.kt
+++ b/app/src/main/java/com/bobbyesp/metadator/features/spotify/data/repository/SearchRepositoryImpl.kt
@@ -14,19 +14,17 @@ class SearchRepositoryImpl @Inject constructor(
      * does not support it. For now, it will only return up to 50 results.
      */
     override suspend fun searchTracks(query: String): Result<List<Track>> {
-        return try {
+        try {
             val searchResult = searchService.search(
                 query,
                 searchTypes = arrayOf(SearchApi.SearchType.Track),
-                filters = listOf()
+                filters = emptyList()
             )
-            searchResult.let {
-                if (it.tracks == null) return Result.failure(IllegalStateException("Search result is null"))
-            }
-            Result.success(searchResult.tracks!!.items)
-        } catch (e: Exception) {
-            Result.failure(e)
+
+            searchResult.tracks?.let { return Result.success(it.items) }
+                ?: return Result.failure(NullPointerException("Search result is null"))
+        } catch (th: Throwable) {
+            return Result.failure(th)
         }
     }
-
 }
\ No newline at end of file
diff --git a/app/src/main/java/com/bobbyesp/metadator/features/spotify/domain/services/search/SpotifySearchService.kt b/app/src/main/java/com/bobbyesp/metadator/features/spotify/domain/services/search/SpotifySearchService.kt
index 0155ab2..d6eba6c 100644
--- a/app/src/main/java/com/bobbyesp/metadator/features/spotify/domain/services/search/SpotifySearchService.kt
+++ b/app/src/main/java/com/bobbyesp/metadator/features/spotify/domain/services/search/SpotifySearchService.kt
@@ -1,8 +1,10 @@
 package com.bobbyesp.metadator.features.spotify.domain.services.search
 
+import androidx.paging.Pager
 import com.adamratzman.spotify.endpoints.pub.SearchApi
 import com.adamratzman.spotify.models.SearchFilter
 import com.adamratzman.spotify.models.SpotifySearchResult
+import com.adamratzman.spotify.models.Track
 
 interface SpotifySearchService {
     suspend fun search(
@@ -10,4 +12,9 @@ interface SpotifySearchService {
         vararg searchTypes: SearchApi.SearchType,
         filters: List<SearchFilter>
     ): SpotifySearchResult
+
+    suspend fun searchPaginatedTracks(
+        query: String,
+        filters: List<SearchFilter>,
+    ): Pager<Int, Track>
 }
\ No newline at end of file
diff --git a/app/src/main/java/com/bobbyesp/metadator/presentation/pages/utilities/tageditor/spotify/MetadataBsVM.kt b/app/src/main/java/com/bobbyesp/metadator/presentation/pages/utilities/tageditor/spotify/MetadataBsVM.kt
index 5ea4f72..d26c0dd 100644
--- a/app/src/main/java/com/bobbyesp/metadator/presentation/pages/utilities/tageditor/spotify/MetadataBsVM.kt
+++ b/app/src/main/java/com/bobbyesp/metadator/presentation/pages/utilities/tageditor/spotify/MetadataBsVM.kt
@@ -2,14 +2,11 @@ package com.bobbyesp.metadator.presentation.pages.utilities.tageditor.spotify
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
-import androidx.paging.Pager
-import androidx.paging.PagingConfig
 import androidx.paging.PagingData
 import androidx.paging.cachedIn
-import com.adamratzman.spotify.SpotifyAppApi
 import com.adamratzman.spotify.models.Track
-import com.bobbyesp.metadator.features.spotify.domain.pagination.TracksPagingSource
-import com.bobbyesp.metadator.features.spotify.domain.services.SpotifyService
+import com.bobbyesp.metadator.features.spotify.domain.services.search.SpotifySearchService
+import com.bobbyesp.utilities.states.ResourceState
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.Flow
@@ -17,23 +14,14 @@ import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.asSharedFlow
 import kotlinx.coroutines.flow.asStateFlow
-import kotlinx.coroutines.flow.emptyFlow
 import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 
 @HiltViewModel
 class MetadataBsVM @Inject constructor(
-    private val spotifyService: SpotifyService
+    private val searchService: SpotifySearchService
 ) : ViewModel() {
-    private lateinit var spotifyApi: SpotifyAppApi
-
-    init {
-        viewModelScope.launch {
-            spotifyApi = spotifyService.getSpotifyApi()
-        }
-    }
-
     private val mutableViewStateFlow = MutableStateFlow(ViewState())
     val viewStateFlow = mutableViewStateFlow.asStateFlow()
 
@@ -42,7 +30,7 @@ class MetadataBsVM @Inject constructor(
 
     data class ViewState(
         val stage: BottomSheetStage = BottomSheetStage.SEARCH,
-        val searchedTracks: Flow<PagingData<Track>> = emptyFlow(),
+        val searchedTracks: ResourceState<Flow<PagingData<Track>>> = ResourceState.Loading(null),
         val selectedTrack: Track? = null,
         val lastQuery: String = "",
     )
@@ -54,25 +42,26 @@ class MetadataBsVM @Inject constructor(
         }
     }
 
-    private fun getTracksPaginatedData(query: String) {
-        val tracksPager = Pager(
-            config = PagingConfig(
-                pageSize = 20,
-                enablePlaceholders = false,
-                initialLoadSize = 40,
-            ),
-            pagingSourceFactory = {
-                TracksPagingSource(
-                    spotifyApi = spotifyApi,
-                    query = query,
+    private suspend fun getTracksPaginatedData(query: String) {
+        try {
+            val tracksPager = searchService.searchPaginatedTracks(
+                query = query,
+                filters = emptyList()
+            ).flow.cachedIn(viewModelScope)
+
+            mutableViewStateFlow.update {
+                it.copy(
+                    searchedTracks = ResourceState.Success(tracksPager)
+                )
+            }
+        } catch (th: Throwable) {
+            mutableViewStateFlow.update {
+                it.copy(
+                    searchedTracks = ResourceState.Error(
+                        message = th.message ?: th.stackTrace.toString()
+                    )
                 )
             }
-        ).flow.cachedIn(viewModelScope)
-
-        mutableViewStateFlow.update {
-            it.copy(
-                searchedTracks = tracksPager
-            )
         }
     }
 
diff --git a/app/src/main/java/com/bobbyesp/metadator/presentation/pages/utilities/tageditor/spotify/stages/SpMetadataBsSearch.kt b/app/src/main/java/com/bobbyesp/metadator/presentation/pages/utilities/tageditor/spotify/stages/SpMetadataBsSearch.kt
index 73d9dac..2362438 100644
--- a/app/src/main/java/com/bobbyesp/metadator/presentation/pages/utilities/tageditor/spotify/stages/SpMetadataBsSearch.kt
+++ b/app/src/main/java/com/bobbyesp/metadator/presentation/pages/utilities/tageditor/spotify/stages/SpMetadataBsSearch.kt
@@ -1,5 +1,6 @@
 package com.bobbyesp.metadator.presentation.pages.utilities.tageditor.spotify.stages
 
+import androidx.compose.foundation.BorderStroke
 import androidx.compose.foundation.ExperimentalFoundationApi
 import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Arrangement
@@ -11,8 +12,8 @@ import androidx.compose.foundation.layout.padding
 import androidx.compose.foundation.lazy.LazyColumn
 import androidx.compose.foundation.lazy.LazyListState
 import androidx.compose.foundation.lazy.rememberLazyListState
-import androidx.compose.material3.LinearProgressIndicator
 import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Surface
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.State
@@ -31,6 +32,8 @@ import com.adamratzman.spotify.models.Track
 import com.bobbyesp.metadator.R
 import com.bobbyesp.metadator.presentation.components.cards.songs.spotify.SpotifyHorizontalSongCard
 import com.bobbyesp.metadator.presentation.pages.utilities.tageditor.spotify.MetadataBsVM
+import com.bobbyesp.ui.components.state.LoadingState
+import com.bobbyesp.utilities.states.ResourceState
 import com.bobbyesp.utilities.ui.pagingStateHandler
 
 @OptIn(ExperimentalFoundationApi::class)
@@ -42,7 +45,8 @@ fun SpMetadataBsSearch(
     pageViewState: State<MetadataBsVM.ViewState>,
     onChooseTrack: (Track) -> Unit
 ) {
-    val paginatedTracks = pageViewState.value.searchedTracks.collectAsLazyPagingItems()
+    val paginatedTracksState = pageViewState.value.searchedTracks
+    val paginatedTracks = paginatedTracksState.data?.collectAsLazyPagingItems()
 
     LazyColumn(
         state = listState,
@@ -80,37 +84,67 @@ fun SpMetadataBsSearch(
             }
         }
 
-        items(
-            count = paginatedTracks.itemCount,
-            key = paginatedTracks.itemKey(),
-            contentType = paginatedTracks.itemContentType()
-        ) { index ->
-            val item = paginatedTracks[index] ?: return@items
-            SpotifyHorizontalSongCard(
-                innerModifier = Modifier.padding(8.dp),
-                surfaceColor = Color.Transparent,
-                track = item,
-                onClick = {
-                    onChooseTrack(item)
+        when (paginatedTracksState) {
+            is ResourceState.Loading -> {
+                item {
+                    LoadingState(stringResource(id = R.string.retrieving_spotify_token))
+                }
+            }
+
+            is ResourceState.Success -> {
+                items(
+                    count = paginatedTracks!!.itemCount,
+                    key = paginatedTracks.itemKey(),
+                    contentType = paginatedTracks.itemContentType()
+                ) { index ->
+                    val item = paginatedTracks[index] ?: return@items
+                    SpotifyHorizontalSongCard(
+                        innerModifier = Modifier.padding(8.dp),
+                        surfaceColor = Color.Transparent,
+                        track = item,
+                        onClick = {
+                            onChooseTrack(item)
+                        }
+                    )
+                }
+
+                pagingStateHandler(paginatedTracks, itemCount = 1) {
+                    LoadingState(stringResource(id = R.string.loading))
+                }
+            }
+
+            is ResourceState.Error -> {
+                item {
+                    Surface(
+                        modifier = Modifier
+                            .fillMaxWidth()
+                            .padding(8.dp),
+                        border = BorderStroke(
+                            1.dp,
+                            MaterialTheme.colorScheme.error.copy(alpha = 0.5f)
+                        ),
+                        contentColor = MaterialTheme.colorScheme.error,
+                        shape = MaterialTheme.shapes.medium
+                    ) {
+                        Column(
+                            modifier = Modifier.padding(4.dp),
+                            verticalArrangement = Arrangement.spacedBy(
+                                8.dp,
+                                Alignment.CenterVertically
+                            ),
+                            horizontalAlignment = Alignment.CenterHorizontally
+                        ) {
+                            Text(
+                                modifier = Modifier,
+                                text = paginatedTracksState.message
+                                    ?: stringResource(id = com.bobbyesp.ui.R.string.unknown_error_title),
+                                style = MaterialTheme.typography.bodyMedium,
+                                textAlign = TextAlign.Center,
+                                fontWeight = FontWeight.Normal
+                            )
+                        }
+                    }
                 }
-            )
-        }
-        pagingStateHandler(paginatedTracks, itemCount = 1) {
-            Column(
-                modifier = Modifier.fillMaxWidth(),
-                verticalArrangement = Arrangement.spacedBy(8.dp, Alignment.CenterVertically),
-                horizontalAlignment = Alignment.CenterHorizontally
-            ) {
-                Text(
-                    text = stringResource(id = R.string.loading),
-                    style = MaterialTheme.typography.bodyMedium,
-                    textAlign = TextAlign.Center,
-                    fontWeight = FontWeight.Bold,
-                    modifier = Modifier.fillMaxWidth()
-                )
-                LinearProgressIndicator(
-                    modifier = Modifier.fillMaxWidth(0.8f)
-                )
             }
         }
     }
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
index b6fe4ce..1373269 100644
--- a/app/src/main/res/values/strings.xml
+++ b/app/src/main/res/values/strings.xml
@@ -74,4 +74,5 @@
     <string name="marquee_text">Marquee text</string>
     <string name="marquee_text_description">The text that overflows the limits of the screen has an animation to show its entire content (this may lag the app).</string>
     <string name="lyrics">Lyrics</string>
+    <string name="retrieving_spotify_token">Retrieveing Spotify API token...</string>
 </resources>
\ No newline at end of file
diff --git a/app/ui/src/main/java/com/bobbyesp/ui/components/state/LoadingState.kt b/app/ui/src/main/java/com/bobbyesp/ui/components/state/LoadingState.kt
new file mode 100644
index 0000000..2e0646e
--- /dev/null
+++ b/app/ui/src/main/java/com/bobbyesp/ui/components/state/LoadingState.kt
@@ -0,0 +1,37 @@
+package com.bobbyesp.ui.components.state
+
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.material3.LinearProgressIndicator
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.text.font.FontWeight
+import androidx.compose.ui.text.style.TextAlign
+import androidx.compose.ui.unit.dp
+
+@Composable
+fun LoadingState(text: String, modifier: Modifier = Modifier) {
+    Column(
+        modifier = modifier.fillMaxWidth(),
+        verticalArrangement = Arrangement.spacedBy(
+            8.dp,
+            Alignment.CenterVertically
+        ),
+        horizontalAlignment = Alignment.CenterHorizontally
+    ) {
+        Text(
+            text = text,
+            style = MaterialTheme.typography.bodyMedium,
+            textAlign = TextAlign.Center,
+            fontWeight = FontWeight.Bold,
+            modifier = Modifier.fillMaxWidth()
+        )
+        LinearProgressIndicator(
+            modifier = Modifier.fillMaxWidth(0.8f)
+        )
+    }
+}
\ No newline at end of file