react-native-audio-browser 0.2.0-next.11 → 0.2.0-next.13

package/android/src/test/java/com/audiobrowser/TestFixtures.kt

@@ -1,14 +1,21 @@
 package com.audiobrowser
 
 import com.audiobrowser.util.artworkOf
+import com.margelo.nitro.audiobrowser.ArtworkRendering
 import com.margelo.nitro.audiobrowser.ArtworkRequestConfig
+import com.margelo.nitro.audiobrowser.CardImage
+import com.margelo.nitro.audiobrowser.GridTile
 import com.margelo.nitro.audiobrowser.ImageQueryParams
-import com.margelo.nitro.audiobrowser.ImageRowItem
+import com.margelo.nitro.audiobrowser.ImageShape
 import com.margelo.nitro.audiobrowser.ImageSource
 import com.margelo.nitro.audiobrowser.MediaRequestConfig
 import com.margelo.nitro.audiobrowser.NativeRouteEntry
 import com.margelo.nitro.audiobrowser.ResolvedTrack
+import com.margelo.nitro.audiobrowser.Section
+import com.margelo.nitro.audiobrowser.SectionStyle
+import com.margelo.nitro.audiobrowser.StyleDisplay
 import com.margelo.nitro.audiobrowser.Track
+import com.margelo.nitro.audiobrowser.TrackStyle
 import com.margelo.nitro.audiobrowser.TransformableRequestConfig
 
 /**
@@ -26,47 +33,38 @@ object TestFixtures {
     artist: String? = null,
     album: String? = null,
     favorited: Boolean? = null,
-    groupTitle: String? = null,
-    imageRow: Array<ImageRowItem>? = null,
+    disabled: Boolean? = null,
+    style: TrackStyle? = null,
   ) =
     Track(
       id = id,
-      url = null,
+      path = null,
       src = src,
       artwork = artworkOf(artwork),
       artworkSource = null,
       request = null,
-      artworkCarPlayTinted = null,
       title = title,
       subtitle = null,
       artist = artist,
-      albumUrl = null,
+      albumPath = null,
       album = album,
       description = null,
       genre = null,
       duration = null,
-      style = null,
-      childrenStyle = null,
+      style = style,
+      disabled = disabled,
       favorited = favorited,
-      groupTitle = groupTitle,
       live = null,
-      imageRow = imageRow,
     )
 
-  fun imageRowItem(src: String, title: String = src) =
-    ImageRowItem(
-      id = null,
-      url = null,
-      src = src,
-      artwork = null,
-      artworkSource = null,
-      title = title,
-      artist = null,
-      album = null,
-      albumUrl = null,
-      live = null,
-      request = null,
-    )
+  /** A page [Section] — plain list by default. */
+  fun section(
+    children: Array<Track> = emptyArray(),
+    title: String? = null,
+    subtitle: String? = null,
+    style: SectionStyle? = null,
+    path: String? = null,
+  ) = Section(title = title, subtitle = subtitle, style = style, path = path, children = children)
 
   fun transformableConfig(
     baseUrl: String? = null,
@@ -115,43 +113,44 @@ object TestFixtures {
    */
   fun browseTrack(
     title: String = "T",
-    url: String = "https://api.example.com/channel/abc",
+    path: String = "https://api.example.com/channel/abc",
     artwork: String? = null,
     artworkSource: ImageSource? = null,
+    style: TrackStyle? = null,
   ) =
     Track(
       id = null,
-      url = url,
+      path = path,
       src = null, // browsable, not playable
       artwork = artworkOf(artwork),
       artworkSource = artworkSource,
       request = null,
-      artworkCarPlayTinted = null,
       title = title,
       subtitle = null,
       artist = null,
-      albumUrl = null,
+      albumPath = null,
       album = null,
       description = null,
       genre = null,
       duration = null,
-      style = null,
-      childrenStyle = null,
+      style = style,
+      disabled = null,
       favorited = null,
-      groupTitle = null,
       live = null,
-      imageRow = null,
     )
 
   /** A container [ResolvedTrack] — what a browse route hands back for a path. */
   fun resolvedTrack(
-    url: String = "/container",
+    path: String = "/container",
     title: String = "Container",
     children: Array<Track>? = null,
-    imageRow: Array<ImageRowItem>? = null,
+    sections: Array<Section>? = null,
+    style: SectionStyle? = null,
   ) =
     ResolvedTrack(
-      url = url,
+      path = path,
+      style = style,
+      sections = sections,
       children = children,
       carPlaySiriListButton = null,
       id = null,
@@ -159,21 +158,17 @@ object TestFixtures {
       artwork = null,
       artworkSource = null,
       request = null,
-      artworkCarPlayTinted = null,
       title = title,
       subtitle = null,
       artist = null,
-      albumUrl = null,
+      albumPath = null,
       album = null,
       description = null,
       genre = null,
       duration = null,
-      style = null,
-      childrenStyle = null,
+      disabled = null,
       favorited = null,
-      groupTitle = null,
       live = null,
-      imageRow = imageRow,
     )
 
   /**
@@ -214,4 +209,42 @@ object TestFixtures {
       contentType = null,
       userAgent = null,
     )
+
+  fun trackStyle(
+    display: StyleDisplay? = null,
+    artworkRendering: ArtworkRendering? = null,
+    imageShape: ImageShape? = null,
+    accessorySymbol: String? = null,
+    cardTint: String? = null,
+    cardImage: CardImage? = null,
+  ) =
+    TrackStyle(
+      display = display,
+      artworkRendering = artworkRendering,
+      imageShape = imageShape,
+      accessorySymbol = accessorySymbol,
+      cardTint = cardTint,
+      cardImage = cardImage,
+    )
+
+  fun sectionStyle(
+    display: StyleDisplay? = null,
+    artworkRendering: ArtworkRendering? = null,
+    imageShape: ImageShape? = null,
+    accessorySymbol: String? = null,
+    cardTint: String? = null,
+    cardImage: CardImage? = null,
+    gridWrap: Boolean? = null,
+    gridTile: GridTile? = null,
+  ) =
+    SectionStyle(
+      gridWrap = gridWrap,
+      gridTile = gridTile,
+      display = display,
+      artworkRendering = artworkRendering,
+      imageShape = imageShape,
+      accessorySymbol = accessorySymbol,
+      cardTint = cardTint,
+      cardImage = cardImage,
+    )
 }

package/android/src/test/java/com/audiobrowser/browser/BrowserManagerFavoritesTest.kt

@@ -0,0 +1,153 @@
+package com.audiobrowser.browser
+
+import com.audiobrowser.TestFixtures.resolvedTrack
+import com.audiobrowser.TestFixtures.staticRoute
+import com.audiobrowser.TestFixtures.track
+import kotlinx.coroutines.runBlocking
+import org.junit.Assert.assertEquals
+import org.junit.Before
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+
+/**
+ * Favorite hydration keyed by track identity (id when non-blank, else src — see Track.identity /
+ * ADR 0008). Hydration is exercised through [BrowserManager.resolve], the path every browse page
+ * takes.
+ *
+ * Routes serve `browseStatic` (no JNI/HTTP); Robolectric is required for `android.util.LruCache`
+ * and `android.net.Uri`.
+ */
+@RunWith(RobolectricTestRunner::class)
+class BrowserManagerFavoritesTest {
+
+  private lateinit var browserManager: BrowserManager
+
+  @Before
+  fun setup() {
+    browserManager = BrowserManager()
+  }
+
+  private fun servePage(path: String, vararg children: com.margelo.nitro.audiobrowser.Track) {
+    browserManager.config =
+      BrowserConfig(
+        routes =
+          arrayOf(staticRoute(path, resolvedTrack(path = path, children = arrayOf(*children))))
+      )
+  }
+
+  private fun favoritedByTitle(children: Array<com.margelo.nitro.audiobrowser.Track>?) =
+    children?.associate { it.title to it.favorited }
+
+  @Test
+  fun `hydrates by id when the track has one`() = runBlocking {
+    servePage(
+      "/home",
+      track(title = "A", id = "stable-a", src = "https://s/a.mp3"),
+      track(title = "B", id = "stable-b", src = "https://s/b.mp3"),
+    )
+    browserManager.setFavoriteEnabled(true)
+    browserManager.setFavorites(listOf("stable-b"))
+
+    val resolved = browserManager.resolve("/home")
+
+    assertEquals(
+      mapOf("A" to false, "B" to true),
+      favoritedByTitle(resolved.flattenedChildren?.toTypedArray()),
+    )
+  }
+
+  @Test
+  fun `falls back to src for id-less tracks`() = runBlocking {
+    servePage(
+      "/home",
+      track(title = "A", src = "https://s/a.mp3"),
+      track(title = "B", src = "https://s/b.mp3"),
+    )
+    browserManager.setFavoriteEnabled(true)
+    browserManager.setFavorites(listOf("https://s/b.mp3"))
+
+    val resolved = browserManager.resolve("/home")
+
+    assertEquals(
+      mapOf("A" to false, "B" to true),
+      favoritedByTitle(resolved.flattenedChildren?.toTypedArray()),
+    )
+  }
+
+  @Test
+  fun `a favorite stored under src does not match an id-bearing track`() = runBlocking {
+    // The identity is the id when present — a src-keyed entry must not light up
+    // a track whose identity is its id (one rule, no partial matching).
+    servePage("/home", track(title = "A", id = "stable-a", src = "https://s/a.mp3"))
+    browserManager.setFavoriteEnabled(true)
+    browserManager.setFavorites(listOf("https://s/a.mp3"))
+
+    val resolved = browserManager.resolve("/home")
+
+    assertEquals(mapOf("A" to false), favoritedByTitle(resolved.flattenedChildren?.toTypedArray()))
+  }
+
+  @Test
+  fun `caller-set favorited wins over hydration`() = runBlocking {
+    servePage(
+      "/home",
+      track(title = "A", id = "stable-a", src = "https://s/a.mp3", favorited = false),
+    )
+    browserManager.setFavoriteEnabled(true)
+    browserManager.setFavorites(listOf("stable-a"))
+
+    val resolved = browserManager.resolve("/home")
+
+    // API-provided value is never overwritten, even when the identity is favorited.
+    assertEquals(mapOf("A" to false), favoritedByTitle(resolved.flattenedChildren?.toTypedArray()))
+  }
+
+  @Test
+  fun `disabled favoriting leaves tracks untouched`() = runBlocking {
+    servePage("/home", track(title = "A", id = "stable-a", src = "https://s/a.mp3"))
+    // favoriteEnabled defaults to false
+    browserManager.setFavorites(listOf("stable-a"))
+
+    val resolved = browserManager.resolve("/home")
+
+    assertEquals(
+      mapOf<String, Boolean?>("A" to null),
+      favoritedByTitle(resolved.flattenedChildren?.toTypedArray()),
+    )
+  }
+
+  @Test
+  fun `updateFavorite adds and removes by identity`() = runBlocking {
+    servePage("/home", track(title = "A", id = "stable-a", src = "https://s/a.mp3"))
+    browserManager.setFavoriteEnabled(true)
+
+    assertEquals(
+      mapOf("A" to false),
+      favoritedByTitle(browserManager.resolve("/home").flattenedChildren?.toTypedArray()),
+    )
+
+    browserManager.updateFavorite("stable-a", true)
+    assertEquals(
+      mapOf("A" to true),
+      favoritedByTitle(browserManager.resolve("/home").flattenedChildren?.toTypedArray()),
+    )
+
+    browserManager.updateFavorite("stable-a", false)
+    assertEquals(
+      mapOf("A" to false),
+      favoritedByTitle(browserManager.resolve("/home").flattenedChildren?.toTypedArray()),
+    )
+  }
+
+  @Test
+  fun `getCachedTrack re-hydrates favorites by identity`() = runBlocking {
+    servePage("/home", track(title = "A", id = "stable-a", src = "https://s/a.mp3"))
+    browserManager.setFavoriteEnabled(true)
+    browserManager.resolve("/home")
+
+    browserManager.updateFavorite("stable-a", true)
+
+    assertEquals(true, browserManager.getCachedTrack("stable-a")?.favorited)
+  }
+}