Skip to content

Commit

Permalink
Add dedicated SimilarArtists call
Browse files Browse the repository at this point in the history
  • Loading branch information
@deluan
deluan committed Oct 20, 2020
1 parent 29d8950 commit e9e09a7
Show file tree
Hide file tree
Showing 22 changed files with 316 additions and 90 deletions.
110 changes: 77 additions & 33 deletions core/external_info.go
View file
Expand Up @@ -19,11 +19,14 @@ const placeholderArtistImageMediumUrl = "https://lastfm.freetls.fastly.net/i/u/1
const placeholderArtistImageLargeUrl = "https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png"

type ExternalInfo interface {
ArtistInfo(ctx context.Context, artistId string, includeNotPresent bool, count int) (*model.ArtistInfo, error)
ArtistInfo(ctx context.Context, id string) (*model.ArtistInfo, error)
SimilarArtists(ctx context.Context, id string, includeNotPresent bool, count int) (model.Artists, error)
SimilarSongs(ctx context.Context, id string, count int) (model.MediaFiles, error)
}

type LastFMClient interface {
ArtistGetInfo(ctx context.Context, name string) (*lastfm.Artist, error)
ArtistGetSimilar(ctx context.Context, name string, limit int) ([]lastfm.Artist, error)
}

type SpotifyClient interface {
Expand All @@ -40,20 +43,86 @@ type externalInfo struct {
spf SpotifyClient
}

func (e *externalInfo) ArtistInfo(ctx context.Context, artistId string,
includeNotPresent bool, count int) (*model.ArtistInfo, error) {
info := model.ArtistInfo{ID: artistId}
func (e *externalInfo) getArtist(ctx context.Context, id string) (artist *model.Artist, err error) {
var entity interface{}
entity, err = GetEntityByID(ctx, e.ds, id)
if err != nil {
return nil, err
}

switch v := entity.(type) {
case *model.Artist:
artist = v
case *model.MediaFile:
artist = &model.Artist{
ID: v.ArtistID,
Name: v.Artist,
}
case *model.Album:
artist = &model.Artist{
ID: v.AlbumArtistID,
Name: v.Artist,
}
default:
err = model.ErrNotFound
}
return
}

func (e *externalInfo) SimilarSongs(ctx context.Context, id string, count int) (model.MediaFiles, error) {
// TODO
// Get Similar Artists
// Get `count` songs from all similar artists, sorted randomly
return nil, nil
}

func (e *externalInfo) SimilarArtists(ctx context.Context, id string, includeNotPresent bool, count int) (model.Artists, error) {
artist, err := e.getArtist(ctx, id)
if err != nil {
return nil, err
}

var result model.Artists
var notPresent []string

similar, err := e.lfm.ArtistGetSimilar(ctx, artist.Name, count)
if err != nil {
return nil, err
}

artist, err := e.ds.Artist(ctx).Get(artistId)
// First select artists that are present.
for _, s := range similar {
sa, err := e.ds.Artist(ctx).FindByName(s.Name)
if err != nil {
notPresent = append(notPresent, s.Name)
continue
}
result = append(result, *sa)
}

// Then fill up with non-present artists
if includeNotPresent {
for _, s := range notPresent {
sa := model.Artist{ID: "-1", Name: s}
result = append(result, sa)
}
}

return result, nil
}

func (e *externalInfo) ArtistInfo(ctx context.Context, id string) (*model.ArtistInfo, error) {
artist, err := e.getArtist(ctx, id)
if err != nil {
return nil, err
}
info.Name = artist.Name

info := model.ArtistInfo{ID: artist.ID, Name: artist.Name}

// TODO Load from local: artist.jpg/png/webp, artist.json (with the remaining info)

var wg sync.WaitGroup
e.callArtistInfo(ctx, artist, includeNotPresent, &wg, &info)
e.callArtistInfo(ctx, artist, &wg, &info)
e.callArtistImages(ctx, artist, &wg, &info)
wg.Wait()

Expand All @@ -68,7 +137,7 @@ func (e *externalInfo) ArtistInfo(ctx context.Context, artistId string,
return &info, nil
}

func (e *externalInfo) callArtistInfo(ctx context.Context, artist *model.Artist, includeNotPresent bool,
func (e *externalInfo) callArtistInfo(ctx context.Context, artist *model.Artist,
wg *sync.WaitGroup, info *model.ArtistInfo) {
if e.lfm != nil {
log.Debug(ctx, "Calling Last.FM ArtistGetInfo", "artist", artist.Name)
Expand All @@ -85,7 +154,6 @@ func (e *externalInfo) callArtistInfo(ctx context.Context, artist *model.Artist,
e.setBio(info, lfmArtist.Bio.Summary)
e.setLastFMUrl(info, lfmArtist.URL)
e.setMbzID(info, lfmArtist.MBID)
e.setSimilar(ctx, info, lfmArtist.Similar.Artists, includeNotPresent)
}()
}
}
Expand Down Expand Up @@ -157,27 +225,3 @@ func (e *externalInfo) setLargeImageUrl(info *model.ArtistInfo, url string) {
info.LargeImageUrl = url
}
}

func (e *externalInfo) setSimilar(ctx context.Context, info *model.ArtistInfo, artists []lastfm.Artist, includeNotPresent bool) {
if len(info.Similar) == 0 {
var notPresent []string

// First select artists that are present.
for _, s := range artists {
sa, err := e.ds.Artist(ctx).FindByName(s.Name)
if err != nil {
notPresent = append(notPresent, s.Name)
continue
}
info.Similar = append(info.Similar, *sa)
}

// Then fill up with non-present artists
if includeNotPresent {
for _, s := range notPresent {
sa := model.Artist{ID: "-1", Name: s}
info.Similar = append(info.Similar, sa)
}
}
}
}
28 changes: 28 additions & 0 deletions core/get_entity.go
View file
@@ -0,0 +1,28 @@
package core

import (
"context"

"github.com/deluan/navidrome/model"
)

// TODO: Should the type be encoded in the ID?
func GetEntityByID(ctx context.Context, ds model.DataStore, id string) (interface{}, error) {
ar, err := ds.Artist(ctx).Get(id)
if err == nil {
return ar, nil
}
al, err := ds.Album(ctx).Get(id)
if err == nil {
return al, nil
}
pls, err := ds.Playlist(ctx).Get(id)
if err == nil {
return pls, nil
}
mf, err := ds.MediaFile(ctx).Get(id)
if err == nil {
return mf, nil
}
return nil, err
}
36 changes: 29 additions & 7 deletions core/lastfm/client.go
View file
Expand Up @@ -7,6 +7,7 @@ import (
"io/ioutil"
"net/http"
"net/url"
"strconv"
)

const (
Expand All @@ -27,14 +28,10 @@ type Client struct {
hc HttpClient
}

// TODO SimilarArtists()
func (c *Client) ArtistGetInfo(ctx context.Context, name string) (*Artist, error) {
params := url.Values{}
params.Add("method", "artist.getInfo")
func (c *Client) makeRequest(params url.Values) (*Response, error) {
params.Add("format", "json")
params.Add("api_key", c.apiKey)
params.Add("artist", name)
params.Add("lang", c.lang)

req, _ := http.NewRequest("GET", apiBaseUrl, nil)
req.URL.RawQuery = params.Encode()

Expand All @@ -55,7 +52,32 @@ func (c *Client) ArtistGetInfo(ctx context.Context, name string) (*Artist, error

var response Response
err = json.Unmarshal(data, &response)
return &response.Artist, err

return &response, err
}

func (c *Client) ArtistGetInfo(ctx context.Context, name string) (*Artist, error) {
params := url.Values{}
params.Add("method", "artist.getInfo")
params.Add("artist", name)
params.Add("lang", c.lang)
response, err := c.makeRequest(params)
if err != nil {
return nil, err
}
return &response.Artist, nil
}

func (c *Client) ArtistGetSimilar(ctx context.Context, name string, limit int) ([]Artist, error) {
params := url.Values{}
params.Add("method", "artist.getSimilar")
params.Add("artist", name)
params.Add("limit", strconv.Itoa(limit))
response, err := c.makeRequest(params)
if err != nil {
return nil, err
}
return response.SimilarArtists.Artists, nil
}

func (c *Client) parseError(data []byte) error {
Expand Down
42 changes: 41 additions & 1 deletion core/lastfm/client_test.go
View file
Expand Up @@ -21,7 +21,7 @@ var _ = Describe("Client", func() {
client = NewClient("API_KEY", "pt", httpClient)
})

Describe("ArtistInfo", func() {
Describe("ArtistGetInfo", func() {
It("returns an artist for a successful response", func() {
f, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json")
httpClient.res = http.Response{Body: f, StatusCode: 200}
Expand Down Expand Up @@ -60,6 +60,46 @@ var _ = Describe("Client", func() {
})

})

Describe("ArtistGetSimilar", func() {
It("returns an artist for a successful response", func() {
f, _ := os.Open("tests/fixtures/lastfm.artist.getsimilar.json")
httpClient.res = http.Response{Body: f, StatusCode: 200}

artists, err := client.ArtistGetSimilar(context.TODO(), "U2", 2)
Expect(err).To(BeNil())
Expect(len(artists)).To(Equal(2))
Expect(httpClient.savedRequest.URL.String()).To(Equal(apiBaseUrl + "?api_key=API_KEY&artist=U2&format=json&limit=2&method=artist.getSimilar"))
})

It("fails if Last.FM returns an error", func() {
httpClient.res = http.Response{
Body: ioutil.NopCloser(bytes.NewBufferString(`{"error":3,"message":"Invalid Method - No method with that name in this package"}`)),
StatusCode: 400,
}

_, err := client.ArtistGetSimilar(context.TODO(), "U2", 2)
Expect(err).To(MatchError("last.fm error(3): Invalid Method - No method with that name in this package"))
})

It("fails if HttpClient.Do() returns error", func() {
httpClient.err = errors.New("generic error")

_, err := client.ArtistGetSimilar(context.TODO(), "U2", 2)
Expect(err).To(MatchError("generic error"))
})

It("fails if returned body is not a valid JSON", func() {
httpClient.res = http.Response{
Body: ioutil.NopCloser(bytes.NewBufferString(`<xml>NOT_VALID_JSON</xml>`)),
StatusCode: 200,
}

_, err := client.ArtistGetSimilar(context.TODO(), "U2", 2)
Expect(err).To(MatchError("invalid character '<' looking for beginning of value"))
})

})
})

type fakeHttpClient struct {
Expand Down
13 changes: 8 additions & 5 deletions core/lastfm/responses.go
View file
@@ -1,7 +1,8 @@
package lastfm

type Response struct {
Artist Artist `json:"artist"`
Artist Artist `json:"artist"`
SimilarArtists SimilarArtists `json:"similarartists"`
}

type Artist struct {
Expand All @@ -14,15 +15,17 @@ type Artist struct {
Listeners string `json:"listeners"`
Plays string `json:"plays"`
} `json:"stats"`
Similar struct {
Artists []Artist `json:"artist"`
} `json:"similar"`
Tags struct {
Similar SimilarArtists `json:"similar"`
Tags struct {
Tag []ArtistTag `json:"tag"`
} `json:"tags"`
Bio ArtistBio `json:"bio"`
}

type SimilarArtists struct {
Artists []Artist `json:"artist"`
}

type ArtistImage struct {
URL string `json:"#text"`
Size string `json:"size"`
Expand Down
13 changes: 13 additions & 0 deletions core/lastfm/responses_test.go
View file
Expand Up @@ -28,6 +28,19 @@ var _ = Describe("LastFM responses", func() {
})
})

Describe("SimilarArtists", func() {
It("parses the response correctly", func() {
var resp Response
body, _ := ioutil.ReadFile("tests/fixtures/lastfm.artist.getsimilar.json")
err := json.Unmarshal(body, &resp)
Expect(err).To(BeNil())

Expect(resp.SimilarArtists.Artists).To(HaveLen(2))
Expect(resp.SimilarArtists.Artists[0].Name).To(Equal("Passengers"))
Expect(resp.SimilarArtists.Artists[1].Name).To(Equal("INXS"))
})
})

Describe("Error", func() {
It("parses the error response correctly", func() {
var error Error
Expand Down
1 change: 0 additions & 1 deletion model/artist_info.go
View file
Expand Up @@ -5,7 +5,6 @@ type ArtistInfo struct {
Name string
MBID string
Biography string
Similar []Artist
SmallImageUrl string
MediumImageUrl string
LargeImageUrl string
Expand Down
2 changes: 2 additions & 0 deletions server/subsonic/api.go
View file
Expand Up @@ -79,6 +79,8 @@ func (api *Router) routes() http.Handler {
H(withPlayer, "getArtistInfo", c.GetArtistInfo)
H(withPlayer, "getArtistInfo2", c.GetArtistInfo2)
H(withPlayer, "getTopSongs", c.GetTopSongs)
H(withPlayer, "getSimilarSongs", c.GetSimilarSongs)
H(withPlayer, "getSimilarSongs2", c.GetSimilarSongs2)
})
r.Group(func(r chi.Router) {
c := initAlbumListController(api)
Expand Down

0 comments on commit e9e09a7

Please sign in to comment.