Use userId in player, other fixes (#3182)

* [bugfix] player: use userId, other fixes

This PR primarily resolves #1928 by switching the foreign key of `player` from `user.user_name` to `user.id`.
There are also a few other fixes/changes:

- For some bizarre reason, `ip_address` is never returned from `read`/`get`. Change the field to `ip`, which works. Somehow
- Update `players_test.go` mock to also check for user agent, replicating the actual code
- Update `player_repository.go` `isPermitted` to check user id. I don't know how this worked before...
- tests!
- a few places referred to `typ`, when it is really `userAgent`. Change the field names

* baseRequest -> selectPlayer

* remove comment

* update migration, make all of persistence foreign key enabled

* maybe don't forget to save the file first

core/players.go

@@ -13,7 +13,7 @@ import (
 
 type Players interface {
 	Get(ctx context.Context, playerId string) (*model.Player, error)
-	Register(ctx context.Context, id, client, typ, ip string) (*model.Player, *model.Transcoding, error)
+	Register(ctx context.Context, id, client, userAgent, ip string) (*model.Player, *model.Transcoding, error)
 }
 
 func NewPlayers(ds model.DataStore) Players {
@@ -28,7 +28,7 @@ func (p *players) Register(ctx context.Context, id, client, userAgent, ip string
 	var plr *model.Player
 	var trc *model.Transcoding
 	var err error
-	userName, _ := request.UsernameFrom(ctx)
+	user, _ := request.UserFrom(ctx)
 	if id != "" {
 		plr, err = p.ds.Player(ctx).Get(id)
 		if err == nil && plr.Client != client {
@@ -36,13 +36,13 @@ func (p *players) Register(ctx context.Context, id, client, userAgent, ip string
 		}
 	}
 	if err != nil || id == "" {
-		plr, err = p.ds.Player(ctx).FindMatch(userName, client, userAgent)
+		plr, err = p.ds.Player(ctx).FindMatch(user.ID, client, userAgent)
 		if err == nil {
 			log.Debug(ctx, "Found matching player", "id", plr.ID, "client", client, "username", userName, "type", userAgent)
 		} else {
 			plr = &model.Player{
 				ID:              uuid.NewString(),
-				UserName:        userName,
+				UserId:          user.ID,
 				Client:          client,
 				ScrobbleEnabled: true,
 			}
@@ -51,7 +51,7 @@ func (p *players) Register(ctx context.Context, id, client, userAgent, ip string
 	}
 	plr.Name = fmt.Sprintf("%s [%s]", client, userAgent)
 	plr.UserAgent = userAgent
-	plr.IPAddress = ip
+	plr.IP = ip
 	plr.LastSeen = time.Now()
 	err = p.ds.Player(ctx).Put(plr)
 	if err != nil {

core/players_test.go

@@ -34,7 +34,7 @@ var _ = Describe("Players", func() {
 			Expect(p.ID).ToNot(BeEmpty())
 			Expect(p.LastSeen).To(BeTemporally(">=", beforeRegister))
 			Expect(p.Client).To(Equal("client"))
-			Expect(p.UserName).To(Equal("johndoe"))
+			Expect(p.UserId).To(Equal("userid"))
 			Expect(p.UserAgent).To(Equal("chrome"))
 			Expect(repo.lastSaved).To(Equal(p))
 			Expect(trc).To(BeNil())
@@ -73,7 +73,7 @@ var _ = Describe("Players", func() {
 		})
 
 		It("finds player by client and user names when ID is not found", func() {
-			plr := &model.Player{ID: "123", Name: "A Player", Client: "client", UserName: "johndoe", LastSeen: time.Time{}}
+			plr := &model.Player{ID: "123", Name: "A Player", Client: "client", UserId: "userid", UserAgent: "chrome", LastSeen: time.Time{}}
 			repo.add(plr)
 			p, _, err := players.Register(ctx, "999", "client", "chrome", "1.2.3.4")
 			Expect(err).ToNot(HaveOccurred())
@@ -83,7 +83,7 @@ var _ = Describe("Players", func() {
 		})
 
 		It("finds player by client and user names when not ID is provided", func() {
-			plr := &model.Player{ID: "123", Name: "A Player", Client: "client", UserName: "johndoe", LastSeen: time.Time{}}
+			plr := &model.Player{ID: "123", Name: "A Player", Client: "client", UserId: "userid", UserAgent: "chrome", LastSeen: time.Time{}}
 			repo.add(plr)
 			p, _, err := players.Register(ctx, "", "client", "chrome", "1.2.3.4")
 			Expect(err).ToNot(HaveOccurred())
@@ -102,6 +102,22 @@ var _ = Describe("Players", func() {
 			Expect(repo.lastSaved).To(Equal(p))
 			Expect(trc.ID).To(Equal("1"))
 		})
+
+		Context("bad username casing", func() {
+			ctx := log.NewContext(context.TODO())
+			ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "Johndoe"})
+			ctx = request.WithUsername(ctx, "Johndoe")
+
+			It("finds player by client and user names when not ID is provided", func() {
+				plr := &model.Player{ID: "123", Name: "A Player", Client: "client", UserId: "userid", UserAgent: "chrome", LastSeen: time.Time{}}
+				repo.add(plr)
+				p, _, err := players.Register(ctx, "", "client", "chrome", "1.2.3.4")
+				Expect(err).ToNot(HaveOccurred())
+				Expect(p.ID).To(Equal("123"))
+				Expect(p.LastSeen).To(BeTemporally(">=", beforeRegister))
+				Expect(repo.lastSaved).To(Equal(p))
+			})
+		})
 	})
 })
 
@@ -125,9 +141,9 @@ func (m *mockPlayerRepository) Get(id string) (*model.Player, error) {
 	return nil, model.ErrNotFound
 }
 
-func (m *mockPlayerRepository) FindMatch(userName, client, typ string) (*model.Player, error) {
+func (m *mockPlayerRepository) FindMatch(userId, client, userAgent string) (*model.Player, error) {
 	for _, p := range m.data {
-		if p.Client == client && p.UserName == userName {
+		if p.Client == client && p.UserId == userId && p.UserAgent == userAgent {
 			return &p, nil
 		}
 	}

core/scrobbler/play_tracker.go

@@ -118,7 +118,7 @@ func (p *playTracker) Submit(ctx context.Context, submissions []Submission) erro
 	username, _ := request.UsernameFrom(ctx)
 	player, _ := request.PlayerFrom(ctx)
 	if !player.ScrobbleEnabled {
-		log.Debug(ctx, "External scrobbling disabled for this player", "player", player.Name, "ip", player.IPAddress, "user", username)
+		log.Debug(ctx, "External scrobbling disabled for this player", "player", player.Name, "ip", player.IP, "user", username)
 	}
 	event := &events.RefreshResource{}
 	success := 0