mirror of
https://github.com/navidrome/navidrome.git
synced 2026-08-01 07:21:17 +00:00
f48416685f
* fix(artwork): include top-level album folders in parent cover art lookup The Path != "." guard added in #5451 was too aggressive — it excluded any folder with Path=".", which includes top-level album folders (not just the library root). Changed to ParentID != "" which correctly excludes only the actual library root folder. Fixes #5456 * fix: correct comment in test — album is under library root, not artist root * test: add ascii tree diagram to top-level album e2e test * test: replace internal bug references with issue link in e2e comments Signed-off-by: Deluan <deluan@navidrome.org> * test: add e2e test matching reporter's exact library layout (#5456) Adds a deeply nested test (Genre/Artist/Album/Disc) with 12 discs using the reporter's actual folder names to verify artwork resolution works for non-top-level album folders too. * fix(scanner): use a syntectic admin user when no admin user is found Signed-off-by: Deluan <deluan@navidrome.org> * fix(scanner): bump album UpdatedAt on Phase 3 refresh to invalidate artwork cache When Phase 3 corrects an album's FolderIDs (or any other field), bump UpdatedAt to the current time. This ensures the artwork cache key changes, invalidating any stale artwork that was resolved and cached during Phase 1 when the album had incomplete folder data. * fix(artwork): include ImportedAt in artwork cache key to invalidate stale cache Reverts the Phase 3 UpdatedAt bump (which would change album.UpdatedAt semantics) and instead includes album.ImportedAt in the artwork cache key computation. Since ImportedAt is bumped to time.Now() on every album Put, any Phase 3 correction naturally invalidates cached artwork that was resolved mid-scan with incomplete folder data. * fix(artwork): simplify lastUpdate logic using TimeNewest utility Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org>
372 lines
15 KiB
Go
372 lines
15 KiB
Go
package artworke2e_test
|
|
|
|
import (
|
|
"fmt"
|
|
"testing/fstest"
|
|
|
|
"github.com/navidrome/navidrome/conf"
|
|
"github.com/navidrome/navidrome/model"
|
|
. "github.com/onsi/ginkgo/v2"
|
|
. "github.com/onsi/gomega"
|
|
)
|
|
|
|
var _ = Describe("Disc artwork resolution", func() {
|
|
BeforeEach(func() {
|
|
setupHarness()
|
|
})
|
|
|
|
When("the album is single-disc with a disc1.jpg in the only folder", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── 01 - Track.mp3
|
|
// └── disc1.jpg ← matched by disc*.*
|
|
It("returns the disc1.jpg image (matched as disc*.*)", func() {
|
|
conf.Server.DiscArtPriority = "disc*.*, cd*.*, cover.*, folder.*, front.*, embedded"
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/01 - Track.mp3": trackFile(1, "Track"),
|
|
"Artist/Album/disc1.jpg": imageFile("disc1-image"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes("disc1-image")))
|
|
})
|
|
})
|
|
|
|
When("the album has no per-disc image and no album cover", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// └── 01 - Track.mp3 (no disc or album art — returns ErrUnavailable)
|
|
It("returns ErrUnavailable for the disc lookup", func() {
|
|
conf.Server.DiscArtPriority = "disc*.*, cd*.*"
|
|
conf.Server.CoverArtPriority = "cover.*, folder.*"
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/01 - Track.mp3": trackFile(1, "Track"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt)
|
|
_, err := readArtworkOrErr(discID)
|
|
Expect(err).To(HaveOccurred())
|
|
})
|
|
})
|
|
|
|
When("the album has no per-disc image but has an album cover", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── 01 - Track.mp3
|
|
// └── cover.jpg ← album-level fallback (no disc art present)
|
|
It("falls back to the album cover", func() {
|
|
conf.Server.DiscArtPriority = "disc*.*, cd*.*"
|
|
conf.Server.CoverArtPriority = defaultCoverPriority
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/01 - Track.mp3": trackFile(1, "Track"),
|
|
"Artist/Album/cover.jpg": imageFile("album-cover"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes("album-cover")))
|
|
})
|
|
})
|
|
|
|
When("multiple disc images exist in the same folder (disc1 vs disc10)", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── 01 - Track.mp3
|
|
// ├── disc1.jpg ← matches request for disc 1
|
|
// └── disc10.jpg
|
|
It("matches the requested disc number, not a higher-numbered one", func() {
|
|
conf.Server.DiscArtPriority = "disc*.*"
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/01 - Track.mp3": trackFile(1, "Track"),
|
|
"Artist/Album/disc1.jpg": imageFile("disc-one"),
|
|
"Artist/Album/disc10.jpg": imageFile("disc-ten"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes("disc-one")))
|
|
})
|
|
})
|
|
|
|
When("a multi-disc album has per-disc covers", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── CD1/
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── disc1.jpg ← matches request for disc 1
|
|
// └── CD2/
|
|
// ├── 01 - Track.mp3
|
|
// └── disc2.jpg ← matches request for disc 2
|
|
It("returns the requested disc's image", func() {
|
|
conf.Server.DiscArtPriority = "disc*.*"
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}),
|
|
"Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}),
|
|
"Artist/Album/CD1/disc1.jpg": imageFile("disc-1"),
|
|
"Artist/Album/CD2/disc2.jpg": imageFile("disc-2"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 2), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes("disc-2")))
|
|
})
|
|
})
|
|
|
|
// Doc scenarios from:
|
|
// https://www.navidrome.org/docs/usage/library/artwork/#disc-cover-art
|
|
// Default DiscArtPriority is "disc*.*, cd*.*, cover.*, folder.*, front.*, discsubtitle, embedded".
|
|
When("a disc subfolder has a cd2.png image", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── CD1/
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── disc1.jpg
|
|
// └── CD2/
|
|
// ├── 01 - Track.mp3
|
|
// └── cd2.png ← matched by cd*.* for disc 2
|
|
It("matches via the cd*.* pattern", func() {
|
|
conf.Server.DiscArtPriority = defaultDiscPriority
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}),
|
|
"Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}),
|
|
"Artist/Album/CD1/disc1.jpg": imageFile("disc-1"),
|
|
"Artist/Album/CD2/cd2.png": imageFile("cd-2"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 2), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes("cd-2")))
|
|
})
|
|
})
|
|
|
|
When("a disc subfolder has cover.jpg but no disc*.*/cd*.* image", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── CD1/
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── cover.jpg ← matched by cover.* inside disc folder
|
|
// └── CD2/
|
|
// ├── 01 - Track.mp3
|
|
// └── cover.jpg
|
|
It("falls through to cover.* inside the disc folder", func() {
|
|
conf.Server.DiscArtPriority = defaultDiscPriority
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}),
|
|
"Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}),
|
|
"Artist/Album/CD1/cover.jpg": imageFile("disc1-cover"),
|
|
"Artist/Album/CD2/cover.jpg": imageFile("disc2-cover"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes("disc1-cover")))
|
|
})
|
|
})
|
|
|
|
When("DiscArtPriority is the empty string", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── CD1/
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── disc1.jpg (ignored — DiscArtPriority is empty)
|
|
// ├── CD2/
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── cd2.png (ignored — DiscArtPriority is empty)
|
|
// └── cover.jpg ← used for every disc (album-level fallback)
|
|
It("skips every disc-level source and returns the album cover", func() {
|
|
conf.Server.DiscArtPriority = ""
|
|
conf.Server.CoverArtPriority = defaultCoverPriority
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}),
|
|
"Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}),
|
|
"Artist/Album/CD1/disc1.jpg": imageFile("disc-1"),
|
|
"Artist/Album/CD2/cd2.png": imageFile("cd-2"),
|
|
"Artist/Album/cover.jpg": imageFile("album-cover"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
for _, n := range []int{1, 2} {
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, n), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes("album-cover")),
|
|
"disc %d should use the album cover when DiscArtPriority is empty", n)
|
|
}
|
|
})
|
|
})
|
|
|
|
When("the documented multi-disc layout is used (disc1.jpg + cd2.png + album-root cover.jpg)", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── disc1/
|
|
// │ ├── disc1.jpg ← matched by disc*.* for disc 1
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── 02 - Track.mp3
|
|
// ├── disc2/
|
|
// │ ├── cd2.png ← matched by cd*.* for disc 2
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── 02 - Track.mp3
|
|
// └── cover.jpg (album-level fallback, unused here)
|
|
It("matches the per-disc image for each disc", func() {
|
|
conf.Server.DiscArtPriority = defaultDiscPriority
|
|
conf.Server.CoverArtPriority = defaultCoverPriority
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/disc1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}),
|
|
"Artist/Album/disc1/02 - Track.mp3": trackFile(2, "T2", map[string]any{"disc": "1"}),
|
|
"Artist/Album/disc2/01 - Track.mp3": trackFile(1, "T3", map[string]any{"disc": "2"}),
|
|
"Artist/Album/disc2/02 - Track.mp3": trackFile(2, "T4", map[string]any{"disc": "2"}),
|
|
"Artist/Album/disc1/disc1.jpg": imageFile("disc-1"),
|
|
"Artist/Album/disc2/cd2.png": imageFile("cd-2"),
|
|
"Artist/Album/cover.jpg": imageFile("album-root"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
disc1ID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt)
|
|
disc2ID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 2), &al.UpdatedAt)
|
|
Expect(readArtwork(disc1ID)).To(Equal(imageBytes("disc-1")))
|
|
Expect(readArtwork(disc2ID)).To(Equal(imageBytes("cd-2")))
|
|
})
|
|
})
|
|
|
|
When("discsubtitle keyword matches an image whose stem equals the disc's subtitle", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── 01 - Track.mp3 (discsubtitle="Bonus Tracks")
|
|
// └── Bonus Tracks.jpg ← matched by "discsubtitle" keyword
|
|
It("selects the subtitle-named image", func() {
|
|
conf.Server.DiscArtPriority = "discsubtitle"
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1", "discsubtitle": "Bonus Tracks"}),
|
|
"Artist/Album/Bonus Tracks.jpg": imageFile("bonus-tracks"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes("bonus-tracks")))
|
|
})
|
|
})
|
|
|
|
// Reproduces https://github.com/navidrome/navidrome/issues/5456
|
|
// Deeply nested layout matching the reporter's actual structure.
|
|
When("a deeply nested multi-disc album has cover.jpg and per-disc folder.jpg", func() {
|
|
// Genre/Artist/Album/ ← album root with cover.jpg
|
|
// ├── cover.jpg ← album-level cover
|
|
// ├── Disc 01 (Subtitle)/
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── folder.jpg ← disc 1 art
|
|
// ├── Disc 02 (Subtitle)/
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── folder.jpg
|
|
// └── ... (12 discs)
|
|
It("uses album-root cover.jpg for album art and per-disc folder.jpg for each disc", func() {
|
|
conf.Server.DiscArtPriority = defaultDiscPriority
|
|
conf.Server.CoverArtPriority = defaultCoverPriority
|
|
discNames := []string{
|
|
"Disc 01 (Birth of the Dead - The Studio Sides)",
|
|
"Disc 02 (Birth of the Dead - The Live Sides)",
|
|
"Disc 03 (The Grateful Dead)",
|
|
"Disc 04 (Anthem of the Sun)",
|
|
"Disc 05 (Aoxomoxoa)",
|
|
"Disc 06 (Live; Dead)",
|
|
"Disc 07 (Workingman's Dead)",
|
|
"Disc 08 (American Beauty)",
|
|
"Disc 09 (Grateful Dead)",
|
|
"Disc 10 (Europe '72)",
|
|
"Disc 11 (Europe '72)",
|
|
"Disc 12 (History of the Grateful Dead, Volume One (Bear's Choice))",
|
|
}
|
|
layout := fstest.MapFS{
|
|
"Pop; Rock/Grateful Dead/(2001) The Golden Road/cover.jpg": imageFile("album-root-cover"),
|
|
}
|
|
for i, name := range discNames {
|
|
discNum := i + 1
|
|
prefix := fmt.Sprintf("Pop; Rock/Grateful Dead/(2001) The Golden Road/%s/", name)
|
|
layout[prefix+"01 - Track.mp3"] = trackFile(1, fmt.Sprintf("T%d", discNum), map[string]any{"disc": fmt.Sprintf("%d", discNum)})
|
|
layout[prefix+"folder.jpg"] = imageFile(fmt.Sprintf("disc-%02d-folder", discNum))
|
|
}
|
|
setLayout(layout)
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
|
|
Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("album-root-cover")))
|
|
|
|
for i := range discNames {
|
|
discNum := i + 1
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, discNum), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes(fmt.Sprintf("disc-%02d-folder", discNum))),
|
|
"disc %d should use its own folder.jpg", discNum)
|
|
}
|
|
})
|
|
})
|
|
|
|
// https://github.com/navidrome/navidrome/issues/5456
|
|
// Top-level album variant — album folder at library root (Path=".").
|
|
When("a top-level multi-disc album has cover.jpg and per-disc folder.jpg", func() {
|
|
// Album/ (top-level, Path=".")
|
|
// ├── cover.jpg ← album-level cover
|
|
// ├── Disc 01/
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── folder.jpg ← disc 1 art
|
|
// ├── Disc 02/
|
|
// │ ├── 01 - Track.mp3
|
|
// │ └── folder.jpg
|
|
// └── Disc 03/
|
|
// ├── 01 - Track.mp3
|
|
// └── folder.jpg
|
|
It("uses album-root cover.jpg for album art and per-disc folder.jpg for each disc", func() {
|
|
conf.Server.DiscArtPriority = defaultDiscPriority
|
|
conf.Server.CoverArtPriority = defaultCoverPriority
|
|
layout := fstest.MapFS{
|
|
"Album/cover.jpg": imageFile("album-root-cover"),
|
|
}
|
|
for i := 1; i <= 3; i++ {
|
|
prefix := fmt.Sprintf("Album/Disc %02d/", i)
|
|
layout[prefix+"01 - Track.mp3"] = trackFile(1, fmt.Sprintf("T%d", i), map[string]any{"disc": fmt.Sprintf("%d", i)})
|
|
layout[prefix+"folder.jpg"] = imageFile(fmt.Sprintf("disc-%02d-folder", i))
|
|
}
|
|
setLayout(layout)
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
|
|
Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("album-root-cover")))
|
|
|
|
for i := 1; i <= 3; i++ {
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, i), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes(fmt.Sprintf("disc-%02d-folder", i))),
|
|
"disc %d should use its own folder.jpg", i)
|
|
}
|
|
})
|
|
})
|
|
|
|
When("discsubtitle is set but no image filename matches the subtitle", func() {
|
|
// Artist/
|
|
// └── Album/
|
|
// ├── 01 - Track.mp3 (discsubtitle="Bonus Tracks")
|
|
// └── cover.jpg ← wins (discsubtitle has no match, falls through)
|
|
It("falls through to the next priority entry", func() {
|
|
conf.Server.DiscArtPriority = "discsubtitle, cover.*"
|
|
setLayout(fstest.MapFS{
|
|
"Artist/Album/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1", "discsubtitle": "Bonus Tracks"}),
|
|
"Artist/Album/cover.jpg": imageFile("cover"),
|
|
})
|
|
scan()
|
|
|
|
al := firstAlbum()
|
|
discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt)
|
|
Expect(readArtwork(discID)).To(Equal(imageBytes("cover")))
|
|
})
|
|
})
|
|
})
|