fix dupe options handler

Author: dbubel

endpoints.go

@@ -18,7 +18,7 @@ func (e Endpoints) Append(mid ...MiddleWare) {
 // Prepend add middleware to the front of the chain for the endpoint group
 // but after the global middleware
 func (e Endpoints) Prepend(mid ...MiddleWare) {
-	mw := make([]MiddleWare, 0, 0)
+	mw := make([]MiddleWare, 0)
 	mw = append(mw, mid...)
 	for i := 0; i < len(e); i++ {
 		e[i].MiddlewareHandlers = append(mw, e[i].MiddlewareHandlers...)

examples/simple.go

@@ -20,7 +20,9 @@ func main() {
 		w.Header().Set("Access-Control-Allow-Headers", "Origin, Content-Type, Content-Length, Accept-Encoding, Authorization")
 		w.WriteHeader(http.StatusOK)
 	})
+
 	app.AddEndpoint(http.MethodGet, "/hello", a, w, w2)
+	app.AddGlobalMiddleware(w2)
 
 	app.Run(&http.Server{
 		Addr:           ":8080",

go.mod

@@ -1,3 +1,11 @@
 module github.com/dbubel/intake/v2
 
 go 1.23
+
+require github.com/stretchr/testify v1.10.0
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,10 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
+github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

intake.go

@@ -10,21 +10,22 @@ import (
 	"time"
 )
 
-// TODO: OPTIONS handler
 type MiddleWare func(http.HandlerFunc) http.HandlerFunc
 
 type Intake struct {
 	Mux                *http.ServeMux
 	PanicHandler       func(http.ResponseWriter, *http.Request, interface{})
 	GlobalMiddleware   []MiddleWare
 	OptionsHandlerFunc http.HandlerFunc
+	// Track paths that already have OPTIONS handlers
+	optionsPaths map[string]bool
 }
 
-
 func New() *Intake {
 	return &Intake{
-		GlobalMiddleware: make([]MiddleWare, 0, 0),
+		GlobalMiddleware: make([]MiddleWare, 0),
 		Mux:              http.NewServeMux(),
+		optionsPaths:     make(map[string]bool),
 	}
 }
 
@@ -43,6 +44,9 @@ func (a *Intake) AddEndpoints(e ...Endpoints) {
 
 func (a *Intake) OptionsHandler(h http.HandlerFunc) {
 	a.OptionsHandlerFunc = h
+	// When setting a new OPTIONS handler, we need to clear existing paths
+	// in case the handler has changed
+	a.optionsPaths = make(map[string]bool)
 }
 
 func (a *Intake) AddEndpoint(verb string, path string, finalHandler http.HandlerFunc, middleware ...MiddleWare) {
@@ -58,9 +62,13 @@ func (a *Intake) AddEndpoint(verb string, path string, finalHandler http.Handler
 	a.Mux.HandleFunc(fmt.Sprintf("%s %s", verb, path), func(w http.ResponseWriter, r *http.Request) {
 		finalHandler(w, r)
 	})
-	if a.OptionsHandlerFunc != nil {
+
+	// Only add OPTIONS handler if we have one and haven't already added it for this path
+	if a.OptionsHandlerFunc != nil && !a.optionsPaths[path] {
 		a.Mux.HandleFunc(fmt.Sprintf("%s %s", http.MethodOptions, path), a.OptionsHandlerFunc)
+		a.optionsPaths[path] = true
 	}
+
 	fmt.Printf("added route %s %s\n", verb, path)
 }
 

intake_test.go

@@ -1 +1,97 @@
 package intake
+
+import (
+	"encoding/json"
+	"io/ioutil"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+type testPayload struct {
+	Msg string `json:"msg"`
+}
+
+func TestIntake(t *testing.T) {
+	payload := testPayload{Msg: "test response"}
+	var app = New()
+
+	testHandler := func(w http.ResponseWriter, r *http.Request) {
+		json.NewEncoder(w).Encode(payload)
+	}
+
+	t.Run("test single endpoint", func(t *testing.T) {
+		app.AddEndpoint(http.MethodGet, "/test", testHandler)
+
+		r := httptest.NewRequest(http.MethodGet, "/test", nil)
+		w := httptest.NewRecorder()
+		app.Mux.ServeHTTP(w, r)
+
+		require.Equal(t, http.StatusOK, w.Code)
+		resp, err := ioutil.ReadAll(w.Body)
+		require.NoError(t, err)
+
+		var res testPayload
+		require.NoError(t, json.Unmarshal(resp, &res))
+		require.Equal(t, "test response", res.Msg)
+	})
+
+	t.Run("test options handler", func(t *testing.T) {
+		optionsHandler := func(w http.ResponseWriter, r *http.Request) {
+			w.Header().Set("Allow", "GET, POST, OPTIONS")
+			w.WriteHeader(http.StatusOK)
+		}
+
+		app.OptionsHandler(optionsHandler)
+		app.AddEndpoint(http.MethodGet, "/test-options", testHandler)
+		app.AddEndpoint(http.MethodPost, "/test-options", testHandler)
+
+		r := httptest.NewRequest(http.MethodOptions, "/test-options", nil)
+		w := httptest.NewRecorder()
+		app.Mux.ServeHTTP(w, r)
+
+		require.Equal(t, http.StatusOK, w.Code)
+		require.Equal(t, "GET, POST, OPTIONS", w.Header().Get("Allow"))
+	})
+
+	t.Run("test middleware execution", func(t *testing.T) {
+		middlewareCalled := false
+		middleware := func(next http.HandlerFunc) http.HandlerFunc {
+			return func(w http.ResponseWriter, r *http.Request) {
+				middlewareCalled = true
+				next(w, r)
+			}
+		}
+
+		app.AddGlobalMiddleware(middleware)
+		app.AddEndpoint(http.MethodGet, "/test-middleware", testHandler)
+
+		r := httptest.NewRequest(http.MethodGet, "/test-middleware", nil)
+		w := httptest.NewRecorder()
+		app.Mux.ServeHTTP(w, r)
+
+		require.True(t, middlewareCalled)
+		require.Equal(t, http.StatusOK, w.Code)
+	})
+
+	t.Run("test duplicate options handler", func(t *testing.T) {
+		optionsCallCount := 0
+		optionsHandler := func(w http.ResponseWriter, r *http.Request) {
+			optionsCallCount++
+			w.WriteHeader(http.StatusOK)
+		}
+
+		app.OptionsHandler(optionsHandler)
+		app.AddEndpoint(http.MethodGet, "/test-duplicate", testHandler)
+		app.AddEndpoint(http.MethodPost, "/test-duplicate", testHandler)
+
+		r := httptest.NewRequest(http.MethodOptions, "/test-duplicate", nil)
+		w := httptest.NewRecorder()
+		app.Mux.ServeHTTP(w, r)
+
+		require.Equal(t, 1, optionsCallCount)
+		require.Equal(t, http.StatusOK, w.Code)
+	})
+}