Add req.Params to replace utils.Param*

2023-12-21 16:32:37 -05:00
parent 965fc9d9be
commit 00597e01e9
5 changed files with 393 additions and 39 deletions
@@ -0,0 +1,140 @@
+package req
+
+import (
+	"errors"
+	"fmt"
+	"net/http"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/navidrome/navidrome/log"
+	"github.com/navidrome/navidrome/utils"
+)
+
+type Values struct {
+	*http.Request
+}
+
+func Params(r *http.Request) *Values {
+	return &Values{r}
+}
+
+var (
+	ErrMissingParam = errors.New("missing parameter")
+	ErrInvalidParam = errors.New("invalid parameter")
+)
+
+func newError(err error, param string) error {
+	return fmt.Errorf("%w: '%s'", err, param)
+}
+func (r *Values) String(param string) (string, error) {
+	v := r.URL.Query().Get(param)
+	if v == "" {
+		return "", newError(ErrMissingParam, param)
+	}
+	return v, nil
+}
+
+func (r *Values) StringOr(param, def string) string {
+	v, _ := r.String(param)
+	if v == "" {
+		return def
+	}
+	return v
+}
+
+func (r *Values) Strings(param string) ([]string, error) {
+	values := r.URL.Query()[param]
+	if len(values) == 0 {
+		return nil, newError(ErrMissingParam, param)
+	}
+	return values, nil
+}
+
+func (r *Values) TimeOr(param string, def time.Time) time.Time {
+	v, _ := r.String(param)
+	if v == "" || v == "-1" {
+		return def
+	}
+	value, err := strconv.ParseInt(v, 10, 64)
+	if err != nil {
+		return def
+	}
+	t := utils.ToTime(value)
+	if t.Before(time.Date(1970, time.January, 2, 0, 0, 0, 0, time.UTC)) {
+		return def
+	}
+	return t
+}
+
+func (r *Values) Times(param string) []time.Time {
+	pStr, _ := r.Strings(param)
+	times := make([]time.Time, len(pStr))
+	for i, t := range pStr {
+		ti, err := strconv.ParseInt(t, 10, 64)
+		if err != nil {
+			log.Warn(r.Context(), "Ignoring invalid time param", "time", t, err)
+			times[i] = time.Now()
+			continue
+		}
+		times[i] = utils.ToTime(ti)
+	}
+	return times
+}
+
+func (r *Values) Int64(param string) (int64, error) {
+	v, err := r.String(param)
+	if err != nil {
+		return 0, err
+	}
+	value, err := strconv.ParseInt(v, 10, 64)
+	if err != nil {
+		return 0, fmt.Errorf("%w '%s': expected integer, got '%s'", ErrInvalidParam, param, v)
+	}
+	return value, nil
+}
+
+func (r *Values) Int(param string) (int, error) {
+	v, err := r.Int64(param)
+	if err != nil {
+		return 0, err
+	}
+	return int(v), nil
+}
+
+func (r *Values) IntOr(param string, def int) int {
+	v, err := r.Int64(param)
+	if err != nil {
+		return def
+	}
+	return int(v)
+}
+
+func (r *Values) Int64Or(param string, def int64) int64 {
+	v, err := r.Int64(param)
+	if err != nil {
+		return def
+	}
+	return v
+}
+
+func (r *Values) Ints(param string) []int {
+	pStr, _ := r.Strings(param)
+	ints := make([]int, 0, len(pStr))
+	for _, s := range pStr {
+		i, err := strconv.ParseInt(s, 10, 64)
+		if err == nil {
+			ints = append(ints, int(i))
+		}
+	}
+	return ints
+}
+
+func (r *Values) BoolOr(param string, def bool) bool {
+	v, _ := r.String(param)
+	if v == "" {
+		return def
+	}
+	return strings.Contains("/true/on/1/", "/"+strings.ToLower(v)+"/")
+}
@@ -0,0 +1,208 @@
+package req_test
+
+import (
+	"fmt"
+	"net/http/httptest"
+	"testing"
+	"time"
+
+	"github.com/navidrome/navidrome/utils"
+	"github.com/navidrome/navidrome/utils/req"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestUtils(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Request Helpers Suite")
+}
+
+var _ = Describe("Request Helpers", func() {
+	var r *req.Values
+
+	Describe("ParamString", func() {
+		BeforeEach(func() {
+			r = req.Params(httptest.NewRequest("GET", "/ping?a=123", nil))
+		})
+
+		It("returns param as string", func() {
+			Expect(r.String("a")).To(Equal("123"))
+		})
+
+		It("returns empty string if param does not exist", func() {
+			v, err := r.String("NON_EXISTENT_PARAM")
+			Expect(err).To(MatchError(req.ErrMissingParam))
+			Expect(err.Error()).To(ContainSubstring("NON_EXISTENT_PARAM"))
+			Expect(v).To(BeEmpty())
+		})
+	})
+
+	Describe("ParamStringDefault", func() {
+		BeforeEach(func() {
+			r = req.Params(httptest.NewRequest("GET", "/ping?a=123", nil))
+		})
+
+		It("returns param as string", func() {
+			Expect(r.StringOr("a", "default_value")).To(Equal("123"))
+		})
+
+		It("returns default string if param does not exist", func() {
+			Expect(r.StringOr("xx", "default_value")).To(Equal("default_value"))
+		})
+	})
+
+	Describe("ParamStrings", func() {
+		BeforeEach(func() {
+			r = req.Params(httptest.NewRequest("GET", "/ping?a=123&a=456", nil))
+		})
+
+		It("returns all param occurrences as []string", func() {
+			Expect(r.Strings("a")).To(Equal([]string{"123", "456"}))
+		})
+
+		It("returns empty array if param does not exist", func() {
+			v, err := r.Strings("xx")
+			Expect(err).To(MatchError(req.ErrMissingParam))
+			Expect(v).To(BeEmpty())
+		})
+	})
+
+	Describe("ParamTime", func() {
+		d := time.Date(2002, 8, 9, 12, 11, 13, 1000000, time.Local)
+		t := utils.ToMillis(d)
+		now := time.Now()
+		BeforeEach(func() {
+			r = req.Params(httptest.NewRequest("GET", fmt.Sprintf("/ping?t=%d&inv=abc", t), nil))
+		})
+
+		It("returns parsed time", func() {
+			Expect(r.TimeOr("t", now)).To(Equal(d))
+		})
+
+		It("returns default time if param does not exist", func() {
+			Expect(r.TimeOr("xx", now)).To(Equal(now))
+		})
+
+		It("returns default time if param is an invalid timestamp", func() {
+			Expect(r.TimeOr("inv", now)).To(Equal(now))
+		})
+	})
+
+	Describe("ParamTimes", func() {
+		d1 := time.Date(2002, 8, 9, 12, 11, 13, 1000000, time.Local)
+		d2 := time.Date(2002, 8, 9, 12, 13, 56, 0000000, time.Local)
+		t1 := utils.ToMillis(d1)
+		t2 := utils.ToMillis(d2)
+		BeforeEach(func() {
+			r = req.Params(httptest.NewRequest("GET", fmt.Sprintf("/ping?t=%d&t=%d", t1, t2), nil))
+		})
+
+		It("returns all param occurrences as []time.Time", func() {
+			Expect(r.Times("t")).To(Equal([]time.Time{d1, d2}))
+		})
+
+		It("returns empty string if param does not exist", func() {
+			Expect(r.Times("xx")).To(BeEmpty())
+		})
+
+		It("returns current time as default if param is invalid", func() {
+			now := time.Now()
+			r = req.Params(httptest.NewRequest("GET", "/ping?t=null", nil))
+			times := r.Times("t")
+			Expect(times).To(HaveLen(1))
+			Expect(times[0]).To(BeTemporally(">=", now))
+		})
+	})
+
+	Describe("ParamInt", func() {
+		BeforeEach(func() {
+			r = req.Params(httptest.NewRequest("GET", "/ping?i=123&inv=123.45", nil))
+		})
+		Context("int", func() {
+			It("returns parsed int", func() {
+				Expect(r.IntOr("i", 999)).To(Equal(123))
+			})
+
+			It("returns default value if param does not exist", func() {
+				Expect(r.IntOr("xx", 999)).To(Equal(999))
+			})
+
+			It("returns default value if param is an invalid int", func() {
+				Expect(r.IntOr("inv", 999)).To(Equal(999))
+			})
+		})
+		Context("int64", func() {
+			It("returns parsed int64", func() {
+				Expect(r.IntOr("i", 999)).To(Equal(123))
+			})
+
+			It("returns default value if param does not exist", func() {
+				Expect(r.IntOr("xx", 999)).To(Equal(999))
+			})
+
+			It("returns default value if param is an invalid int", func() {
+				Expect(r.IntOr("inv", 999)).To(Equal(999))
+			})
+		})
+	})
+
+	Describe("ParamInts", func() {
+		BeforeEach(func() {
+			r = req.Params(httptest.NewRequest("GET", "/ping?i=123&i=456", nil))
+		})
+
+		It("returns array of occurrences found", func() {
+			Expect(r.Ints("i")).To(Equal([]int{123, 456}))
+		})
+
+		It("returns empty array if param does not exist", func() {
+			Expect(r.Ints("xx")).To(BeEmpty())
+		})
+	})
+
+	Describe("ParamBool", func() {
+		Context("value is true", func() {
+			BeforeEach(func() {
+				r = req.Params(httptest.NewRequest("GET", "/ping?b=true&c=on&d=1&e=True", nil))
+			})
+
+			It("parses 'true'", func() {
+				Expect(r.BoolOr("b", false)).To(BeTrue())
+			})
+
+			It("parses 'on'", func() {
+				Expect(r.BoolOr("c", false)).To(BeTrue())
+			})
+
+			It("parses '1'", func() {
+				Expect(r.BoolOr("d", false)).To(BeTrue())
+			})
+
+			It("parses 'True'", func() {
+				Expect(r.BoolOr("e", false)).To(BeTrue())
+			})
+		})
+
+		Context("value is false", func() {
+			BeforeEach(func() {
+				r = req.Params(httptest.NewRequest("GET", "/ping?b=false&c=off&d=0", nil))
+			})
+
+			It("parses 'false'", func() {
+				Expect(r.BoolOr("b", true)).To(BeFalse())
+			})
+
+			It("parses 'off'", func() {
+				Expect(r.BoolOr("c", true)).To(BeFalse())
+			})
+
+			It("parses '0'", func() {
+				Expect(r.BoolOr("d", true)).To(BeFalse())
+			})
+
+			It("returns default value if param does not exist", func() {
+				Expect(r.BoolOr("xx", true)).To(BeTrue())
+			})
+		})
+	})
+})