331 lines
10 KiB
Go
331 lines
10 KiB
Go
package server
|
|
|
|
import (
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"os"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
"github.com/navidrome/navidrome/conf"
|
|
"github.com/navidrome/navidrome/conf/configtest"
|
|
"github.com/navidrome/navidrome/consts"
|
|
"github.com/navidrome/navidrome/model/request"
|
|
. "github.com/onsi/ginkgo/v2"
|
|
. "github.com/onsi/gomega"
|
|
)
|
|
|
|
var _ = Describe("middlewares", func() {
|
|
BeforeEach(func() {
|
|
DeferCleanup(configtest.SetupConfig())
|
|
})
|
|
Describe("robotsTXT", func() {
|
|
var nextCalled bool
|
|
next := func(w http.ResponseWriter, r *http.Request) {
|
|
nextCalled = true
|
|
}
|
|
BeforeEach(func() {
|
|
nextCalled = false
|
|
})
|
|
|
|
It("returns the robot.txt when requested from root", func() {
|
|
r := httptest.NewRequest("GET", "/robots.txt", nil)
|
|
w := httptest.NewRecorder()
|
|
|
|
robotsTXT(os.DirFS("tests/fixtures"))(http.HandlerFunc(next)).ServeHTTP(w, r)
|
|
|
|
Expect(nextCalled).To(BeFalse())
|
|
Expect(w.Body.String()).To(HavePrefix("User-agent:"))
|
|
})
|
|
|
|
It("allows prefixes", func() {
|
|
r := httptest.NewRequest("GET", "/app/robots.txt", nil)
|
|
w := httptest.NewRecorder()
|
|
|
|
robotsTXT(os.DirFS("tests/fixtures"))(http.HandlerFunc(next)).ServeHTTP(w, r)
|
|
|
|
Expect(nextCalled).To(BeFalse())
|
|
Expect(w.Body.String()).To(HavePrefix("User-agent:"))
|
|
})
|
|
|
|
It("passes through requests for other files", func() {
|
|
r := httptest.NewRequest("GET", "/this_is_not_a_robots.txt_file", nil)
|
|
w := httptest.NewRecorder()
|
|
|
|
robotsTXT(os.DirFS("tests/fixtures"))(http.HandlerFunc(next)).ServeHTTP(w, r)
|
|
|
|
Expect(nextCalled).To(BeTrue())
|
|
})
|
|
})
|
|
|
|
Describe("serverAddressMiddleware", func() {
|
|
var (
|
|
nextHandler http.Handler
|
|
middleware http.Handler
|
|
recorder *httptest.ResponseRecorder
|
|
req *http.Request
|
|
)
|
|
|
|
BeforeEach(func() {
|
|
nextHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
})
|
|
middleware = serverAddressMiddleware(nextHandler)
|
|
recorder = httptest.NewRecorder()
|
|
})
|
|
|
|
Context("with no X-Forwarded headers", func() {
|
|
BeforeEach(func() {
|
|
req, _ = http.NewRequest("GET", "http://example.com", nil)
|
|
})
|
|
|
|
It("should not modify the request", func() {
|
|
middleware.ServeHTTP(recorder, req)
|
|
Expect(req.Host).To(Equal("example.com"))
|
|
Expect(req.URL.Scheme).To(Equal("http"))
|
|
})
|
|
})
|
|
|
|
Context("with X-Forwarded-Host header", func() {
|
|
BeforeEach(func() {
|
|
req, _ = http.NewRequest("GET", "http://example.com", nil)
|
|
req.Header.Set("X-Forwarded-Host", "forwarded.example.com")
|
|
})
|
|
|
|
It("should modify the request with the X-Forwarded-Host header value", func() {
|
|
middleware.ServeHTTP(recorder, req)
|
|
Expect(req.Host).To(Equal("forwarded.example.com"))
|
|
Expect(req.URL.Scheme).To(Equal("http"))
|
|
})
|
|
})
|
|
|
|
Context("with X-Forwarded-Proto header", func() {
|
|
BeforeEach(func() {
|
|
req, _ = http.NewRequest("GET", "http://example.com", nil)
|
|
req.Header.Set("X-Forwarded-Proto", "https")
|
|
})
|
|
|
|
It("should modify the request with the X-Forwarded-Proto header value", func() {
|
|
middleware.ServeHTTP(recorder, req)
|
|
Expect(req.Host).To(Equal("example.com"))
|
|
Expect(req.URL.Scheme).To(Equal("https"))
|
|
})
|
|
})
|
|
|
|
Context("with X-Forwarded-Scheme header", func() {
|
|
BeforeEach(func() {
|
|
req, _ = http.NewRequest("GET", "http://example.com", nil)
|
|
req.Header.Set("X-Forwarded-Scheme", "https")
|
|
})
|
|
|
|
It("should modify the request with the X-Forwarded-Scheme header value", func() {
|
|
middleware.ServeHTTP(recorder, req)
|
|
Expect(req.Host).To(Equal("example.com"))
|
|
Expect(req.URL.Scheme).To(Equal("https"))
|
|
})
|
|
})
|
|
|
|
Context("with multiple X-Forwarded headers", func() {
|
|
BeforeEach(func() {
|
|
req, _ = http.NewRequest("GET", "http://example.com", nil)
|
|
req.Header.Set("X-Forwarded-Host", "forwarded.example.com")
|
|
req.Header.Set("X-Forwarded-Proto", "https")
|
|
req.Header.Set("X-Forwarded-Scheme", "http")
|
|
})
|
|
|
|
It("should modify the request with the first non-empty X-Forwarded header value", func() {
|
|
middleware.ServeHTTP(recorder, req)
|
|
Expect(req.Host).To(Equal("forwarded.example.com"))
|
|
Expect(req.URL.Scheme).To(Equal("https"))
|
|
})
|
|
})
|
|
|
|
Context("with multiple values in X-Forwarded-Host header", func() {
|
|
BeforeEach(func() {
|
|
req, _ = http.NewRequest("GET", "http://example.com", nil)
|
|
req.Header.Set("X-Forwarded-Host", "forwarded1.example.com, forwarded2.example.com")
|
|
})
|
|
|
|
It("should modify the request with the first value in X-Forwarded-Host header", func() {
|
|
middleware.ServeHTTP(recorder, req)
|
|
Expect(req.Host).To(Equal("forwarded1.example.com"))
|
|
Expect(req.URL.Scheme).To(Equal("http"))
|
|
})
|
|
})
|
|
})
|
|
|
|
Describe("clientUniqueIDMiddleware", func() {
|
|
var (
|
|
nextHandler http.Handler
|
|
middleware http.Handler
|
|
req *http.Request
|
|
nextReq *http.Request
|
|
rec *httptest.ResponseRecorder
|
|
)
|
|
|
|
BeforeEach(func() {
|
|
nextHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(http.StatusOK)
|
|
nextReq = r
|
|
})
|
|
middleware = clientUniqueIDMiddleware(nextHandler)
|
|
req, _ = http.NewRequest(http.MethodGet, "/", nil)
|
|
rec = httptest.NewRecorder()
|
|
})
|
|
|
|
Context("when the request header has the unique client ID", func() {
|
|
BeforeEach(func() {
|
|
req.Header.Set(consts.UIClientUniqueIDHeader, "123456")
|
|
conf.Server.BasePath = "/music"
|
|
})
|
|
|
|
It("sets the unique client ID as a cookie and adds it to the request context", func() {
|
|
middleware.ServeHTTP(rec, req)
|
|
|
|
Expect(rec.Result().Cookies()).To(HaveLen(1))
|
|
Expect(rec.Result().Cookies()[0].Name).To(Equal(consts.UIClientUniqueIDHeader))
|
|
Expect(rec.Result().Cookies()[0].Value).To(Equal("123456"))
|
|
Expect(rec.Result().Cookies()[0].MaxAge).To(Equal(consts.CookieExpiry))
|
|
Expect(rec.Result().Cookies()[0].HttpOnly).To(BeTrue())
|
|
Expect(rec.Result().Cookies()[0].Secure).To(BeTrue())
|
|
Expect(rec.Result().Cookies()[0].SameSite).To(Equal(http.SameSiteStrictMode))
|
|
Expect(rec.Result().Cookies()[0].Path).To(Equal("/music"))
|
|
clientUniqueId, _ := request.ClientUniqueIdFrom(nextReq.Context())
|
|
Expect(clientUniqueId).To(Equal("123456"))
|
|
})
|
|
})
|
|
|
|
Context("when the request header does not have the unique client ID", func() {
|
|
Context("when the request has the unique client ID in a cookie", func() {
|
|
BeforeEach(func() {
|
|
req.AddCookie(&http.Cookie{
|
|
Name: consts.UIClientUniqueIDHeader,
|
|
Value: "123456",
|
|
})
|
|
})
|
|
|
|
It("adds the unique client ID to the request context", func() {
|
|
middleware.ServeHTTP(rec, req)
|
|
|
|
Expect(rec.Result().Cookies()).To(HaveLen(0))
|
|
|
|
clientUniqueId, _ := request.ClientUniqueIdFrom(nextReq.Context())
|
|
Expect(clientUniqueId).To(Equal("123456"))
|
|
})
|
|
})
|
|
|
|
Context("when the request does not have the unique client ID in a cookie", func() {
|
|
It("does not add the unique client ID to the request context", func() {
|
|
middleware.ServeHTTP(rec, req)
|
|
|
|
Expect(rec.Result().Cookies()).To(HaveLen(0))
|
|
|
|
clientUniqueId, _ := request.ClientUniqueIdFrom(nextReq.Context())
|
|
Expect(clientUniqueId).To(BeEmpty())
|
|
})
|
|
})
|
|
})
|
|
})
|
|
|
|
Describe("URLParamsMiddleware", func() {
|
|
var (
|
|
router *chi.Mux
|
|
middleware http.Handler
|
|
recorder *httptest.ResponseRecorder
|
|
testHandler http.HandlerFunc
|
|
)
|
|
|
|
BeforeEach(func() {
|
|
router = chi.NewRouter()
|
|
recorder = httptest.NewRecorder()
|
|
testHandler = func(w http.ResponseWriter, r *http.Request) {
|
|
_, _ = w.Write([]byte("OK"))
|
|
}
|
|
})
|
|
|
|
Context("when request has no query parameters", func() {
|
|
It("adds URL parameters to the request", func() {
|
|
middleware = URLParamsMiddleware(testHandler)
|
|
router.Mount("/", middleware)
|
|
|
|
req, _ := http.NewRequest("GET", "/?user=1", nil)
|
|
router.ServeHTTP(recorder, req)
|
|
|
|
Expect(recorder.Code).To(Equal(http.StatusOK))
|
|
Expect(recorder.Body.String()).To(Equal("OK"))
|
|
Expect(req.URL.RawQuery).To(ContainSubstring("user=1"))
|
|
})
|
|
})
|
|
|
|
Context("when request has query parameters", func() {
|
|
It("merges URL parameters and query parameters", func() {
|
|
router.Route("/{key}", func(r chi.Router) {
|
|
r.Use(URLParamsMiddleware)
|
|
r.Get("/", testHandler)
|
|
})
|
|
|
|
req, _ := http.NewRequest("GET", "/test?key=value", nil)
|
|
router.ServeHTTP(recorder, req)
|
|
Expect(recorder.Code).To(Equal(http.StatusOK))
|
|
Expect(recorder.Body.String()).To(Equal("OK"))
|
|
Expect(req.URL.RawQuery).To(ContainSubstring("key=value"))
|
|
Expect(req.URL.RawQuery).To(ContainSubstring("%3Akey=test"))
|
|
})
|
|
})
|
|
|
|
Context("when URL parameter has wildcard key", func() {
|
|
It("does not include wildcard key in query parameters", func() {
|
|
router.Route("/{t*}", func(r chi.Router) {
|
|
r.Use(URLParamsMiddleware)
|
|
r.Get("/", testHandler)
|
|
})
|
|
|
|
req, _ := http.NewRequest("GET", "/test?key=value", nil)
|
|
router.ServeHTTP(recorder, req)
|
|
|
|
Expect(recorder.Code).To(Equal(http.StatusOK))
|
|
Expect(recorder.Body.String()).To(Equal("OK"))
|
|
Expect(req.URL.RawQuery).To(ContainSubstring("key=value"))
|
|
})
|
|
})
|
|
|
|
Context("when URL parameters require encoding", func() {
|
|
It("encodes URL parameters correctly", func() {
|
|
router.Route("/{key}", func(r chi.Router) {
|
|
r.Use(URLParamsMiddleware)
|
|
r.Get("/", testHandler)
|
|
})
|
|
|
|
req, _ := http.NewRequest("GET", "/test with space?key=another value", nil)
|
|
router.ServeHTTP(recorder, req)
|
|
|
|
Expect(recorder.Code).To(Equal(http.StatusOK))
|
|
Expect(recorder.Body.String()).To(Equal("OK"))
|
|
queryValues, _ := url.ParseQuery(req.URL.RawQuery)
|
|
Expect(queryValues.Get(":key")).To(Equal("test with space"))
|
|
Expect(queryValues.Get("key")).To(Equal("another value"))
|
|
})
|
|
})
|
|
|
|
Context("when there are multiple URL parameters", func() {
|
|
It("includes all URL parameters in the query string", func() {
|
|
router.Route("/{key}/{value}", func(r chi.Router) {
|
|
r.Use(URLParamsMiddleware)
|
|
r.Get("/", testHandler)
|
|
})
|
|
|
|
req, _ := http.NewRequest("GET", "/test/value?key=other_value", nil)
|
|
router.ServeHTTP(recorder, req)
|
|
|
|
Expect(recorder.Code).To(Equal(http.StatusOK))
|
|
Expect(recorder.Body.String()).To(Equal("OK"))
|
|
|
|
queryValues, _ := url.ParseQuery(req.URL.RawQuery)
|
|
Expect(queryValues.Get(":key")).To(Equal("test"))
|
|
Expect(queryValues.Get(":value")).To(Equal("value"))
|
|
Expect(queryValues.Get("key")).To(Equal("other_value"))
|
|
})
|
|
})
|
|
})
|
|
})
|