")) Expect(bio).ToNot(ContainSubstring("
")) }) - It("uses the configured language", func() { - client = newClient(httpClient, "fr") - // Mock JWT token for the new client instance with a valid JWT - testJWT := createTestJWT(5 * time.Minute) - httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s","refresh_token":""}`, testJWT))), - }) - f, err := os.Open("tests/fixtures/deezer.artist.bio.json") + It("uses the provided language", func() { + f, err := os.Open("tests/fixtures/deezer.artist.bio.fr.json") Expect(err).To(BeNil()) httpClient.mock("https://pipe.deezer.com/api", http.Response{Body: f, StatusCode: 200}) - _, err = client.getArtistBio(GinkgoT().Context(), 27) + _, err = client.getArtistBio(GinkgoT().Context(), 27, "fr") Expect(err).To(BeNil()) Expect(httpClient.lastRequest.Header.Get("Accept-Language")).To(Equal("fr")) }) It("includes the JWT token in the request", func() { - f, err := os.Open("tests/fixtures/deezer.artist.bio.json") + f, err := os.Open("tests/fixtures/deezer.artist.bio.en.json") Expect(err).To(BeNil()) httpClient.mock("https://pipe.deezer.com/api", http.Response{Body: f, StatusCode: 200}) - _, err = client.getArtistBio(GinkgoT().Context(), 27) + _, err = client.getArtistBio(GinkgoT().Context(), 27, "en") Expect(err).To(BeNil()) // Verify that the Authorization header has the Bearer token format authHeader := httpClient.lastRequest.Header.Get("Authorization") @@ -120,7 +135,7 @@ var _ = Describe("client", func() { Body: io.NopCloser(bytes.NewBufferString(errorResponse)), }) - _, err := client.getArtistBio(GinkgoT().Context(), 999) + _, err := client.getArtistBio(GinkgoT().Context(), 999, "en") Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("GraphQL error")) Expect(err.Error()).To(ContainSubstring("Artist not found")) @@ -142,7 +157,7 @@ var _ = Describe("client", func() { Body: io.NopCloser(bytes.NewBufferString(emptyBioResponse)), }) - _, err := client.getArtistBio(GinkgoT().Context(), 27) + _, err := client.getArtistBio(GinkgoT().Context(), 27, "en") Expect(err).To(MatchError("deezer: biography not found")) }) @@ -152,7 +167,7 @@ var _ = Describe("client", func() { Body: io.NopCloser(bytes.NewBufferString(`{"error":"Internal server error"}`)), }) - _, err := client.getArtistBio(GinkgoT().Context(), 27) + _, err := client.getArtistBio(GinkgoT().Context(), 27, "en") Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("failed to get JWT")) }) @@ -165,7 +180,7 @@ var _ = Describe("client", func() { Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s","refresh_token":""}`, expiredJWT))), }) - _, err := client.getArtistBio(GinkgoT().Context(), 27) + _, err := client.getArtistBio(GinkgoT().Context(), 27, "en") Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("JWT token already expired or expires too soon")) }) diff --git a/adapters/deezer/deezer.go b/adapters/deezer/deezer.go index 7ec48b38d..ed3071766 100644 --- a/adapters/deezer/deezer.go +++ b/adapters/deezer/deezer.go @@ -26,15 +26,19 @@ const deezerArtistSearchLimit = 50 type deezerAgent struct { dataStore model.DataStore client *client + languages []string } func deezerConstructor(dataStore model.DataStore) agents.Interface { - agent := &deezerAgent{dataStore: dataStore} + agent := &deezerAgent{ + dataStore: dataStore, + languages: conf.Server.Deezer.Languages, + } httpClient := &http.Client{ Timeout: consts.DefaultHttpClientTimeOut, } cachedHttpClient := cache.NewHTTPClient(httpClient, consts.DefaultHttpClientTimeOut) - agent.client = newClient(cachedHttpClient, conf.Server.Deezer.Language) + agent.client = newClient(cachedHttpClient) return agent } @@ -135,7 +139,9 @@ func (s *deezerAgent) GetArtistTopSongs(ctx context.Context, _, artistName, _ st res := slice.Map(tracks, func(r Track) agents.Song { return agents.Song{ - Name: r.Title, + Name: r.Title, + Album: r.Album.Title, + Duration: uint32(r.Duration * 1000), // Convert seconds to milliseconds } }) return res, nil @@ -147,7 +153,14 @@ func (s *deezerAgent) GetArtistBiography(ctx context.Context, _, name, _ string) return "", err } - return s.client.getArtistBio(ctx, artist.ID) + for _, lang := range s.languages { + bio, err := s.client.getArtistBio(ctx, artist.ID, lang) + if err == nil && bio != "" { + return bio, nil + } + log.Debug(ctx, "Deezer/artist.bio returned empty/error, trying next language", "artist", name, "lang", lang, err) + } + return "", agents.ErrNotFound } func init() { diff --git a/adapters/deezer/deezer_test.go b/adapters/deezer/deezer_test.go new file mode 100644 index 000000000..4dd251585 --- /dev/null +++ b/adapters/deezer/deezer_test.go @@ -0,0 +1,171 @@ +package deezer + +import ( + "bytes" + "context" + "fmt" + "io" + "net/http" + "os" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("deezerAgent", func() { + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + DeferCleanup(configtest.SetupConfig()) + conf.Server.Deezer.Enabled = true + }) + + Describe("deezerConstructor", func() { + It("uses configured languages", func() { + conf.Server.Deezer.Languages = []string{"pt", "en"} + agent := deezerConstructor(&tests.MockDataStore{}).(*deezerAgent) + Expect(agent.languages).To(Equal([]string{"pt", "en"})) + }) + }) + + Describe("GetArtistBiography - Language Fallback", func() { + var agent *deezerAgent + var httpClient *langAwareHttpClient + + BeforeEach(func() { + httpClient = newLangAwareHttpClient() + + // Mock search artist (returns Michael Jackson) + fSearch, _ := os.Open("tests/fixtures/deezer.search.artist.json") + httpClient.searchResponse = &http.Response{Body: fSearch, StatusCode: 200} + + // Mock JWT token + testJWT := createTestJWT(5 * time.Minute) + httpClient.jwtResponse = &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s","refresh_token":""}`, testJWT))), + } + }) + + setupAgent := func(languages []string) { + conf.Server.Deezer.Languages = languages + agent = &deezerAgent{ + dataStore: &tests.MockDataStore{}, + client: newClient(httpClient), + languages: languages, + } + } + + It("returns content in first language when available (1 bio API call)", func() { + setupAgent([]string{"fr", "en"}) + + // French biography available + fFr, _ := os.Open("tests/fixtures/deezer.artist.bio.fr.json") + httpClient.bioResponses["fr"] = &http.Response{Body: fFr, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "", "Michael Jackson", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("Guy-Manuel de Homem Christo et Thomas Bangalter")) + Expect(httpClient.bioRequestCount).To(Equal(1)) + Expect(httpClient.bioRequests[0].Header.Get("Accept-Language")).To(Equal("fr")) + }) + + It("falls back to second language when first returns empty (2 bio API calls)", func() { + setupAgent([]string{"ja", "en"}) + + // Japanese returns empty biography + fJa, _ := os.Open("tests/fixtures/deezer.artist.bio.empty.json") + httpClient.bioResponses["ja"] = &http.Response{Body: fJa, StatusCode: 200} + // English returns full biography + fEn, _ := os.Open("tests/fixtures/deezer.artist.bio.en.json") + httpClient.bioResponses["en"] = &http.Response{Body: fEn, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "", "Michael Jackson", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("Schoolmates Thomas and Guy-Manuel")) + Expect(httpClient.bioRequestCount).To(Equal(2)) + Expect(httpClient.bioRequests[0].Header.Get("Accept-Language")).To(Equal("ja")) + Expect(httpClient.bioRequests[1].Header.Get("Accept-Language")).To(Equal("en")) + }) + + It("returns ErrNotFound when all languages return empty", func() { + setupAgent([]string{"ja", "xx"}) + + // Both languages return empty biography + fJa, _ := os.Open("tests/fixtures/deezer.artist.bio.empty.json") + httpClient.bioResponses["ja"] = &http.Response{Body: fJa, StatusCode: 200} + fXx, _ := os.Open("tests/fixtures/deezer.artist.bio.empty.json") + httpClient.bioResponses["xx"] = &http.Response{Body: fXx, StatusCode: 200} + + _, err := agent.GetArtistBiography(ctx, "", "Michael Jackson", "") + + Expect(err).To(MatchError(agents.ErrNotFound)) + Expect(httpClient.bioRequestCount).To(Equal(2)) + }) + }) +}) + +// langAwareHttpClient is a mock HTTP client that returns different responses based on the Accept-Language header +type langAwareHttpClient struct { + searchResponse *http.Response + jwtResponse *http.Response + bioResponses map[string]*http.Response + bioRequests []*http.Request + bioRequestCount int +} + +func newLangAwareHttpClient() *langAwareHttpClient { + return &langAwareHttpClient{ + bioResponses: make(map[string]*http.Response), + bioRequests: make([]*http.Request, 0), + } +} + +func (c *langAwareHttpClient) Do(req *http.Request) (*http.Response, error) { + // Handle search artist request + if req.URL.Host == "api.deezer.com" && req.URL.Path == "/search/artist" { + if c.searchResponse != nil { + return c.searchResponse, nil + } + return &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"data":[],"total":0}`)), + }, nil + } + + // Handle JWT token request + if req.URL.Host == "auth.deezer.com" && req.URL.Path == "/login/anonymous" { + if c.jwtResponse != nil { + return c.jwtResponse, nil + } + return &http.Response{ + StatusCode: 500, + Body: io.NopCloser(bytes.NewBufferString(`{"error":"no mock"}`)), + }, nil + } + + // Handle bio request (GraphQL API) + if req.URL.Host == "pipe.deezer.com" && req.URL.Path == "/api" { + c.bioRequestCount++ + c.bioRequests = append(c.bioRequests, req) + lang := req.Header.Get("Accept-Language") + if resp, ok := c.bioResponses[lang]; ok { + return resp, nil + } + // Return empty bio by default + return &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"data":{"artist":{"bio":{"full":""}}}}`)), + }, nil + } + + panic("URL not mocked: " + req.URL.String()) +} diff --git a/adapters/lastfm/agent.go b/adapters/lastfm/agent.go index e3e53b234..6dc635b50 100644 --- a/adapters/lastfm/agent.go +++ b/adapters/lastfm/agent.go @@ -26,8 +26,8 @@ const ( sessionKeyProperty = "LastFMSessionKey" ) -var ignoredBiographies = []string{ - // Unknown Artist +var ignoredContent = []string{ + // Empty Artist/Album ` head > meta[property="og:image"]`) artistIgnoredImage = "2a96cbd8b46e442fc41c2b86b821562f" // Last.fm artist placeholder image name @@ -199,7 +241,7 @@ var ( func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string) ([]agents.ExternalImage, error) { log.Debug(ctx, "Getting artist images from Last.fm", "name", name) - a, err := l.callArtistGetInfo(ctx, name) + a, err := l.callArtistGetInfo(ctx, name, l.languages[0]) if err != nil { return nil, fmt.Errorf("get artist info: %w", err) } @@ -239,14 +281,14 @@ func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string) return res, nil } -func (l *lastfmAgent) callAlbumGetInfo(ctx context.Context, name, artist, mbid string) (*Album, error) { - a, err := l.client.albumGetInfo(ctx, name, artist, mbid) +func (l *lastfmAgent) callAlbumGetInfo(ctx context.Context, name, artist, mbid string, lang string) (*Album, error) { + a, err := l.client.albumGetInfo(ctx, name, artist, mbid, lang) var lfErr *lastFMError isLastFMError := errors.As(err, &lfErr) if mbid != "" && (isLastFMError && lfErr.Code == 6) { log.Debug(ctx, "LastFM/album.getInfo could not find album by mbid, trying again", "album", name, "mbid", mbid) - return l.callAlbumGetInfo(ctx, name, artist, "") + return l.callAlbumGetInfo(ctx, name, artist, "", lang) } if err != nil { @@ -260,11 +302,11 @@ func (l *lastfmAgent) callAlbumGetInfo(ctx context.Context, name, artist, mbid s return a, nil } -func (l *lastfmAgent) callArtistGetInfo(ctx context.Context, name string) (*Artist, error) { +func (l *lastfmAgent) callArtistGetInfo(ctx context.Context, name string, lang string) (*Artist, error) { l.getInfoMutex.Lock() defer l.getInfoMutex.Unlock() - a, err := l.client.artistGetInfo(ctx, name) + a, err := l.client.artistGetInfo(ctx, name, lang) if err != nil { log.Error(ctx, "Error calling LastFM/artist.getInfo", "artist", name, err) return nil, err @@ -290,6 +332,15 @@ func (l *lastfmAgent) callArtistGetTopTracks(ctx context.Context, artistName str return t.Track, nil } +func (l *lastfmAgent) callTrackGetSimilar(ctx context.Context, name, artist string, count int) ([]SimilarTrack, error) { + s, err := l.client.trackGetSimilar(ctx, name, artist, count) + if err != nil { + log.Error(ctx, "Error calling LastFM/track.getSimilar", "track", name, "artist", artist, err) + return nil, err + } + return s.Track, nil +} + func (l *lastfmAgent) getArtistForScrobble(track *model.MediaFile, role model.Role, displayName string) string { if conf.Server.LastFM.ScrobbleFirstArtistOnly && len(track.Participants[role]) > 0 { return track.Participants[role][0].Name diff --git a/adapters/lastfm/agent_test.go b/adapters/lastfm/agent_test.go index fc6238408..bdc0a0e33 100644 --- a/adapters/lastfm/agent_test.go +++ b/adapters/lastfm/agent_test.go @@ -6,6 +6,7 @@ import ( "errors" "io" "net/http" + "net/url" "os" "strconv" "time" @@ -38,12 +39,12 @@ var _ = Describe("lastfmAgent", func() { }) Describe("lastFMConstructor", func() { When("Agent is properly configured", func() { - It("uses configured api key and language", func() { - conf.Server.LastFM.Language = "pt" + It("uses configured api key and languages", func() { + conf.Server.LastFM.Languages = []string{"pt", "en"} agent := lastFMConstructor(ds) Expect(agent.apiKey).To(Equal("123")) Expect(agent.secret).To(Equal("secret")) - Expect(agent.lang).To(Equal("pt")) + Expect(agent.languages).To(Equal([]string{"pt", "en"})) }) }) When("Agent is disabled", func() { @@ -71,7 +72,7 @@ var _ = Describe("lastfmAgent", func() { var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -101,12 +102,129 @@ var _ = Describe("lastfmAgent", func() { }) }) + Describe("Language Fallback", func() { + Describe("GetArtistBiography", func() { + var agent *lastfmAgent + var httpClient *langAwareHttpClient + + BeforeEach(func() { + httpClient = newLangAwareHttpClient() + }) + + It("returns content in first language when available (1 API call)", func() { + conf.Server.LastFM.Languages = []string{"pt", "en"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Portuguese biography available + f, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + httpClient.responses["pt"] = http.Response{Body: f, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "123", "U2", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("U2 é uma das mais importantes bandas de rock")) + Expect(httpClient.requestCount).To(Equal(1)) + Expect(httpClient.requests[0].URL.Query().Get("lang")).To(Equal("pt")) + }) + + It("falls back to second language when first returns empty (2 API calls)", func() { + conf.Server.LastFM.Languages = []string{"ja", "en"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Japanese returns empty/ignored biography (actual Last.fm response with just "Read more" link) + fJa, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + // English returns full biography + fEn, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.en.json") + httpClient.responses["en"] = http.Response{Body: fEn, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "123", "Legião Urbana", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("Legião Urbana was a Brazilian post-punk band")) + Expect(httpClient.requestCount).To(Equal(2)) + Expect(httpClient.requests[0].URL.Query().Get("lang")).To(Equal("ja")) + Expect(httpClient.requests[1].URL.Query().Get("lang")).To(Equal("en")) + }) + + It("returns ErrNotFound when all languages return empty", func() { + conf.Server.LastFM.Languages = []string{"ja", "xx"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Both languages return empty/ignored biography (using actual Last.fm response format) + fJa, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + // Second language also returns empty + fXx, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.empty.json") + httpClient.responses["xx"] = http.Response{Body: fXx, StatusCode: 200} + + _, err := agent.GetArtistBiography(ctx, "123", "Legião Urbana", "") + + Expect(err).To(MatchError(agents.ErrNotFound)) + Expect(httpClient.requestCount).To(Equal(2)) + }) + }) + + Describe("GetAlbumInfo", func() { + var agent *lastfmAgent + var httpClient *langAwareHttpClient + + BeforeEach(func() { + httpClient = newLangAwareHttpClient() + }) + + It("falls back to second language when first returns empty description (2 API calls)", func() { + conf.Server.LastFM.Languages = []string{"ja", "en"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Japanese returns album without wiki/description (actual Last.fm response) + fJa, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + // English returns album with description + fEn, _ := os.Open("tests/fixtures/lastfm.album.getinfo.en.json") + httpClient.responses["en"] = http.Response{Body: fEn, StatusCode: 200} + + albumInfo, err := agent.GetAlbumInfo(ctx, "Dois", "Legião Urbana", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(albumInfo.Name).To(Equal("Dois")) + Expect(albumInfo.Description).To(ContainSubstring("segundo álbum de estúdio")) + Expect(httpClient.requestCount).To(Equal(2)) + Expect(httpClient.requests[0].URL.Query().Get("lang")).To(Equal("ja")) + Expect(httpClient.requests[1].URL.Query().Get("lang")).To(Equal("en")) + }) + + It("returns album without description when all languages return empty", func() { + conf.Server.LastFM.Languages = []string{"ja", "xx"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Both languages return album without description + fJa, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + fXx, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty.json") + httpClient.responses["xx"] = http.Response{Body: fXx, StatusCode: 200} + + albumInfo, err := agent.GetAlbumInfo(ctx, "Dois", "Legião Urbana", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(albumInfo.Name).To(Equal("Dois")) + Expect(albumInfo.Description).To(BeEmpty()) + Expect(httpClient.requestCount).To(Equal(2)) + }) + }) + }) + Describe("GetSimilarArtists", func() { var agent *lastfmAgent var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -144,7 +262,7 @@ var _ = Describe("lastfmAgent", func() { var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -177,6 +295,54 @@ var _ = Describe("lastfmAgent", func() { }) }) + Describe("GetSimilarSongsByTrack", func() { + var agent *lastfmAgent + var httpClient *tests.FakeHttpClient + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("API_KEY", "SECRET", httpClient) + agent = lastFMConstructor(ds) + agent.client = client + }) + + It("returns similar songs", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + Expect(agent.GetSimilarSongsByTrack(ctx, "123", "Just Can't Get Enough", "Depeche Mode", "", 5)).To(Equal([]agents.Song{ + {Name: "Dreaming of Me", MBID: "027b553e-7c74-3ed4-a95e-1d4fea51f174", Artist: "Depeche Mode", ArtistMBID: "8538e728-ca0b-4321-b7e5-cff6565dd4c0"}, + {Name: "Everything Counts", MBID: "5a5a3ca4-bdb8-4641-a674-9b54b9b319a6", Artist: "Depeche Mode", ArtistMBID: "8538e728-ca0b-4321-b7e5-cff6565dd4c0"}, + {Name: "Don't You Want Me", MBID: "", Artist: "The Human League", ArtistMBID: "7adaabfb-acfb-47bc-8c7c-59471c2f0db8"}, + {Name: "Tainted Love", MBID: "", Artist: "Soft Cell", ArtistMBID: "7fb50287-029d-47cc-825a-235ca28024b2"}, + {Name: "Blue Monday", MBID: "727e84c6-1b56-31dd-a958-a5f46305cec0", Artist: "New Order", ArtistMBID: "f1106b17-dcbb-45f6-b938-199ccfab50cc"}, + })) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("track")).To(Equal("Just Can't Get Enough")) + Expect(httpClient.SavedRequest.URL.Query().Get("artist")).To(Equal("Depeche Mode")) + }) + + It("returns ErrNotFound when no similar songs found", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.unknown.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + _, err := agent.GetSimilarSongsByTrack(ctx, "123", "UnknownTrack", "UnknownArtist", "", 3) + Expect(err).To(MatchError(agents.ErrNotFound)) + Expect(httpClient.RequestCount).To(Equal(1)) + }) + + It("returns an error if Last.fm call fails", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetSimilarSongsByTrack(ctx, "123", "Believe", "Cher", "", 3) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + }) + + It("returns an error if Last.fm call returns an error", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(lastfmError3)), StatusCode: 200} + _, err := agent.GetSimilarSongsByTrack(ctx, "123", "Believe", "Cher", "", 3) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + }) + }) + Describe("Scrobbling", func() { var agent *lastfmAgent var httpClient *tests.FakeHttpClient @@ -184,7 +350,7 @@ var _ = Describe("lastfmAgent", func() { BeforeEach(func() { _ = ds.UserProps(ctx).Put("user-1", sessionKeyProperty, "SK-1") httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "en", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client track = &model.MediaFile{ @@ -217,7 +383,8 @@ var _ = Describe("lastfmAgent", func() { Expect(err).ToNot(HaveOccurred()) Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - sentParams := httpClient.SavedRequest.URL.Query() + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) Expect(sentParams.Get("method")).To(Equal("track.updateNowPlaying")) Expect(sentParams.Get("sk")).To(Equal("SK-1")) Expect(sentParams.Get("track")).To(Equal(track.Title)) @@ -245,7 +412,8 @@ var _ = Describe("lastfmAgent", func() { err := agent.NowPlaying(ctx, "user-1", track, 0) Expect(err).ToNot(HaveOccurred()) - sentParams := httpClient.SavedRequest.URL.Query() + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) Expect(sentParams.Get("artist")).To(Equal("First Artist")) Expect(sentParams.Get("albumArtist")).To(Equal("First Album Artist")) }) @@ -261,7 +429,8 @@ var _ = Describe("lastfmAgent", func() { Expect(err).ToNot(HaveOccurred()) Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - sentParams := httpClient.SavedRequest.URL.Query() + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) Expect(sentParams.Get("method")).To(Equal("track.scrobble")) Expect(sentParams.Get("sk")).To(Equal("SK-1")) Expect(sentParams.Get("track")).To(Equal(track.Title)) @@ -286,7 +455,8 @@ var _ = Describe("lastfmAgent", func() { err := agent.Scrobble(ctx, "user-1", scrobbler.Scrobble{MediaFile: *track, TimeStamp: ts}) Expect(err).ToNot(HaveOccurred()) - sentParams := httpClient.SavedRequest.URL.Query() + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) Expect(sentParams.Get("artist")).To(Equal("First Artist")) Expect(sentParams.Get("albumArtist")).To(Equal("First Album Artist")) }) @@ -354,7 +524,7 @@ var _ = Describe("lastfmAgent", func() { var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -424,7 +594,7 @@ var _ = Describe("lastfmAgent", func() { BeforeEach(func() { apiClient = &tests.FakeHttpClient{} httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", apiClient) + client := newClient("API_KEY", "SECRET", apiClient) agent = lastFMConstructor(ds) agent.client = client agent.httpClient = httpClient @@ -485,3 +655,31 @@ var _ = Describe("lastfmAgent", func() { }) }) }) + +// langAwareHttpClient is a mock HTTP client that returns different responses based on the lang parameter +type langAwareHttpClient struct { + responses map[string]http.Response + requests []*http.Request + requestCount int +} + +func newLangAwareHttpClient() *langAwareHttpClient { + return &langAwareHttpClient{ + responses: make(map[string]http.Response), + requests: make([]*http.Request, 0), + } +} + +func (c *langAwareHttpClient) Do(req *http.Request) (*http.Response, error) { + c.requestCount++ + c.requests = append(c.requests, req) + lang := req.URL.Query().Get("lang") + if resp, ok := c.responses[lang]; ok { + return &resp, nil + } + // Return default empty response if no specific response is configured + return &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{}`)), + }, nil +} diff --git a/adapters/lastfm/auth_router.go b/adapters/lastfm/auth_router.go index 290caaad3..5a9b060e5 100644 --- a/adapters/lastfm/auth_router.go +++ b/adapters/lastfm/auth_router.go @@ -44,7 +44,7 @@ func NewRouter(ds model.DataStore) *Router { hc := &http.Client{ Timeout: consts.DefaultHttpClientTimeOut, } - r.client = newClient(r.apiKey, r.secret, "en", hc) + r.client = newClient(r.apiKey, r.secret, hc) return r } diff --git a/adapters/lastfm/client.go b/adapters/lastfm/client.go index 6a24ac80a..726df1360 100644 --- a/adapters/lastfm/client.go +++ b/adapters/lastfm/client.go @@ -34,24 +34,23 @@ type httpDoer interface { Do(req *http.Request) (*http.Response, error) } -func newClient(apiKey string, secret string, lang string, hc httpDoer) *client { - return &client{apiKey, secret, lang, hc} +func newClient(apiKey string, secret string, hc httpDoer) *client { + return &client{apiKey, secret, hc} } type client struct { apiKey string secret string - lang string hc httpDoer } -func (c *client) albumGetInfo(ctx context.Context, name string, artist string, mbid string) (*Album, error) { +func (c *client) albumGetInfo(ctx context.Context, name string, artist string, mbid string, lang string) (*Album, error) { params := url.Values{} params.Add("method", "album.getInfo") params.Add("album", name) params.Add("artist", artist) params.Add("mbid", mbid) - params.Add("lang", c.lang) + params.Add("lang", lang) response, err := c.makeRequest(ctx, http.MethodGet, params, false) if err != nil { return nil, err @@ -59,11 +58,11 @@ func (c *client) albumGetInfo(ctx context.Context, name string, artist string, m return &response.Album, nil } -func (c *client) artistGetInfo(ctx context.Context, name string) (*Artist, error) { +func (c *client) artistGetInfo(ctx context.Context, name string, lang string) (*Artist, error) { params := url.Values{} params.Add("method", "artist.getInfo") params.Add("artist", name) - params.Add("lang", c.lang) + params.Add("lang", lang) response, err := c.makeRequest(ctx, http.MethodGet, params, false) if err != nil { return nil, err @@ -95,6 +94,19 @@ func (c *client) artistGetTopTracks(ctx context.Context, name string, limit int) return &response.TopTracks, nil } +func (c *client) trackGetSimilar(ctx context.Context, name, artist string, limit int) (*SimilarTracks, error) { + params := url.Values{} + params.Add("method", "track.getSimilar") + params.Add("track", name) + params.Add("artist", artist) + params.Add("limit", strconv.Itoa(limit)) + response, err := c.makeRequest(ctx, http.MethodGet, params, false) + if err != nil { + return nil, err + } + return &response.SimilarTracks, nil +} + func (c *client) GetToken(ctx context.Context) (string, error) { params := url.Values{} params.Add("method", "auth.getToken") @@ -185,8 +197,15 @@ func (c *client) makeRequest(ctx context.Context, method string, params url.Valu c.sign(params) } - req, _ := http.NewRequestWithContext(ctx, method, apiBaseUrl, nil) - req.URL.RawQuery = params.Encode() + var req *http.Request + if method == http.MethodPost { + body := strings.NewReader(params.Encode()) + req, _ = http.NewRequestWithContext(ctx, method, apiBaseUrl, body) + req.Header.Set("Content-Type", "application/x-www-form-urlencoded") + } else { + req, _ = http.NewRequestWithContext(ctx, method, apiBaseUrl, nil) + req.URL.RawQuery = params.Encode() + } log.Trace(ctx, fmt.Sprintf("Sending Last.fm %s request", req.Method), "url", req.URL) resp, err := c.hc.Do(req) diff --git a/adapters/lastfm/client_test.go b/adapters/lastfm/client_test.go index 85ec11506..271ae1419 100644 --- a/adapters/lastfm/client_test.go +++ b/adapters/lastfm/client_test.go @@ -22,7 +22,7 @@ var _ = Describe("client", func() { BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client = newClient("API_KEY", "SECRET", "pt", httpClient) + client = newClient("API_KEY", "SECRET", httpClient) }) Describe("albumGetInfo", func() { @@ -30,7 +30,7 @@ var _ = Describe("client", func() { f, _ := os.Open("tests/fixtures/lastfm.album.getinfo.json") httpClient.Res = http.Response{Body: f, StatusCode: 200} - album, err := client.albumGetInfo(context.Background(), "Believe", "U2", "mbid-1234") + album, err := client.albumGetInfo(context.Background(), "Believe", "U2", "mbid-1234", "pt") Expect(err).To(BeNil()) Expect(album.Name).To(Equal("Believe")) Expect(httpClient.SavedRequest.URL.String()).To(Equal(apiBaseUrl + "?album=Believe&api_key=API_KEY&artist=U2&format=json&lang=pt&mbid=mbid-1234&method=album.getInfo")) @@ -42,7 +42,7 @@ var _ = Describe("client", func() { f, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") httpClient.Res = http.Response{Body: f, StatusCode: 200} - artist, err := client.artistGetInfo(context.Background(), "U2") + artist, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(BeNil()) Expect(artist.Name).To(Equal("U2")) Expect(httpClient.SavedRequest.URL.String()).To(Equal(apiBaseUrl + "?api_key=API_KEY&artist=U2&format=json&lang=pt&method=artist.getInfo")) @@ -54,7 +54,7 @@ var _ = Describe("client", func() { StatusCode: 500, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError("last.fm http status: (500)")) }) @@ -64,7 +64,7 @@ var _ = Describe("client", func() { StatusCode: 400, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError(&lastFMError{Code: 3, Message: "Invalid Method - No method with that name in this package"})) }) @@ -74,14 +74,14 @@ var _ = Describe("client", func() { StatusCode: 200, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError(&lastFMError{Code: 6, Message: "The artist you supplied could not be found"})) }) It("fails if HttpClient.Do() returns error", func() { httpClient.Err = errors.New("generic error") - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError("generic error")) }) @@ -91,7 +91,7 @@ var _ = Describe("client", func() { StatusCode: 200, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError("invalid character '<' looking for beginning of value")) }) @@ -121,6 +121,30 @@ var _ = Describe("client", func() { }) }) + Describe("trackGetSimilar", func() { + It("returns similar tracks for a successful response", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + similar, err := client.trackGetSimilar(context.Background(), "Just Can't Get Enough", "Depeche Mode", 5) + Expect(err).To(BeNil()) + Expect(len(similar.Track)).To(Equal(5)) + Expect(similar.Track[0].Name).To(Equal("Dreaming of Me")) + Expect(similar.Track[0].Artist.Name).To(Equal("Depeche Mode")) + Expect(similar.Track[0].Match).To(Equal(1.0)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(apiBaseUrl + "?api_key=API_KEY&artist=Depeche+Mode&format=json&limit=5&method=track.getSimilar&track=Just+Can%27t+Get+Enough")) + }) + + It("returns empty list when no similar tracks found", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.unknown.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + similar, err := client.trackGetSimilar(context.Background(), "UnknownTrack", "UnknownArtist", 3) + Expect(err).To(BeNil()) + Expect(similar.Track).To(BeEmpty()) + }) + }) + Describe("GetToken", func() { It("returns a token when the request is successful", func() { httpClient.Res = http.Response{ @@ -154,6 +178,74 @@ var _ = Describe("client", func() { }) }) + Describe("scrobble", func() { + It("sends parameters in request body for POST", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"scrobbles":{"scrobble":{"ignoredMessage":{"code":"0"}},"@attr":{"accepted":1}}}`)), + StatusCode: 200, + } + + info := ScrobbleInfo{ + artist: "U2", + track: "One", + album: "Achtung Baby", + trackNumber: 1, + duration: 276, + albumArtist: "U2", + } + err := client.scrobble(context.Background(), "SESSION_KEY", info) + Expect(err).To(BeNil()) + + req := httpClient.SavedRequest + Expect(req.Method).To(Equal(http.MethodPost)) + Expect(req.Header.Get("Content-Type")).To(Equal("application/x-www-form-urlencoded")) + Expect(req.URL.RawQuery).To(BeEmpty()) + + body, _ := io.ReadAll(req.Body) + bodyParams, _ := url.ParseQuery(string(body)) + Expect(bodyParams.Get("method")).To(Equal("track.scrobble")) + Expect(bodyParams.Get("artist")).To(Equal("U2")) + Expect(bodyParams.Get("track")).To(Equal("One")) + Expect(bodyParams.Get("sk")).To(Equal("SESSION_KEY")) + Expect(bodyParams.Get("api_key")).To(Equal("API_KEY")) + Expect(bodyParams.Get("api_sig")).ToNot(BeEmpty()) + }) + }) + + Describe("updateNowPlaying", func() { + It("sends parameters in request body for POST", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"nowplaying":{"ignoredMessage":{"code":"0"}}}`)), + StatusCode: 200, + } + + info := ScrobbleInfo{ + artist: "U2", + track: "One", + album: "Achtung Baby", + trackNumber: 1, + duration: 276, + albumArtist: "U2", + } + err := client.updateNowPlaying(context.Background(), "SESSION_KEY", info) + Expect(err).To(BeNil()) + + req := httpClient.SavedRequest + Expect(req.Method).To(Equal(http.MethodPost)) + Expect(req.Header.Get("Content-Type")).To(Equal("application/x-www-form-urlencoded")) + Expect(req.URL.RawQuery).To(BeEmpty()) + + body, _ := io.ReadAll(req.Body) + bodyParams, _ := url.ParseQuery(string(body)) + Expect(bodyParams.Get("method")).To(Equal("track.updateNowPlaying")) + Expect(bodyParams.Get("artist")).To(Equal("U2")) + Expect(bodyParams.Get("track")).To(Equal("One")) + Expect(bodyParams.Get("sk")).To(Equal("SESSION_KEY")) + Expect(bodyParams.Get("api_key")).To(Equal("API_KEY")) + Expect(bodyParams.Get("api_sig")).ToNot(BeEmpty()) + }) + }) + Describe("sign", func() { It("adds an api_sig param with the signature", func() { params := url.Values{} diff --git a/adapters/lastfm/responses.go b/adapters/lastfm/responses.go index 1ceebe767..026741672 100644 --- a/adapters/lastfm/responses.go +++ b/adapters/lastfm/responses.go @@ -5,6 +5,7 @@ type Response struct { SimilarArtists SimilarArtists `json:"similarartists"` TopTracks TopTracks `json:"toptracks"` Album Album `json:"album"` + SimilarTracks SimilarTracks `json:"similartracks"` Error int `json:"error"` Message string `json:"message"` Token string `json:"token"` @@ -59,6 +60,28 @@ type TopTracks struct { Attr Attr `json:"@attr"` } +type SimilarTracks struct { + Track []SimilarTrack `json:"track"` + Attr SimilarAttr `json:"@attr"` +} + +type SimilarTrack struct { + Name string `json:"name"` + MBID string `json:"mbid"` + Match float64 `json:"match"` + Artist SimilarTrackArtist `json:"artist"` +} + +type SimilarTrackArtist struct { + Name string `json:"name"` + MBID string `json:"mbid"` +} + +type SimilarAttr struct { + Artist string `json:"artist"` + Track string `json:"track"` +} + type Session struct { Name string `json:"name"` Key string `json:"key"` diff --git a/conf/configuration.go b/conf/configuration.go index 5d3660397..aa1056f75 100644 --- a/conf/configuration.go +++ b/conf/configuration.go @@ -1,6 +1,7 @@ package conf import ( + "cmp" "fmt" "net/url" "os" @@ -57,6 +58,7 @@ type configOptions struct { AutoTranscodeDownload bool DefaultDownsamplingFormat string SearchFullString bool + SimilarSongsMatchThreshold int RecentlyAddedByModTime bool PreferSortTags bool IgnoredArticles string @@ -173,6 +175,9 @@ type lastfmOptions struct { Secret string Language string ScrobbleFirstArtistOnly bool + + // Computed values + Languages []string // Computed from Language, split by comma } type spotifyOptions struct { @@ -183,6 +188,9 @@ type spotifyOptions struct { type deezerOptions struct { Enabled bool Language string + + // Computed values + Languages []string // Computed from Language, split by comma } type listenBrainzOptions struct { @@ -368,6 +376,16 @@ func Load(noConfigDump bool) { disableExternalServices() } + // Make sure we don't have empty PIDs + Server.PID.Album = cmp.Or(Server.PID.Album, consts.DefaultAlbumPID) + Server.PID.Track = cmp.Or(Server.PID.Track, consts.DefaultTrackPID) + + // Parse LastFM.Language into Languages slice (comma-separated, with fallback to DefaultInfoLanguage) + Server.LastFM.Languages = parseLanguages(Server.LastFM.Language) + + // Parse Deezer.Language into Languages slice (comma-separated, with fallback to DefaultInfoLanguage) + Server.Deezer.Languages = parseLanguages(Server.Deezer.Language) + logDeprecatedOptions("Scanner.GenreSeparators", "") logDeprecatedOptions("Scanner.GroupAlbumReleases", "") logDeprecatedOptions("DevEnableBufferedScrobble", "") // Deprecated: Buffered scrobbling is now always enabled and this option is ignored @@ -456,6 +474,22 @@ func validatePlaylistsPath() error { return nil } +// parseLanguages parses a comma-separated language string into a slice. +// It trims whitespace from each entry and ensures at least [DefaultInfoLanguage] is returned. +func parseLanguages(lang string) []string { + var languages []string + for _, l := range strings.Split(lang, ",") { + l = strings.TrimSpace(l) + if l != "" { + languages = append(languages, l) + } + } + if len(languages) == 0 { + return []string{consts.DefaultInfoLanguage} + } + return languages +} + func validatePurgeMissingOption() error { allowedValues := []string{consts.PurgeMissingNever, consts.PurgeMissingAlways, consts.PurgeMissingFull} valid := false @@ -555,6 +589,7 @@ func setViperDefaults() { viper.SetDefault("autotranscodedownload", false) viper.SetDefault("defaultdownsamplingformat", consts.DefaultDownsamplingFormat) viper.SetDefault("searchfullstring", false) + viper.SetDefault("similarsongsmatchthreshold", 85) viper.SetDefault("recentlyaddedbymodtime", false) viper.SetDefault("prefersorttags", false) viper.SetDefault("ignoredarticles", "The El La Los Las Le Les Os As O A") @@ -611,14 +646,14 @@ func setViperDefaults() { viper.SetDefault("subsonic.legacyclients", "DSub,SubMusic") viper.SetDefault("agents", "lastfm,spotify,deezer") viper.SetDefault("lastfm.enabled", true) - viper.SetDefault("lastfm.language", "en") + viper.SetDefault("lastfm.language", consts.DefaultInfoLanguage) viper.SetDefault("lastfm.apikey", "") viper.SetDefault("lastfm.secret", "") viper.SetDefault("lastfm.scrobblefirstartistonly", false) viper.SetDefault("spotify.id", "") viper.SetDefault("spotify.secret", "") viper.SetDefault("deezer.enabled", true) - viper.SetDefault("deezer.language", "en") + viper.SetDefault("deezer.language", consts.DefaultInfoLanguage) viper.SetDefault("listenbrainz.enabled", true) viper.SetDefault("listenbrainz.baseurl", "https://api.listenbrainz.org/1/") viper.SetDefault("enablescrobblehistory", true) @@ -633,7 +668,7 @@ func setViperDefaults() { viper.SetDefault("inspect.backloglimit", consts.RequestThrottleBacklogLimit) viper.SetDefault("inspect.backlogtimeout", consts.RequestThrottleBacklogTimeout) viper.SetDefault("plugins.folder", "") - viper.SetDefault("plugins.enabled", false) + viper.SetDefault("plugins.enabled", true) viper.SetDefault("plugins.cachesize", "200MB") viper.SetDefault("plugins.autoreload", false) diff --git a/conf/configuration_test.go b/conf/configuration_test.go index 06973456f..90604f54f 100644 --- a/conf/configuration_test.go +++ b/conf/configuration_test.go @@ -26,6 +26,32 @@ var _ = Describe("Configuration", func() { conf.ResetConf() }) + Describe("ParseLanguages", func() { + It("parses single language", func() { + Expect(conf.ParseLanguages("en")).To(Equal([]string{"en"})) + }) + + It("parses multiple comma-separated languages", func() { + Expect(conf.ParseLanguages("pt,en")).To(Equal([]string{"pt", "en"})) + }) + + It("trims whitespace from languages", func() { + Expect(conf.ParseLanguages(" pt , en ")).To(Equal([]string{"pt", "en"})) + }) + + It("returns default 'en' when empty", func() { + Expect(conf.ParseLanguages("")).To(Equal([]string{"en"})) + }) + + It("returns default 'en' when only whitespace", func() { + Expect(conf.ParseLanguages(" ")).To(Equal([]string{"en"})) + }) + + It("handles multiple languages with various spacing", func() { + Expect(conf.ParseLanguages("ja, pt, en")).To(Equal([]string{"ja", "pt", "en"})) + }) + }) + DescribeTable("should load configuration from", func(format string) { filename := filepath.Join("testdata", "cfg."+format) diff --git a/conf/export_test.go b/conf/export_test.go index 1b6daf036..abd2fa5a4 100644 --- a/conf/export_test.go +++ b/conf/export_test.go @@ -5,3 +5,5 @@ func ResetConf() { } var SetViperDefaults = setViperDefaults + +var ParseLanguages = parseLanguages diff --git a/consts/consts.go b/consts/consts.go index 2d342f909..583df5c91 100644 --- a/consts/consts.go +++ b/consts/consts.go @@ -56,6 +56,8 @@ const ( ServerReadHeaderTimeout = 3 * time.Second + DefaultInfoLanguage = "en" + ArtistInfoTimeToLive = 24 * time.Hour AlbumInfoTimeToLive = 7 * 24 * time.Hour UpdateLastAccessFrequency = time.Minute diff --git a/core/agents/agents.go b/core/agents/agents.go index c82d77b14..ead6dacd0 100644 --- a/core/agents/agents.go +++ b/core/agents/agents.go @@ -22,6 +22,8 @@ type PluginLoader interface { LoadMediaAgent(name string) (Interface, bool) } +// Agents is a meta-agent that aggregates multiple built-in and plugin agents. It tries each enabled agent in order +// until one returns valid data. type Agents struct { ds model.DataStore pluginLoader PluginLoader @@ -129,26 +131,14 @@ func (a *Agents) GetArtistMBID(ctx context.Context, id string, name string) (str case consts.VariousArtistsID: return "", nil } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentMethod(ctx, a, "GetArtistMBID", func(ag Interface) (string, error) { retriever, ok := ag.(ArtistMBIDRetriever) if !ok { - continue + return "", ErrNotFound } - mbid, err := retriever.GetArtistMBID(ctx, id, name) - if mbid != "" && err == nil { - log.Debug(ctx, "Got MBID", "agent", ag.AgentName(), "artist", name, "mbid", mbid, "elapsed", time.Since(start)) - return mbid, nil - } - } - return "", ErrNotFound + return retriever.GetArtistMBID(ctx, id, name) + }) } func (a *Agents) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { @@ -158,26 +148,14 @@ func (a *Agents) GetArtistURL(ctx context.Context, id, name, mbid string) (strin case consts.VariousArtistsID: return "", nil } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentMethod(ctx, a, "GetArtistURL", func(ag Interface) (string, error) { retriever, ok := ag.(ArtistURLRetriever) if !ok { - continue + return "", ErrNotFound } - url, err := retriever.GetArtistURL(ctx, id, name, mbid) - if url != "" && err == nil { - log.Debug(ctx, "Got External Url", "agent", ag.AgentName(), "artist", name, "url", url, "elapsed", time.Since(start)) - return url, nil - } - } - return "", ErrNotFound + return retriever.GetArtistURL(ctx, id, name, mbid) + }) } func (a *Agents) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error) { @@ -187,26 +165,14 @@ func (a *Agents) GetArtistBiography(ctx context.Context, id, name, mbid string) case consts.VariousArtistsID: return "", nil } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentMethod(ctx, a, "GetArtistBiography", func(ag Interface) (string, error) { retriever, ok := ag.(ArtistBiographyRetriever) if !ok { - continue + return "", ErrNotFound } - bio, err := retriever.GetArtistBiography(ctx, id, name, mbid) - if err == nil { - log.Debug(ctx, "Got Biography", "agent", ag.AgentName(), "artist", name, "len", len(bio), "elapsed", time.Since(start)) - return bio, nil - } - } - return "", ErrNotFound + return retriever.GetArtistBiography(ctx, id, name, mbid) + }) } // GetSimilarArtists returns similar artists by id, name, and/or mbid. Because some artists returned from an enabled @@ -254,26 +220,14 @@ func (a *Agents) GetArtistImages(ctx context.Context, id, name, mbid string) ([] case consts.VariousArtistsID: return nil, nil } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentSliceMethod(ctx, a, "GetArtistImages", func(ag Interface) ([]ExternalImage, error) { retriever, ok := ag.(ArtistImageRetriever) if !ok { - continue + return nil, ErrNotFound } - images, err := retriever.GetArtistImages(ctx, id, name, mbid) - if len(images) > 0 && err == nil { - log.Debug(ctx, "Got Images", "agent", ag.AgentName(), "artist", name, "images", images, "elapsed", time.Since(start)) - return images, nil - } - } - return nil, ErrNotFound + return retriever.GetArtistImages(ctx, id, name, mbid) + }) } // GetArtistTopSongs returns top songs by id, name, and/or mbid. Because some songs returned from an enabled @@ -288,80 +242,127 @@ func (a *Agents) GetArtistTopSongs(ctx context.Context, id, artistName, mbid str overLimit := int(float64(count) * conf.Server.DevExternalArtistFetchMultiplier) - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + return callAgentSliceMethod(ctx, a, "GetArtistTopSongs", func(ag Interface) ([]Song, error) { retriever, ok := ag.(ArtistTopSongsRetriever) if !ok { - continue + return nil, ErrNotFound } - songs, err := retriever.GetArtistTopSongs(ctx, id, artistName, mbid, overLimit) - if len(songs) > 0 && err == nil { - log.Debug(ctx, "Got Top Songs", "agent", ag.AgentName(), "artist", artistName, "songs", songs, "elapsed", time.Since(start)) - return songs, nil - } - } - return nil, ErrNotFound + return retriever.GetArtistTopSongs(ctx, id, artistName, mbid, overLimit) + }) } func (a *Agents) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error) { if name == consts.UnknownAlbum { return nil, ErrNotFound } - start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) - if ag == nil { - continue - } - if utils.IsCtxDone(ctx) { - break - } + + return callAgentMethod(ctx, a, "GetAlbumInfo", func(ag Interface) (*AlbumInfo, error) { retriever, ok := ag.(AlbumInfoRetriever) if !ok { - continue + return nil, ErrNotFound } - album, err := retriever.GetAlbumInfo(ctx, name, artist, mbid) - if err == nil { - log.Debug(ctx, "Got Album Info", "agent", ag.AgentName(), "album", name, "artist", artist, - "mbid", mbid, "elapsed", time.Since(start)) - return album, nil - } - } - return nil, ErrNotFound + return retriever.GetAlbumInfo(ctx, name, artist, mbid) + }) } func (a *Agents) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]ExternalImage, error) { if name == consts.UnknownAlbum { return nil, ErrNotFound } + + return callAgentSliceMethod(ctx, a, "GetAlbumImages", func(ag Interface) ([]ExternalImage, error) { + retriever, ok := ag.(AlbumImageRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetAlbumImages(ctx, name, artist, mbid) + }) +} + +// GetSimilarSongsByTrack returns similar songs for a given track. +func (a *Agents) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + return callAgentSliceMethod(ctx, a, "GetSimilarSongsByTrack", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(SimilarSongsByTrackRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetSimilarSongsByTrack(ctx, id, name, artist, mbid, count) + }) +} + +// GetSimilarSongsByAlbum returns similar songs for a given album. +func (a *Agents) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + return callAgentSliceMethod(ctx, a, "GetSimilarSongsByAlbum", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(SimilarSongsByAlbumRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetSimilarSongsByAlbum(ctx, id, name, artist, mbid, count) + }) +} + +// GetSimilarSongsByArtist returns similar songs for a given artist. +func (a *Agents) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]Song, error) { + switch id { + case consts.UnknownArtistID: + return nil, ErrNotFound + case consts.VariousArtistsID: + return nil, nil + } + + return callAgentSliceMethod(ctx, a, "GetSimilarSongsByArtist", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(SimilarSongsByArtistRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetSimilarSongsByArtist(ctx, id, name, mbid, count) + }) +} + +func callAgentMethod[T comparable](ctx context.Context, agents *Agents, methodName string, fn func(Interface) (T, error)) (T, error) { + var zero T start := time.Now() - for _, enabledAgent := range a.getEnabledAgentNames() { - ag := a.getAgent(enabledAgent) + for _, enabledAgent := range agents.getEnabledAgentNames() { + ag := agents.getAgent(enabledAgent) if ag == nil { continue } if utils.IsCtxDone(ctx) { break } - retriever, ok := ag.(AlbumImageRetriever) - if !ok { + result, err := fn(ag) + if err != nil { + log.Trace(ctx, "Agent method call error", "method", methodName, "agent", ag.AgentName(), "error", err) continue } - images, err := retriever.GetAlbumImages(ctx, name, artist, mbid) - if err != nil { - log.Trace(ctx, "Agent GetAlbumImages failed", "agent", ag.AgentName(), "album", name, "artist", artist, "mbid", mbid, err) + + if result != zero { + log.Debug(ctx, "Got result", "method", methodName, "agent", ag.AgentName(), "elapsed", time.Since(start)) + return result, nil } - if len(images) > 0 && err == nil { - log.Debug(ctx, "Got Album Images", "agent", ag.AgentName(), "album", name, "artist", artist, - "mbid", mbid, "elapsed", time.Since(start)) - return images, nil + } + return zero, ErrNotFound +} + +func callAgentSliceMethod[T any](ctx context.Context, agents *Agents, methodName string, fn func(Interface) ([]T, error)) ([]T, error) { + start := time.Now() + for _, enabledAgent := range agents.getEnabledAgentNames() { + ag := agents.getAgent(enabledAgent) + if ag == nil { + continue + } + if utils.IsCtxDone(ctx) { + break + } + results, err := fn(ag) + if err != nil { + log.Trace(ctx, "Agent method call error", "method", methodName, "agent", ag.AgentName(), "error", err) + continue + } + + if len(results) > 0 { + log.Debug(ctx, "Got results", "method", methodName, "agent", ag.AgentName(), "count", len(results), "elapsed", time.Since(start)) + return results, nil } } return nil, ErrNotFound @@ -376,3 +377,6 @@ var _ ArtistImageRetriever = (*Agents)(nil) var _ ArtistTopSongsRetriever = (*Agents)(nil) var _ AlbumInfoRetriever = (*Agents)(nil) var _ AlbumImageRetriever = (*Agents)(nil) +var _ SimilarSongsByTrackRetriever = (*Agents)(nil) +var _ SimilarSongsByAlbumRetriever = (*Agents)(nil) +var _ SimilarSongsByArtistRetriever = (*Agents)(nil) diff --git a/core/agents/agents_test.go b/core/agents/agents_test.go index 0b7eec282..1d5ae464b 100644 --- a/core/agents/agents_test.go +++ b/core/agents/agents_test.go @@ -295,6 +295,72 @@ var _ = Describe("Agents", func() { Expect(mock.Args).To(BeEmpty()) }) }) + + Describe("GetSimilarSongsByTrack", func() { + It("returns on first match", func() { + Expect(ag.GetSimilarSongsByTrack(ctx, "123", "test song", "test artist", "mb123", 2)).To(Equal([]Song{{ + Name: "Similar Song", + MBID: "mbid555", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test song", "test artist", "mb123", 2)) + }) + It("skips the agent if it returns an error", func() { + mock.Err = errors.New("error") + _, err := ag.GetSimilarSongsByTrack(ctx, "123", "test song", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(HaveExactElements("123", "test song", "test artist", "mb123", 2)) + }) + It("interrupts if the context is canceled", func() { + cancel() + _, err := ag.GetSimilarSongsByTrack(ctx, "123", "test song", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(BeEmpty()) + }) + }) + + Describe("GetSimilarSongsByAlbum", func() { + It("returns on first match", func() { + Expect(ag.GetSimilarSongsByAlbum(ctx, "123", "test album", "test artist", "mb123", 2)).To(Equal([]Song{{ + Name: "Album Similar Song", + MBID: "mbid666", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test album", "test artist", "mb123", 2)) + }) + It("skips the agent if it returns an error", func() { + mock.Err = errors.New("error") + _, err := ag.GetSimilarSongsByAlbum(ctx, "123", "test album", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(HaveExactElements("123", "test album", "test artist", "mb123", 2)) + }) + It("interrupts if the context is canceled", func() { + cancel() + _, err := ag.GetSimilarSongsByAlbum(ctx, "123", "test album", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(BeEmpty()) + }) + }) + + Describe("GetSimilarSongsByArtist", func() { + It("returns on first match", func() { + Expect(ag.GetSimilarSongsByArtist(ctx, "123", "test artist", "mb123", 2)).To(Equal([]Song{{ + Name: "Artist Similar Song", + MBID: "mbid777", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test artist", "mb123", 2)) + }) + It("skips the agent if it returns an error", func() { + mock.Err = errors.New("error") + _, err := ag.GetSimilarSongsByArtist(ctx, "123", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(HaveExactElements("123", "test artist", "mb123", 2)) + }) + It("interrupts if the context is canceled", func() { + cancel() + _, err := ag.GetSimilarSongsByArtist(ctx, "123", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(BeEmpty()) + }) + }) }) }) @@ -377,6 +443,39 @@ func (a *mockAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) }, nil } +func (a *mockAgent) GetSimilarSongsByTrack(_ context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + a.Args = []interface{}{id, name, artist, mbid, count} + if a.Err != nil { + return nil, a.Err + } + return []Song{{ + Name: "Similar Song", + MBID: "mbid555", + }}, nil +} + +func (a *mockAgent) GetSimilarSongsByAlbum(_ context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + a.Args = []interface{}{id, name, artist, mbid, count} + if a.Err != nil { + return nil, a.Err + } + return []Song{{ + Name: "Album Similar Song", + MBID: "mbid666", + }}, nil +} + +func (a *mockAgent) GetSimilarSongsByArtist(_ context.Context, id, name, mbid string, count int) ([]Song, error) { + a.Args = []interface{}{id, name, mbid, count} + if a.Err != nil { + return nil, a.Err + } + return []Song{{ + Name: "Artist Similar Song", + MBID: "mbid777", + }}, nil +} + type emptyAgent struct { Interface } diff --git a/core/agents/interfaces.go b/core/agents/interfaces.go index 054a14c51..19df91d02 100644 --- a/core/agents/interfaces.go +++ b/core/agents/interfaces.go @@ -33,9 +33,15 @@ type ExternalImage struct { } type Song struct { - ID string - Name string - MBID string + ID string + Name string + MBID string + ISRC string + Artist string + ArtistMBID string + Album string + AlbumMBID string + Duration uint32 // Duration in milliseconds, 0 means unknown } var ( @@ -76,6 +82,41 @@ type ArtistTopSongsRetriever interface { GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]Song, error) } +// SimilarSongsByTrackRetriever provides similar songs based on a specific track +type SimilarSongsByTrackRetriever interface { + // GetSimilarSongsByTrack returns songs similar to the given track. + // Parameters: + // - id: local mediafile ID + // - name: track title + // - artist: artist name + // - mbid: MusicBrainz recording ID (may be empty) + // - count: maximum number of results + GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) +} + +// SimilarSongsByAlbumRetriever provides similar songs based on an album +type SimilarSongsByAlbumRetriever interface { + // GetSimilarSongsByAlbum returns songs similar to tracks on the given album. + // Parameters: + // - id: local album ID + // - name: album name + // - artist: album artist name + // - mbid: MusicBrainz release ID (may be empty) + // - count: maximum number of results + GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) +} + +// SimilarSongsByArtistRetriever provides similar songs based on an artist +type SimilarSongsByArtistRetriever interface { + // GetSimilarSongsByArtist returns songs similar to the artist's catalog. + // Parameters: + // - id: local artist ID + // - name: artist name + // - mbid: MusicBrainz artist ID (may be empty) + // - count: maximum number of results + GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]Song, error) +} + var Map map[string]Constructor func Register(name string, init Constructor) { diff --git a/core/artwork/artwork_internal_test.go b/core/artwork/artwork_internal_test.go index cfb7850bd..c18caf737 100644 --- a/core/artwork/artwork_internal_test.go +++ b/core/artwork/artwork_internal_test.go @@ -302,6 +302,33 @@ var _ = Describe("Artwork", func() { Entry("landscape jpg image", "jpg", true, 200), ) }) + When("Requested size is larger than original", func() { + It("clamps size to original dimensions", func() { + conf.Server.CoverArtPriority = "front.png" + // front.png is 16x16, requesting 99999 should return at original size + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 99999, false) + Expect(err).ToNot(HaveOccurred()) + + img, _, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + // Should be clamped to original size (16), not 99999 + Expect(img.Bounds().Size().X).To(Equal(16)) + Expect(img.Bounds().Size().Y).To(Equal(16)) + }) + + It("clamps square size to original dimensions", func() { + conf.Server.CoverArtPriority = "front.png" + // front.png is 16x16, requesting 99999 with square should return 16x16 square + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 99999, true) + Expect(err).ToNot(HaveOccurred()) + + img, _, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + // Should be clamped to original size (16), not 99999 + Expect(img.Bounds().Size().X).To(Equal(16)) + Expect(img.Bounds().Size().Y).To(Equal(16)) + }) + }) }) }) diff --git a/core/artwork/reader_resized.go b/core/artwork/reader_resized.go index 83e6e25c2..6de983baf 100644 --- a/core/artwork/reader_resized.go +++ b/core/artwork/reader_resized.go @@ -87,6 +87,11 @@ func resizeImage(reader io.Reader, size int, square bool) (io.Reader, int, error bounds := original.Bounds() originalSize := max(bounds.Max.X, bounds.Max.Y) + // Clamp size to original dimensions - upscaling wastes resources and adds no information + if size > originalSize { + size = originalSize + } + if originalSize <= size && !square { return nil, originalSize, nil } diff --git a/core/external/extdata_helper_test.go b/core/external/extdata_helper_test.go index 29975e5c5..185a568b1 100644 --- a/core/external/extdata_helper_test.go +++ b/core/external/extdata_helper_test.go @@ -92,6 +92,11 @@ func (m *mockMediaFileRepo) Get(id string) (*model.MediaFile, error) { return args.Get(0).(*model.MediaFile), args.Error(1) } +// GetAllByTags implements model.MediaFileRepository. +func (m *mockMediaFileRepo) GetAllByTags(_ model.TagName, _ []string, options ...model.QueryOptions) (model.MediaFiles, error) { + return m.GetAll(options...) +} + // GetAll implements model.MediaFileRepository. func (m *mockMediaFileRepo) GetAll(options ...model.QueryOptions) (model.MediaFiles, error) { argsSlice := make([]interface{}, len(options)) @@ -282,3 +287,27 @@ func (m *mockAgents) GetAlbumImages(ctx context.Context, name, artist, mbid stri } return nil, args.Error(1) } + +func (m *mockAgents) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + args := m.Called(ctx, id, name, artist, mbid, count) + if args.Get(0) != nil { + return args.Get(0).([]agents.Song), args.Error(1) + } + return nil, args.Error(1) +} + +func (m *mockAgents) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + args := m.Called(ctx, id, name, artist, mbid, count) + if args.Get(0) != nil { + return args.Get(0).([]agents.Song), args.Error(1) + } + return nil, args.Error(1) +} + +func (m *mockAgents) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]agents.Song, error) { + args := m.Called(ctx, id, name, mbid, count) + if args.Get(0) != nil { + return args.Get(0).([]agents.Song), args.Error(1) + } + return nil, args.Error(1) +} diff --git a/core/external/provider.go b/core/external/provider.go index a6eb848a0..13a4caf1f 100644 --- a/core/external/provider.go +++ b/core/external/provider.go @@ -32,7 +32,7 @@ const ( type Provider interface { UpdateAlbumInfo(ctx context.Context, id string) (*model.Album, error) UpdateArtistInfo(ctx context.Context, id string, count int, includeNotPresent bool) (*model.Artist, error) - ArtistRadio(ctx context.Context, id string, count int) (model.MediaFiles, error) + SimilarSongs(ctx context.Context, id string, count int) (model.MediaFiles, error) TopSongs(ctx context.Context, artist string, count int) (model.MediaFiles, error) ArtistImage(ctx context.Context, id string) (*url.URL, error) AlbumImage(ctx context.Context, id string) (*url.URL, error) @@ -80,6 +80,9 @@ type Agents interface { agents.ArtistSimilarRetriever agents.ArtistTopSongsRetriever agents.ArtistURLRetriever + agents.SimilarSongsByTrackRetriever + agents.SimilarSongsByAlbumRetriever + agents.SimilarSongsByArtistRetriever } func NewProvider(ds model.DataStore, agents Agents) Provider { @@ -256,7 +259,7 @@ func (e *provider) populateArtistInfo(ctx context.Context, artist auxArtist) (au g.Go(func() error { e.callGetImage(ctx, e.ag, &artist); return nil }) g.Go(func() error { e.callGetBiography(ctx, e.ag, &artist); return nil }) g.Go(func() error { e.callGetURL(ctx, e.ag, &artist); return nil }) - g.Go(func() error { e.callGetSimilar(ctx, e.ag, &artist, maxSimilarArtists, true); return nil }) + g.Go(func() error { e.callGetSimilarArtists(ctx, e.ag, &artist, maxSimilarArtists, true); return nil }) _ = g.Wait() if utils.IsCtxDone(ctx) { @@ -275,22 +278,54 @@ func (e *provider) populateArtistInfo(ctx context.Context, artist auxArtist) (au return artist, nil } -func (e *provider) ArtistRadio(ctx context.Context, id string, count int) (model.MediaFiles, error) { +func (e *provider) SimilarSongs(ctx context.Context, id string, count int) (model.MediaFiles, error) { + entity, err := model.GetEntityByID(ctx, e.ds, id) + if err != nil { + return nil, err + } + + var songs []agents.Song + + // Try entity-specific similarity first + switch v := entity.(type) { + case *model.MediaFile: + songs, err = e.ag.GetSimilarSongsByTrack(ctx, v.ID, v.Title, v.Artist, v.MbzRecordingID, count) + case *model.Album: + songs, err = e.ag.GetSimilarSongsByAlbum(ctx, v.ID, v.Name, v.AlbumArtist, v.MbzAlbumID, count) + case *model.Artist: + songs, err = e.ag.GetSimilarSongsByArtist(ctx, v.ID, v.Name, v.MbzArtistID, count) + default: + log.Warn(ctx, "Unknown entity type", "id", id, "type", fmt.Sprintf("%T", entity)) + return nil, model.ErrNotFound + } + + if err == nil && len(songs) > 0 { + return e.matchSongsToLibrary(ctx, songs, count) + } + + // Fallback to existing similar artists + top songs algorithm + return e.similarSongsFallback(ctx, id, count) +} + +// similarSongsFallback uses the original similar artists + top songs algorithm. The idea is to +// get the artist of the given entity, retrieve similar artists, get their top songs, and pick +// a weighted random selection of songs to return as similar songs. +func (e *provider) similarSongsFallback(ctx context.Context, id string, count int) (model.MediaFiles, error) { artist, err := e.getArtist(ctx, id) if err != nil { return nil, err } - e.callGetSimilar(ctx, e.ag, &artist, 15, false) + e.callGetSimilarArtists(ctx, e.ag, &artist, 15, false) if utils.IsCtxDone(ctx) { - log.Warn(ctx, "ArtistRadio call canceled", ctx.Err()) + log.Warn(ctx, "SimilarSongs call canceled", ctx.Err()) return nil, ctx.Err() } weightedSongs := random.NewWeightedChooser[model.MediaFile]() addArtist := func(a model.Artist, weightedSongs *random.WeightedChooser[model.MediaFile], count, artistWeight int) error { if utils.IsCtxDone(ctx) { - log.Warn(ctx, "ArtistRadio call canceled", ctx.Err()) + log.Warn(ctx, "SimilarSongs call canceled", ctx.Err()) return ctx.Err() } @@ -422,21 +457,20 @@ func (e *provider) getMatchingTopSongs(ctx context.Context, agent agents.ArtistT return nil, fmt.Errorf("failed to get top songs for artist %s: %w", artistName, err) } - idMatches, err := e.loadTracksByID(ctx, songs) - if err != nil { - return nil, fmt.Errorf("failed to load tracks by ID: %w", err) - } - mbidMatches, err := e.loadTracksByMBID(ctx, songs) - if err != nil { - return nil, fmt.Errorf("failed to load tracks by MBID: %w", err) - } - titleMatches, err := e.loadTracksByTitle(ctx, songs, artist, idMatches, mbidMatches) - if err != nil { - return nil, fmt.Errorf("failed to load tracks by title: %w", err) + // Enrich songs with artist info if not already present (for top songs, we know the artist) + for i := range songs { + if songs[i].Artist == "" { + songs[i].Artist = artistName + } + if songs[i].ArtistMBID == "" { + songs[i].ArtistMBID = artist.MbzArtistID + } } - log.Trace(ctx, "Top Songs loaded", "name", artistName, "numSongs", len(songs), "numIDMatches", len(idMatches), "numMBIDMatches", len(mbidMatches), "numTitleMatches", len(titleMatches)) - mfs := e.selectTopSongs(songs, idMatches, mbidMatches, titleMatches, count) + mfs, err := e.matchSongsToLibrary(ctx, songs, count) + if err != nil { + return nil, err + } if len(mfs) == 0 { log.Debug(ctx, "No matching top songs found", "name", artistName) @@ -447,137 +481,6 @@ func (e *provider) getMatchingTopSongs(ctx context.Context, agent agents.ArtistT return mfs, nil } -func (e *provider) loadTracksByMBID(ctx context.Context, songs []agents.Song) (map[string]model.MediaFile, error) { - var mbids []string - for _, s := range songs { - if s.MBID != "" { - mbids = append(mbids, s.MBID) - } - } - matches := map[string]model.MediaFile{} - if len(mbids) == 0 { - return matches, nil - } - res, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ - Filters: squirrel.And{ - squirrel.Eq{"mbz_recording_id": mbids}, - squirrel.Eq{"missing": false}, - }, - }) - if err != nil { - return matches, err - } - for _, mf := range res { - if id := mf.MbzRecordingID; id != "" { - if _, ok := matches[id]; !ok { - matches[id] = mf - } - } - } - return matches, nil -} - -func (e *provider) loadTracksByID(ctx context.Context, songs []agents.Song) (map[string]model.MediaFile, error) { - var ids []string - for _, s := range songs { - if s.ID != "" { - ids = append(ids, s.ID) - } - } - matches := map[string]model.MediaFile{} - if len(ids) == 0 { - return matches, nil - } - res, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ - Filters: squirrel.And{ - squirrel.Eq{"media_file.id": ids}, - squirrel.Eq{"missing": false}, - }, - }) - if err != nil { - return matches, err - } - for _, mf := range res { - if _, ok := matches[mf.ID]; !ok { - matches[mf.ID] = mf - } - } - return matches, nil -} - -func (e *provider) loadTracksByTitle(ctx context.Context, songs []agents.Song, artist *auxArtist, idMatches, mbidMatches map[string]model.MediaFile) (map[string]model.MediaFile, error) { - titleMap := map[string]string{} - for _, s := range songs { - // Skip if already matched by ID or MBID - if s.ID != "" && idMatches[s.ID].ID != "" { - continue - } - if s.MBID != "" && mbidMatches[s.MBID].ID != "" { - continue - } - sanitized := str.SanitizeFieldForSorting(s.Name) - titleMap[sanitized] = s.Name - } - matches := map[string]model.MediaFile{} - if len(titleMap) == 0 { - return matches, nil - } - titleFilters := squirrel.Or{} - for sanitized := range titleMap { - titleFilters = append(titleFilters, squirrel.Like{"order_title": sanitized}) - } - - res, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ - Filters: squirrel.And{ - squirrel.Or{ - squirrel.Eq{"artist_id": artist.ID}, - squirrel.Eq{"album_artist_id": artist.ID}, - }, - titleFilters, - squirrel.Eq{"missing": false}, - }, - Sort: "starred desc, rating desc, year asc, compilation asc ", - }) - if err != nil { - return matches, err - } - for _, mf := range res { - sanitized := str.SanitizeFieldForSorting(mf.Title) - if _, ok := matches[sanitized]; !ok { - matches[sanitized] = mf - } - } - return matches, nil -} - -func (e *provider) selectTopSongs(songs []agents.Song, byID, byMBID, byTitle map[string]model.MediaFile, count int) model.MediaFiles { - var mfs model.MediaFiles - for _, t := range songs { - if len(mfs) == count { - break - } - // Try ID match first - if t.ID != "" { - if mf, ok := byID[t.ID]; ok { - mfs = append(mfs, mf) - continue - } - } - // Try MBID match second - if t.MBID != "" { - if mf, ok := byMBID[t.MBID]; ok { - mfs = append(mfs, mf) - continue - } - } - // Fall back to title match - if mf, ok := byTitle[str.SanitizeFieldForSorting(t.Name)]; ok { - mfs = append(mfs, mf) - } - } - return mfs -} - func (e *provider) callGetURL(ctx context.Context, agent agents.ArtistURLRetriever, artist *auxArtist) { artisURL, err := agent.GetArtistURL(ctx, artist.ID, artist.Name(), artist.MbzArtistID) if err != nil { @@ -614,7 +517,7 @@ func (e *provider) callGetImage(ctx context.Context, agent agents.ArtistImageRet } } -func (e *provider) callGetSimilar(ctx context.Context, agent agents.ArtistSimilarRetriever, artist *auxArtist, +func (e *provider) callGetSimilarArtists(ctx context.Context, agent agents.ArtistSimilarRetriever, artist *auxArtist, limit int, includeNotPresent bool) { artistName := artist.Name() similar, err := agent.GetSimilarArtists(ctx, artist.ID, artistName, artist.MbzArtistID, limit) diff --git a/core/external/provider_artistradio_test.go b/core/external/provider_artistradio_test.go deleted file mode 100644 index 18afede6b..000000000 --- a/core/external/provider_artistradio_test.go +++ /dev/null @@ -1,205 +0,0 @@ -package external_test - -import ( - "context" - "errors" - - "github.com/Masterminds/squirrel" - "github.com/navidrome/navidrome/core/agents" - . "github.com/navidrome/navidrome/core/external" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" - "github.com/stretchr/testify/mock" -) - -var _ = Describe("Provider - ArtistRadio", func() { - var ds model.DataStore - var provider Provider - var mockAgent *mockSimilarArtistAgent - var mockTopAgent agents.ArtistTopSongsRetriever - var mockSimilarAgent agents.ArtistSimilarRetriever - var agentsCombined Agents - var artistRepo *mockArtistRepo - var mediaFileRepo *mockMediaFileRepo - var ctx context.Context - - BeforeEach(func() { - ctx = GinkgoT().Context() - - artistRepo = newMockArtistRepo() - mediaFileRepo = newMockMediaFileRepo() - - ds = &tests.MockDataStore{ - MockedArtist: artistRepo, - MockedMediaFile: mediaFileRepo, - } - - mockAgent = &mockSimilarArtistAgent{} - mockTopAgent = mockAgent - mockSimilarAgent = mockAgent - - agentsCombined = &mockAgents{ - topSongsAgent: mockTopAgent, - similarAgent: mockSimilarAgent, - } - - provider = NewProvider(ds, agentsCombined) - }) - - It("returns similar songs from main artist and similar artists", func() { - artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - similarArtist := model.Artist{ID: "artist-3", Name: "Similar Artist"} - song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} - song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} - song3 := model.MediaFile{ID: "song-3", Title: "Song Three", ArtistID: "artist-3", MbzRecordingID: "mbid-3"} - - artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() - artistRepo.On("Get", "artist-3").Return(&similarArtist, nil).Maybe() - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{artist1}, nil).Once() - - similarAgentsResp := []agents.Artist{ - {Name: "Similar Artist", MBID: "similar-mbid"}, - } - mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). - Return(similarAgentsResp, nil).Once() - - // Mock the three-phase artist lookup: ID (skipped - no IDs), MBID, then Name - // MBID lookup returns empty (no match) - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - _, ok := opt.Filters.(squirrel.Eq) - return opt.Max == 0 && ok - })).Return(model.Artists{}, nil).Once() - // Name lookup returns the similar artist - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - _, ok := opt.Filters.(squirrel.Or) - return opt.Max == 0 && ok - })).Return(model.Artists{similarArtist}, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). - Return([]agents.Song{ - {Name: "Song One", MBID: "mbid-1"}, - {Name: "Song Two", MBID: "mbid-2"}, - }, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-3", "Similar Artist", "", mock.Anything). - Return([]agents.Song{ - {Name: "Song Three", MBID: "mbid-3"}, - }, nil).Once() - - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song3}, nil).Once() - - songs, err := provider.ArtistRadio(ctx, "artist-1", 3) - - Expect(err).ToNot(HaveOccurred()) - Expect(songs).To(HaveLen(3)) - for _, song := range songs { - Expect(song.ID).To(BeElementOf("song-1", "song-2", "song-3")) - } - }) - - It("returns ErrNotFound when artist is not found", func() { - artistRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) - mediaFileRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{}, nil).Maybe() - - songs, err := provider.ArtistRadio(ctx, "artist-unknown-artist", 5) - - Expect(err).To(Equal(model.ErrNotFound)) - Expect(songs).To(BeNil()) - }) - - It("returns songs from main artist when GetSimilarArtists returns error", func() { - artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} - - artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{artist1}, nil).Maybe() - - mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). - Return(nil, errors.New("error getting similar artists")).Once() - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 0 && opt.Filters != nil - })).Return(model.Artists{}, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). - Return([]agents.Song{ - {Name: "Song One", MBID: "mbid-1"}, - }, nil).Once() - - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() - - songs, err := provider.ArtistRadio(ctx, "artist-1", 5) - - Expect(err).ToNot(HaveOccurred()) - Expect(songs).To(HaveLen(1)) - Expect(songs[0].ID).To(Equal("song-1")) - }) - - It("returns empty list when GetArtistTopSongs returns error", func() { - artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - - artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{artist1}, nil).Maybe() - - mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). - Return([]agents.Artist{}, nil).Once() - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 0 && opt.Filters != nil - })).Return(model.Artists{}, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). - Return(nil, errors.New("error getting top songs")).Once() - - songs, err := provider.ArtistRadio(ctx, "artist-1", 5) - - Expect(err).ToNot(HaveOccurred()) - Expect(songs).To(BeEmpty()) - }) - - It("respects count parameter", func() { - artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} - song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} - - artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 1 && opt.Filters != nil - })).Return(model.Artists{artist1}, nil).Maybe() - - mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). - Return([]agents.Artist{}, nil).Once() - - artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 0 && opt.Filters != nil - })).Return(model.Artists{}, nil).Once() - - mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). - Return([]agents.Song{ - {Name: "Song One", MBID: "mbid-1"}, - {Name: "Song Two", MBID: "mbid-2"}, - }, nil).Once() - - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() - - songs, err := provider.ArtistRadio(ctx, "artist-1", 1) - - Expect(err).ToNot(HaveOccurred()) - Expect(songs).To(HaveLen(1)) - Expect(songs[0].ID).To(BeElementOf("song-1", "song-2")) - }) -}) diff --git a/core/external/provider_matching.go b/core/external/provider_matching.go new file mode 100644 index 000000000..74ad56d42 --- /dev/null +++ b/core/external/provider_matching.go @@ -0,0 +1,504 @@ +package external + +import ( + "context" + "fmt" + "math" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/str" + "github.com/xrash/smetrics" +) + +// matchSongsToLibrary matches agent song results to local library tracks using a multi-phase +// matching algorithm that prioritizes accuracy over recall. +// +// # Algorithm Overview +// +// The algorithm matches songs from external agents (Last.fm, Deezer, etc.) to tracks in the +// local music library using four matching strategies in priority order: +// +// 1. Direct ID match: Songs with an ID field are matched directly to MediaFiles by ID +// 2. MusicBrainz Recording ID (MBID) match: Songs with MBID are matched to tracks with +// matching mbz_recording_id +// 3. ISRC match: Songs with ISRC are matched to tracks with matching ISRC tag +// 4. Title+Artist fuzzy match: Remaining songs are matched using fuzzy string comparison +// with metadata specificity scoring +// +// # Matching Priority +// +// When selecting the final result, matches are prioritized in order: ID > MBID > ISRC > Title+Artist. +// This ensures that more reliable identifiers take precedence over fuzzy text matching. +// +// # Fuzzy Matching Details +// +// For title+artist matching, the algorithm uses Jaro-Winkler similarity (threshold configurable +// via SimilarSongsMatchThreshold, default 85%). Matches are ranked by: +// +// 1. Title similarity (Jaro-Winkler score, 0.0-1.0) +// 2. Duration proximity (closer duration = higher score, 1.0 if unknown) +// 3. Specificity level (0-5, based on metadata precision): +// - Level 5: Title + Artist MBID + Album MBID (most specific) +// - Level 4: Title + Artist MBID + Album name (fuzzy) +// - Level 3: Title + Artist name + Album name (fuzzy) +// - Level 2: Title + Artist MBID +// - Level 1: Title + Artist name +// - Level 0: Title only +// 4. Album similarity (Jaro-Winkler, as final tiebreaker) +// +// # Examples +// +// Example 1 - MBID Priority: +// +// Agent returns: {Name: "Paranoid Android", MBID: "abc-123", Artist: "Radiohead"} +// Library has: [ +// {ID: "t1", Title: "Paranoid Android", MbzRecordingID: "abc-123"}, +// {ID: "t2", Title: "Paranoid Android", Artist: "Radiohead"}, +// ] +// Result: t1 (MBID match takes priority over title+artist) +// +// Example 2 - ISRC Priority: +// +// Agent returns: {Name: "Paranoid Android", ISRC: "GBAYE0000351", Artist: "Radiohead"} +// Library has: [ +// {ID: "t1", Title: "Paranoid Android", Tags: {isrc: ["GBAYE0000351"]}}, +// {ID: "t2", Title: "Paranoid Android", Artist: "Radiohead"}, +// ] +// Result: t1 (ISRC match takes priority over title+artist) +// +// Example 3 - Specificity Ranking: +// +// Agent returns: {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"} +// Library has: [ +// {ID: "t1", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "101"}, // Level 1 +// {ID: "t2", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, // Level 3 +// ] +// Result: t2 (Level 3 beats Level 1 due to album match) +// +// Example 4 - Fuzzy Title Matching: +// +// Agent returns: {Name: "Bohemian Rhapsody", Artist: "Queen"} +// Library has: {ID: "t1", Title: "Bohemian Rhapsody - Remastered", Artist: "Queen"} +// With threshold=85%: Match succeeds (similarity ~0.87) +// With threshold=100%: No match (not exact) +// +// # Parameters +// +// - ctx: Context for database operations +// - songs: Slice of agent.Song results from external providers +// - count: Maximum number of matches to return +// +// # Returns +// +// Returns up to 'count' MediaFiles from the library that best match the input songs, +// preserving the original order from the agent. Songs that cannot be matched are skipped. +func (e *provider) matchSongsToLibrary(ctx context.Context, songs []agents.Song, count int) (model.MediaFiles, error) { + idMatches, err := e.loadTracksByID(ctx, songs) + if err != nil { + return nil, fmt.Errorf("failed to load tracks by ID: %w", err) + } + mbidMatches, err := e.loadTracksByMBID(ctx, songs, idMatches) + if err != nil { + return nil, fmt.Errorf("failed to load tracks by MBID: %w", err) + } + isrcMatches, err := e.loadTracksByISRC(ctx, songs, idMatches, mbidMatches) + if err != nil { + return nil, fmt.Errorf("failed to load tracks by ISRC: %w", err) + } + titleMatches, err := e.loadTracksByTitleAndArtist(ctx, songs, idMatches, mbidMatches, isrcMatches) + if err != nil { + return nil, fmt.Errorf("failed to load tracks by title: %w", err) + } + + return e.selectBestMatchingSongs(songs, idMatches, mbidMatches, isrcMatches, titleMatches, count), nil +} + +// songMatchedIn checks if a song has already been matched in any of the provided match maps. +// It checks the song's ID, MBID, and ISRC fields against the corresponding map keys. +func songMatchedIn(s agents.Song, priorMatches ...map[string]model.MediaFile) bool { + _, found := lookupByIdentifiers(s, priorMatches...) + return found +} + +// lookupByIdentifiers searches for a song's identifiers (ID, MBID, ISRC) in the provided maps. +// Returns the first matching MediaFile found and true, or an empty MediaFile and false if no match. +func lookupByIdentifiers(s agents.Song, maps ...map[string]model.MediaFile) (model.MediaFile, bool) { + keys := []string{s.ID, s.MBID, s.ISRC} + for _, m := range maps { + for _, key := range keys { + if key != "" { + if mf, ok := m[key]; ok && mf.ID != "" { + return mf, true + } + } + } + } + return model.MediaFile{}, false +} + +// loadTracksByID fetches MediaFiles from the library using direct ID matching. +// It extracts all non-empty ID fields from the input songs and performs a single +// batch query to the database. Returns a map keyed by MediaFile ID for O(1) lookup. +// Only non-missing files are returned. +func (e *provider) loadTracksByID(ctx context.Context, songs []agents.Song) (map[string]model.MediaFile, error) { + var ids []string + for _, s := range songs { + if s.ID != "" { + ids = append(ids, s.ID) + } + } + matches := map[string]model.MediaFile{} + if len(ids) == 0 { + return matches, nil + } + res, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"media_file.id": ids}, + squirrel.Eq{"missing": false}, + }, + }) + if err != nil { + return matches, err + } + for _, mf := range res { + if _, ok := matches[mf.ID]; !ok { + matches[mf.ID] = mf + } + } + return matches, nil +} + +// loadTracksByMBID fetches MediaFiles from the library using MusicBrainz Recording IDs. +// It extracts all non-empty MBID fields from the input songs and performs a single +// batch query against the mbz_recording_id column. Returns a map keyed by MBID for +// O(1) lookup. Only non-missing files are returned. +func (e *provider) loadTracksByMBID(ctx context.Context, songs []agents.Song, priorMatches ...map[string]model.MediaFile) (map[string]model.MediaFile, error) { + var mbids []string + for _, s := range songs { + if s.MBID != "" && !songMatchedIn(s, priorMatches...) { + mbids = append(mbids, s.MBID) + } + } + matches := map[string]model.MediaFile{} + if len(mbids) == 0 { + return matches, nil + } + res, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"mbz_recording_id": mbids}, + squirrel.Eq{"missing": false}, + }, + }) + if err != nil { + return matches, err + } + for _, mf := range res { + if id := mf.MbzRecordingID; id != "" { + if _, ok := matches[id]; !ok { + matches[id] = mf + } + } + } + return matches, nil +} + +// loadTracksByISRC fetches MediaFiles from the library using ISRC (International Standard +// Recording Code) matching. It extracts all non-empty ISRC fields from the input songs and +// queries the tags JSON column for matching ISRC values. Returns a map keyed by ISRC for +// O(1) lookup. Only non-missing files are returned. +func (e *provider) loadTracksByISRC(ctx context.Context, songs []agents.Song, priorMatches ...map[string]model.MediaFile) (map[string]model.MediaFile, error) { + var isrcs []string + for _, s := range songs { + if s.ISRC != "" && !songMatchedIn(s, priorMatches...) { + isrcs = append(isrcs, s.ISRC) + } + } + matches := map[string]model.MediaFile{} + if len(isrcs) == 0 { + return matches, nil + } + res, err := e.ds.MediaFile(ctx).GetAllByTags(model.TagISRC, isrcs, model.QueryOptions{ + Filters: squirrel.Eq{"missing": false}, + }) + if err != nil { + return matches, err + } + for _, mf := range res { + for _, isrc := range mf.Tags.Values(model.TagISRC) { + if _, ok := matches[isrc]; !ok { + matches[isrc] = mf + } + } + } + return matches, nil +} + +// songQuery represents a normalized query for matching a song to library tracks. +// All string fields are sanitized (lowercased, diacritics removed) for comparison. +// This struct is used internally by loadTracksByTitleAndArtist to group queries by artist. +type songQuery struct { + title string // Sanitized song title + artist string // Sanitized artist name (without articles like "The") + artistMBID string // MusicBrainz Artist ID (optional, for higher specificity matching) + album string // Sanitized album name (optional, for specificity scoring) + albumMBID string // MusicBrainz Album ID (optional, for highest specificity matching) + durationMs uint32 // Duration in milliseconds (0 means unknown, skip duration filtering) +} + +// matchScore combines title/album similarity with metadata specificity for ranking matches +type matchScore struct { + titleSimilarity float64 // 0.0-1.0 (Jaro-Winkler) + durationProximity float64 // 0.0-1.0 (closer duration = higher, 1.0 if unknown) + albumSimilarity float64 // 0.0-1.0 (Jaro-Winkler), used as tiebreaker + specificityLevel int // 0-5 (higher = more specific metadata match) +} + +// betterThan returns true if this score beats another. +// Comparison order: title similarity > duration proximity > specificity level > album similarity +func (s matchScore) betterThan(other matchScore) bool { + if s.titleSimilarity != other.titleSimilarity { + return s.titleSimilarity > other.titleSimilarity + } + if s.durationProximity != other.durationProximity { + return s.durationProximity > other.durationProximity + } + if s.specificityLevel != other.specificityLevel { + return s.specificityLevel > other.specificityLevel + } + return s.albumSimilarity > other.albumSimilarity +} + +// computeSpecificityLevel determines how well query metadata matches a track (0-5). +// Higher values indicate more specific matches (MBIDs > names > title only). +// Uses fuzzy matching for album names with the same threshold as title matching. +func computeSpecificityLevel(q songQuery, mf model.MediaFile, albumThreshold float64) int { + title := str.SanitizeFieldForSorting(mf.Title) + artist := str.SanitizeFieldForSortingNoArticle(mf.Artist) + album := str.SanitizeFieldForSorting(mf.Album) + + // Level 5: Title + Artist MBID + Album MBID (most specific) + if q.artistMBID != "" && q.albumMBID != "" && + mf.MbzArtistID == q.artistMBID && mf.MbzAlbumID == q.albumMBID { + return 5 + } + // Level 4: Title + Artist MBID + Album name (fuzzy) + if q.artistMBID != "" && q.album != "" && + mf.MbzArtistID == q.artistMBID && similarityRatio(album, q.album) >= albumThreshold { + return 4 + } + // Level 3: Title + Artist name + Album name (fuzzy) + if q.artist != "" && q.album != "" && + artist == q.artist && similarityRatio(album, q.album) >= albumThreshold { + return 3 + } + // Level 2: Title + Artist MBID + if q.artistMBID != "" && mf.MbzArtistID == q.artistMBID { + return 2 + } + // Level 1: Title + Artist name + if q.artist != "" && artist == q.artist { + return 1 + } + // Level 0: Title only match (but for fuzzy, title matched via similarity) + // Check if at least the title matches exactly + if title == q.title { + return 0 + } + return -1 // No exact title match, but could still be a fuzzy match +} + +// loadTracksByTitleAndArtist loads tracks matching by title with optional artist/album filtering. +// Uses a unified scoring approach that combines title similarity (Jaro-Winkler) with +// metadata specificity (MBIDs, album names) for both exact and fuzzy matches. +// Returns a map keyed by "title|artist" for compatibility with selectBestMatchingSongs. +func (e *provider) loadTracksByTitleAndArtist(ctx context.Context, songs []agents.Song, priorMatches ...map[string]model.MediaFile) (map[string]model.MediaFile, error) { + queries := e.buildTitleQueries(songs, priorMatches...) + if len(queries) == 0 { + return map[string]model.MediaFile{}, nil + } + + threshold := float64(conf.Server.SimilarSongsMatchThreshold) / 100.0 + + // Group queries by artist for efficient DB access + byArtist := map[string][]songQuery{} + for _, q := range queries { + if q.artist != "" { + byArtist[q.artist] = append(byArtist[q.artist], q) + } + } + + matches := map[string]model.MediaFile{} + for artist, artistQueries := range byArtist { + // Single DB query per artist - get all their tracks + tracks, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"order_artist_name": artist}, + squirrel.Eq{"missing": false}, + }, + Sort: "starred desc, rating desc, year asc, compilation asc", + }) + if err != nil { + continue + } + + // Find best match for each query using unified scoring + for _, q := range artistQueries { + if mf, found := e.findBestMatch(q, tracks, threshold); found { + key := q.title + "|" + q.artist + if _, exists := matches[key]; !exists { + matches[key] = mf + } + } + } + } + return matches, nil +} + +// durationProximity returns a score from 0.0 to 1.0 indicating how close +// the track's duration is to the target. A perfect match returns 1.0, and the +// score decreases as the difference grows (using 1 / (1 + diff)). Returns 1.0 +// if durationMs is 0 (unknown), so duration does not influence scoring. +func durationProximity(durationMs uint32, mediaFileDurationSec float32) float64 { + if durationMs <= 0 { + return 1.0 // Unknown duration — don't penalise + } + durationSec := float64(durationMs) / 1000.0 + diff := math.Abs(durationSec - float64(mediaFileDurationSec)) + return 1.0 / (1.0 + diff) +} + +// findBestMatch finds the best matching track using combined title/album similarity and specificity scoring. +// A track must meet the threshold for title similarity, then the best match is chosen by: +// 1. Highest title similarity +// 2. Duration proximity (closer duration = higher score, 1.0 if unknown) +// 3. Highest specificity level +// 4. Highest album similarity (as final tiebreaker) +func (e *provider) findBestMatch(q songQuery, tracks model.MediaFiles, threshold float64) (model.MediaFile, bool) { + var bestMatch model.MediaFile + bestScore := matchScore{titleSimilarity: -1} + found := false + + for _, mf := range tracks { + trackTitle := str.SanitizeFieldForSorting(mf.Title) + titleSim := similarityRatio(q.title, trackTitle) + + if titleSim < threshold { + continue + } + + // Compute album similarity for tiebreaking (0.0 if no album in query) + var albumSim float64 + if q.album != "" { + trackAlbum := str.SanitizeFieldForSorting(mf.Album) + albumSim = similarityRatio(q.album, trackAlbum) + } + + score := matchScore{ + titleSimilarity: titleSim, + durationProximity: durationProximity(q.durationMs, mf.Duration), + albumSimilarity: albumSim, + specificityLevel: computeSpecificityLevel(q, mf, threshold), + } + + if score.betterThan(bestScore) { + bestScore = score + bestMatch = mf + found = true + } + } + return bestMatch, found +} + +// buildTitleQueries converts agent songs into normalized songQuery structs for title+artist matching. +// It skips songs that have already been matched in prior phases (by ID, MBID, or ISRC) and sanitizes +// all string fields for consistent comparison (lowercase, diacritics removed, articles stripped from artist names). +func (e *provider) buildTitleQueries(songs []agents.Song, priorMatches ...map[string]model.MediaFile) []songQuery { + var queries []songQuery + for _, s := range songs { + if songMatchedIn(s, priorMatches...) { + continue + } + queries = append(queries, songQuery{ + title: str.SanitizeFieldForSorting(s.Name), + artist: str.SanitizeFieldForSortingNoArticle(s.Artist), + artistMBID: s.ArtistMBID, + album: str.SanitizeFieldForSorting(s.Album), + albumMBID: s.AlbumMBID, + durationMs: s.Duration, + }) + } + return queries +} + +// selectBestMatchingSongs assembles the final result by mapping input songs to their best matching +// library tracks. It iterates through the input songs in order and selects the first available match +// using priority order: ID > MBID > ISRC > title+artist. +// +// The function also handles deduplication: when multiple different input songs would match the same +// library track (e.g., "Song (Live)" and "Song (Remastered)" both matching "Song (Live)" in the library), +// only the first match is kept. However, if the same input song appears multiple times (intentional +// repetition), duplicates are preserved in the output. +// +// Returns up to 'count' MediaFiles, preserving the input order. Songs that cannot be matched are skipped. +func (e *provider) selectBestMatchingSongs(songs []agents.Song, byID, byMBID, byISRC, byTitleArtist map[string]model.MediaFile, count int) model.MediaFiles { + mfs := make(model.MediaFiles, 0, len(songs)) + // Track MediaFile.ID -> input song that added it, for deduplication + addedBy := make(map[string]agents.Song, len(songs)) + + for _, t := range songs { + if len(mfs) == count { + break + } + + mf, found := findMatchingTrack(t, byID, byMBID, byISRC, byTitleArtist) + if !found { + continue + } + + // Check for duplicate library track + if prevSong, alreadyAdded := addedBy[mf.ID]; alreadyAdded { + // Only add duplicate if input songs are identical + if t != prevSong { + continue // Different input songs → skip mismatch-induced duplicate + } + } else { + addedBy[mf.ID] = t + } + + mfs = append(mfs, mf) + } + return mfs +} + +// findMatchingTrack looks up a song in the match maps using priority order: ID > MBID > ISRC > title+artist. +// Returns the matched MediaFile and true if found, or an empty MediaFile and false if no match exists. +func findMatchingTrack(t agents.Song, byID, byMBID, byISRC, byTitleArtist map[string]model.MediaFile) (model.MediaFile, bool) { + // Try identifier-based matches first (ID, MBID, ISRC) + if mf, found := lookupByIdentifiers(t, byID, byMBID, byISRC); found { + return mf, true + } + // Fall back to title+artist fuzzy match + key := str.SanitizeFieldForSorting(t.Name) + "|" + str.SanitizeFieldForSortingNoArticle(t.Artist) + if mf, ok := byTitleArtist[key]; ok { + return mf, true + } + return model.MediaFile{}, false +} + +// similarityRatio calculates the similarity between two strings using Jaro-Winkler algorithm. +// Returns a value between 0.0 (completely different) and 1.0 (identical). +// Jaro-Winkler is well-suited for matching song titles because it gives higher scores +// when strings share a common prefix (e.g., "Song Title" vs "Song Title - Remastered"). +func similarityRatio(a, b string) float64 { + if a == b { + return 1.0 + } + if len(a) == 0 || len(b) == 0 { + return 0.0 + } + // JaroWinkler params: boostThreshold=0.7, prefixSize=4 + return smetrics.JaroWinkler(a, b, 0.7, 4) +} diff --git a/core/external/provider_matching_internal_test.go b/core/external/provider_matching_internal_test.go new file mode 100644 index 000000000..5b9ccea3b --- /dev/null +++ b/core/external/provider_matching_internal_test.go @@ -0,0 +1,57 @@ +package external + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("similarityRatio", func() { + It("returns 1.0 for identical strings", func() { + Expect(similarityRatio("hello", "hello")).To(BeNumerically("==", 1.0)) + }) + + It("returns 0.0 for empty strings", func() { + Expect(similarityRatio("", "test")).To(BeNumerically("==", 0.0)) + Expect(similarityRatio("test", "")).To(BeNumerically("==", 0.0)) + }) + + It("returns high similarity for remastered suffix", func() { + // Jaro-Winkler gives ~0.92 for this case + ratio := similarityRatio("paranoid android", "paranoid android remastered") + Expect(ratio).To(BeNumerically(">=", 0.85)) + }) + + It("returns high similarity for suffix additions like (Live)", func() { + // Jaro-Winkler gives ~0.96 for this case + ratio := similarityRatio("bohemian rhapsody", "bohemian rhapsody live") + Expect(ratio).To(BeNumerically(">=", 0.90)) + }) + + It("returns high similarity for 'yesterday' variants (common prefix)", func() { + // Jaro-Winkler gives ~0.90 because of common prefix + ratio := similarityRatio("yesterday", "yesterday once more") + Expect(ratio).To(BeNumerically(">=", 0.85)) + }) + + It("returns low similarity for same suffix", func() { + // Jaro-Winkler gives ~0.70 for this case + ratio := similarityRatio("postman (live)", "taxman (live)") + Expect(ratio).To(BeNumerically("<", 0.85)) + }) + + It("handles unicode characters", func() { + ratio := similarityRatio("dont stop believin", "don't stop believin'") + Expect(ratio).To(BeNumerically(">=", 0.85)) + }) + + It("returns low similarity for completely different strings", func() { + ratio := similarityRatio("abc", "xyz") + Expect(ratio).To(BeNumerically("<", 0.5)) + }) + + It("is symmetric", func() { + ratio1 := similarityRatio("hello world", "hello") + ratio2 := similarityRatio("hello", "hello world") + Expect(ratio1).To(Equal(ratio2)) + }) +}) diff --git a/core/external/provider_matching_test.go b/core/external/provider_matching_test.go new file mode 100644 index 000000000..b3624ef3a --- /dev/null +++ b/core/external/provider_matching_test.go @@ -0,0 +1,762 @@ +package external_test + +import ( + "context" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/agents" + . "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/stretchr/testify/mock" +) + +var _ = Describe("Provider - Song Matching", func() { + var ds model.DataStore + var provider Provider + var agentsCombined *mockAgents + var artistRepo *mockArtistRepo + var mediaFileRepo *mockMediaFileRepo + var albumRepo *mockAlbumRepo + var ctx context.Context + + BeforeEach(func() { + ctx = GinkgoT().Context() + + artistRepo = newMockArtistRepo() + mediaFileRepo = newMockMediaFileRepo() + albumRepo = newMockAlbumRepo() + + ds = &tests.MockDataStore{ + MockedArtist: artistRepo, + MockedMediaFile: mediaFileRepo, + MockedAlbum: albumRepo, + } + + agentsCombined = &mockAgents{} + provider = NewProvider(ds, agentsCombined) + }) + + // Shared helper for tests that only need artist track queries (no ID/MBID matching) + setupSimilarSongsExpectations := func(returnedSongs []agents.Song, artistTracks model.MediaFiles) { + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything). + Return(returnedSongs, nil).Once() + + // loadTracksByTitleAndArtist - queries by artist name + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 2 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasArtist := eq["order_artist_name"] + return hasArtist + })).Return(artistTracks, nil).Maybe() + } + + Describe("matchSongsToLibrary priority matching", func() { + var track model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + // Disable fuzzy matching for these tests to avoid unexpected GetAll calls + conf.Server.SimilarSongsMatchThreshold = 100 + + track = model.MediaFile{ID: "track-1", Title: "Test Track", Artist: "Test Artist", MbzRecordingID: ""} + + // Setup for GetEntityByID to return the track + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + }) + + setupExpectations := func(returnedSongs []agents.Song, idMatches, mbidMatches, artistTracks model.MediaFiles) { + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything). + Return(returnedSongs, nil).Once() + + // loadTracksByID + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(idMatches, nil).Once() + + // loadTracksByMBID + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasMBID := eq["mbz_recording_id"] + return hasMBID + })).Return(mbidMatches, nil).Once() + + // loadTracksByTitleAndArtist - now queries by artist name + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 2 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasArtist := eq["order_artist_name"] + return hasArtist + })).Return(artistTracks, nil).Maybe() + } + + Context("when agent returns artist and album metadata", func() { + It("matches by title + artist MBID + album MBID (highest priority)", func() { + // Song in library with all MBIDs + correctMatch := model.MediaFile{ + ID: "correct-match", Title: "Similar Song", Artist: "Depeche Mode", Album: "Violator", + MbzArtistID: "artist-mbid-123", MbzAlbumID: "album-mbid-456", + } + // Another song with same title but different MBIDs (should NOT match) + wrongMatch := model.MediaFile{ + ID: "wrong-match", Title: "Similar Song", Artist: "Depeche Mode", Album: "Some Other Album", + MbzArtistID: "artist-mbid-123", MbzAlbumID: "different-album-mbid", + } + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Depeche Mode", ArtistMBID: "artist-mbid-123", Album: "Violator", AlbumMBID: "album-mbid-456"}, + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct-match")) + }) + + It("matches by title + artist name + album name when MBIDs unavailable", func() { + // Song in library without MBIDs but with matching artist/album names + correctMatch := model.MediaFile{ + ID: "correct-match", Title: "Similar Song", Artist: "depeche mode", Album: "violator", + } + // Another song with same title but different artist (should NOT match) + wrongMatch := model.MediaFile{ + ID: "wrong-match", Title: "Similar Song", Artist: "Other Artist", Album: "Other Album", + } + + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Depeche Mode", Album: "Violator"}, // No MBIDs + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct-match")) + }) + + It("matches by title + artist only when album info unavailable", func() { + // Song in library with matching artist + correctMatch := model.MediaFile{ + ID: "correct-match", Title: "Similar Song", Artist: "depeche mode", Album: "Some Album", + } + // Another song with same title but different artist + wrongMatch := model.MediaFile{ + ID: "wrong-match", Title: "Similar Song", Artist: "Other Artist", Album: "Other Album", + } + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Depeche Mode"}, // No album info + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct-match")) + }) + + It("does not match songs without artist info", func() { + // Songs without artist info cannot be matched since we query by artist + returnedSongs := []agents.Song{ + {Name: "Similar Song"}, // No artist/album info at all + } + + // No artist to query, so no GetAll calls for title matching + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(BeEmpty()) + }) + }) + + Context("when matching multiple songs with the same title but different artists", func() { + It("returns distinct matches for each artist's version (covers scenario)", func() { + // Multiple covers of the same song by different artists + cover1 := model.MediaFile{ + ID: "cover-1", Title: "Yesterday", Artist: "The Beatles", Album: "Help!", + } + cover2 := model.MediaFile{ + ID: "cover-2", Title: "Yesterday", Artist: "Ray Charles", Album: "Greatest Hits", + } + cover3 := model.MediaFile{ + ID: "cover-3", Title: "Yesterday", Artist: "Frank Sinatra", Album: "My Way", + } + + returnedSongs := []agents.Song{ + {Name: "Yesterday", Artist: "The Beatles", Album: "Help!"}, + {Name: "Yesterday", Artist: "Ray Charles", Album: "Greatest Hits"}, + {Name: "Yesterday", Artist: "Frank Sinatra", Album: "My Way"}, + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{cover1, cover2, cover3}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // All three covers should be returned, not just the first one + Expect(songs).To(HaveLen(3)) + // Verify all three different versions are included + ids := []string{songs[0].ID, songs[1].ID, songs[2].ID} + Expect(ids).To(ContainElements("cover-1", "cover-2", "cover-3")) + }) + }) + + Context("when matching multiple songs with different precision levels", func() { + It("prefers more precise matches for each song", func() { + // Library has multiple versions of same song + preciseMatch := model.MediaFile{ + ID: "precise", Title: "Song A", Artist: "Artist One", Album: "Album One", + MbzArtistID: "mbid-1", MbzAlbumID: "album-mbid-1", + } + lessAccurateMatch := model.MediaFile{ + ID: "less-accurate", Title: "Song A", Artist: "Artist One", Album: "Compilation", + MbzArtistID: "mbid-1", + } + artistTwoMatch := model.MediaFile{ + ID: "artist-two", Title: "Song B", Artist: "Artist Two", + } + + returnedSongs := []agents.Song{ + {Name: "Song A", Artist: "Artist One", ArtistMBID: "mbid-1", Album: "Album One", AlbumMBID: "album-mbid-1"}, + {Name: "Song B", Artist: "Artist Two"}, // Different artist + } + + setupExpectations(returnedSongs, model.MediaFiles{}, model.MediaFiles{}, model.MediaFiles{lessAccurateMatch, preciseMatch, artistTwoMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(2)) + // First song should be the precise match (has all MBIDs) + Expect(songs[0].ID).To(Equal("precise")) + // Second song matches by title + artist + Expect(songs[1].ID).To(Equal("artist-two")) + }) + }) + }) + + Describe("Fuzzy matching fallback", func() { + var track model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + track = model.MediaFile{ID: "track-1", Title: "Test Track", Artist: "Test Artist"} + + // Setup for GetEntityByID to return the track + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + }) + + Context("with default threshold (85%)", func() { + It("matches songs with remastered suffix", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + // Agent returns "Paranoid Android" but library has "Paranoid Android - Remastered" + returnedSongs := []agents.Song{ + {Name: "Paranoid Android", Artist: "Radiohead"}, + } + // Artist catalog has the remastered version (fuzzy match will find it) + artistTracks := model.MediaFiles{ + {ID: "remastered", Title: "Paranoid Android - Remastered", Artist: "Radiohead"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("remastered")) + }) + + It("matches songs with live suffix", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + returnedSongs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen"}, + } + artistTracks := model.MediaFiles{ + {ID: "live", Title: "Bohemian Rhapsody (Live)", Artist: "Queen"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("live")) + }) + + It("does not match completely different songs", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + returnedSongs := []agents.Song{ + {Name: "Yesterday", Artist: "The Beatles"}, + } + // Artist catalog has completely different songs + artistTracks := model.MediaFiles{ + {ID: "different", Title: "Tomorrow Never Knows", Artist: "The Beatles"}, + {ID: "different2", Title: "Here Comes The Sun", Artist: "The Beatles"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(BeEmpty()) + }) + }) + + Context("with threshold set to 100 (exact match only)", func() { + It("only matches exact titles", func() { + conf.Server.SimilarSongsMatchThreshold = 100 + + returnedSongs := []agents.Song{ + {Name: "Paranoid Android", Artist: "Radiohead"}, + } + // Artist catalog has only remastered version - no exact match + artistTracks := model.MediaFiles{ + {ID: "remastered", Title: "Paranoid Android - Remastered", Artist: "Radiohead"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(BeEmpty()) + }) + }) + + Context("with lower threshold (75%)", func() { + It("matches more aggressively", func() { + conf.Server.SimilarSongsMatchThreshold = 75 + + returnedSongs := []agents.Song{ + {Name: "Song", Artist: "Artist"}, + } + artistTracks := model.MediaFiles{ + {ID: "extended", Title: "Song (Extended Mix)", Artist: "Artist"}, + } + + setupSimilarSongsExpectations(returnedSongs, artistTracks) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("extended")) + }) + }) + + Context("with fuzzy album matching", func() { + It("matches album with (Remaster) suffix", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + // Agent returns "A Night at the Opera" but library has remastered version + returnedSongs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera"}, + } + // Library has same album with remaster suffix + correctMatch := model.MediaFile{ + ID: "correct", Title: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera (2011 Remaster)", + } + wrongMatch := model.MediaFile{ + ID: "wrong", Title: "Bohemian Rhapsody", Artist: "Queen", Album: "Greatest Hits", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + // Should prefer the fuzzy album match (Level 3) over title+artist only (Level 1) + Expect(songs[0].ID).To(Equal("correct")) + }) + + It("matches album with (Deluxe Edition) suffix", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + returnedSongs := []agents.Song{ + {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, + } + correctMatch := model.MediaFile{ + ID: "correct", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator (Deluxe Edition)", + } + wrongMatch := model.MediaFile{ + ID: "wrong", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "101", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{wrongMatch, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct")) + }) + + It("prefers exact album match over fuzzy album match", func() { + conf.Server.SimilarSongsMatchThreshold = 85 + + returnedSongs := []agents.Song{ + {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, + } + exactMatch := model.MediaFile{ + ID: "exact", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator", + } + fuzzyMatch := model.MediaFile{ + ID: "fuzzy", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator (Deluxe Edition)", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{fuzzyMatch, exactMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + // Both have same title similarity (1.0), so should prefer exact album match (higher specificity via higher album similarity) + Expect(songs[0].ID).To(Equal("exact")) + }) + }) + }) + + Describe("Duration matching", func() { + var track model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.SimilarSongsMatchThreshold = 100 // Exact title match for predictable tests + + track = model.MediaFile{ID: "track-1", Title: "Test Track", Artist: "Test Artist"} + + // Setup for GetEntityByID to return the track + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + }) + + Context("when agent provides duration", func() { + It("prefers tracks with matching duration", func() { + // Agent returns song with duration 180000ms (180 seconds) + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library has two versions: one matching duration, one not + correctMatch := model.MediaFile{ + ID: "correct", Title: "Similar Song", Artist: "Test Artist", Duration: 180.0, + } + wrongDuration := model.MediaFile{ + ID: "wrong", Title: "Similar Song", Artist: "Test Artist", Duration: 240.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{wrongDuration, correctMatch}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct")) + }) + + It("matches tracks with close duration", func() { + // Agent returns song with duration 180000ms (180 seconds) + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library has track with 182.5 seconds (close to target) + closeDuration := model.MediaFile{ + ID: "close-duration", Title: "Similar Song", Artist: "Test Artist", Duration: 182.5, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{closeDuration}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("close-duration")) + }) + + It("prefers closer duration over farther duration", func() { + // Agent returns song with duration 180000ms (180 seconds) + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library has one close, one far + closeDuration := model.MediaFile{ + ID: "close", Title: "Similar Song", Artist: "Test Artist", Duration: 181.0, + } + farDuration := model.MediaFile{ + ID: "far", Title: "Similar Song", Artist: "Test Artist", Duration: 190.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{farDuration, closeDuration}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("close")) + }) + + It("still matches when no tracks have matching duration", func() { + // Agent returns song with duration 180000ms + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library only has tracks with very different duration + differentDuration := model.MediaFile{ + ID: "different", Title: "Similar Song", Artist: "Test Artist", Duration: 300.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{differentDuration}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Duration mismatch doesn't exclude the track; it's just scored lower + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("different")) + }) + + It("prefers title match over duration match when titles differ", func() { + // Agent returns "Similar Song" with duration 180000ms + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + // Library has: + // - differentTitle: matches duration but has different title (won't pass title threshold) + // - correctTitle: doesn't match duration but has correct title (wins on title similarity) + differentTitle := model.MediaFile{ + ID: "wrong-title", Title: "Different Song", Artist: "Test Artist", Duration: 180.0, + } + correctTitle := model.MediaFile{ + ID: "correct-title", Title: "Similar Song", Artist: "Test Artist", Duration: 300.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{differentTitle, correctTitle}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Title similarity is the top priority, so the correct title wins despite duration mismatch + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("correct-title")) + }) + }) + + Context("when agent does not provide duration", func() { + It("matches without duration filtering (duration=0)", func() { + // Agent returns song without duration + returnedSongs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 0}, + } + // Library tracks with various durations should all be candidates + anyTrack := model.MediaFile{ + ID: "any", Title: "Similar Song", Artist: "Test Artist", Duration: 999.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{anyTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("any")) + }) + }) + + Context("edge cases", func() { + It("handles very short songs with close duration", func() { + // 30-second song with 1-second difference + returnedSongs := []agents.Song{ + {Name: "Short Song", Artist: "Test Artist", Duration: 30000}, + } + shortTrack := model.MediaFile{ + ID: "short", Title: "Short Song", Artist: "Test Artist", Duration: 31.0, + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{shortTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("short")) + }) + }) + }) + + Describe("Deduplication of mismatched songs", func() { + var track model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.SimilarSongsMatchThreshold = 85 // Allow fuzzy matching + + track = model.MediaFile{ID: "track-1", Title: "Test Track", Artist: "Test Artist"} + + // Setup for GetEntityByID to return the track + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + }) + + It("removes duplicates when different input songs match the same library track", func() { + // Agent returns two different versions that will both fuzzy-match to the same library track + returnedSongs := []agents.Song{ + {Name: "Bohemian Rhapsody (Live)", Artist: "Queen"}, + {Name: "Bohemian Rhapsody (Original Mix)", Artist: "Queen"}, + } + // Library only has one version + libraryTrack := model.MediaFile{ + ID: "br-live", Title: "Bohemian Rhapsody (Live)", Artist: "Queen", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{libraryTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Should only return one track, not two duplicates + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("br-live")) + }) + + It("preserves duplicates when identical input songs match the same library track", func() { + // Agent returns the exact same song twice (intentional repetition) + returnedSongs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera"}, + {Name: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera"}, + } + // Library has matching track + libraryTrack := model.MediaFile{ + ID: "br", Title: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{libraryTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Should return two tracks since input songs were identical + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("br")) + Expect(songs[1].ID).To(Equal("br")) + }) + + It("handles mixed scenario with both identical and different input songs", func() { + // Agent returns: Song A, Song B (different from A), Song A again (same as first) + // All three match to the same library track + returnedSongs := []agents.Song{ + {Name: "Yesterday", Artist: "The Beatles", Album: "Help!"}, + {Name: "Yesterday (Remastered)", Artist: "The Beatles", Album: "1"}, // Different version + {Name: "Yesterday", Artist: "The Beatles", Album: "Help!"}, // Same as first + {Name: "Yesterday (Anthology)", Artist: "The Beatles", Album: "Anthology"}, // Another different version + } + // Library only has one version + libraryTrack := model.MediaFile{ + ID: "yesterday", Title: "Yesterday", Artist: "The Beatles", Album: "Help!", + } + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{libraryTrack}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // Should return 2 tracks: + // 1. First "Yesterday" (original) + // 2. Third "Yesterday" (same as first, so kept) + // Skip: Second "Yesterday (Remastered)" (different input, same library track) + // Skip: Fourth "Yesterday (Anthology)" (different input, same library track) + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("yesterday")) + Expect(songs[1].ID).To(Equal("yesterday")) + }) + + It("does not deduplicate songs that match different library tracks", func() { + // Agent returns different songs that match different library tracks + returnedSongs := []agents.Song{ + {Name: "Song A", Artist: "Artist"}, + {Name: "Song B", Artist: "Artist"}, + {Name: "Song C", Artist: "Artist"}, + } + // Library has all three songs + trackA := model.MediaFile{ID: "track-a", Title: "Song A", Artist: "Artist"} + trackB := model.MediaFile{ID: "track-b", Title: "Song B", Artist: "Artist"} + trackC := model.MediaFile{ID: "track-c", Title: "Song C", Artist: "Artist"} + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{trackA, trackB, trackC}) + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + // All three should be returned since they match different library tracks + Expect(songs).To(HaveLen(3)) + Expect(songs[0].ID).To(Equal("track-a")) + Expect(songs[1].ID).To(Equal("track-b")) + Expect(songs[2].ID).To(Equal("track-c")) + }) + + It("respects count limit after deduplication", func() { + // Agent returns 4 songs: 2 unique + 2 that would create duplicates + returnedSongs := []agents.Song{ + {Name: "Song A", Artist: "Artist"}, + {Name: "Song A (Live)", Artist: "Artist"}, // Different, matches same track + {Name: "Song B", Artist: "Artist"}, + {Name: "Song B (Remix)", Artist: "Artist"}, // Different, matches same track + } + trackA := model.MediaFile{ID: "track-a", Title: "Song A", Artist: "Artist"} + trackB := model.MediaFile{ID: "track-b", Title: "Song B", Artist: "Artist"} + + setupSimilarSongsExpectations(returnedSongs, model.MediaFiles{trackA, trackB}) + + // Request only 2 songs + songs, err := provider.SimilarSongs(ctx, "track-1", 2) + + Expect(err).ToNot(HaveOccurred()) + // Should return exactly 2: Song A and Song B (skipping duplicates) + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("track-a")) + Expect(songs[1].ID).To(Equal("track-b")) + }) + }) +}) diff --git a/core/external/provider_similarsongs_test.go b/core/external/provider_similarsongs_test.go new file mode 100644 index 000000000..1491d394e --- /dev/null +++ b/core/external/provider_similarsongs_test.go @@ -0,0 +1,443 @@ +package external_test + +import ( + "context" + "errors" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/core/agents" + . "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/stretchr/testify/mock" +) + +var _ = Describe("Provider - SimilarSongs", func() { + var ds model.DataStore + var provider Provider + var mockAgent *mockSimilarArtistAgent + var mockTopAgent agents.ArtistTopSongsRetriever + var mockSimilarAgent agents.ArtistSimilarRetriever + var agentsCombined *mockAgents + var artistRepo *mockArtistRepo + var mediaFileRepo *mockMediaFileRepo + var albumRepo *mockAlbumRepo + var ctx context.Context + + BeforeEach(func() { + ctx = GinkgoT().Context() + + artistRepo = newMockArtistRepo() + mediaFileRepo = newMockMediaFileRepo() + albumRepo = newMockAlbumRepo() + + ds = &tests.MockDataStore{ + MockedArtist: artistRepo, + MockedMediaFile: mediaFileRepo, + MockedAlbum: albumRepo, + } + + mockAgent = &mockSimilarArtistAgent{} + mockTopAgent = mockAgent + mockSimilarAgent = mockAgent + + agentsCombined = &mockAgents{ + topSongsAgent: mockTopAgent, + similarAgent: mockSimilarAgent, + } + + provider = NewProvider(ds, agentsCombined) + }) + + Describe("dispatch by entity type", func() { + Context("when ID is a MediaFile (track)", func() { + It("calls GetSimilarSongsByTrack and returns matched songs", func() { + track := model.MediaFile{ID: "track-1", Title: "Just Can't Get Enough", Artist: "Depeche Mode", MbzRecordingID: "track-mbid"} + matchedSong := model.MediaFile{ID: "matched-1", Title: "Dreaming of Me", Artist: "Depeche Mode"} + + // GetEntityByID tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, "track-1", "Just Can't Get Enough", "Depeche Mode", "track-mbid", 5). + Return([]agents.Song{ + {Name: "Dreaming of Me", MBID: "", Artist: "Depeche Mode", ArtistMBID: "artist-mbid"}, + }, nil).Once() + + // Mock loadTracksByID - no ID matches + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(model.MediaFiles{}, nil).Once() + + // Mock loadTracksByMBID - no MBID matches (empty MBID means this won't be called) + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasMBID := eq["mbz_recording_id"] + return hasMBID + })).Return(model.MediaFiles{}, nil).Maybe() + + // Mock loadTracksByTitleAndArtist - queries by artist name + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 2 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasArtist := eq["order_artist_name"] + return hasArtist + })).Return(model.MediaFiles{matchedSong}, nil).Maybe() + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("matched-1")) + }) + + It("falls back to artist-based algorithm when GetSimilarSongsByTrack returns empty", func() { + track := model.MediaFile{ID: "track-1", Title: "Track", Artist: "Artist", ArtistID: "artist-1"} + artist := model.Artist{ID: "artist-1", Name: "Artist"} + song := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + + // GetEntityByID for the initial call tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, "track-1", "Track", "Artist", "", mock.Anything). + Return([]agents.Song{}, nil).Once() + + // Fallback calls getArtist(id) which calls GetEntityByID again - this time it finds the mediafile + // and recursively calls getArtist(v.ArtistID) + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + + // Then it recurses with the artist-1 ID + artistRepo.On("Get", "artist-1").Return(&artist, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist}, nil).Maybe() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist", "", mock.Anything). + Return([]agents.Song{{Name: "Song One", MBID: "mbid-1"}}, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + }) + }) + + Context("when ID is an Album", func() { + It("calls GetSimilarSongsByAlbum and returns matched songs", func() { + album := model.Album{ID: "album-1", Name: "Speak & Spell", AlbumArtist: "Depeche Mode", MbzAlbumID: "album-mbid"} + matchedSong := model.MediaFile{ID: "matched-1", Title: "New Life", Artist: "Depeche Mode", MbzRecordingID: "song-mbid"} + + // GetEntityByID tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "album-1").Return(&album, nil).Once() + + agentsCombined.On("GetSimilarSongsByAlbum", mock.Anything, "album-1", "Speak & Spell", "Depeche Mode", "album-mbid", 5). + Return([]agents.Song{ + {Name: "New Life", MBID: "song-mbid", Artist: "Depeche Mode"}, + }, nil).Once() + + // Mock loadTracksByID - no ID matches + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(model.MediaFiles{}, nil).Once() + + // Mock loadTracksByMBID - MBID match + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + _, hasEq := and[0].(squirrel.Eq) + return hasEq + })).Return(model.MediaFiles{matchedSong}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "album-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("matched-1")) + }) + + It("falls back when GetSimilarSongsByAlbum returns ErrNotFound", func() { + album := model.Album{ID: "album-1", Name: "Album", AlbumArtist: "Artist", AlbumArtistID: "artist-1"} + artist := model.Artist{ID: "artist-1", Name: "Artist"} + song := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + + // GetEntityByID for the initial call tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "album-1").Return(&album, nil).Once() + + agentsCombined.On("GetSimilarSongsByAlbum", mock.Anything, "album-1", "Album", "Artist", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + // Fallback calls getArtist(id) which calls GetEntityByID again - this time it finds the album + // and recursively calls getArtist(v.AlbumArtistID) + artistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "album-1").Return(&album, nil).Once() + + // Then it recurses with the artist-1 ID + artistRepo.On("Get", "artist-1").Return(&artist, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist}, nil).Maybe() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist", "", mock.Anything). + Return([]agents.Song{{Name: "Song One", MBID: "mbid-1"}}, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "album-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + }) + }) + + Context("when ID is an Artist", func() { + It("calls GetSimilarSongsByArtist and returns matched songs", func() { + artist := model.Artist{ID: "artist-1", Name: "Depeche Mode", MbzArtistID: "artist-mbid"} + matchedSong := model.MediaFile{ID: "matched-1", Title: "Enjoy the Silence", Artist: "Depeche Mode", MbzRecordingID: "song-mbid"} + + artistRepo.On("Get", "artist-1").Return(&artist, nil).Once() + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Depeche Mode", "artist-mbid", 5). + Return([]agents.Song{ + {Name: "Enjoy the Silence", MBID: "song-mbid", Artist: "Depeche Mode"}, + }, nil).Once() + + // Mock loadTracksByID - no ID matches + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(model.MediaFiles{}, nil).Once() + + // Mock loadTracksByMBID - MBID match + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + _, hasEq := and[0].(squirrel.Eq) + return hasEq + })).Return(model.MediaFiles{matchedSong}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("matched-1")) + }) + }) + }) + + It("returns similar songs from main artist and similar artists", func() { + artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} + similarArtist := model.Artist{ID: "artist-3", Name: "Similar Artist"} + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} + song3 := model.MediaFile{ID: "song-3", Title: "Song Three", ArtistID: "artist-3", MbzRecordingID: "mbid-3"} + + artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() + artistRepo.On("Get", "artist-3").Return(&similarArtist, nil).Maybe() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist1}, nil).Once() + + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + similarAgentsResp := []agents.Artist{ + {Name: "Similar Artist", MBID: "similar-mbid"}, + } + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). + Return(similarAgentsResp, nil).Once() + + // Mock the three-phase artist lookup: ID (skipped - no IDs), MBID, then Name + // MBID lookup returns empty (no match) + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return opt.Max == 0 && ok + })).Return(model.Artists{}, nil).Once() + // Name lookup returns the similar artist + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Or) + return opt.Max == 0 && ok + })).Return(model.Artists{similarArtist}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return([]agents.Song{ + {Name: "Song One", MBID: "mbid-1"}, + {Name: "Song Two", MBID: "mbid-2"}, + }, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-3", "Similar Artist", "", mock.Anything). + Return([]agents.Song{ + {Name: "Song Three", MBID: "mbid-3"}, + }, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song3}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 3) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + for _, song := range songs { + Expect(song.ID).To(BeElementOf("song-1", "song-2", "song-3")) + } + }) + + It("returns ErrNotFound when artist is not found", func() { + artistRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) + mediaFileRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) + albumRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{}, nil).Maybe() + + songs, err := provider.SimilarSongs(ctx, "artist-unknown-artist", 5) + + Expect(err).To(Equal(model.ErrNotFound)) + Expect(songs).To(BeNil()) + }) + + It("returns songs from main artist when GetSimilarArtists returns error", func() { + artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + + artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist1}, nil).Maybe() + + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). + Return(nil, errors.New("error getting similar artists")).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return([]agents.Song{ + {Name: "Song One", MBID: "mbid-1"}, + }, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + }) + + It("returns empty list when GetArtistTopSongs returns error", func() { + artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} + + artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist1}, nil).Maybe() + + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, errors.New("error getting top songs")).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(BeEmpty()) + }) + + It("respects count parameter", func() { + artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} + + artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist1}, nil).Maybe() + + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return([]agents.Song{ + {Name: "Song One", MBID: "mbid-1"}, + {Name: "Song Two", MBID: "mbid-2"}, + }, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 1) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(BeElementOf("song-1", "song-2")) + }) +}) diff --git a/core/external/provider_topsongs_test.go b/core/external/provider_topsongs_test.go index 114a35f63..0e513aa37 100644 --- a/core/external/provider_topsongs_test.go +++ b/core/external/provider_topsongs_test.go @@ -7,6 +7,8 @@ import ( _ "github.com/navidrome/navidrome/adapters/lastfm" _ "github.com/navidrome/navidrome/adapters/listenbrainz" _ "github.com/navidrome/navidrome/adapters/spotify" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/agents" . "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/model" @@ -26,6 +28,10 @@ var _ = Describe("Provider - TopSongs", func() { ) BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + // Disable fuzzy matching for these tests to avoid unexpected GetAll calls + conf.Server.SimilarSongsMatchThreshold = 100 + ctx = GinkgoT().Context() artistRepo = newMockArtistRepo() // Use helper mock diff --git a/core/metrics/insights.go b/core/metrics/insights.go index df3ca9a42..f42e5c099 100644 --- a/core/metrics/insights.go +++ b/core/metrics/insights.go @@ -215,6 +215,7 @@ var staticData = sync.OnceValue(func() insights.Data { data.Config.BackupCount = conf.Server.Backup.Count data.Config.DevActivityPanel = conf.Server.DevActivityPanel data.Config.ScannerEnabled = conf.Server.Scanner.Enabled + data.Config.ScannerExtractor = conf.Server.Scanner.Extractor data.Config.ScanSchedule = conf.Server.Scanner.Schedule data.Config.ScanWatcherWait = uint64(math.Trunc(conf.Server.Scanner.WatcherWait.Seconds())) data.Config.ScanOnStartup = conf.Server.Scanner.ScanOnStartup diff --git a/core/metrics/insights/data.go b/core/metrics/insights/data.go index 19007fd06..99eb542a7 100644 --- a/core/metrics/insights/data.go +++ b/core/metrics/insights/data.go @@ -47,6 +47,7 @@ type Data struct { LogFileConfigured bool `json:"logFileConfigured,omitempty"` TLSConfigured bool `json:"tlsConfigured,omitempty"` ScannerEnabled bool `json:"scannerEnabled,omitempty"` + ScannerExtractor string `json:"scannerExtractor,omitempty"` ScanSchedule string `json:"scanSchedule,omitempty"` ScanWatcherWait uint64 `json:"scanWatcherWait,omitempty"` ScanOnStartup bool `json:"scanOnStartup,omitempty"` diff --git a/core/playlists.go b/core/playlists.go index 1f98bf508..8ec5991cf 100644 --- a/core/playlists.go +++ b/core/playlists.go @@ -179,7 +179,9 @@ func (s *playlists) parseNSP(_ context.Context, pls *model.Playlist, reader io.R func (s *playlists) parseM3U(ctx context.Context, pls *model.Playlist, folder *model.Folder, reader io.Reader) error { mediaFileRepository := s.ds.MediaFile(ctx) var mfs model.MediaFiles - for lines := range slice.CollectChunks(slice.LinesFrom(reader), 400) { + // Chunk size of 100 lines, as each line can generate up to 4 lookup candidates + // (NFC/NFD × raw/lowercase), and SQLite has a max expression tree depth of 1000. + for lines := range slice.CollectChunks(slice.LinesFrom(reader), 100) { filteredLines := make([]string, 0, len(lines)) for _, line := range lines { line := strings.TrimSpace(line) @@ -206,33 +208,66 @@ func (s *playlists) parseM3U(ctx context.Context, pls *model.Playlist, folder *m continue } - // Normalize to NFD for filesystem compatibility (macOS). Database stores paths in NFD. - // See https://github.com/navidrome/navidrome/issues/4663 - resolvedPaths = slice.Map(resolvedPaths, func(path string) string { - return strings.ToLower(norm.NFD.String(path)) - }) + // SQLite comparisons do not perform Unicode normalization, and filesystem normalization + // differs across platforms (macOS often yields NFD, while Linux/Windows typically use NFC). + // Generate lookup candidates for both forms so playlist entries match DB paths regardless + // of the original normalization. See https://github.com/navidrome/navidrome/issues/4884 + // + // We also include the original (non-lowercased) paths because SQLite's COLLATE NOCASE + // only handles ASCII case-insensitivity. Non-ASCII characters like fullwidth letters + // (e.g., ＡＢＣＤ vs ａｂｃｄ) are not matched case-insensitively by NOCASE. + lookupCandidates := make([]string, 0, len(resolvedPaths)*4) + seen := make(map[string]struct{}, len(resolvedPaths)*4) + for _, path := range resolvedPaths { + // Add original paths first (for exact matching of non-ASCII characters) + nfcRaw := norm.NFC.String(path) + if _, ok := seen[nfcRaw]; !ok { + seen[nfcRaw] = struct{}{} + lookupCandidates = append(lookupCandidates, nfcRaw) + } + nfdRaw := norm.NFD.String(path) + if _, ok := seen[nfdRaw]; !ok { + seen[nfdRaw] = struct{}{} + lookupCandidates = append(lookupCandidates, nfdRaw) + } - found, err := mediaFileRepository.FindByPaths(resolvedPaths) + // Add lowercased paths (for ASCII case-insensitive matching via NOCASE) + nfc := strings.ToLower(nfcRaw) + if _, ok := seen[nfc]; !ok { + seen[nfc] = struct{}{} + lookupCandidates = append(lookupCandidates, nfc) + } + nfd := strings.ToLower(nfdRaw) + if _, ok := seen[nfd]; !ok { + seen[nfd] = struct{}{} + lookupCandidates = append(lookupCandidates, nfd) + } + } + + found, err := mediaFileRepository.FindByPaths(lookupCandidates) if err != nil { log.Warn(ctx, "Error reading files from DB", "playlist", pls.Name, err) continue } - // Build lookup map with library-qualified keys, normalized for comparison + + // Build lookup map with library-qualified keys, normalized for comparison. + // Canonicalize to NFC so NFD/NFC become comparable. existing := make(map[string]int, len(found)) for idx := range found { - // Normalize to lowercase for case-insensitive comparison - // Key format: "libraryID:path" - key := fmt.Sprintf("%d:%s", found[idx].LibraryID, strings.ToLower(found[idx].Path)) + key := fmt.Sprintf("%d:%s", found[idx].LibraryID, strings.ToLower(norm.NFC.String(found[idx].Path))) existing[key] = idx } // Find media files in the order of the resolved paths, to keep playlist order for _, path := range resolvedPaths { - idx, ok := existing[path] + key := strings.ToLower(norm.NFC.String(path)) + idx, ok := existing[key] if ok { mfs = append(mfs, found[idx]) } else { - log.Warn(ctx, "Path in playlist not found", "playlist", pls.Name, "path", path) + // Prefer logging a composed representation when possible to avoid confusing output + // with decomposed combining marks. + log.Warn(ctx, "Path in playlist not found", "playlist", pls.Name, "path", norm.NFC.String(path)) } } } @@ -394,7 +429,20 @@ func (s *playlists) resolvePaths(ctx context.Context, folder *model.Folder, line func (s *playlists) updatePlaylist(ctx context.Context, newPls *model.Playlist) error { owner, _ := request.UserFrom(ctx) + // Try to find existing playlist by path. Since filesystem normalization differs across + // platforms (macOS uses NFD, Linux/Windows use NFC), we try both forms to match + // playlists that may have been imported on a different platform. pls, err := s.ds.Playlist(ctx).FindByPath(newPls.Path) + if errors.Is(err, model.ErrNotFound) { + // Try alternate normalization form + altPath := norm.NFD.String(newPls.Path) + if altPath == newPls.Path { + altPath = norm.NFC.String(newPls.Path) + } + if altPath != newPls.Path { + pls, err = s.ds.Playlist(ctx).FindByPath(altPath) + } + } if err != nil && !errors.Is(err, model.ErrNotFound) { return err } diff --git a/core/playlists_test.go b/core/playlists_test.go index f3347ae77..7712a268e 100644 --- a/core/playlists_test.go +++ b/core/playlists_test.go @@ -135,6 +135,55 @@ var _ = Describe("Playlists", func() { }) }) + DescribeTable("Playlist filename Unicode normalization (regression fix-playlist-filename-normalization)", + func(storedForm, filesystemForm string) { + // Use Polish characters that decompose: ó (U+00F3) -> o + combining acute (U+006F + U+0301) + plsNameNFC := "Piosenki_Polskie_zółć" // NFC form (composed) + plsNameNFD := norm.NFD.String(plsNameNFC) + Expect(plsNameNFD).ToNot(Equal(plsNameNFC)) // Verify they differ + + nameByForm := map[string]string{"NFC": plsNameNFC, "NFD": plsNameNFD} + storedName := nameByForm[storedForm] + filesystemName := nameByForm[filesystemForm] + + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{}} + ps = core.NewPlaylists(ds) + + // Create the playlist file on disk with the filesystem's normalization form + plsFile := tmpDir + "/" + filesystemName + ".m3u" + Expect(os.WriteFile(plsFile, []byte("#PLAYLIST:Test\n"), 0600)).To(Succeed()) + + // Pre-populate mock repo with the stored normalization form + storedPath := tmpDir + "/" + storedName + ".m3u" + existingPls := &model.Playlist{ + ID: "existing-id", + Name: "Existing Playlist", + Path: storedPath, + Sync: true, + } + mockPlsRepo.data = map[string]*model.Playlist{storedPath: existingPls} + + // Import using the filesystem's normalization form + plsFolder := &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: tmpDir, + Path: "", + Name: "", + } + pls, err := ps.ImportFile(ctx, plsFolder, filesystemName+".m3u") + Expect(err).ToNot(HaveOccurred()) + + // Should update existing playlist, not create new one + Expect(pls.ID).To(Equal("existing-id")) + Expect(pls.Name).To(Equal("Existing Playlist")) + }, + Entry("finds NFD-stored playlist when filesystem provides NFC path", "NFD", "NFC"), + Entry("finds NFC-stored playlist when filesystem provides NFD path", "NFC", "NFD"), + ) + Describe("Cross-library relative paths", func() { var tmpDir, plsDir, songsDir string @@ -446,23 +495,79 @@ var _ = Describe("Playlists", func() { Expect(pls.Tracks[0].Path).To(Equal("abc/tEsT1.Mp3")) }) - It("handles Unicode normalization when comparing paths (NFD vs NFC)", func() { - // Simulate macOS filesystem: stores paths in NFD (decomposed) form - // "è" (U+00E8) in NFC becomes "e" + "◌̀" (U+0065 + U+0300) in NFD - nfdPath := "artist/Mich" + string([]rune{'e', '\u0300'}) + "le/song.mp3" // NFD: e + combining grave - repo.data = []string{nfdPath} - - // Simulate Apple Music M3U: uses NFC (composed) form - nfcPath := "/music/artist/Mich\u00E8le/song.mp3" // NFC: single è character - m3u := nfcPath + "\n" + // Fullwidth characters (e.g., ＡＢＣＤ) are not handled by SQLite's NOCASE collation, + // so we need exact matching for non-ASCII characters. + It("matches fullwidth characters exactly (SQLite NOCASE limitation)", func() { + // Fullwidth uppercase ＡＣＲＯＳＳ (U+FF21, U+FF23, U+FF32, U+FF2F, U+FF33, U+FF33) + repo.data = []string{ + "plex/02 - ＡＣＲＯＳＳ.flac", + } + m3u := "/music/plex/02 - ＡＣＲＯＳＳ.flac\n" f := strings.NewReader(m3u) pls, err := ps.ImportM3U(ctx, f) Expect(err).ToNot(HaveOccurred()) Expect(pls.Tracks).To(HaveLen(1)) - // Should match despite different Unicode normalization forms - Expect(pls.Tracks[0].Path).To(Equal(nfdPath)) + Expect(pls.Tracks[0].Path).To(Equal("plex/02 - ＡＣＲＯＳＳ.flac")) }) + // Unicode normalization tests: NFC (composed) vs NFD (decomposed) forms + // macOS stores paths in NFD, Linux/Windows use NFC. Playlists may use either form. + DescribeTable("matches paths across Unicode NFC/NFD normalization", + func(description, pathNFC string, dbForm, playlistForm norm.Form) { + pathNFD := norm.NFD.String(pathNFC) + Expect(pathNFD).ToNot(Equal(pathNFC), "test path should have decomposable characters") + + // Set up DB with specified normalization form + var dbPath string + if dbForm == norm.NFC { + dbPath = pathNFC + } else { + dbPath = pathNFD + } + repo.data = []string{dbPath} + + // Set up playlist with specified normalization form + var playlistPath string + if playlistForm == norm.NFC { + playlistPath = pathNFC + } else { + playlistPath = pathNFD + } + m3u := "/music/" + playlistPath + "\n" + f := strings.NewReader(m3u) + + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal(dbPath)) + }, + // French: è (U+00E8) decomposes to e + combining grave (U+0065 + U+0300) + Entry("French diacritics - DB:NFD, playlist:NFC", + "macOS DB with Apple Music playlist", + "artist/Michèle/song.mp3", norm.NFD, norm.NFC), + + // Japanese Katakana: ド (U+30C9) decomposes to ト (U+30C8) + combining dakuten (U+3099) + Entry("Japanese Katakana with dakuten - DB:NFC, playlist:NFC (#4884)", + "Linux/Windows DB with NFC playlist", + "artist/\u30a2\u30a4\u30c9\u30eb/\u30c9\u30ea\u30fc\u30e0\u30bd\u30f3\u30b0.mp3", norm.NFC, norm.NFC), + Entry("Japanese Katakana with dakuten - DB:NFD, playlist:NFC (#4884)", + "macOS DB with NFC playlist", + "artist/\u30a2\u30a4\u30c9\u30eb/\u30c9\u30ea\u30fc\u30e0\u30bd\u30f3\u30b0.mp3", norm.NFD, norm.NFC), + + // Cyrillic: й (U+0439) decomposes to и (U+0438) + combining breve (U+0306) + Entry("Cyrillic characters - DB:NFD, playlist:NFC (#4791)", + "macOS DB with NFC playlist", + "Жуки/Батарейка/01 - Разлюбила.mp3", norm.NFD, norm.NFC), + + // Polish: ó (U+00F3) decomposes to o + combining acute (U+0301) + Entry("Polish diacritics - DB:NFD, playlist:NFC (#4663)", + "macOS DB with NFC playlist", + "Zespół/Człowiek/Piosenka o miłości.mp3", norm.NFD, norm.NFC), + Entry("Polish diacritics - DB:NFC, playlist:NFD", + "Linux/Windows DB with macOS-exported playlist", + "Zespół/Człowiek/Piosenka o miłości.mp3", norm.NFC, norm.NFD), + ) + }) Describe("InPlaylistsPath", func() { @@ -563,9 +668,6 @@ func (r *mockedMediaFileFromListRepo) FindByPaths(paths []string) (model.MediaFi var mfs model.MediaFiles for idx, dataPath := range r.data { - // Normalize the data path to NFD (simulates macOS filesystem storage) - normalizedDataPath := norm.NFD.String(dataPath) - for _, requestPath := range paths { // Strip library qualifier if present (format: "libraryID:path") actualPath := requestPath @@ -577,12 +679,9 @@ func (r *mockedMediaFileFromListRepo) FindByPaths(paths []string) (model.MediaFi } } - // The request path should already be normalized to NFD by production code - // before calling FindByPaths (to match DB storage) - normalizedRequestPath := norm.NFD.String(actualPath) - - // Case-insensitive comparison (like SQL's "collate nocase") - if strings.EqualFold(normalizedRequestPath, normalizedDataPath) { + // Case-insensitive comparison (like SQL's "collate nocase"), but with no + // implicit Unicode normalization (SQLite does not normalize NFC/NFD). + if strings.EqualFold(actualPath, dataPath) { mfs = append(mfs, model.MediaFile{ ID: strconv.Itoa(idx), Path: dataPath, // Return original path from DB @@ -597,10 +696,16 @@ func (r *mockedMediaFileFromListRepo) FindByPaths(paths []string) (model.MediaFi type mockedPlaylistRepo struct { last *model.Playlist + data map[string]*model.Playlist // keyed by path model.PlaylistRepository } -func (r *mockedPlaylistRepo) FindByPath(string) (*model.Playlist, error) { +func (r *mockedPlaylistRepo) FindByPath(path string) (*model.Playlist, error) { + if r.data != nil { + if pls, ok := r.data[path]; ok { + return pls, nil + } + } return nil, model.ErrNotFound } diff --git a/model/mediafile.go b/model/mediafile.go index 1ae63e759..1d34cd76e 100644 --- a/model/mediafile.go +++ b/model/mediafile.go @@ -359,6 +359,7 @@ type MediaFileRepository interface { Get(id string) (*MediaFile, error) GetWithParticipants(id string) (*MediaFile, error) GetAll(options ...QueryOptions) (MediaFiles, error) + GetAllByTags(tag TagName, values []string, options ...QueryOptions) (MediaFiles, error) GetCursor(options ...QueryOptions) (MediaFileCursor, error) Delete(id string) error DeleteMissing(ids []string) error diff --git a/model/metadata/persistent_ids.go b/model/metadata/persistent_ids.go index b45882946..d4222441c 100644 --- a/model/metadata/persistent_ids.go +++ b/model/metadata/persistent_ids.go @@ -8,6 +8,7 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" "github.com/navidrome/navidrome/utils" @@ -26,10 +27,14 @@ type getPIDFunc = func(mf model.MediaFile, md Metadata, spec string, prependLibI func createGetPID(hash hashFunc) getPIDFunc { var getPID getPIDFunc - getAttr := func(mf model.MediaFile, md Metadata, attr string, prependLibId bool) string { + getAttr := func(mf model.MediaFile, md Metadata, attr string, prependLibId bool, spec string) string { attr = strings.TrimSpace(strings.ToLower(attr)) switch attr { case "albumid": + if spec == conf.Server.PID.Album { + log.Error("Recursive PID definition detected, ignoring `albumid`", "spec", spec) + return "" + } return getPID(mf, md, conf.Server.PID.Album, prependLibId) case "folder": return filepath.Dir(mf.Path) @@ -49,7 +54,7 @@ func createGetPID(hash hashFunc) getPIDFunc { attributes := strings.Split(field, ",") hasValue := false values := slice.Map(attributes, func(attr string) string { - v := getAttr(mf, md, attr, prependLibId) + v := getAttr(mf, md, attr, prependLibId, spec) if v != "" { hasValue = true } diff --git a/model/metadata/persistent_ids_test.go b/model/metadata/persistent_ids_test.go index 7ae0c91f7..ad81eaa53 100644 --- a/model/metadata/persistent_ids_test.go +++ b/model/metadata/persistent_ids_test.go @@ -114,6 +114,24 @@ var _ = Describe("getPID", func() { Expect(getPID(mf, md, spec, false)).To(Equal("(album name)")) }) }) + + When("albumid configuration refers to albumid recursively", func() { + It("should avoid infinite recursion", func() { + // Reproduce the issue from #4920 + conf.Server.PID.Album = "albumid,album,albumversion,releasedate" + spec := conf.Server.PID.Album + md.tags = map[model.TagName][]string{ + "album": {"Album Name"}, + "albumversion": {"Version"}, + "releasedate": {"2022"}, + } + // Should not panic and return a valid PID ignoring the recursive "albumid" + Expect(func() { + pid := getPID(mf, md, spec, false) + Expect(pid).To(Equal("(\\album name\\Version\\2022)")) + }).To(Not(Panic())) + }) + }) }) Context("edge cases", func() { diff --git a/persistence/album_repository.go b/persistence/album_repository.go index dab255784..adca058c2 100644 --- a/persistence/album_repository.go +++ b/persistence/album_repository.go @@ -119,8 +119,8 @@ var albumFilters = sync.OnceValue(func() map[string]filterFunc { "artist_id": artistFilter, "year": yearFilter, "recently_played": recentlyPlayedFilter, - "starred": booleanFilter, - "has_rating": hasRatingFilter, + "starred": annotationBoolFilter("starred"), + "has_rating": annotationBoolFilter("rating"), "missing": booleanFilter, "genre_id": tagIDFilter, "role_total_id": allRolesFilter, @@ -149,10 +149,6 @@ func recentlyPlayedFilter(string, interface{}) Sqlizer { return Gt{"play_count": 0} } -func hasRatingFilter(string, interface{}) Sqlizer { - return Gt{"rating": 0} -} - func yearFilter(_ string, value interface{}) Sqlizer { return Or{ And{ diff --git a/persistence/album_repository_test.go b/persistence/album_repository_test.go index 612e459f0..2705653ab 100644 --- a/persistence/album_repository_test.go +++ b/persistence/album_repository_test.go @@ -5,6 +5,7 @@ import ( "time" "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/model" @@ -77,6 +78,82 @@ var _ = Describe("AlbumRepository", func() { }) }) + Context("Filters", func() { + var albumWithoutAnnotation model.Album + + BeforeEach(func() { + // Create album without any annotation (no star, no rating) + albumWithoutAnnotation = model.Album{ID: "no-annotation-album", Name: "No Annotation", LibraryID: 1} + Expect(albumRepo.Put(&albumWithoutAnnotation)).To(Succeed()) + }) + + AfterEach(func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": albumWithoutAnnotation.ID})) + }) + + Describe("starred", func() { + It("false includes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Album without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + }) + + Describe("has_rating", func() { + It("false includes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"has_rating": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Album without annotation should be included in has_rating=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"has_rating": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + }) + }) + Describe("Album.PlayCount", func() { // Implementation is in withAnnotation() method DescribeTable("normalizes play count when AlbumPlayCountMode is absolute", diff --git a/persistence/artist_repository.go b/persistence/artist_repository.go index c9e38a1ee..5c34ace5d 100644 --- a/persistence/artist_repository.go +++ b/persistence/artist_repository.go @@ -133,7 +133,7 @@ func NewArtistRepository(ctx context.Context, db dbx.Builder) model.ArtistReposi r.registerModel(&model.Artist{}, map[string]filterFunc{ "id": idFilter(r.tableName), "name": fullTextFilter(r.tableName, "mbz_artist_id"), - "starred": booleanFilter, + "starred": annotationBoolFilter("starred"), "role": roleFilter, "missing": booleanFilter, "library_id": artistLibraryIdFilter, diff --git a/persistence/artist_repository_test.go b/persistence/artist_repository_test.go index dfaf499ac..18883378d 100644 --- a/persistence/artist_repository_test.go +++ b/persistence/artist_repository_test.go @@ -5,6 +5,7 @@ import ( "encoding/json" "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/model" @@ -386,6 +387,54 @@ var _ = Describe("ArtistRepository", func() { }) }) + Describe("Filters", func() { + var artistWithoutAnnotation model.Artist + + BeforeEach(func() { + // Create artist without any annotation + artistWithoutAnnotation = model.Artist{ID: "no-annotation-artist", Name: "No Annotation Artist"} + err := createArtistWithLibrary(repo, &artistWithoutAnnotation, 1) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + if raw, ok := repo.(*artistRepository); ok { + _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": artistWithoutAnnotation.ID})) + } + }) + + Describe("starred", func() { + It("false includes items without annotations", func() { + res, err := repo.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + artists := res.(model.Artists) + + var found bool + for _, a := range artists { + if a.ID == artistWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Artist without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := repo.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + artists := res.(model.Artists) + + for _, a := range artists { + Expect(a.ID).ToNot(Equal(artistWithoutAnnotation.ID)) + } + }) + }) + }) + Describe("MBID and Text Search", func() { var lib2 model.Library var lr model.LibraryRepository diff --git a/persistence/mediafile_repository.go b/persistence/mediafile_repository.go index 7f65540c7..2054a34b6 100644 --- a/persistence/mediafile_repository.go +++ b/persistence/mediafile_repository.go @@ -95,7 +95,7 @@ var mediaFileFilter = sync.OnceValue(func() map[string]filterFunc { filters := map[string]filterFunc{ "id": idFilter("media_file"), "title": fullTextFilter("media_file", "mbz_recording_id", "mbz_release_track_id"), - "starred": booleanFilter, + "starred": annotationBoolFilter("starred"), "genre_id": tagIDFilter, "missing": booleanFilter, "artists_id": artistFilter, @@ -195,6 +195,31 @@ func (r *mediaFileRepository) GetAll(options ...model.QueryOptions) (model.Media return res.toModels(), nil } +func (r *mediaFileRepository) GetAllByTags(tag model.TagName, values []string, options ...model.QueryOptions) (model.MediaFiles, error) { + placeholders := make([]string, len(values)) + args := make([]any, len(values)) + for i, v := range values { + placeholders[i] = "?" + args[i] = v + } + tagFilter := Expr( + fmt.Sprintf("exists (select 1 from json_tree(media_file.tags, '$.%s') where key='value' and value in (%s))", + tag, strings.Join(placeholders, ",")), + args..., + ) + + var opts model.QueryOptions + if len(options) > 0 { + opts = options[0] + } + if opts.Filters != nil { + opts.Filters = And{tagFilter, opts.Filters} + } else { + opts.Filters = tagFilter + } + return r.GetAll(opts) +} + func (r *mediaFileRepository) GetCursor(options ...model.QueryOptions) (model.MediaFileCursor, error) { sq := r.selectMediaFile(options...) cursor, err := queryWithStableResults[dbMediaFile](r.sqlRepository, sq) diff --git a/persistence/mediafile_repository_test.go b/persistence/mediafile_repository_test.go index e33639721..6b646819d 100644 --- a/persistence/mediafile_repository_test.go +++ b/persistence/mediafile_repository_test.go @@ -5,6 +5,7 @@ import ( "time" "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/log" @@ -417,6 +418,50 @@ var _ = Describe("MediaRepository", func() { }) }) + Context("Filters", func() { + var mfWithoutAnnotation model.MediaFile + + BeforeEach(func() { + mfWithoutAnnotation = model.MediaFile{ID: "no-annotation-file", LibraryID: 1, Path: "/test/no-annotation.mp3", Title: "No Annotation"} + Expect(mr.Put(&mfWithoutAnnotation)).To(Succeed()) + }) + + AfterEach(func() { + _ = mr.Delete(mfWithoutAnnotation.ID) + }) + + Describe("starred", func() { + It("false includes items without annotations", func() { + res, err := mr.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + files := res.(model.MediaFiles) + + var found bool + for _, f := range files { + if f.ID == mfWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "MediaFile without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := mr.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + files := res.(model.MediaFiles) + + for _, f := range files { + Expect(f.ID).ToNot(Equal(mfWithoutAnnotation.ID)) + } + }) + }) + }) + Describe("Search", func() { Context("text search", func() { It("finds media files by title", func() { @@ -516,4 +561,92 @@ var _ = Describe("MediaRepository", func() { }) }) }) + + Describe("FindByPaths", func() { + // Test fixtures for Unicode and case-sensitivity tests + var testFiles []model.MediaFile + + BeforeEach(func() { + testFiles = []model.MediaFile{ + {ID: "findpath-1", LibraryID: 1, Path: "artist/Album/track.mp3", Title: "Track"}, + {ID: "findpath-2", LibraryID: 1, Path: "artist/Album/UPPER.mp3", Title: "Upper"}, + // Fullwidth uppercase: ＡＣＲＯＳＳ (U+FF21 U+FF23 U+FF32 U+FF2F U+FF33 U+FF33) + {ID: "findpath-3", LibraryID: 1, Path: "plex/02 - ＡＣＲＯＳＳ.flac", Title: "Fullwidth"}, + // French diacritic: è (U+00E8, can decompose to e + combining grave) + {ID: "findpath-4", LibraryID: 1, Path: "artist/Michèle/song.mp3", Title: "French"}, + } + for _, mf := range testFiles { + Expect(mr.Put(&mf)).To(Succeed()) + } + }) + + AfterEach(func() { + for _, mf := range testFiles { + _ = mr.Delete(mf.ID) + } + }) + + It("finds files by exact path", func() { + results, err := mr.FindByPaths([]string{"1:artist/Album/track.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("findpath-1")) + }) + + It("finds files case-insensitively for ASCII characters (NOCASE)", func() { + // SQLite's COLLATE NOCASE handles ASCII case-insensitivity + results, err := mr.FindByPaths([]string{"1:ARTIST/ALBUM/TRACK.MP3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("findpath-1")) + }) + + It("finds fullwidth characters only with exact case match (SQLite NOCASE limitation)", func() { + // SQLite's NOCASE does NOT handle fullwidth uppercase/lowercase equivalence + // The DB has fullwidth uppercase ＡＣＲＯＳＳ, searching with exact match should work + results, err := mr.FindByPaths([]string{"1:plex/02 - ＡＣＲＯＳＳ.flac"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("findpath-3")) + + // Searching with fullwidth lowercase ａｃｒｏｓｓ should NOT match + // (this is the SQLite limitation that requires exact matching for non-ASCII) + results, err = mr.FindByPaths([]string{"1:plex/02 - ａｃｒｏｓｓ.flac"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("returns multiple files when querying multiple paths", func() { + results, err := mr.FindByPaths([]string{ + "1:artist/Album/track.mp3", + "1:artist/Album/UPPER.mp3", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + }) + + It("returns empty slice for non-existent paths", func() { + results, err := mr.FindByPaths([]string{"1:nonexistent/path.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("returns empty slice for empty input", func() { + results, err := mr.FindByPaths([]string{}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("handles library-qualified paths correctly", func() { + // Library 1 should find the file + results, err := mr.FindByPaths([]string{"1:artist/Album/track.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + + // Library 2 should NOT find it (file is in library 1) + results, err = mr.FindByPaths([]string{"2:artist/Album/track.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + }) }) diff --git a/persistence/sql_annotations.go b/persistence/sql_annotations.go index fac519829..cf95d39a2 100644 --- a/persistence/sql_annotations.go +++ b/persistence/sql_annotations.go @@ -4,6 +4,7 @@ import ( "database/sql" "errors" "fmt" + "strings" "time" . "github.com/Masterminds/squirrel" @@ -43,6 +44,19 @@ func (r sqlRepository) withAnnotation(query SelectBuilder, idField string) Selec return query } +func annotationBoolFilter(field string) func(string, any) Sqlizer { + return func(_ string, value any) Sqlizer { + v, ok := value.(string) + if !ok { + return nil + } + if strings.ToLower(v) == "true" { + return Expr(fmt.Sprintf("COALESCE(%s, 0) > 0", field)) + } + return Expr(fmt.Sprintf("COALESCE(%s, 0) = 0", field)) + } +} + func (r sqlRepository) annId(itemID ...string) And { userID := loggedUser(r.ctx).ID return And{ diff --git a/persistence/sql_annotations_test.go b/persistence/sql_annotations_test.go new file mode 100644 index 000000000..1848bbc8b --- /dev/null +++ b/persistence/sql_annotations_test.go @@ -0,0 +1,153 @@ +package persistence + +import ( + "context" + + "github.com/Masterminds/squirrel" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Annotation Filters", func() { + var ( + albumRepo *albumRepository + albumWithoutAnnotation model.Album + ) + + BeforeEach(func() { + ctx := request.WithUser(context.Background(), model.User{ID: "userid", UserName: "johndoe"}) + albumRepo = NewAlbumRepository(ctx, GetDBXBuilder()).(*albumRepository) + + // Create album without any annotation (no star, no rating) + albumWithoutAnnotation = model.Album{ID: "no-annotation-album", Name: "No Annotation", LibraryID: 1} + Expect(albumRepo.Put(&albumWithoutAnnotation)).To(Succeed()) + }) + + AfterEach(func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": albumWithoutAnnotation.ID})) + }) + + Describe("annotationBoolFilter", func() { + DescribeTable("creates correct SQL expressions", + func(field, value string, expectedSQL string, expectedArgs []interface{}) { + sqlizer := annotationBoolFilter(field)(field, value) + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal(expectedSQL)) + Expect(args).To(Equal(expectedArgs)) + }, + Entry("starred=true", "starred", "true", "COALESCE(starred, 0) > 0", []interface{}(nil)), + Entry("starred=false", "starred", "false", "COALESCE(starred, 0) = 0", []interface{}(nil)), + Entry("starred=True (case insensitive)", "starred", "True", "COALESCE(starred, 0) > 0", []interface{}(nil)), + Entry("rating=true", "rating", "true", "COALESCE(rating, 0) > 0", []interface{}(nil)), + ) + + It("returns nil if value is not a string", func() { + sqlizer := annotationBoolFilter("starred")("starred", 123) + Expect(sqlizer).To(BeNil()) + }) + }) + + Describe("starredFilter", func() { + It("false includes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("starred")("starred", "false"), + }) + Expect(err).ToNot(HaveOccurred()) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Item without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("starred")("starred", "true"), + }) + Expect(err).ToNot(HaveOccurred()) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + }) + + Describe("hasRatingFilter", func() { + It("false includes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("rating")("rating", "false"), + }) + Expect(err).ToNot(HaveOccurred()) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Item without annotation should be included in has_rating=false filter") + }) + + It("true excludes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("rating")("rating", "true"), + }) + Expect(err).ToNot(HaveOccurred()) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + + It("true includes items with rating > 0", func() { + // Create album with rating 1 + ratedAlbum := model.Album{ID: "rated-album", Name: "Rated Album", LibraryID: 1} + Expect(albumRepo.Put(&ratedAlbum)).To(Succeed()) + Expect(albumRepo.SetRating(1, ratedAlbum.ID)).To(Succeed()) + defer func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": ratedAlbum.ID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": ratedAlbum.ID})) + }() + + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("rating")("rating", "true"), + }) + Expect(err).ToNot(HaveOccurred()) + + var found bool + for _, a := range albums { + if a.ID == ratedAlbum.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Album with rating 5 should be included in has_rating=true filter") + }) + }) + + It("ignores invalid filter values (not strings)", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": 123}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Item without annotation should be included when filter is ignored") + }) +}) diff --git a/plugins/capabilities/metadata_agent.go b/plugins/capabilities/metadata_agent.go index fbe89a2be..407f21ec5 100644 --- a/plugins/capabilities/metadata_agent.go +++ b/plugins/capabilities/metadata_agent.go @@ -40,6 +40,18 @@ type MetadataAgent interface { // GetAlbumImages retrieves images for an album. //nd:export name=nd_get_album_images GetAlbumImages(AlbumRequest) (*AlbumImagesResponse, error) + + // GetSimilarSongsByTrack retrieves songs similar to a specific track. + //nd:export name=nd_get_similar_songs_by_track + GetSimilarSongsByTrack(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) + + // GetSimilarSongsByAlbum retrieves songs similar to tracks on an album. + //nd:export name=nd_get_similar_songs_by_album + GetSimilarSongsByAlbum(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) + + // GetSimilarSongsByArtist retrieves songs similar to an artist's catalog. + //nd:export name=nd_get_similar_songs_by_artist + GetSimilarSongsByArtist(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) } // ArtistMBIDRequest is the request for GetArtistMBID. @@ -122,7 +134,7 @@ type TopSongsRequest struct { Count int32 `json:"count"` } -// SongRef is a reference to a song with name and optional MBID. +// SongRef is a reference to a song with metadata for matching. type SongRef struct { // ID is the internal Navidrome mediafile ID (if known). ID string `json:"id,omitempty"` @@ -130,6 +142,18 @@ type SongRef struct { Name string `json:"name"` // MBID is the MusicBrainz ID for the song. MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` } // TopSongsResponse is the response for GetArtistTopSongs. @@ -165,3 +189,49 @@ type AlbumImagesResponse struct { // Images is the list of album images. Images []ImageInfo `json:"images"` } + +// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +type SimilarSongsByTrackRequest struct { + // ID is the internal Navidrome mediafile ID. + ID string `json:"id"` + // Name is the track title. + Name string `json:"name"` + // Artist is the artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz recording ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +type SimilarSongsByAlbumRequest struct { + // ID is the internal Navidrome album ID. + ID string `json:"id"` + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz release ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +type SimilarSongsByArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz artist ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +type SimilarSongsResponse struct { + // Songs is the list of similar songs. + Songs []SongRef `json:"songs"` +} diff --git a/plugins/capabilities/metadata_agent.yaml b/plugins/capabilities/metadata_agent.yaml index ebc4a2ba0..4940a5056 100644 --- a/plugins/capabilities/metadata_agent.yaml +++ b/plugins/capabilities/metadata_agent.yaml @@ -64,6 +64,30 @@ exports: output: $ref: '#/components/schemas/AlbumImagesResponse' contentType: application/json + nd_get_similar_songs_by_track: + description: GetSimilarSongsByTrack retrieves songs similar to a specific track. + input: + $ref: '#/components/schemas/SimilarSongsByTrackRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarSongsResponse' + contentType: application/json + nd_get_similar_songs_by_album: + description: GetSimilarSongsByAlbum retrieves songs similar to tracks on an album. + input: + $ref: '#/components/schemas/SimilarSongsByAlbumRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarSongsResponse' + contentType: application/json + nd_get_similar_songs_by_artist: + description: GetSimilarSongsByArtist retrieves songs similar to an artist's catalog. + input: + $ref: '#/components/schemas/SimilarSongsByArtistRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarSongsResponse' + contentType: application/json components: schemas: AlbumImagesResponse: @@ -229,8 +253,86 @@ components: $ref: '#/components/schemas/ArtistRef' required: - artists + SimilarSongsByAlbumRequest: + description: SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. + properties: + id: + type: string + description: ID is the internal Navidrome album ID. + name: + type: string + description: Name is the album name. + artist: + type: string + description: Artist is the album artist name. + mbid: + type: string + description: MBID is the MusicBrainz release ID (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of similar songs to return. + required: + - id + - name + - artist + - count + SimilarSongsByArtistRequest: + description: SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz artist ID (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of similar songs to return. + required: + - id + - name + - count + SimilarSongsByTrackRequest: + description: SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. + properties: + id: + type: string + description: ID is the internal Navidrome mediafile ID. + name: + type: string + description: Name is the track title. + artist: + type: string + description: Artist is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz recording ID (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of similar songs to return. + required: + - id + - name + - artist + - count + SimilarSongsResponse: + description: SimilarSongsResponse is the response for GetSimilarSongsBy* functions. + properties: + songs: + type: array + description: Songs is the list of similar songs. + items: + $ref: '#/components/schemas/SongRef' + required: + - songs SongRef: - description: SongRef is a reference to a song with name and optional MBID. + description: SongRef is a reference to a song with metadata for matching. properties: id: type: string @@ -241,6 +343,25 @@ components: mbid: type: string description: MBID is the MusicBrainz ID for the song. + isrc: + type: string + description: ISRC is the International Standard Recording Code for the song. + artist: + type: string + description: Artist is the artist name. + artistMbid: + type: string + description: ArtistMBID is the MusicBrainz artist ID. + album: + type: string + description: Album is the album name. + albumMbid: + type: string + description: AlbumMBID is the MusicBrainz release ID. + duration: + type: number + format: float + description: Duration is the song duration in seconds. required: - name TopSongsRequest: diff --git a/plugins/cmd/ndpgen/internal/generator.go b/plugins/cmd/ndpgen/internal/generator.go index 26df6fc17..69e232565 100644 --- a/plugins/cmd/ndpgen/internal/generator.go +++ b/plugins/cmd/ndpgen/internal/generator.go @@ -568,6 +568,18 @@ func skipSerializingFunc(goType string) string { return "String::is_empty" case "bool": return "std::ops::Not::not" + case "int32": + return "is_zero_i32" + case "uint32": + return "is_zero_u32" + case "int64": + return "is_zero_i64" + case "uint64": + return "is_zero_u64" + case "float32": + return "is_zero_f32" + case "float64": + return "is_zero_f64" default: return "Option::is_none" } diff --git a/plugins/cmd/ndpgen/internal/generator_test.go b/plugins/cmd/ndpgen/internal/generator_test.go index 0fcd0da98..4a189ddd2 100644 --- a/plugins/cmd/ndpgen/internal/generator_test.go +++ b/plugins/cmd/ndpgen/internal/generator_test.go @@ -1234,6 +1234,37 @@ type OnInitOutput struct { }) var _ = Describe("Rust Generation", func() { + Describe("skipSerializingFunc", func() { + It("should return Option::is_none for pointer, slice, and map types", func() { + Expect(skipSerializingFunc("*string")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("*MyStruct")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("[]string")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("[]int32")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("map[string]int")).To(Equal("Option::is_none")) + }) + + It("should return String::is_empty for string type", func() { + Expect(skipSerializingFunc("string")).To(Equal("String::is_empty")) + }) + + It("should return std::ops::Not::not for bool type", func() { + Expect(skipSerializingFunc("bool")).To(Equal("std::ops::Not::not")) + }) + + It("should return is_zero_* functions for numeric types", func() { + Expect(skipSerializingFunc("int32")).To(Equal("is_zero_i32")) + Expect(skipSerializingFunc("uint32")).To(Equal("is_zero_u32")) + Expect(skipSerializingFunc("int64")).To(Equal("is_zero_i64")) + Expect(skipSerializingFunc("uint64")).To(Equal("is_zero_u64")) + Expect(skipSerializingFunc("float32")).To(Equal("is_zero_f32")) + Expect(skipSerializingFunc("float64")).To(Equal("is_zero_f64")) + }) + + It("should return Option::is_none for unknown types", func() { + Expect(skipSerializingFunc("CustomType")).To(Equal("Option::is_none")) + }) + }) + Describe("rustOutputType", func() { It("should convert Go primitives to Rust primitives", func() { Expect(rustOutputType("bool")).To(Equal("bool")) diff --git a/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl b/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl index 01e6513ac..597a17338 100644 --- a/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl +++ b/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl @@ -7,6 +7,20 @@ use serde::{Deserialize, Serialize}; {{- if hasHashMap .Capability}} use std::collections::HashMap; {{- end}} + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } {{- end}} {{- /* Generate type alias definitions */ -}} diff --git a/plugins/cmd/ndpgen/internal/types.go b/plugins/cmd/ndpgen/internal/types.go index 5fd7e892c..7bd2bcc3f 100644 --- a/plugins/cmd/ndpgen/internal/types.go +++ b/plugins/cmd/ndpgen/internal/types.go @@ -466,9 +466,7 @@ func RustDefaultValue(goType string) string { switch goType { case "string": return `String::new()` - case "int", "int32": - return "0" - case "int64": + case "int", "int32", "int64", "uint", "uint32", "uint64": return "0" case "float32", "float64": return "0.0" @@ -602,6 +600,10 @@ func ToRustTypeWithStructs(goType string, knownStructs map[string]bool) string { return "i32" case "int64": return "i64" + case "uint", "uint32": + return "u32" + case "uint64": + return "u64" case "float32": return "f32" case "float64": diff --git a/plugins/cmd/ndpgen/internal/xtp_schema.go b/plugins/cmd/ndpgen/internal/xtp_schema.go index 200e72adb..db30262cc 100644 --- a/plugins/cmd/ndpgen/internal/xtp_schema.go +++ b/plugins/cmd/ndpgen/internal/xtp_schema.go @@ -106,7 +106,7 @@ func buildExport(export Export) xtpExport { // isPrimitiveGoType returns true if the Go type is a primitive type. func isPrimitiveGoType(goType string) bool { switch goType { - case "bool", "string", "int", "int32", "int64", "float32", "float64", "[]byte": + case "bool", "string", "int", "int32", "int64", "uint", "uint32", "uint64", "float32", "float64", "[]byte": return true } return false @@ -302,6 +302,12 @@ func goTypeToXTPTypeAndFormat(goType string) (typ, format string) { return "integer", "int32" case "int64": return "integer", "int64" + case "uint", "uint32": + // XTP schema doesn't support unsigned formats; use int64 to hold full uint32 range + return "integer", "int64" + case "uint64": + // XTP schema doesn't support unsigned formats; use int64 (may lose precision for large values) + return "integer", "int64" case "float32": return "number", "float" case "float64": diff --git a/plugins/examples/crypto-ticker/manifest.json b/plugins/examples/crypto-ticker/manifest.json index 59d00cbaa..362fcd0e9 100644 --- a/plugins/examples/crypto-ticker/manifest.json +++ b/plugins/examples/crypto-ticker/manifest.json @@ -60,9 +60,6 @@ } }, "permissions": { - "config": { - "reason": "To read ticker symbols configuration" - }, "scheduler": { "reason": "To schedule reconnection attempts on connection loss" }, diff --git a/plugins/examples/discord-rich-presence-rs/manifest.json b/plugins/examples/discord-rich-presence-rs/manifest.json index d92069762..4cf64b557 100644 --- a/plugins/examples/discord-rich-presence-rs/manifest.json +++ b/plugins/examples/discord-rich-presence-rs/manifest.json @@ -42,7 +42,7 @@ "type": "array", "title": "User Tokens", "description": "Discord tokens for each Navidrome user. WARNING: Store tokens securely!", - "default": [{}], + "minItems": 1, "items": { "type": "object", "properties": { @@ -63,7 +63,7 @@ } } }, - "required": ["clientid"] + "required": ["clientid", "users"] }, "uiSchema": { "type": "VerticalLayout", diff --git a/plugins/examples/discord-rich-presence/manifest.json b/plugins/examples/discord-rich-presence/manifest.json index 403cb917e..ac8eec010 100644 --- a/plugins/examples/discord-rich-presence/manifest.json +++ b/plugins/examples/discord-rich-presence/manifest.json @@ -46,7 +46,7 @@ "type": "array", "title": "User Tokens", "description": "Discord tokens for each Navidrome user. WARNING: Store tokens securely!", - "default": [{}], + "minItems": 1, "items": { "type": "object", "properties": { @@ -67,7 +67,7 @@ } } }, - "required": ["clientid"] + "required": ["clientid", "users"] }, "uiSchema": { "type": "VerticalLayout", diff --git a/plugins/host_websocket.go b/plugins/host_websocket.go index c4d18c127..7d1b93def 100644 --- a/plugins/host_websocket.go +++ b/plugins/host_websocket.go @@ -324,105 +324,52 @@ func (s *webSocketServiceImpl) readLoop(ctx context.Context, connectionID string } } -func (s *webSocketServiceImpl) invokeOnTextMessage(ctx context.Context, connectionID, message string) { +// invokeWebSocketCallback is a generic helper that handles the common callback invocation pattern. +func invokeWebSocketCallback[I any](ctx context.Context, s *webSocketServiceImpl, funcName string, input I, callbackName string, connectionID string) { instance := s.getPluginInstance() if instance == nil { return } - input := capabilities.OnTextMessageRequest{ - ConnectionID: connectionID, - Message: message, - } - - // Create a timeout context for this callback invocation callbackCtx, cancel := context.WithTimeout(ctx, webSocketCallbackTimeout) defer cancel() start := time.Now() - err := callPluginFunctionNoOutput(callbackCtx, instance, FuncWebSocketOnTextMessage, input) + err := callPluginFunctionNoOutput(callbackCtx, instance, funcName, input) if err != nil { - // Don't log error if function simply doesn't exist (optional callback) if !errors.Is(errFunctionNotFound, err) { - log.Error(ctx, "WebSocket text message callback failed", "plugin", s.pluginName, "connectionID", connectionID, "duration", time.Since(start), err) + log.Error(ctx, "WebSocket "+callbackName+" callback failed", "plugin", s.pluginName, "connectionID", connectionID, "duration", time.Since(start), err) } } } +func (s *webSocketServiceImpl) invokeOnTextMessage(ctx context.Context, connectionID, message string) { + invokeWebSocketCallback(ctx, s, FuncWebSocketOnTextMessage, capabilities.OnTextMessageRequest{ + ConnectionID: connectionID, + Message: message, + }, "text message", connectionID) +} + func (s *webSocketServiceImpl) invokeOnBinaryMessage(ctx context.Context, connectionID string, data []byte) { - instance := s.getPluginInstance() - if instance == nil { - return - } - - input := capabilities.OnBinaryMessageRequest{ + invokeWebSocketCallback(ctx, s, FuncWebSocketOnBinaryMessage, capabilities.OnBinaryMessageRequest{ ConnectionID: connectionID, Data: base64.StdEncoding.EncodeToString(data), - } - - // Create a timeout context for this callback invocation - callbackCtx, cancel := context.WithTimeout(ctx, webSocketCallbackTimeout) - defer cancel() - - start := time.Now() - err := callPluginFunctionNoOutput(callbackCtx, instance, FuncWebSocketOnBinaryMessage, input) - if err != nil { - // Don't log error if function simply doesn't exist (optional callback) - if !errors.Is(errFunctionNotFound, err) { - log.Error(ctx, "WebSocket binary message callback failed", "plugin", s.pluginName, "connectionID", connectionID, "duration", time.Since(start), err) - } - } + }, "binary message", connectionID) } func (s *webSocketServiceImpl) invokeOnError(ctx context.Context, connectionID, errorMsg string) { - instance := s.getPluginInstance() - if instance == nil { - return - } - - input := capabilities.OnErrorRequest{ + invokeWebSocketCallback(ctx, s, FuncWebSocketOnError, capabilities.OnErrorRequest{ ConnectionID: connectionID, Error: errorMsg, - } - - // Create a timeout context for this callback invocation - callbackCtx, cancel := context.WithTimeout(ctx, webSocketCallbackTimeout) - defer cancel() - - start := time.Now() - err := callPluginFunctionNoOutput(callbackCtx, instance, FuncWebSocketOnError, input) - if err != nil { - // Don't log error if function simply doesn't exist (optional callback) - if !errors.Is(errFunctionNotFound, err) { - log.Error(ctx, "WebSocket error callback failed", "plugin", s.pluginName, "connectionID", connectionID, "duration", time.Since(start), err) - } - } + }, "error", connectionID) } func (s *webSocketServiceImpl) invokeOnClose(ctx context.Context, connectionID string, code int32, reason string) { - instance := s.getPluginInstance() - if instance == nil { - return - } - - input := capabilities.OnCloseRequest{ + invokeWebSocketCallback(ctx, s, FuncWebSocketOnClose, capabilities.OnCloseRequest{ ConnectionID: connectionID, Code: code, Reason: reason, - } - - // Create a timeout context for this callback invocation - callbackCtx, cancel := context.WithTimeout(ctx, webSocketCallbackTimeout) - defer cancel() - - start := time.Now() - err := callPluginFunctionNoOutput(callbackCtx, instance, FuncWebSocketOnClose, input) - if err != nil { - // Don't log error if function simply doesn't exist (optional callback) - if !errors.Is(errFunctionNotFound, err) { - log.Error(ctx, "WebSocket close callback failed", "plugin", s.pluginName, "connectionID", connectionID, "duration", time.Since(start), err) - } - } + }, "close", connectionID) } func (s *webSocketServiceImpl) getPluginInstance() *plugin { diff --git a/plugins/manager_call.go b/plugins/manager_call.go index 957d552f7..834f45425 100644 --- a/plugins/manager_call.go +++ b/plugins/manager_call.go @@ -72,7 +72,8 @@ func callPluginFunction[I any, O any](ctx context.Context, plugin *plugin, funcN } if exit != 0 { if exit == notImplementedCode { - plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, false, elapsed.Milliseconds()) + log.Trace(ctx, "Plugin function not implemented", "plugin", plugin.name, "function", funcName, "pluginDuration", elapsed, "navidromeDuration", startCall.Sub(start)) + plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, true, elapsed.Milliseconds()) return result, fmt.Errorf("%w: %s", errNotImplemented, funcName) } plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, false, elapsed.Milliseconds()) diff --git a/plugins/manager_call_test.go b/plugins/manager_call_test.go index 742c0e084..32e9df99f 100644 --- a/plugins/manager_call_test.go +++ b/plugins/manager_call_test.go @@ -126,6 +126,6 @@ var _ = Describe("callPluginFunction metrics", Ordered, func() { Expect(calls).To(HaveLen(1)) Expect(calls[0].plugin).To(Equal("partial-metadata-agent")) Expect(calls[0].method).To(Equal(FuncGetArtistMBID)) - Expect(calls[0].ok).To(BeFalse()) + Expect(calls[0].ok).To(BeTrue()) }) }) diff --git a/plugins/manager_loader.go b/plugins/manager_loader.go index cc4d27167..b558da1be 100644 --- a/plugins/manager_loader.go +++ b/plugins/manager_loader.go @@ -334,8 +334,9 @@ func (m *Manager) loadPluginWithConfig(p *model.Plugin) error { } extismConfig := extism.PluginConfig{ - EnableWasi: true, - RuntimeConfig: runtimeConfig, + EnableWasi: true, + RuntimeConfig: runtimeConfig, + EnableHttpResponseHeaders: true, } compiled, err := extism.NewCompiledPlugin(m.ctx, pluginManifest, extismConfig, hostFunctions) if err != nil { diff --git a/plugins/manifest-schema.json b/plugins/manifest-schema.json index 881592c28..4e64ca6ea 100644 --- a/plugins/manifest-schema.json +++ b/plugins/manifest-schema.json @@ -153,17 +153,6 @@ } } }, - "ConfigPermission": { - "type": "object", - "description": "Configuration access permissions for a plugin", - "additionalProperties": false, - "properties": { - "reason": { - "type": "string", - "description": "Explanation for why config access is needed" - } - } - }, "SubsonicAPIPermission": { "type": "object", "description": "SubsonicAPI service permissions. Requires 'users' permission to be declared.", diff --git a/plugins/manifest_gen.go b/plugins/manifest_gen.go index 9762babbf..27c3c0677 100644 --- a/plugins/manifest_gen.go +++ b/plugins/manifest_gen.go @@ -45,12 +45,6 @@ func (j *ConfigDefinition) UnmarshalJSON(value []byte) error { return nil } -// Configuration access permissions for a plugin -type ConfigPermission struct { - // Explanation for why config access is needed - Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` -} - // Experimental features that may change or be removed in future versions type Experimental struct { // Threads corresponds to the JSON schema field "threads". diff --git a/plugins/metadata_agent.go b/plugins/metadata_agent.go index 7db2142d1..451ef26d1 100644 --- a/plugins/metadata_agent.go +++ b/plugins/metadata_agent.go @@ -14,14 +14,17 @@ const CapabilityMetadataAgent Capability = "MetadataAgent" // Export function names (snake_case as per design) const ( - FuncGetArtistMBID = "nd_get_artist_mbid" - FuncGetArtistURL = "nd_get_artist_url" - FuncGetArtistBiography = "nd_get_artist_biography" - FuncGetSimilarArtists = "nd_get_similar_artists" - FuncGetArtistImages = "nd_get_artist_images" - FuncGetArtistTopSongs = "nd_get_artist_top_songs" - FuncGetAlbumInfo = "nd_get_album_info" - FuncGetAlbumImages = "nd_get_album_images" + FuncGetArtistMBID = "nd_get_artist_mbid" + FuncGetArtistURL = "nd_get_artist_url" + FuncGetArtistBiography = "nd_get_artist_biography" + FuncGetSimilarArtists = "nd_get_similar_artists" + FuncGetArtistImages = "nd_get_artist_images" + FuncGetArtistTopSongs = "nd_get_artist_top_songs" + FuncGetAlbumInfo = "nd_get_album_info" + FuncGetAlbumImages = "nd_get_album_images" + FuncGetSimilarSongsByTrack = "nd_get_similar_songs_by_track" + FuncGetSimilarSongsByAlbum = "nd_get_similar_songs_by_album" + FuncGetSimilarSongsByArtist = "nd_get_similar_songs_by_artist" ) func init() { @@ -35,6 +38,9 @@ func init() { FuncGetArtistTopSongs, FuncGetAlbumInfo, FuncGetAlbumImages, + FuncGetSimilarSongsByTrack, + FuncGetSimilarSongsByAlbum, + FuncGetSimilarSongsByArtist, ) } @@ -147,12 +153,7 @@ func (a *MetadataAgent) GetArtistTopSongs(ctx context.Context, id, artistName, m return nil, agents.ErrNotFound } - songs := make([]agents.Song, len(result.Songs)) - for i, s := range result.Songs { - songs[i] = agents.Song{ID: s.ID, Name: s.Name, MBID: s.MBID} - } - - return songs, nil + return songRefsToAgentSongs(result.Songs), nil } // GetAlbumInfo retrieves album information @@ -195,15 +196,63 @@ func (a *MetadataAgent) GetAlbumImages(ctx context.Context, name, artist, mbid s return images, nil } +func callSimilarSongsPluginFunction[T any](ctx context.Context, plugin *plugin, funcName string, input T) ([]agents.Song, error) { + result, err := callPluginFunction[T, *capabilities.SimilarSongsResponse](ctx, plugin, funcName, input) + if err != nil { + return nil, err + } + if result == nil || len(result.Songs) == 0 { + return nil, agents.ErrNotFound + } + return songRefsToAgentSongs(result.Songs), nil +} + +// GetSimilarSongsByTrack retrieves songs similar to a specific track +func (a *MetadataAgent) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + return callSimilarSongsPluginFunction[capabilities.SimilarSongsByTrackRequest](ctx, a.plugin, FuncGetSimilarSongsByTrack, capabilities.SimilarSongsByTrackRequest{ID: id, Name: name, Artist: artist, MBID: mbid, Count: int32(count)}) +} + +// GetSimilarSongsByAlbum retrieves songs similar to tracks on an album +func (a *MetadataAgent) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + return callSimilarSongsPluginFunction[capabilities.SimilarSongsByAlbumRequest](ctx, a.plugin, FuncGetSimilarSongsByAlbum, capabilities.SimilarSongsByAlbumRequest{ID: id, Name: name, Artist: artist, MBID: mbid, Count: int32(count)}) +} + +// GetSimilarSongsByArtist retrieves songs similar to an artist's catalog +func (a *MetadataAgent) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]agents.Song, error) { + return callSimilarSongsPluginFunction[capabilities.SimilarSongsByArtistRequest](ctx, a.plugin, FuncGetSimilarSongsByArtist, capabilities.SimilarSongsByArtistRequest{ID: id, Name: name, MBID: mbid, Count: int32(count)}) +} + +// songRefsToAgentSongs converts a slice of SongRef to agents.Song +func songRefsToAgentSongs(refs []capabilities.SongRef) []agents.Song { + songs := make([]agents.Song, len(refs)) + for i, s := range refs { + songs[i] = agents.Song{ + ID: s.ID, + Name: s.Name, + MBID: s.MBID, + ISRC: s.ISRC, + Artist: s.Artist, + ArtistMBID: s.ArtistMBID, + Album: s.Album, + AlbumMBID: s.AlbumMBID, + Duration: uint32(s.Duration * 1000), + } + } + return songs +} + // Verify interface implementations at compile time var ( - _ agents.Interface = (*MetadataAgent)(nil) - _ agents.ArtistMBIDRetriever = (*MetadataAgent)(nil) - _ agents.ArtistURLRetriever = (*MetadataAgent)(nil) - _ agents.ArtistBiographyRetriever = (*MetadataAgent)(nil) - _ agents.ArtistSimilarRetriever = (*MetadataAgent)(nil) - _ agents.ArtistImageRetriever = (*MetadataAgent)(nil) - _ agents.ArtistTopSongsRetriever = (*MetadataAgent)(nil) - _ agents.AlbumInfoRetriever = (*MetadataAgent)(nil) - _ agents.AlbumImageRetriever = (*MetadataAgent)(nil) + _ agents.Interface = (*MetadataAgent)(nil) + _ agents.ArtistMBIDRetriever = (*MetadataAgent)(nil) + _ agents.ArtistURLRetriever = (*MetadataAgent)(nil) + _ agents.ArtistBiographyRetriever = (*MetadataAgent)(nil) + _ agents.ArtistSimilarRetriever = (*MetadataAgent)(nil) + _ agents.ArtistImageRetriever = (*MetadataAgent)(nil) + _ agents.ArtistTopSongsRetriever = (*MetadataAgent)(nil) + _ agents.AlbumInfoRetriever = (*MetadataAgent)(nil) + _ agents.AlbumImageRetriever = (*MetadataAgent)(nil) + _ agents.SimilarSongsByTrackRetriever = (*MetadataAgent)(nil) + _ agents.SimilarSongsByAlbumRetriever = (*MetadataAgent)(nil) + _ agents.SimilarSongsByArtistRetriever = (*MetadataAgent)(nil) ) diff --git a/plugins/metadata_agent_test.go b/plugins/metadata_agent_test.go index b4c37a88c..694cef716 100644 --- a/plugins/metadata_agent_test.go +++ b/plugins/metadata_agent_test.go @@ -108,6 +108,37 @@ var _ = Describe("MetadataAgent", Ordered, func() { Expect(images[0].Size).To(Equal(500)) }) }) + + Describe("GetSimilarSongsByTrack", func() { + It("returns similar songs from the plugin", func() { + retriever := agent.(agents.SimilarSongsByTrackRetriever) + songs, err := retriever.GetSimilarSongsByTrack(GinkgoT().Context(), "track-1", "Yesterday", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Name).To(Equal("Similar to Yesterday #1")) + Expect(songs[0].Artist).To(Equal("The Beatles")) + }) + }) + + Describe("GetSimilarSongsByAlbum", func() { + It("returns similar songs from the plugin", func() { + retriever := agent.(agents.SimilarSongsByAlbumRetriever) + songs, err := retriever.GetSimilarSongsByAlbum(GinkgoT().Context(), "album-1", "Abbey Road", "The Beatles", "album-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Album).To(Equal("Abbey Road")) + }) + }) + + Describe("GetSimilarSongsByArtist", func() { + It("returns similar songs from the plugin", func() { + retriever := agent.(agents.SimilarSongsByArtistRetriever) + songs, err := retriever.GetSimilarSongsByArtist(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Name).To(ContainSubstring("The Beatles Style Song")) + }) + }) }) var _ = Describe("MetadataAgent error handling", Ordered, func() { @@ -186,6 +217,27 @@ var _ = Describe("MetadataAgent error handling", Ordered, func() { Expect(err).To(HaveOccurred()) Expect(err.Error()).To(ContainSubstring("simulated plugin error")) }) + + It("returns error from GetSimilarSongsByTrack", func() { + retriever := errorAgent.(agents.SimilarSongsByTrackRetriever) + _, err := retriever.GetSimilarSongsByTrack(GinkgoT().Context(), "track-1", "Test", "Artist", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarSongsByAlbum", func() { + retriever := errorAgent.(agents.SimilarSongsByAlbumRetriever) + _, err := retriever.GetSimilarSongsByAlbum(GinkgoT().Context(), "album-1", "Album", "Artist", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarSongsByArtist", func() { + retriever := errorAgent.(agents.SimilarSongsByArtistRetriever) + _, err := retriever.GetSimilarSongsByArtist(GinkgoT().Context(), "artist-1", "Artist", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) }) var _ = Describe("MetadataAgent partial implementation", Ordered, func() { @@ -255,6 +307,23 @@ var _ = Describe("MetadataAgent partial implementation", Ordered, func() { retriever := partialAgent.(agents.AlbumImageRetriever) _, err := retriever.GetAlbumImages(GinkgoT().Context(), "Album", "Artist", "mbid") Expect(err).To(MatchError(errNotImplemented)) + }) + It("returns ErrNotFound for unimplemented method (GetSimilarSongsByTrack)", func() { + retriever := partialAgent.(agents.SimilarSongsByTrackRetriever) + _, err := retriever.GetSimilarSongsByTrack(GinkgoT().Context(), "track-1", "Test", "Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarSongsByAlbum)", func() { + retriever := partialAgent.(agents.SimilarSongsByAlbumRetriever) + _, err := retriever.GetSimilarSongsByAlbum(GinkgoT().Context(), "album-1", "Album", "Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarSongsByArtist)", func() { + retriever := partialAgent.(agents.SimilarSongsByArtistRetriever) + _, err := retriever.GetSimilarSongsByArtist(GinkgoT().Context(), "artist-1", "Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) }) }) diff --git a/plugins/pdk/go/metadata/metadata.go b/plugins/pdk/go/metadata/metadata.go index 6898468a5..7cd63865b 100644 --- a/plugins/pdk/go/metadata/metadata.go +++ b/plugins/pdk/go/metadata/metadata.go @@ -117,7 +117,53 @@ type SimilarArtistsResponse struct { Artists []ArtistRef `json:"artists"` } -// SongRef is a reference to a song with name and optional MBID. +// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +type SimilarSongsByAlbumRequest struct { + // ID is the internal Navidrome album ID. + ID string `json:"id"` + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz release ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +type SimilarSongsByArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz artist ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +type SimilarSongsByTrackRequest struct { + // ID is the internal Navidrome mediafile ID. + ID string `json:"id"` + // Name is the track title. + Name string `json:"name"` + // Artist is the artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz recording ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +type SimilarSongsResponse struct { + // Songs is the list of similar songs. + Songs []SongRef `json:"songs"` +} + +// SongRef is a reference to a song with metadata for matching. type SongRef struct { // ID is the internal Navidrome mediafile ID (if known). ID string `json:"id,omitempty"` @@ -125,6 +171,18 @@ type SongRef struct { Name string `json:"name"` // MBID is the MusicBrainz ID for the song. MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` } // TopSongsRequest is the request for GetArtistTopSongs. @@ -193,16 +251,34 @@ type AlbumInfoProvider interface { // AlbumImagesProvider provides the GetAlbumImages function. type AlbumImagesProvider interface { GetAlbumImages(AlbumRequest) (*AlbumImagesResponse, error) +} + +// SimilarSongsByTrackProvider provides the GetSimilarSongsByTrack function. +type SimilarSongsByTrackProvider interface { + GetSimilarSongsByTrack(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByAlbumProvider provides the GetSimilarSongsByAlbum function. +type SimilarSongsByAlbumProvider interface { + GetSimilarSongsByAlbum(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByArtistProvider provides the GetSimilarSongsByArtist function. +type SimilarSongsByArtistProvider interface { + GetSimilarSongsByArtist(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) } // Internal implementation holders var ( - artistMBIDImpl func(ArtistMBIDRequest) (*ArtistMBIDResponse, error) - artistURLImpl func(ArtistRequest) (*ArtistURLResponse, error) - artistBiographyImpl func(ArtistRequest) (*ArtistBiographyResponse, error) - similarArtistsImpl func(SimilarArtistsRequest) (*SimilarArtistsResponse, error) - artistImagesImpl func(ArtistRequest) (*ArtistImagesResponse, error) - artistTopSongsImpl func(TopSongsRequest) (*TopSongsResponse, error) - albumInfoImpl func(AlbumRequest) (*AlbumInfoResponse, error) - albumImagesImpl func(AlbumRequest) (*AlbumImagesResponse, error) + artistMBIDImpl func(ArtistMBIDRequest) (*ArtistMBIDResponse, error) + artistURLImpl func(ArtistRequest) (*ArtistURLResponse, error) + artistBiographyImpl func(ArtistRequest) (*ArtistBiographyResponse, error) + similarArtistsImpl func(SimilarArtistsRequest) (*SimilarArtistsResponse, error) + artistImagesImpl func(ArtistRequest) (*ArtistImagesResponse, error) + artistTopSongsImpl func(TopSongsRequest) (*TopSongsResponse, error) + albumInfoImpl func(AlbumRequest) (*AlbumInfoResponse, error) + albumImagesImpl func(AlbumRequest) (*AlbumImagesResponse, error) + similarSongsByTrackImpl func(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) + similarSongsByAlbumImpl func(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) + similarSongsByArtistImpl func(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) ) // Register registers a metadata implementation. @@ -232,6 +308,15 @@ func Register(impl Metadata) { if p, ok := impl.(AlbumImagesProvider); ok { albumImagesImpl = p.GetAlbumImages } + if p, ok := impl.(SimilarSongsByTrackProvider); ok { + similarSongsByTrackImpl = p.GetSimilarSongsByTrack + } + if p, ok := impl.(SimilarSongsByAlbumProvider); ok { + similarSongsByAlbumImpl = p.GetSimilarSongsByAlbum + } + if p, ok := impl.(SimilarSongsByArtistProvider); ok { + similarSongsByArtistImpl = p.GetSimilarSongsByArtist + } } // NotImplementedCode is the standard return code for unimplemented functions. @@ -453,3 +538,84 @@ func _NdGetAlbumImages() int32 { return 0 } + +//go:wasmexport nd_get_similar_songs_by_track +func _NdGetSimilarSongsByTrack() int32 { + if similarSongsByTrackImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarSongsByTrackRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarSongsByTrackImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_songs_by_album +func _NdGetSimilarSongsByAlbum() int32 { + if similarSongsByAlbumImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarSongsByAlbumRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarSongsByAlbumImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_songs_by_artist +func _NdGetSimilarSongsByArtist() int32 { + if similarSongsByArtistImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarSongsByArtistRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarSongsByArtistImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/metadata/metadata_stub.go b/plugins/pdk/go/metadata/metadata_stub.go index 07336142e..bdcd06fcb 100644 --- a/plugins/pdk/go/metadata/metadata_stub.go +++ b/plugins/pdk/go/metadata/metadata_stub.go @@ -114,7 +114,53 @@ type SimilarArtistsResponse struct { Artists []ArtistRef `json:"artists"` } -// SongRef is a reference to a song with name and optional MBID. +// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +type SimilarSongsByAlbumRequest struct { + // ID is the internal Navidrome album ID. + ID string `json:"id"` + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz release ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +type SimilarSongsByArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz artist ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +type SimilarSongsByTrackRequest struct { + // ID is the internal Navidrome mediafile ID. + ID string `json:"id"` + // Name is the track title. + Name string `json:"name"` + // Artist is the artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz recording ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +type SimilarSongsResponse struct { + // Songs is the list of similar songs. + Songs []SongRef `json:"songs"` +} + +// SongRef is a reference to a song with metadata for matching. type SongRef struct { // ID is the internal Navidrome mediafile ID (if known). ID string `json:"id,omitempty"` @@ -122,6 +168,18 @@ type SongRef struct { Name string `json:"name"` // MBID is the MusicBrainz ID for the song. MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` } // TopSongsRequest is the request for GetArtistTopSongs. @@ -192,6 +250,21 @@ type AlbumImagesProvider interface { GetAlbumImages(AlbumRequest) (*AlbumImagesResponse, error) } +// SimilarSongsByTrackProvider provides the GetSimilarSongsByTrack function. +type SimilarSongsByTrackProvider interface { + GetSimilarSongsByTrack(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByAlbumProvider provides the GetSimilarSongsByAlbum function. +type SimilarSongsByAlbumProvider interface { + GetSimilarSongsByAlbum(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByArtistProvider provides the GetSimilarSongsByArtist function. +type SimilarSongsByArtistProvider interface { + GetSimilarSongsByArtist(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) +} + // NotImplementedCode is the standard return code for unimplemented functions. const NotImplementedCode int32 = -2 diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs index df7695f0e..463e52c37 100644 --- a/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs @@ -4,6 +4,20 @@ // It is intended for use in Navidrome plugins built with extism-pdk. use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } /// AlbumImagesResponse is the response for GetAlbumImages. #[derive(Debug, Clone, Default, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] @@ -150,7 +164,72 @@ pub struct SimilarArtistsResponse { #[serde(default)] pub artists: VecSchoolmates Thomas and Guy-Manuel began their career in 1992 with the indie rock trio Darlin' (named after The Beach Boys song) but were scathingly dismissed by Melody Maker magazine as \"daft punk.\" Turning to house-inspired electronica, they used the put down as a name for their DJ-ing partnership and became a hugely successful and influential dance act. First major single \"Da Funk\" was accompanied by a Spike Jonze-directed video and more success followed with global dance floor anthem \"Around the World,\" \"One More Time,\" and \"Harder, Faster, Better, Stronger\" - which was sampled by Kanye West for his hit \"Stronger.\" Albums Homework (1997), Discovery (2001) and Human After All (2005) all made the UK Top 10 establishing a style of simple, Chicago house-inspired grooves exploding into a robotic, rave sound.
" + } + } + }, + "extensions": { + "queryCost": 3 + } +} diff --git a/tests/fixtures/deezer.artist.bio.fr.json b/tests/fixtures/deezer.artist.bio.fr.json new file mode 100644 index 000000000..435f6fcf0 --- /dev/null +++ b/tests/fixtures/deezer.artist.bio.fr.json @@ -0,0 +1,12 @@ +{ + "data": { + "artist": { + "bio": { + "full": "Guy-Manuel de Homem Christo et Thomas Bangalter se rencontrent en 1987 au lycée Carnot de Paris. Partageant une même passion pour la musique, les deux amis fondent en 1992 Darlin', un groupe de rock influencé par les Stooges et MC5, dont la production sera taxée par un critique de la presse anglaise de «daft punk» (« punk idiot »).Schoolmates Thomas and Guy-Manuel began their career in 1992 with the indie rock trio Darlin' (named after The Beach Boys song) but were scathingly dismissed by Melody Maker magazine as \"daft punk.\" Turning to house-inspired electronica, they used the put down as a name for their DJ-ing partnership and became a hugely successful and influential dance act.
" - } - } - } -} diff --git a/tests/fixtures/lastfm.album.getinfo.empty.json b/tests/fixtures/lastfm.album.getinfo.empty.json new file mode 100644 index 000000000..06403ff8c --- /dev/null +++ b/tests/fixtures/lastfm.album.getinfo.empty.json @@ -0,0 +1 @@ +{"album":{"artist":"Legião Urbana","mbid":"1749dd07-5aa9-436e-babc-e3e982deb273","tags":{"tag":[{"url":"https:\/\/www.last.fm\/tag\/rock","name":"rock"},{"url":"https:\/\/www.last.fm\/tag\/80s","name":"80s"},{"url":"https:\/\/www.last.fm\/tag\/brazilian","name":"brazilian"},{"url":"https:\/\/www.last.fm\/tag\/brasil","name":"brasil"},{"url":"https:\/\/www.last.fm\/tag\/brazilian+rock","name":"brazilian rock"}]},"name":"Dois","image":[{"size":"small","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/34s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"medium","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/64s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"large","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/174s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"extralarge","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"mega","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"}],"tracks":{"track":[{"streamable":{"fulltrack":"0","#text":"0"},"duration":232,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Daniel+na+Cova+dos+Le%C3%B5es","name":"Daniel na Cova dos Leões","@attr":{"rank":1},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":null,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Quase+Sem+Querer","name":"Quase Sem Querer","@attr":{"rank":2},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":280,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Acrilic+On+Canvas","name":"Acrilic On Canvas","@attr":{"rank":3},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":271,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Eduardo+e+M%C3%B4nica","name":"Eduardo e Mônica","@attr":{"rank":4},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":94,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Central+Do+Brasil","name":"Central Do Brasil","@attr":{"rank":5},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":302,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Tempo+Perdido","name":"Tempo Perdido","@attr":{"rank":6},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":170,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Metr%C3%B3pole","name":"Metrópole","@attr":{"rank":7},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":175,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Plantas+Em+Baixo+Do+Aqu%C3%A1rio","name":"Plantas Em Baixo Do Aquário","@attr":{"rank":8},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":162,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/M%C3%BAsica+urbana+2","name":"Música urbana 2","@attr":{"rank":9},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":184,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Andrea+Doria","name":"Andrea Doria","@attr":{"rank":10},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":231,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/F%C3%A1brica","name":"Fábrica","@attr":{"rank":11},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":258,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/%C3%8Dndios","name":"Índios","@attr":{"rank":12},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}}]},"listeners":"494356","playcount":"9833783","url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois"}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.album.getinfo.en.json b/tests/fixtures/lastfm.album.getinfo.en.json new file mode 100644 index 000000000..f5444f35b --- /dev/null +++ b/tests/fixtures/lastfm.album.getinfo.en.json @@ -0,0 +1 @@ +{"album":{"artist":"Legião Urbana","mbid":"1749dd07-5aa9-436e-babc-e3e982deb273","tags":{"tag":[{"url":"https:\/\/www.last.fm\/tag\/rock","name":"rock"},{"url":"https:\/\/www.last.fm\/tag\/80s","name":"80s"},{"url":"https:\/\/www.last.fm\/tag\/brazilian","name":"brazilian"},{"url":"https:\/\/www.last.fm\/tag\/brasil","name":"brasil"},{"url":"https:\/\/www.last.fm\/tag\/brazilian+rock","name":"brazilian rock"}]},"playcount":"9833783","image":[{"size":"small","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/34s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"medium","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/64s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"large","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/174s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"extralarge","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"mega","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"}],"tracks":{"track":[{"streamable":{"fulltrack":"0","#text":"0"},"duration":232,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Daniel+na+Cova+dos+Le%C3%B5es","name":"Daniel na Cova dos Leões","@attr":{"rank":1},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":null,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Quase+Sem+Querer","name":"Quase Sem Querer","@attr":{"rank":2},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":280,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Acrilic+On+Canvas","name":"Acrilic On Canvas","@attr":{"rank":3},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":271,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Eduardo+e+M%C3%B4nica","name":"Eduardo e Mônica","@attr":{"rank":4},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":94,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Central+Do+Brasil","name":"Central Do Brasil","@attr":{"rank":5},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":302,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Tempo+Perdido","name":"Tempo Perdido","@attr":{"rank":6},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":170,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Metr%C3%B3pole","name":"Metrópole","@attr":{"rank":7},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":175,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Plantas+Em+Baixo+Do+Aqu%C3%A1rio","name":"Plantas Em Baixo Do Aquário","@attr":{"rank":8},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":162,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/M%C3%BAsica+urbana+2","name":"Música urbana 2","@attr":{"rank":9},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":184,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Andrea+Doria","name":"Andrea Doria","@attr":{"rank":10},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":231,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/F%C3%A1brica","name":"Fábrica","@attr":{"rank":11},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":258,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/%C3%8Dndios","name":"Índios","@attr":{"rank":12},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}}]},"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois","name":"Dois","listeners":"494356","wiki":{"published":"10 Oct 2023, 13:56","summary":"Dois é o segundo álbum de estúdio da banda brasileira de rock Legião Urbana, lançado em 20 de julho de 1986 pela EMI. Ocupa a 21ª posição da lista dos 100 maiores discos da música brasileira pela Rolling Stone Brasil. Em setembro de 2012, foi eleito pelo público da rádio Eldorado FM, do portal Estadao.com e do Caderno C2+Música (estes dois últimos pertencentes ao jornal O Estado de S. Paulo) como o terceiro melhor disco brasileiro da história. O álbum vendeu mais de 900 mil cópias no Brasil. \"Tempo Perdido\" fez um grande sucesso e se tornou num dos clássicos Read more on Last.fm<\/a>.","content":"Dois é o segundo álbum de estúdio da banda brasileira de rock Legião Urbana, lançado em 20 de julho de 1986 pela EMI. Ocupa a 21ª posição da lista dos 100 maiores discos da música brasileira pela Rolling Stone Brasil. Em setembro de 2012, foi eleito pelo público da rádio Eldorado FM, do portal Estadao.com e do Caderno C2+Música (estes dois últimos pertencentes ao jornal O Estado de S. Paulo) como o terceiro melhor disco brasileiro da história. O álbum vendeu mais de 900 mil cópias no Brasil. \"Tempo Perdido\" fez um grande sucesso e se tornou num dos clássicos da Legião. \"Eduardo e Mônica\", \"\"Índios\"\" e \"Quase sem Querer\" também fizeram sucesso. Read more on Last.fm<\/a>. User-contributed text is available under the Creative Commons By-SA License; additional terms may apply."}}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.getinfo.empty.json b/tests/fixtures/lastfm.artist.getinfo.empty.json new file mode 100644 index 000000000..015b51701 --- /dev/null +++ b/tests/fixtures/lastfm.artist.getinfo.empty.json @@ -0,0 +1 @@ +{"artist":{"name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99","url":"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}],"streamable":"0","ontour":"0","stats":{"listeners":"740591","playcount":"44493504"},"similar":{"artist":[{"name":"Renato Russo","url":"https://www.last.fm/music/Renato+Russo","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Engenheiros Do Hawaii","url":"https://www.last.fm/music/Engenheiros+Do+Hawaii","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Os Paralamas Do Sucesso","url":"https://www.last.fm/music/Os+Paralamas+Do+Sucesso","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Barão Vermelho","url":"https://www.last.fm/music/Bar%C3%A3o+Vermelho","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Capital Inicial","url":"https://www.last.fm/music/Capital+Inicial","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]}]},"tags":{"tag":[{"name":"rock","url":"https://www.last.fm/tag/rock"},{"name":"brazilian rock","url":"https://www.last.fm/tag/brazilian+rock"},{"name":"80s","url":"https://www.last.fm/tag/80s"},{"name":"brazilian","url":"https://www.last.fm/tag/brazilian"},{"name":"brasil","url":"https://www.last.fm/tag/brasil"}]},"bio":{"links":{"link":{"#text":"","rel":"original","href":"https://last.fm/music/+noredirect/Legi%C3%A3o+Urbana/+wiki"}},"published":"01 Jan 1970, 00:00","summary":" Read more on Last.fm","content":""}}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.getinfo.en.json b/tests/fixtures/lastfm.artist.getinfo.en.json new file mode 100644 index 000000000..6c643b8e2 --- /dev/null +++ b/tests/fixtures/lastfm.artist.getinfo.en.json @@ -0,0 +1 @@ +{"artist":{"name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99","url":"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}],"streamable":"0","ontour":"0","stats":{"listeners":"740367","playcount":"44476703"},"similar":{"artist":[{"name":"Renato Russo","url":"https://www.last.fm/music/Renato+Russo","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Engenheiros Do Hawaii","url":"https://www.last.fm/music/Engenheiros+Do+Hawaii","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Os Paralamas Do Sucesso","url":"https://www.last.fm/music/Os+Paralamas+Do+Sucesso","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Barão Vermelho","url":"https://www.last.fm/music/Bar%C3%A3o+Vermelho","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Capital Inicial","url":"https://www.last.fm/music/Capital+Inicial","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]}]},"tags":{"tag":[{"name":"rock","url":"https://www.last.fm/tag/rock"},{"name":"brazilian rock","url":"https://www.last.fm/tag/brazilian+rock"},{"name":"80s","url":"https://www.last.fm/tag/80s"},{"name":"brazilian","url":"https://www.last.fm/tag/brazilian"},{"name":"brasil","url":"https://www.last.fm/tag/brasil"}]},"bio":{"links":{"link":{"#text":"","rel":"original","href":"https://last.fm/music/+noredirect/Legi%C3%A3o+Urbana/+wiki"}},"published":"03 Mar 2006, 04:04","summary":"Legião Urbana was a Brazilian post-punk band from Brasília, Distrito Federal, Brazil.\n\nFronted by lead singer and lyricist Renato Russo, Legião Urbana was founded in 1983 and existed until 1996, when Renato passed away due to complications caused by AIDS. Besides being the lead vocalist, Renato was an occasional guitar, bass and keyboards player. He also wrote most of the band's songs. In 13 years of career, they released 8 studio albums - the last being posthumous - and one live. Read more on Last.fm","content":"Legião Urbana was a Brazilian post-punk band from Brasília, Distrito Federal, Brazil.\n\nFronted by lead singer and lyricist Renato Russo, Legião Urbana was founded in 1983 and existed until 1996, when Renato passed away due to complications caused by AIDS. Besides being the lead vocalist, Renato was an occasional guitar, bass and keyboards player. He also wrote most of the band's songs. In 13 years of career, they released 8 studio albums - the last being posthumous - and one live.\n\nLegião Urbana is probably the most famous Brazilian rock bands, especially known for Renato's poetic lyrics, which range from love and spiritualism to politics, family, sex and drugs.\n\nNowadays, Dado Villa-Lobos (ex-guitar player of Legião Urbana) has a solo career and recorded his first album, named \"Jardim De Cactus\", in 2005. Drum player Marcelo Bonfá also tried a solo career. Read more on Last.fm. User-contributed text is available under the Creative Commons By-SA License; additional terms may apply."}}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.track.getsimilar.json b/tests/fixtures/lastfm.track.getsimilar.json new file mode 100644 index 000000000..45041b289 --- /dev/null +++ b/tests/fixtures/lastfm.track.getsimilar.json @@ -0,0 +1 @@ +{"similartracks":{"track":[{"name":"Dreaming of Me","mbid":"027b553e-7c74-3ed4-a95e-1d4fea51f174","match":1.0,"url":"https://www.last.fm/music/Depeche+Mode/_/Dreaming+of+Me","artist":{"name":"Depeche Mode","mbid":"8538e728-ca0b-4321-b7e5-cff6565dd4c0","url":"https://www.last.fm/music/Depeche+Mode"}},{"name":"Everything Counts","mbid":"5a5a3ca4-bdb8-4641-a674-9b54b9b319a6","match":0.892602,"url":"https://www.last.fm/music/Depeche+Mode/_/Everything+Counts","artist":{"name":"Depeche Mode","mbid":"8538e728-ca0b-4321-b7e5-cff6565dd4c0","url":"https://www.last.fm/music/Depeche+Mode"}},{"name":"Don't You Want Me","mbid":"","match":0.491341,"url":"https://www.last.fm/music/The+Human+League/_/Don%27t+You+Want+Me","artist":{"name":"The Human League","mbid":"7adaabfb-acfb-47bc-8c7c-59471c2f0db8","url":"https://www.last.fm/music/The+Human+League"}},{"name":"Tainted Love","mbid":"","match":0.454811,"url":"https://www.last.fm/music/Soft+Cell/_/Tainted+Love","artist":{"name":"Soft Cell","mbid":"7fb50287-029d-47cc-825a-235ca28024b2","url":"https://www.last.fm/music/Soft+Cell"}},{"name":"Blue Monday","mbid":"727e84c6-1b56-31dd-a958-a5f46305cec0","match":0.381057,"url":"https://www.last.fm/music/New+Order/_/Blue+Monday","artist":{"name":"New Order","mbid":"f1106b17-dcbb-45f6-b938-199ccfab50cc","url":"https://www.last.fm/music/New+Order"}}],"@attr":{"artist":"Depeche Mode","track":"Just Can't Get Enough"}}} diff --git a/tests/fixtures/lastfm.track.getsimilar.unknown.json b/tests/fixtures/lastfm.track.getsimilar.unknown.json new file mode 100644 index 000000000..9b879fa05 --- /dev/null +++ b/tests/fixtures/lastfm.track.getsimilar.unknown.json @@ -0,0 +1 @@ +{"similartracks":{"track":[],"@attr":{"track":"UnknownTrack","artist":"UnknownArtist"}}} diff --git a/tests/mock_mediafile_repo.go b/tests/mock_mediafile_repo.go index 5b38a7187..8542fc8d5 100644 --- a/tests/mock_mediafile_repo.go +++ b/tests/mock_mediafile_repo.go @@ -76,6 +76,10 @@ func (m *MockMediaFileRepo) GetWithParticipants(id string) (*model.MediaFile, er return nil, model.ErrNotFound } +func (m *MockMediaFileRepo) GetAllByTags(_ model.TagName, _ []string, options ...model.QueryOptions) (model.MediaFiles, error) { + return m.GetAll(options...) +} + func (m *MockMediaFileRepo) GetAll(qo ...model.QueryOptions) (model.MediaFiles, error) { if len(qo) > 0 { m.Options = qo[0] diff --git a/ui/src/artist/ArtistActions.jsx b/ui/src/artist/ArtistActions.jsx index 8eebe6499..0b48f232d 100644 --- a/ui/src/artist/ArtistActions.jsx +++ b/ui/src/artist/ArtistActions.jsx @@ -14,7 +14,8 @@ import { import ShuffleIcon from '@material-ui/icons/Shuffle' import PlayArrowIcon from '@material-ui/icons/PlayArrow' import { IoIosRadio } from 'react-icons/io' -import { playShuffle, playSimilar, playTopSongs } from './actions.js' +import { playShuffle, playTopSongs } from './actions.js' +import { playSimilar } from '../common/playbackActions.js' const useStyles = makeStyles((theme) => ({ toolbar: { diff --git a/ui/src/artist/actions.js b/ui/src/artist/actions.js index 6a8fbd9c6..94b3adf42 100644 --- a/ui/src/artist/actions.js +++ b/ui/src/artist/actions.js @@ -1,31 +1,6 @@ import subsonic from '../subsonic/index.js' import { playTracks } from '../actions/index.js' - -const mapReplayGain = (song) => { - const { replayGain: rg } = song - if (!rg) { - return song - } - - return { - ...song, - ...(rg.albumGain !== undefined && { rgAlbumGain: rg.albumGain }), - ...(rg.albumPeak !== undefined && { rgAlbumPeak: rg.albumPeak }), - ...(rg.trackGain !== undefined && { rgTrackGain: rg.trackGain }), - ...(rg.trackPeak !== undefined && { rgTrackPeak: rg.trackPeak }), - } -} - -const processSongsForPlayback = (songs) => { - const songData = {} - const ids = [] - songs.forEach((s) => { - const song = mapReplayGain(s) - songData[song.id] = song - ids.push(song.id) - }) - return { songData, ids } -} +import { processSongsForPlayback } from '../common/playbackActions.js' export const playTopSongs = async (dispatch, notify, artistName) => { const res = await subsonic.getTopSongs(artistName, 100) @@ -47,26 +22,6 @@ export const playTopSongs = async (dispatch, notify, artistName) => { dispatch(playTracks(songData, ids)) } -export const playSimilar = async (dispatch, notify, id) => { - const res = await subsonic.getSimilarSongs2(id, 100) - const data = res.json['subsonic-response'] - - if (data.status !== 'ok') { - throw new Error( - `Error fetching similar songs: ${data.error?.message || 'Unknown error'} (Code: ${data.error?.code || 'unknown'})`, - ) - } - - const songs = data.similarSongs2?.song || [] - if (!songs.length) { - notify('message.noSimilarSongsFound', 'warning') - return - } - - const { songData, ids } = processSongsForPlayback(songs) - dispatch(playTracks(songData, ids)) -} - export const playShuffle = async (dataProvider, dispatch, id) => { const res = await dataProvider.getList('song', { pagination: { page: 1, perPage: 500 }, diff --git a/ui/src/common/SongContextMenu.jsx b/ui/src/common/SongContextMenu.jsx index f8b0bba5e..ac5b10e13 100644 --- a/ui/src/common/SongContextMenu.jsx +++ b/ui/src/common/SongContextMenu.jsx @@ -24,6 +24,7 @@ import { } from '../actions' import { LoveButton } from './LoveButton' import config from '../config' +import { playSimilar } from './playbackActions.js' import { formatBytes } from '../utils' import { useRedirect } from 'react-admin' @@ -86,6 +87,24 @@ export const SongContextMenu = ({ label: translate('resources.song.actions.addToQueue'), action: (record) => dispatch(addTracks({ [record.id]: record })), }, + instantMix: { + enabled: config.enableExternalServices, + label: translate('resources.song.actions.instantMix'), + action: async (record) => { + notify('message.startingInstantMix', { type: 'info' }) + try { + const id = record.mediaFileId || record.id + await playSimilar(dispatch, notify, id, { + seedRecord: record, + shuffle: false, + }) + } catch (e) { + // eslint-disable-next-line no-console + console.error('Error starting instant mix:', e) + notify('ra.page.error', { type: 'warning' }) + } + }, + }, addToPlaylist: { enabled: true, label: translate('resources.song.actions.addToPlaylist'), diff --git a/ui/src/common/SongContextMenu.test.jsx b/ui/src/common/SongContextMenu.test.jsx index a30da859f..7172742d3 100644 --- a/ui/src/common/SongContextMenu.test.jsx +++ b/ui/src/common/SongContextMenu.test.jsx @@ -3,19 +3,36 @@ import { render, fireEvent, screen, waitFor } from '@testing-library/react' import { TestContext } from 'ra-test' import { describe, it, expect, vi, beforeEach } from 'vitest' import { SongContextMenu } from './SongContextMenu' +import subsonic from '../subsonic' vi.mock('../dataProvider', () => ({ httpClient: vi.fn(), })) -vi.mock('react-redux', () => ({ useDispatch: () => vi.fn() })) +vi.mock('../subsonic', () => ({ + default: { getSimilarSongs2: vi.fn() }, +})) + +vi.mock('../config', () => ({ + default: { + enableDownloads: true, + enableFavourites: true, + enableSharing: true, + enableExternalServices: true, + }, +})) + +const mockDispatch = vi.fn() +vi.mock('react-redux', () => ({ useDispatch: () => mockDispatch })) const getPlaylistsMock = vi.fn() +const mockNotify = vi.fn() vi.mock('react-admin', async (importOriginal) => { const actual = await importOriginal() return { ...actual, + useNotify: () => mockNotify, useRedirect: () => (url) => { window.location.hash = `#${url}` }, @@ -35,6 +52,14 @@ describe('SongContextMenu', () => { getPlaylistsMock.mockResolvedValue({ data: [{ id: 'pl1', name: 'Pl 1' }], }) + subsonic.getSimilarSongs2.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'ok', + similarSongs2: { song: [{ id: 's1' }] }, + }, + }, + }) }) it('navigates to playlist when selected', async () => { @@ -104,4 +129,99 @@ describe('SongContextMenu', () => { ) expect(mockOnClick).not.toHaveBeenCalled() }) + + describe('Instant Mix action', () => { + it('calls getSimilarSongs2 with song id and shows loading notification', async () => { + render( +