remote/navidrome
1
0
Fork 0
mirror of https://github.com/navidrome/navidrome.git synced 2026-10-12 12:27:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

test(lyrics): parameterize v2 enhanced coverage across all formats

Browse source 
Convert the v2 (enhanced) e2e block from three ad-hoc cases into a DescribeTable
covering all six formats, matching the v1 and legacy tables. Each entry declares
whether the source carries word-level timing: ELRC, TTML, and Lyricsfile YAML
surface a cueLine; LRC, SRT, and plain text do not. All six get kind="main".

Add word-level <span> timing to the first line of the auld-lang-syne.ttml
fixture so TTML exercises the word-level cueLine path (the parser already
supports <span begin/end>, but the fixture was line-level only). The first line
now yields the same five word cues as the ELRC and YAML fixtures, keeping the
table assertions uniform across formats.
This commit is contained in:
Deluan 2026-06-19 17:40:39 -04:00
commit 225ceaad94
2 changed files with 28 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

62
server/e2e/subsonic_lyrics_test.go
View file

@ -62,43 +62,35 @@ var _ = Describe("Lyrics endpoints", func() {
})
// songLyrics extension v2: getLyricsBySongId?enhanced=true opts in to
// word/syllable-level timing (cueLine) and the kind classification. Formats
// that carry word-level timing (ELRC, Lyricsfile YAML) surface cueLine; all
// formats gain kind="main" for a single untyped lyric layer.
// word/syllable-level timing (cueLine) and the kind classification. Every
// format gains kind="main" for a single untyped lyric layer; only formats
// that carry word-level timing (ELRC, TTML word spans, Lyricsfile YAML)
// surface a cueLine. Line-level formats (LRC, SRT, plain) still yield none.
Describe("getLyricsBySongId v2 (enhanced)", func() {
It("exposes word-level cueLine for an enhanced-LRC source", func() {
resp := doReq("getLyricsBySongId", "id", songID("Embedded Enhanced LRC"), "enhanced", "true")
Expect(resp.Status).To(Equal("ok"))
got := firstLyric(resp.LyricsList)
DescribeTable("returns enhanced lyrics, with cueLine only for word-level sources",
func(title string, wantCueLine bool) {
resp := doReq("getLyricsBySongId", "id", songID(title), "enhanced", "true")
Expect(resp.Status).To(Equal("ok"))
got := firstLyric(resp.LyricsList)
Expect(got.Kind).To(Equal("main"))
Expect(got.CueLine).ToNot(BeEmpty())
// The first line "Should auld acquaintance be forgot," has one cue per word.
Expect(got.CueLine[0].Cue).To(HaveLen(5))
Expect(got.CueLine[0].Cue[0].Value).To(Equal("Should "))
})
It("exposes word-level cueLine for a Lyricsfile YAML sidecar", func() {
resp := doReq("getLyricsBySongId", "id", songID("Sidecar YAML"), "enhanced", "true")
Expect(resp.Status).To(Equal("ok"))
got := firstLyric(resp.LyricsList)
Expect(got.Kind).To(Equal("main"))
Expect(got.CueLine).ToNot(BeEmpty())
Expect(got.CueLine[0].Cue).ToNot(BeEmpty())
Expect(got.CueLine[0].Cue[0].Value).To(Equal("Should "))
})
It("emits kind but no cueLine for a line-level (SRT) source", func() {
resp := doReq("getLyricsBySongId", "id", songID("Sidecar SRT"), "enhanced", "true")
Expect(resp.Status).To(Equal("ok"))
got := firstLyric(resp.LyricsList)
// SRT has no word-level timing, so even enhanced yields no cueLine.
Expect(got.Kind).To(Equal("main"))
Expect(got.CueLine).To(BeEmpty())
Expect(got.Line).ToNot(BeEmpty())
})
Expect(got.Kind).To(Equal("main"))
if wantCueLine {
Expect(got.CueLine).ToNot(BeEmpty())
// The first line has one cue per word: "Should auld acquaintance be forgot,".
Expect(got.CueLine[0].Cue).To(HaveLen(5))
Expect(got.CueLine[0].Cue[0].Value).To(Equal("Should "))
} else {
Expect(got.CueLine).To(BeEmpty())
Expect(got.Line).ToNot(BeEmpty())
}
},
Entry("embedded enhanced LRC (word-level)", "Embedded Enhanced LRC", true),
Entry("embedded TTML (word-level spans)", "Embedded TTML", true),
Entry("YAML sidecar (word-level)", "Sidecar YAML", true),
Entry("embedded plain text (no timing)", "Embedded Plain", false),
Entry("LRC sidecar (line-level)", "Sidecar LRC", false),
Entry("SRT sidecar (line-level)", "Sidecar SRT", false),
)
})
// getLyrics is the original Subsonic (pre-OpenSubsonic) endpoint. It looks up

2
tests/fixtures/lyrics/auld-lang-syne.ttml vendored
View file

@ -2,7 +2,7 @@
<tt xmlns="http://www.w3.org/ns/ttml" xml:lang="eng">
<body>
<div>
<p begin="00:00:00.000" end="00:00:04.500">Should auld acquaintance be forgot,</p>
<p begin="00:00:00.000" end="00:00:04.500"><span begin="00:00:00.000" end="00:00:00.900">Should </span><span begin="00:00:00.900" end="00:00:01.800">auld </span><span begin="00:00:01.800" end="00:00:02.700">acquaintance </span><span begin="00:00:02.700" end="00:00:03.600">be </span><span begin="00:00:03.600" end="00:00:04.500">forgot,</span></p>
<p begin="00:00:04.500" end="00:00:09.000">And never brought to mind?</p>
<p begin="00:00:09.000" end="00:00:13.500">Should auld acquaintance be forgot,</p>
<p begin="00:00:13.500" end="00:00:18.000">And auld lang syne?</p>