Skip to content

🎧 Your Personal Streaming Service

fix(jellyfin): honor Recursive=false for library parents (#5788)

Deluan Quintãoadeaa93e7e03
diff --git a/server/jellyfin/e2e/browsing_test.go b/server/jellyfin/e2e/browsing_test.go
index 646de4497..0b2769856 100644
--- a/server/jellyfin/e2e/browsing_test.go
+++ b/server/jellyfin/e2e/browsing_test.go
@@ -118,6 +118,28 @@ var _ = Describe("Browsing", func() {
})
})
+ // Finamp's download sync asks a library for the tracks outside any album this way; answering
+ // with every track would stream the whole library.
+ Describe("Recursive=false", func() {
+ lib1 := enc("1")
+
+ It("returns no songs for a library parent", func() {
+ q := queryResult(get("/Items?IncludeItemTypes=Audio&ParentId=" + lib1 + "&Recursive=false"))
+ Expect(q.Items).To(BeEmpty())
+ Expect(q.TotalRecordCount).To(BeZero())
+ })
+
+ It("still lists the library's albums", func() {
+ q := queryResult(get("/Items?IncludeItemTypes=MusicAlbum&ParentId=" + lib1 + "&Recursive=false"))
+ Expect(names(q.Items)).To(ConsistOf("Abbey Road", "Help!", "IV", "Kind of Blue", "Singles"))
+ })
+
+ It("still lists an album's tracks", func() {
+ q := queryResult(get("/Items?IncludeItemTypes=Audio&ParentId=" + enc(albumID("Abbey Road")) + "&Recursive=false"))
+ Expect(names(q.Items)).To(ConsistOf("Come Together", "Something"))
+ })
+ })
+
// Finamp's artist screen sends ParentId=<libraryId> (scoping) plus AlbumArtistIds/ArtistIds
// for the actual artist filter, not ParentId=<artistId>.
Describe("artist filtering (AlbumArtistIds / ArtistIds)", func() {
diff --git a/server/jellyfin/items.go b/server/jellyfin/items.go
index ff38b6491..43c8de12c 100644
--- a/server/jellyfin/items.go
+++ b/server/jellyfin/items.go
@@ -254,6 +254,12 @@ func (api *Router) parseItemsQuery(ctx context.Context, r *http.Request) itemsQu
q.types = parseTypes(q.rawTypes)
q.scopeIDs, q.isLibraryParent = resolveLibraryScope(ctx, q.parentId)
+ // Recursive=false asks for direct children only, and no track is a library's direct child.
+ // Finamp's sync probes a library this way, and every track is a wrong, unbounded answer.
+ if q.isLibraryParent && !p.BoolOr("recursive", false) {
+ q.types = slices.DeleteFunc(q.types, func(t string) bool { return t == "Audio" })
+ }
+
// With no item type, Jellyfin infers the child type from the parent: album parent -> its tracks
// (Jellify opens albums this way). An artist parent keeps parseTypes' MusicAlbum default (browse
// its albums).
diff --git a/server/jellyfin/items_test.go b/server/jellyfin/items_test.go
index 049151651..401145461 100644
--- a/server/jellyfin/items_test.go
+++ b/server/jellyfin/items_test.go
@@ -133,6 +133,81 @@ var _ = Describe("Items", func() {
Expect(w.Code).To(Equal(http.StatusInternalServerError))
})
+ // Recursive=false asks for direct children only. Finamp's sync probes a library this way
+ // looking for tracks outside any album; answering with every track streams the whole library.
+ Describe("Recursive=false", func() {
+ BeforeEach(func() {
+ ds.Album(context.Background()).(*tests.MockAlbumRepo).SetData(model.Albums{{ID: "a1", Name: "One"}})
+ ds.MediaFile(context.Background()).(*tests.MockMediaFileRepo).SetData(model.MediaFiles{{ID: "s1", AlbumID: "a1"}})
+ })
+
+ It("returns no songs for a library parent, as tracks are never its direct children", func() {
+ w := httptest.NewRecorder()
+ r := httptest.NewRequest("GET", "/Items?ParentId="+dto.EncodeID("1")+"&IncludeItemTypes=Audio&Recursive=false", nil).
+ WithContext(ctxUser())
+ invoke(api.getItems, w, r)
+ Expect(w.Code).To(Equal(http.StatusOK))
+ var res dto.QueryResult
+ Expect(json.Unmarshal(w.Body.Bytes(), &res)).To(Succeed())
+ Expect(res.Items).To(BeEmpty())
+ Expect(res.TotalRecordCount).To(BeZero())
+ })
+
+ It("drops only Audio from a multi-type library query", func() {
+ w := httptest.NewRecorder()
+ r := httptest.NewRequest("GET", "/Items?ParentId="+dto.EncodeID("1")+"&IncludeItemTypes=Audio,MusicAlbum&Recursive=false", nil).
+ WithContext(ctxUser())
+ invoke(api.getItems, w, r)
+ var res dto.QueryResult
+ Expect(json.Unmarshal(w.Body.Bytes(), &res)).To(Succeed())
+ Expect(res.Items).To(HaveLen(1))
+ Expect(res.Items[0].Type).To(Equal("MusicAlbum"))
+ })
+
+ It("still lists albums for a library parent, as they are its direct children", func() {
+ w := httptest.NewRecorder()
+ r := httptest.NewRequest("GET", "/Items?ParentId="+dto.EncodeID("1")+"&IncludeItemTypes=MusicAlbum&Recursive=false", nil).
+ WithContext(ctxUser())
+ invoke(api.getItems, w, r)
+ var res dto.QueryResult
+ Expect(json.Unmarshal(w.Body.Bytes(), &res)).To(Succeed())
+ Expect(res.Items).To(HaveLen(1))
+ })
+
+ It("still lists an album's tracks, as they are its direct children", func() {
+ fp.getErr = model.ErrNotFound
+ w := httptest.NewRecorder()
+ r := httptest.NewRequest("GET", "/Items?ParentId="+dto.EncodeID("a1")+"&IncludeItemTypes=Audio&Recursive=false", nil).
+ WithContext(ctxUser())
+ invoke(api.getItems, w, r)
+ var res dto.QueryResult
+ Expect(json.Unmarshal(w.Body.Bytes(), &res)).To(Succeed())
+ Expect(res.Items).To(HaveLen(1))
+ Expect(res.Items[0].Id).To(Equal(dto.EncodeID("s1")))
+ })
+
+ It("keeps returning every song when no parent scopes the query", func() {
+ w := httptest.NewRecorder()
+ r := httptest.NewRequest("GET", "/Items?IncludeItemTypes=Audio&Recursive=false", nil).WithContext(ctxUser())
+ invoke(api.getItems, w, r)
+ var res dto.QueryResult
+ Expect(json.Unmarshal(w.Body.Bytes(), &res)).To(Succeed())
+ Expect(res.Items).To(HaveLen(1))
+ })
+
+ // Jellyfin's own default: ItemsController binds `bool? recursive` and reads it as
+ // `recursive ?? false`, so an omitted Recursive is a non-recursive request.
+ It("treats an omitted Recursive as false, like Jellyfin", func() {
+ w := httptest.NewRecorder()
+ r := httptest.NewRequest("GET", "/Items?ParentId="+dto.EncodeID("1")+"&IncludeItemTypes=Audio", nil).
+ WithContext(ctxUser())
+ invoke(api.getItems, w, r)
+ var res dto.QueryResult
+ Expect(json.Unmarshal(w.Body.Bytes(), &res)).To(Succeed())
+ Expect(res.Items).To(BeEmpty())
+ })
+ })
+
It("lists an artist's albums when ParentId is an artist and type is MusicAlbum", func() {
ds.Album(context.Background()).(*tests.MockAlbumRepo).SetData(model.Albums{{ID: "a1", Name: "One", AlbumArtistID: "ar1"}})
w := httptest.NewRecorder()