Adds Lyrics Support to Subsonic API (#1379)

* Add function 'isSynced' that identifies if lyrics are synced or not and add tests for the same * implement 'getLyrics' which returns lyrics if they exist Signed-off-by: Dheeraj Lalwani <lalwanidheeraj1234@gmail.com> * remove timestamps frorom the the lyrics if they are synced, fix filters & clean up code Signed-off-by: Dheeraj Lalwani <lalwanidheeraj1234@gmail.com> * add snapshot tests for the 'Lyrics' response & add some clean up Signed-off-by: Dheeraj Lalwani <lalwanidheeraj1234@gmail.com> * add tests for 'GetLyrics' function Signed-off-by: Dheeraj Lalwani <lalwanidheeraj1234@gmail.com> * update the snapshot test & the test for 'GetLyrics' function Signed-off-by: Dheeraj Lalwani <lalwanidheeraj1234@gmail.com>
2021-10-20 02:03:06 +05:30
parent 3214783ce9
commit 5621551dd0
10 changed files with 169 additions and 2 deletions
@@ -7,6 +7,7 @@ import (
 	"io"
 	"net/http/httptest"

+	"github.com/navidrome/navidrome/log"
 	"github.com/navidrome/navidrome/model"
 	"github.com/navidrome/navidrome/tests"
 	. "github.com/onsi/ginkgo"
@@ -15,12 +16,17 @@ import (

 var _ = Describe("MediaRetrievalController", func() {
 	var controller *MediaRetrievalController
+	var ds model.DataStore
+	mockRepo := &mockedMediaFile{}
 	var artwork *fakeArtwork
 	var w *httptest.ResponseRecorder

 	BeforeEach(func() {
+		ds = &tests.MockDataStore{
+			MockedMediaFile: mockRepo,
+		}
 		artwork = &fakeArtwork{}
-		controller = NewMediaRetrievalController(artwork, &tests.MockDataStore{})
+		controller = NewMediaRetrievalController(artwork, ds)
 		w = httptest.NewRecorder()
 	})

@@ -60,6 +66,41 @@ var _ = Describe("MediaRetrievalController", func() {
 			Expect(err).To(MatchError("weird error"))
 		})
 	})
+
+	Describe("GetLyrics", func() {
+		It("should return data for given artist & title", func() {
+			r := newGetRequest("artist=Rick+Astley", "title=Never+Gonna+Give+You+Up")
+			mockRepo.SetData(model.MediaFiles{
+				{
+					ID:     "1",
+					Artist: "Rick Astley",
+					Title:  "Never Gonna Give You Up",
+					Lyrics: "[00:18.80]We're no strangers to love\n[00:22.80]You know the rules and so do I",
+				},
+			})
+			response, err := controller.GetLyrics(w, r)
+			if err != nil {
+				log.Error("You're missing something.", err)
+			}
+			Expect(err).To(BeNil())
+			Expect(response.Lyrics.Artist).To(Equal("Rick Astley"))
+			Expect(response.Lyrics.Title).To(Equal("Never Gonna Give You Up"))
+			Expect(response.Lyrics.Value).To(Equal("We're no strangers to love\nYou know the rules and so do I"))
+		})
+		It("should return empty subsonic response if the record corresponding to the given artist & title is not found", func() {
+			r := newGetRequest("artist=Dheeraj", "title=Rinkiya+Ke+Papa")
+			mockRepo.SetData(model.MediaFiles{})
+			response, err := controller.GetLyrics(w, r)
+			if err != nil {
+				log.Error("You're missing something.", err)
+			}
+			Expect(err).To(BeNil())
+			Expect(response.Lyrics.Artist).To(Equal(""))
+			Expect(response.Lyrics.Title).To(Equal(""))
+			Expect(response.Lyrics.Value).To(Equal(""))
+
+		})
+	})
 })

 type fakeArtwork struct {
@@ -77,3 +118,36 @@ func (c *fakeArtwork) Get(ctx context.Context, id string, size int) (io.ReadClos
 	c.recvSize = size
 	return io.NopCloser(bytes.NewReader([]byte(c.data))), nil
 }
+
+var _ = Describe("isSynced", func() {
+	It("returns false if lyrics contain no timestamps", func() {
+		Expect(isSynced("Just in case my car goes off the highway")).To(Equal(false))
+		Expect(isSynced("[02.50] Just in case my car goes off the highway")).To(Equal(false))
+	})
+	It("returns false if lyrics is an empty string", func() {
+		Expect(isSynced("")).To(Equal(false))
+	})
+	It("returns true if lyrics contain timestamps", func() {
+		Expect(isSynced(`NF Real Music
+		[00:00] ksdjjs
+		[00:00.85] JUST LIKE YOU
+		[00:00.85] Just in case my car goes off the highway`)).To(Equal(true))
+		Expect(isSynced("[04:02:50.85] Never gonna give you up")).To(Equal(true))
+		Expect(isSynced("[02:50.85] Never gonna give you up")).To(Equal(true))
+		Expect(isSynced("[02:50] Never gonna give you up")).To(Equal(true))
+	})
+
+})
+
+type mockedMediaFile struct {
+	model.MediaFileRepository
+	data model.MediaFiles
+}
+
+func (m *mockedMediaFile) SetData(mfs model.MediaFiles) {
+	m.data = mfs
+}
+
+func (m *mockedMediaFile) GetAll(options ...model.QueryOptions) (model.MediaFiles, error) {
+	return m.data, nil
+}