Skip to content

Native Android client for Spotify, built with Jetpack Compose

Liked Songs leads the shortcuts at the top of Home in both looks when Spotify's grid does not carry it (the grid stays at eight tiles, no tile twice), drawn as the other shortcuts with the Liked Songs artwork the library uses, loaded ahead like them, and opening the Liked Songs page [skip ci]

kota-zo2efe3aae4a59
diff --git a/base/app/src/main/java/com/music/spotui/data/api/Api.kt b/base/app/src/main/java/com/music/spotui/data/api/Api.kt
index 1f908f28..1086cbd2 100644
--- a/base/app/src/main/java/com/music/spotui/data/api/Api.kt
+++ b/base/app/src/main/java/com/music/spotui/data/api/Api.kt
@@ -60,6 +60,8 @@ class Api constructor(
const val DISCOGRAPHY_MAX = 300
/** Sentinel id for the pinned "Liked Songs" library entry. */
const val LIKED_SONGS_ID = "liked-songs"
+ /** The Liked Songs artwork, as the library and the home shortcuts draw it. */
+ const val LIKED_COVER = "https://misc.scdn.co/liked-songs/liked-songs-640.png"
/** The "Local Files" folder pinned under Liked Songs in the library (not a Spotify item). */
const val LOCAL_FILES_ID = "local-files"
/** "Downloaded" (songs kept for offline listening), pinned under Local Files. */
@@ -273,8 +275,6 @@ class Api constructor(
}
}
- private val LIKED_COVER = "https://misc.scdn.co/liked-songs/liked-songs-640.png"
-
private fun likedEntry() = LibraryEntry(
spotifyId = LIKED_SONGS_ID,
name = context.getString(R.string.collection_liked_songs_title),
diff --git a/base/app/src/main/java/com/music/spotui/data/entity/HomeFeedModel.kt b/base/app/src/main/java/com/music/spotui/data/entity/HomeFeedModel.kt
index 04a456c5..f8280d53 100644
--- a/base/app/src/main/java/com/music/spotui/data/entity/HomeFeedModel.kt
+++ b/base/app/src/main/java/com/music/spotui/data/entity/HomeFeedModel.kt
@@ -22,6 +22,21 @@ fun List<HomeSection>.withoutDj(): List<HomeSection> =
map { s -> s.copy(items = s.items.filterNot { it is HomeItem.Playlist && (it.id == DJ_PLAYLIST_ID || it.name.trim().equals("DJ", ignoreCase = true)) }) }
.filter { it.items.isNotEmpty() }
+/**
+ * The home shortcuts with Liked Songs first, named [likedName]: Spotify's own grid does not always
+ * carry it. Left as it is when the grid already has it (no tile twice), and kept to eight tiles.
+ */
+fun List<HomeItem>.withLikedFirst(likedName: String): List<HomeItem> {
+ if (any { it is HomeItem.Playlist && it.id == com.music.spotui.data.api.Api.HomeCache.LIKED_SONGS_ID }) return take(8)
+ val liked = HomeItem.Playlist(
+ name = likedName,
+ imageUrl = com.music.spotui.data.api.Api.HomeCache.LIKED_COVER,
+ subtitle = "",
+ id = com.music.spotui.data.api.Api.HomeCache.LIKED_SONGS_ID,
+ )
+ return (listOf<HomeItem>(liked) + this).take(8)
+}
+
private const val DJ_PLAYLIST_ID = "37i9dQZF1EYkqdzj48dyYq"
@kotlinx.serialization.Serializable
diff --git a/base/app/src/main/java/com/music/spotui/ui/immersive/screens/ImmersiveHomeScreen.kt b/base/app/src/main/java/com/music/spotui/ui/immersive/screens/ImmersiveHomeScreen.kt
index af04c878..78f933e1 100644
--- a/base/app/src/main/java/com/music/spotui/ui/immersive/screens/ImmersiveHomeScreen.kt
+++ b/base/app/src/main/java/com/music/spotui/ui/immersive/screens/ImmersiveHomeScreen.kt
@@ -48,9 +48,11 @@ import app.myspoti.engine.R
import com.music.spotui.data.api.Features
import com.music.spotui.data.api.ProfileCache
import com.music.spotui.data.api.Response
+import com.music.spotui.data.api.Api
import com.music.spotui.data.entity.HomeFeedModel
import com.music.spotui.data.entity.HomeItem
import com.music.spotui.data.entity.HomeSection
+import com.music.spotui.data.entity.withLikedFirst
import com.music.spotui.data.entity.withoutDj
import com.music.spotui.di.Graph
import com.music.spotui.di.SongPlayer
@@ -72,6 +74,7 @@ import com.music.spotui.ui.immersive.shell.LocalBarControlSize
import com.music.spotui.ui.immersive.shell.immersiveChromeScroll
import com.music.spotui.ui.immersive.shell.immersiveHeaderContentPadding
import com.music.spotui.ui.immersive.shell.rememberTopBarCollapse
+import com.music.spotui.ui.navigation.Routes
import com.music.spotui.ui.navigation.TabReselect
import com.music.spotui.ui.navigation.albumRoute
import com.music.spotui.ui.navigation.artistRoute
@@ -127,12 +130,15 @@ fun ImmersiveHomeScreen(navController: NavController) {
// section is a carousel like any other.
val gridSection = sections.firstOrNull()?.takeIf { it.title.isBlank() }
val carousels = if (gridSection != null) sections.drop(1) else sections
+ // Liked Songs leads the shortcuts when Spotify's grid does not carry it.
+ val likedName = stringResource(R.string.collection_liked_songs_title)
+ val shortcuts = remember(gridSection, likedName) { gridSection?.items?.withLikedFirst(likedName) }
// The shortcuts at the top load in the background, ready before a tap.
- LaunchedEffect(gridSection?.items?.map { it.name }) {
- val top = gridSection?.items.orEmpty().take(8).mapNotNull { item ->
+ LaunchedEffect(shortcuts?.map { it.name }) {
+ val top = shortcuts.orEmpty().mapNotNull { item ->
when (item) {
is HomeItem.Album -> item.id.takeIf { it.isNotBlank() }?.let { "album" to it }
- is HomeItem.Playlist -> item.id.takeIf { it.isNotBlank() }?.let { "playlist" to it }
+ is HomeItem.Playlist -> if (item.id == Api.HomeCache.LIKED_SONGS_ID) "liked" to "" else item.id.takeIf { it.isNotBlank() }?.let { "playlist" to it }
else -> null
}
}
@@ -167,9 +173,9 @@ fun ImmersiveHomeScreen(navController: NavController) {
}
when {
feed != null && feed.sections.isNotEmpty() -> {
- gridSection?.let { section ->
+ shortcuts?.let { tiles ->
item(key = "home:shortcuts") {
- ShortcutGrid(navController, section.items.take(8), playingContext)
+ ShortcutGrid(navController, tiles, playingContext)
}
}
carousels.forEachIndexed { index, section ->
@@ -225,7 +231,9 @@ private fun visibleSections(feed: HomeFeedModel): List<HomeSection> =
private fun prefetchHomeItem(item: HomeItem) {
when (item) {
is HomeItem.Album -> if (item.id.isNotBlank()) ContextViewModel.prefetch("album", item.id)
- is HomeItem.Playlist -> if (item.id.isNotBlank()) ContextViewModel.prefetch("playlist", item.id)
+ is HomeItem.Playlist ->
+ if (item.id == Api.HomeCache.LIKED_SONGS_ID) ContextViewModel.prefetch("liked", "")
+ else if (item.id.isNotBlank()) ContextViewModel.prefetch("playlist", item.id)
else -> {}
}
}
@@ -239,7 +247,8 @@ private fun onHomeItemClick(navController: NavController, item: HomeItem) {
else navController.navigate(showRoute(item.id, item.name))
// The real playlist content by its id (daily mixes, etc).
is HomeItem.Playlist ->
- if (item.id.isNotBlank()) navController.navigate(playlistRoute(item.id, item.name))
+ if (item.id == Api.HomeCache.LIKED_SONGS_ID) navController.navigate(Routes.Liked.route)
+ else if (item.id.isNotBlank()) navController.navigate(playlistRoute(item.id, item.name))
else navController.navigate(albumRoute(item.name))
}
}
diff --git a/base/app/src/main/java/com/music/spotui/ui/screens/HomeScreen.kt b/base/app/src/main/java/com/music/spotui/ui/screens/HomeScreen.kt
index 1f820b57..67e40039 100644
--- a/base/app/src/main/java/com/music/spotui/ui/screens/HomeScreen.kt
+++ b/base/app/src/main/java/com/music/spotui/ui/screens/HomeScreen.kt
@@ -81,8 +81,10 @@ import app.myspoti.engine.R
import com.music.spotui.data.api.Response
import com.music.spotui.data.entity.AlbumsModel
import com.music.spotui.data.entity.ArtistsModel
+import com.music.spotui.data.api.Api
import com.music.spotui.data.entity.HomeFeedModel
import com.music.spotui.data.entity.HomeItem
+import com.music.spotui.data.entity.withLikedFirst
import com.music.spotui.data.entity.withoutDj
import com.music.spotui.data.entity.HomeSection
import com.music.spotui.ui.components.Loader
@@ -145,7 +147,9 @@ fun HomeScreen(navController: NavController){
private fun prefetchHomeItem(item: HomeItem) {
when (item) {
is HomeItem.Album -> if (item.id.isNotBlank()) ContextViewModel.prefetch("album", item.id)
- is HomeItem.Playlist -> if (item.id.isNotBlank()) ContextViewModel.prefetch("playlist", item.id)
+ is HomeItem.Playlist ->
+ if (item.id == Api.HomeCache.LIKED_SONGS_ID) ContextViewModel.prefetch("liked", "")
+ else if (item.id.isNotBlank()) ContextViewModel.prefetch("playlist", item.id)
else -> {}
}
}
@@ -159,7 +163,8 @@ private fun onHomeItemClick(navController: NavController, item: HomeItem) {
else navController.navigate(com.music.spotui.ui.navigation.showRoute(item.id, item.name))
// Load the real playlist content by its Spotify id (daily mixes, etc).
is HomeItem.Playlist ->
- if (item.id.isNotBlank()) navController.navigate(playlistRoute(item.id, item.name))
+ if (item.id == Api.HomeCache.LIKED_SONGS_ID) navController.navigate(Routes.Liked.route)
+ else if (item.id.isNotBlank()) navController.navigate(playlistRoute(item.id, item.name))
else navController.navigate(albumRoute(item.name))
}
}
@@ -184,12 +189,15 @@ fun HomeFeedContent(navController: NavController, feed: HomeFeedModel, facet: St
val gridSection = remember(sections) { sections.firstOrNull()?.takeIf { it.title.isBlank() } }
val carousels = remember(sections, gridSection) { if (gridSection != null) sections.drop(1) else sections }
val carouselKeys = remember(carousels) { uniqueKeys(carousels.map { it.title }) }
+ // Liked Songs leads the shortcuts when Spotify's grid does not carry it.
+ val likedName = stringResource(R.string.collection_liked_songs_title)
+ val shortcuts = remember(gridSection, likedName) { gridSection?.items?.withLikedFirst(likedName) }
// The shortcuts at the top load in the background, ready before a tap.
- androidx.compose.runtime.LaunchedEffect(gridSection?.items?.map { it.name }) {
- val top = gridSection?.items.orEmpty().take(8).mapNotNull { item ->
+ androidx.compose.runtime.LaunchedEffect(shortcuts?.map { it.name }) {
+ val top = shortcuts.orEmpty().mapNotNull { item ->
when (item) {
is HomeItem.Album -> item.id.takeIf { it.isNotBlank() }?.let { "album" to it }
- is HomeItem.Playlist -> item.id.takeIf { it.isNotBlank() }?.let { "playlist" to it }
+ is HomeItem.Playlist -> if (item.id == Api.HomeCache.LIKED_SONGS_ID) "liked" to "" else item.id.takeIf { it.isNotBlank() }?.let { "playlist" to it }
else -> null
}
}
@@ -233,9 +241,9 @@ fun HomeFeedContent(navController: NavController, feed: HomeFeedModel, facet: St
HomeHeaderRow(navController, facet, onFacet)
}
}
- gridSection?.let { section ->
+ shortcuts?.let { tiles ->
item {
- HomeShortcutGrid(navController, section.items.take(8))
+ HomeShortcutGrid(navController, tiles)
}
}
items(carousels.size, key = { carouselKeys[it] }) { i ->
diff --git a/base/app/src/test/java/com/music/spotui/data/entity/HomeShortcutsTest.kt b/base/app/src/test/java/com/music/spotui/data/entity/HomeShortcutsTest.kt
new file mode 100644
index 00000000..eefba858
--- /dev/null
+++ b/base/app/src/test/java/com/music/spotui/data/entity/HomeShortcutsTest.kt
@@ -0,0 +1,23 @@
+package com.music.spotui.data.entity
+
+import com.music.spotui.data.api.Api
+import org.junit.Assert.assertEquals
+import org.junit.Test
+
+class HomeShortcutsTest {
+ private fun playlist(id: String) = HomeItem.Playlist(name = id, imageUrl = "", subtitle = "", id = id)
+
+ @Test fun likedSongsLeadsTheGridAndTheGridStaysAtEight() {
+ val grid = (1..8).map { playlist("p$it") }
+ val shown = grid.withLikedFirst("Liked Songs")
+ assertEquals(8, shown.size)
+ assertEquals(Api.HomeCache.LIKED_SONGS_ID, (shown[0] as HomeItem.Playlist).id)
+ assertEquals("Liked Songs", shown[0].name)
+ assertEquals(grid.take(7), shown.drop(1))
+ }
+
+ @Test fun aGridThatHasLikedSongsAlreadyGetsNoSecondTile() {
+ val grid = listOf(playlist("p1"), playlist(Api.HomeCache.LIKED_SONGS_ID), playlist("p2"))
+ assertEquals(grid, grid.withLikedFirst("Liked Songs"))
+ }
+}