Add tests to /scrobble endpoint

server/subsonic/media_annotation_test.go

@@ -0,0 +1,146 @@
+package subsonic
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"net/http/httptest"
+	"time"
+
+	"github.com/navidrome/navidrome/model/request"
+
+	"github.com/navidrome/navidrome/core/scrobbler"
+	"github.com/navidrome/navidrome/model"
+	"github.com/navidrome/navidrome/server/events"
+	"github.com/navidrome/navidrome/tests"
+	"github.com/navidrome/navidrome/utils"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("MediaAnnotationController", func() {
+	var controller *MediaAnnotationController
+	var w *httptest.ResponseRecorder
+	var ds model.DataStore
+	var playTracker *fakePlayTracker
+	var eventBroker *fakeEventBroker
+	var ctx context.Context
+
+	BeforeEach(func() {
+		ctx = context.Background()
+		ds = &tests.MockDataStore{}
+		playTracker = &fakePlayTracker{}
+		eventBroker = &fakeEventBroker{}
+		controller = NewMediaAnnotationController(ds, playTracker, eventBroker)
+		w = httptest.NewRecorder()
+	})
+
+	Describe("Scrobble", func() {
+		It("submit all scrobbles with only the id", func() {
+			submissionTime := time.Now()
+			r := newGetRequest("id=12", "id=34")
+
+			_, err := controller.Scrobble(w, r)
+
+			Expect(err).ToNot(HaveOccurred())
+			Expect(playTracker.Submissions).To(HaveLen(2))
+			Expect(playTracker.Submissions[0].Timestamp).To(BeTemporally(">", submissionTime))
+			Expect(playTracker.Submissions[0].TrackID).To(Equal("12"))
+			Expect(playTracker.Submissions[1].Timestamp).To(BeTemporally(">", submissionTime))
+			Expect(playTracker.Submissions[1].TrackID).To(Equal("34"))
+		})
+
+		It("submit all scrobbles with respective times", func() {
+			time1 := time.Now().Add(-20 * time.Minute)
+			t1 := utils.ToMillis(time1)
+			time2 := time.Now().Add(-10 * time.Minute)
+			t2 := utils.ToMillis(time2)
+			r := newGetRequest("id=12", "id=34", fmt.Sprintf("time=%d", t1), fmt.Sprintf("time=%d", t2))
+
+			_, err := controller.Scrobble(w, r)
+
+			Expect(err).ToNot(HaveOccurred())
+			Expect(playTracker.Submissions).To(HaveLen(2))
+			Expect(playTracker.Submissions[0].Timestamp).To(BeTemporally("~", time1))
+			Expect(playTracker.Submissions[0].TrackID).To(Equal("12"))
+			Expect(playTracker.Submissions[1].Timestamp).To(BeTemporally("~", time2))
+			Expect(playTracker.Submissions[1].TrackID).To(Equal("34"))
+		})
+
+		It("checks if number of ids match number of times", func() {
+			r := newGetRequest("id=12", "id=34", "time=1111")
+
+			_, err := controller.Scrobble(w, r)
+
+			Expect(err).To(HaveOccurred())
+			Expect(playTracker.Submissions).To(BeEmpty())
+		})
+
+		Context("submission=false", func() {
+			var req *http.Request
+			BeforeEach(func() {
+				_ = ds.MediaFile(ctx).Put(&model.MediaFile{ID: "12"})
+				ctx = request.WithPlayer(ctx, model.Player{ID: "player-1"})
+				req = newGetRequest("id=12", "submission=false")
+				req = req.WithContext(ctx)
+			})
+
+			It("does not scrobble", func() {
+				_, err := controller.Scrobble(w, req)
+
+				Expect(err).ToNot(HaveOccurred())
+				Expect(playTracker.Submissions).To(BeEmpty())
+			})
+
+			It("registers a NowPlaying", func() {
+				_, err := controller.Scrobble(w, req)
+
+				Expect(err).ToNot(HaveOccurred())
+				Expect(playTracker.Playing).To(HaveLen(1))
+				Expect(playTracker.Playing).To(HaveKey("player-1"))
+			})
+		})
+	})
+})
+
+type fakePlayTracker struct {
+	Submissions []scrobbler.Submission
+	Playing     map[string]string
+	Error       error
+}
+
+func (f *fakePlayTracker) NowPlaying(ctx context.Context, playerId string, playerName string, trackId string) error {
+	if f.Error != nil {
+		return f.Error
+	}
+	if f.Playing == nil {
+		f.Playing = make(map[string]string)
+	}
+	f.Playing[playerId] = trackId
+	return nil
+}
+
+func (f *fakePlayTracker) GetNowPlaying(ctx context.Context) ([]scrobbler.NowPlayingInfo, error) {
+	return nil, f.Error
+}
+
+func (f *fakePlayTracker) Submit(ctx context.Context, submissions []scrobbler.Submission) error {
+	if f.Error != nil {
+		return f.Error
+	}
+	f.Submissions = append(f.Submissions, submissions...)
+	return nil
+}
+
+var _ scrobbler.PlayTracker = (*fakePlayTracker)(nil)
+
+type fakeEventBroker struct {
+	http.Handler
+	Events []events.Event
+}
+
+func (f *fakeEventBroker) SendMessage(ctx context.Context, event events.Event) {
+	f.Events = append(f.Events, event)
+}
+
+var _ events.Broker = (*fakeEventBroker)(nil)