Fix staticcheck's SA1029

engine/common.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/deluan/navidrome/consts"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 )
 
 type Entry struct {
@@ -159,10 +160,9 @@ func FromArtists(ars model.Artists) Entries {
 }
 
 func userName(ctx context.Context) string {
-	user := ctx.Value("user")
+	if user, ok := request.UserFrom(ctx); !ok {
-	if user == nil {
 		return "UNKNOWN"
+	} else {
+		return user.UserName
 	}
-	usr := user.(model.User)
-	return usr.UserName
 }

engine/media_streamer.go

@@ -13,6 +13,7 @@ import (
 	"github.com/deluan/navidrome/engine/transcoder"
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/djherbis/fscache"
 )
 
@@ -161,7 +162,7 @@ func selectTranscodingOptions(ctx context.Context, ds model.DataStore, mf *model
 		bitRate = mf.BitRate
 		return
 	}
-	trc, hasDefault := ctx.Value("transcoding").(model.Transcoding)
+	trc, hasDefault := request.TranscodingFrom(ctx)
 	var cFormat string
 	var cBitRate int
 	if reqFormat != "" {
@@ -170,7 +171,7 @@ func selectTranscodingOptions(ctx context.Context, ds model.DataStore, mf *model
 		if hasDefault {
 			cFormat = trc.TargetFormat
 			cBitRate = trc.DefaultBitRate
-			if p, ok := ctx.Value("player").(model.Player); ok {
+			if p, ok := request.PlayerFrom(ctx); ok {
 				cBitRate = p.MaxBitRate
 			}
 		}

engine/media_streamer_test.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/deluan/navidrome/persistence"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -101,7 +102,7 @@ var _ = Describe("MediaStreamer", func() {
 		Context("player has format configured", func() {
 			BeforeEach(func() {
 				t := model.Transcoding{ID: "oga1", TargetFormat: "oga", DefaultBitRate: 96}
-				ctx = context.WithValue(ctx, "transcoding", t)
+				ctx = request.WithTranscoding(ctx, t)
 			})
 			It("returns raw if raw is requested", func() {
 				mf.Suffix = "flac"
@@ -142,8 +143,8 @@ var _ = Describe("MediaStreamer", func() {
 			BeforeEach(func() {
 				t := model.Transcoding{ID: "oga1", TargetFormat: "oga", DefaultBitRate: 96}
 				p := model.Player{ID: "player1", TranscodingId: t.ID, MaxBitRate: 80}
-				ctx = context.WithValue(ctx, "transcoding", t)
+				ctx = request.WithTranscoding(ctx, t)
-				ctx = context.WithValue(ctx, "player", p)
+				ctx = request.WithPlayer(ctx, p)
 			})
 			It("returns raw if raw is requested", func() {
 				mf.Suffix = "flac"

engine/players.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/google/uuid"
 )
 
@@ -27,7 +28,7 @@ func (p *players) Register(ctx context.Context, id, client, typ, ip string) (*mo
 	var plr *model.Player
 	var trc *model.Transcoding
 	var err error
-	userName := ctx.Value("username").(string)
+	userName, _ := request.UsernameFrom(ctx)
 	if id != "" {
 		plr, err = p.ds.Player(ctx).Get(id)
 		if err == nil && plr.Client != client {

engine/players_test.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/deluan/navidrome/persistence"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -14,8 +15,9 @@ import (
 var _ = Describe("Players", func() {
 	var players Players
 	var repo *mockPlayerRepository
-	ctx := context.WithValue(log.NewContext(context.TODO()), "user", model.User{ID: "userid", UserName: "johndoe"})
+	ctx := log.NewContext(context.TODO())
-	ctx = context.WithValue(ctx, "username", "johndoe")
+	ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "johndoe"})
+	ctx = request.WithUsername(ctx, "johndoe")
 	var beforeRegister time.Time
 
 	BeforeEach(func() {

engine/playlists.go

@@ -5,6 +5,7 @@ import (
 	"time"
 
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/deluan/navidrome/utils"
 )
 
@@ -52,7 +53,7 @@ func (p *playlists) Create(ctx context.Context, playlistId, name string, ids []s
 }
 
 func (p *playlists) getUser(ctx context.Context) string {
-	user, ok := ctx.Value("user").(model.User)
+	user, ok := request.UserFrom(ctx)
 	if ok {
 		return user.UserName
 	}

log/log.go

@@ -24,6 +24,10 @@ const (
 	LevelTrace    = Level(logrus.TraceLevel)
 )
 
+type contextKey string
+
+const loggerCtxKey = contextKey("logger")
+
 var (
 	currentLevel  Level
 	defaultLogger = logrus.New()
@@ -66,7 +70,7 @@ func NewContext(ctx context.Context, keyValuePairs ...interface{}) context.Conte
 	}
 
 	logger := addFields(createNewLogger(), keyValuePairs)
-	ctx = context.WithValue(ctx, "logger", logger)
+	ctx = context.WithValue(ctx, loggerCtxKey, logger)
 
 	return ctx
 }
@@ -176,7 +180,7 @@ func extractLogger(ctx interface{}) (*logrus.Entry, error) {
 	case *logrus.Entry:
 		return ctx, nil
 	case context.Context:
-		logger := ctx.Value("logger")
+		logger := ctx.Value(loggerCtxKey)
 		if logger != nil {
 			return logger.(*logrus.Entry), nil
 		}

log/log_test.go

@@ -136,7 +136,7 @@ var _ = Describe("Logger", func() {
 		It("returns the logger from context if it has one", func() {
 			logger := logrus.NewEntry(logrus.New())
 			ctx := context.Background()
-			ctx = context.WithValue(ctx, "logger", logger)
+			ctx = context.WithValue(ctx, loggerCtxKey, logger)
 
 			Expect(extractLogger(ctx)).To(Equal(logger))
 		})
@@ -144,7 +144,7 @@ var _ = Describe("Logger", func() {
 		It("returns the logger from request's context if it has one", func() {
 			logger := logrus.NewEntry(logrus.New())
 			ctx := context.Background()
-			ctx = context.WithValue(ctx, "logger", logger)
+			ctx = context.WithValue(ctx, loggerCtxKey, logger)
 			req := httptest.NewRequest("get", "/", nil).WithContext(ctx)
 
 			Expect(extractLogger(req)).To(Equal(logger))

model/request/request.go

@@ -0,0 +1,72 @@
+package request
+
+import (
+	"context"
+
+	"github.com/deluan/navidrome/model"
+)
+
+type contextKey string
+
+const (
+	User        = contextKey("user")
+	Username    = contextKey("username")
+	Client      = contextKey("client")
+	Version     = contextKey("version")
+	Player      = contextKey("player")
+	Transcoding = contextKey("transcoding")
+)
+
+func WithUser(ctx context.Context, u model.User) context.Context {
+	return context.WithValue(ctx, User, u)
+}
+
+func WithUsername(ctx context.Context, username string) context.Context {
+	return context.WithValue(ctx, Username, username)
+}
+
+func WithClient(ctx context.Context, client string) context.Context {
+	return context.WithValue(ctx, Client, client)
+}
+
+func WithVersion(ctx context.Context, version string) context.Context {
+	return context.WithValue(ctx, Version, version)
+}
+
+func WithPlayer(ctx context.Context, player model.Player) context.Context {
+	return context.WithValue(ctx, Player, player)
+}
+
+func WithTranscoding(ctx context.Context, t model.Transcoding) context.Context {
+	return context.WithValue(ctx, Transcoding, t)
+}
+
+func UserFrom(ctx context.Context) (model.User, bool) {
+	v, ok := ctx.Value(User).(model.User)
+	return v, ok
+}
+
+func UsernameFrom(ctx context.Context) (string, bool) {
+	v, ok := ctx.Value(Username).(string)
+	return v, ok
+}
+
+func ClientFrom(ctx context.Context) (string, bool) {
+	v, ok := ctx.Value(Client).(string)
+	return v, ok
+}
+
+func VersionFrom(ctx context.Context) (string, bool) {
+	v, ok := ctx.Value(Version).(string)
+	return v, ok
+}
+
+func PlayerFrom(ctx context.Context) (model.Player, bool) {
+	v, ok := ctx.Value(Player).(model.Player)
+	return v, ok
+}
+
+func TranscodingFrom(ctx context.Context) (model.Transcoding, bool) {
+	v, ok := ctx.Value(Transcoding).(model.Transcoding)
+	return v, ok
+}

persistence/album_repository_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/astaxie/beego/orm"
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 )
@@ -14,7 +15,7 @@ var _ = Describe("AlbumRepository", func() {
 	var repo model.AlbumRepository
 
 	BeforeEach(func() {
-		ctx := context.WithValue(log.NewContext(context.TODO()), "user", model.User{ID: "userid"})
+		ctx := request.WithUser(log.NewContext(context.TODO()), model.User{ID: "userid", UserName: "johndoe"})
 		repo = NewAlbumRepository(ctx, orm.NewOrm())
 	})
 

persistence/artist_repository_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/astaxie/beego/orm"
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 )
@@ -14,7 +15,8 @@ var _ = Describe("ArtistRepository", func() {
 	var repo model.ArtistRepository
 
 	BeforeEach(func() {
-		ctx := context.WithValue(log.NewContext(context.TODO()), "user", model.User{ID: "userid"})
+		ctx := log.NewContext(context.TODO())
+		ctx = request.WithUser(ctx, model.User{ID: "userid"})
 		repo = NewArtistRepository(ctx, orm.NewOrm())
 	})
 

persistence/mediafile_repository_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/astaxie/beego/orm"
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/google/uuid"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -16,7 +17,8 @@ var _ = Describe("MediaRepository", func() {
 	var mr model.MediaFileRepository
 
 	BeforeEach(func() {
-		ctx := context.WithValue(log.NewContext(context.TODO()), "user", model.User{ID: "userid"})
+		ctx := log.NewContext(context.TODO())
+		ctx = request.WithUser(ctx, model.User{ID: "userid"})
 		mr = NewMediaFileRepository(ctx, orm.NewOrm())
 	})
 

persistence/persistence_suite_test.go

@@ -10,6 +10,7 @@ import (
 	"github.com/deluan/navidrome/db"
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/deluan/navidrome/tests"
 	_ "github.com/mattn/go-sqlite3"
 	. "github.com/onsi/ginkgo"
@@ -84,7 +85,8 @@ var _ = Describe("Initialize test DB", func() {
 	// TODO Load this data setup from file(s)
 	BeforeSuite(func() {
 		o := orm.NewOrm()
-		ctx := context.WithValue(log.NewContext(context.TODO()), "user", model.User{ID: "userid"})
+		ctx := log.NewContext(context.TODO())
+		ctx = request.WithUser(ctx, model.User{ID: "userid"})
 		mr := NewMediaFileRepository(ctx, o)
 		for i := range testSongs {
 			s := testSongs[i]

persistence/sql_base_repository.go

@@ -11,6 +11,7 @@ import (
 	"github.com/astaxie/beego/orm"
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/google/uuid"
 )
 
@@ -24,21 +25,19 @@ type sqlRepository struct {
 const invalidUserId = "-1"
 
 func userId(ctx context.Context) string {
-	user := ctx.Value("user")
+	if user, ok := request.UserFrom(ctx); !ok {
-	if user == nil {
 		return invalidUserId
+	} else {
+		return user.ID
 	}
-	usr := user.(model.User)
-	return usr.ID
 }
 
 func loggedUser(ctx context.Context) *model.User {
-	user := ctx.Value("user")
+	if user, ok := request.UserFrom(ctx); !ok {
-	if user == nil {
 		return &model.User{}
+	} else {
+		return &user
 	}
-	u := user.(model.User)
-	return &u
 }
 
 func (r sqlRepository) newSelect(options ...model.QueryOptions) SelectBuilder {

server/app/auth.go

@@ -12,6 +12,7 @@ import (
 	"github.com/deluan/navidrome/engine/auth"
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/deluan/rest"
 	"github.com/dgrijalva/jwt-go"
 	"github.com/go-chi/jwtauth"
@@ -146,7 +147,7 @@ func validateLogin(userRepo model.UserRepository, userName, password string) (*m
 func contextWithUser(ctx context.Context, ds model.DataStore, claims jwt.MapClaims) context.Context {
 	userName := claims["sub"].(string)
 	user, _ := ds.User(ctx).FindByUsername(userName)
-	return context.WithValue(ctx, "user", *user)
+	return request.WithUser(ctx, *user)
 }
 
 func getToken(ds model.DataStore, ctx context.Context) (*jwt.Token, error) {

server/subsonic/helpers.go

@@ -10,6 +10,7 @@ import (
 	"github.com/deluan/navidrome/consts"
 	"github.com/deluan/navidrome/engine"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/deluan/navidrome/server/subsonic/responses"
 	"github.com/deluan/navidrome/utils"
 )
@@ -154,10 +155,10 @@ func ToGenres(genres model.Genres) *responses.Genres {
 }
 
 func getTranscoding(ctx context.Context) (format string, bitRate int) {
-	if trc, ok := ctx.Value("transcoding").(model.Transcoding); ok {
+	if trc, ok := request.TranscodingFrom(ctx); ok {
 		format = trc.TargetFormat
 	}
-	if plr, ok := ctx.Value("player").(model.Player); ok {
+	if plr, ok := request.PlayerFrom(ctx); ok {
 		bitRate = plr.MaxBitRate
 	}
 	return

server/subsonic/middlewares.go

@@ -1,7 +1,6 @@
 package subsonic
 
 import (
-	"context"
 	"fmt"
 	"net"
 	"net/http"
@@ -11,6 +10,7 @@ import (
 	"github.com/deluan/navidrome/engine"
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	"github.com/deluan/navidrome/server/subsonic/responses"
 	"github.com/deluan/navidrome/utils"
 )
@@ -50,14 +50,14 @@ func checkRequiredParameters(next http.Handler) http.Handler {
 			}
 		}
 
-		user := utils.ParamString(r, "u")
+		username := utils.ParamString(r, "u")
 		client := utils.ParamString(r, "c")
 		version := utils.ParamString(r, "v")
 		ctx := r.Context()
-		ctx = context.WithValue(ctx, "username", user)
+		ctx = request.WithUsername(ctx, username)
-		ctx = context.WithValue(ctx, "client", client)
+		ctx = request.WithClient(ctx, client)
-		ctx = context.WithValue(ctx, "version", version)
+		ctx = request.WithVersion(ctx, version)
-		log.Debug(ctx, "API: New request "+r.URL.Path, "username", user, "client", client, "version", version)
+		log.Debug(ctx, "API: New request "+r.URL.Path, "username", username, "client", client, "version", version)
 
 		r = r.WithContext(ctx)
 		next.ServeHTTP(w, r)
@@ -87,7 +87,7 @@ func authenticate(users engine.Users) func(next http.Handler) http.Handler {
 			}
 
 			ctx := r.Context()
-			ctx = context.WithValue(ctx, "user", *usr)
+			ctx = request.WithUser(ctx, *usr)
 			r = r.WithContext(ctx)
 
 			next.ServeHTTP(w, r)
@@ -99,17 +99,17 @@ func getPlayer(players engine.Players) func(next http.Handler) http.Handler {
 	return func(next http.Handler) http.Handler {
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			ctx := r.Context()
-			userName := ctx.Value("username").(string)
+			userName, _ := request.UsernameFrom(ctx)
-			client := ctx.Value("client").(string)
+			client, _ := request.ClientFrom(ctx)
 			playerId := playerIDFromCookie(r, userName)
 			ip, _, _ := net.SplitHostPort(r.RemoteAddr)
 			player, trc, err := players.Register(ctx, playerId, client, r.Header.Get("user-agent"), ip)
 			if err != nil {
 				log.Error("Could not register player", "userName", userName, "client", client)
 			} else {
-				ctx = context.WithValue(ctx, "player", *player)
+				ctx = request.WithPlayer(ctx, *player)
 				if trc != nil {
-					ctx = context.WithValue(ctx, "transcoding", *trc)
+					ctx = request.WithTranscoding(ctx, *trc)
 				}
 				r = r.WithContext(ctx)
 

server/subsonic/middlewares_test.go

@@ -10,6 +10,7 @@ import (
 	"github.com/deluan/navidrome/engine"
 	"github.com/deluan/navidrome/log"
 	"github.com/deluan/navidrome/model"
+	"github.com/deluan/navidrome/model/request"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 )
@@ -73,9 +74,13 @@ var _ = Describe("Middlewares", func() {
 			cp := checkRequiredParameters(next)
 			cp.ServeHTTP(w, r)
 
-			Expect(next.req.Context().Value("username")).To(Equal("user"))
+			username, _ := request.UsernameFrom(next.req.Context())
-			Expect(next.req.Context().Value("version")).To(Equal("1.15"))
+			Expect(username).To(Equal("user"))
-			Expect(next.req.Context().Value("client")).To(Equal("test"))
+			version, _ := request.VersionFrom(next.req.Context())
+			Expect(version).To(Equal("1.15"))
+			client, _ := request.ClientFrom(next.req.Context())
+			Expect(client).To(Equal("test"))
+
 			Expect(next.called).To(BeTrue())
 		})
 
@@ -124,7 +129,7 @@ var _ = Describe("Middlewares", func() {
 			Expect(mockedUsers.salt).To(Equal("salt"))
 			Expect(mockedUsers.jwt).To(Equal("jwt"))
 			Expect(next.called).To(BeTrue())
-			user := next.req.Context().Value("user").(model.User)
+			user, _ := request.UserFrom(next.req.Context())
 			Expect(user.UserName).To(Equal("valid"))
 		})
 
@@ -144,8 +149,8 @@ var _ = Describe("Middlewares", func() {
 		BeforeEach(func() {
 			mockedPlayers = &mockPlayers{}
 			r = newGetRequest()
-			ctx := context.WithValue(r.Context(), "username", "someone")
+			ctx := request.WithUsername(r.Context(), "someone")
-			ctx = context.WithValue(ctx, "client", "client")
+			ctx = request.WithClient(ctx, "client")
 			r = r.WithContext(ctx)
 		})
 
@@ -158,7 +163,7 @@ var _ = Describe("Middlewares", func() {
 		})
 
 		It("does not add the cookie if there was an error", func() {
-			ctx := context.WithValue(r.Context(), "client", "error")
+			ctx := request.WithClient(r.Context(), "error")
 			r = r.WithContext(ctx)
 
 			gp := getPlayer(mockedPlayers)(next)
@@ -183,9 +188,10 @@ var _ = Describe("Middlewares", func() {
 
 			It("stores the player in the context", func() {
 				Expect(next.called).To(BeTrue())
-				player := next.req.Context().Value("player").(model.Player)
+				player, _ := request.PlayerFrom(next.req.Context())
 				Expect(player.ID).To(Equal("123"))
-				Expect(next.req.Context().Value("transcoding")).To(BeNil())
+				_, ok := request.TranscodingFrom(next.req.Context())
+				Expect(ok).To(BeFalse())
 			})
 
 			It("returns the playerId in the cookie", func() {
@@ -208,9 +214,9 @@ var _ = Describe("Middlewares", func() {
 			})
 
 			It("stores the player in the context", func() {
-				player := next.req.Context().Value("player").(model.Player)
+				player, _ := request.PlayerFrom(next.req.Context())
 				Expect(player.ID).To(Equal("123"))
-				transcoding := next.req.Context().Value("transcoding").(model.Transcoding)
+				transcoding, _ := request.TranscodingFrom(next.req.Context())
 				Expect(transcoding.ID).To(Equal("12"))
 			})
 		})

server/subsonic/responses/responses_suite_test.go

@@ -1,7 +1,6 @@
 package responses
 
 import (
-	"fmt"
 	"testing"
 
 	"github.com/bradleyjkemp/cupaloy"
@@ -33,9 +32,9 @@ func (matcher snapshotMatcher) Match(actual interface{}) (success bool, err erro
 }
 
 func (matcher snapshotMatcher) FailureMessage(actual interface{}) (message string) {
-	return fmt.Sprintf("Expected to match saved snapshot\n")
+	return "Expected to match saved snapshot\n"
 }
 
 func (matcher snapshotMatcher) NegatedFailureMessage(actual interface{}) (message string) {
-	return fmt.Sprintf("Expected to not match saved snapshot\n")
+	return "Expected to not match saved snapshot\n"
 }