Fix group middlewares getting overwritten and fix partial response

Co-authored-by: Elwin Tamminga <elwintamminga@gmail.com>
Co-committed-by: Elwin Tamminga <elwintamminga@gmail.com>

context.go

@@ -1,8 +1,12 @@
 package router
 
 import (
+	"bytes"
 	"encoding/json"
+	"io"
+	"net"
 	"net/http"
+	"strings"
 
 	"github.com/julienschmidt/httprouter"
 )
@@ -16,11 +20,29 @@ type Context struct {
 	store    map[string]interface{}
 }
 
-func newContext(router *Router, res http.ResponseWriter, req *http.Request, param httprouter.Params) *Context {
+// NewContext creates a new context, this function is only exported for use in tests
+func NewContext(router *Router, res http.ResponseWriter, req *http.Request, param httprouter.Params) *Context {
 	return &Context{router, req, res, param.ByName, make(map[string]interface{})}
 }
 
-// String returns the given status code and writes the bytes to the body
+// QueryParam returns the specified parameter from the query string.
+// Returns an empty string if it doesn't exist. Returns the first parameter if multiple instances exist
+func (c *Context) QueryParam(param string) string {
+	params := c.Request.URL.Query()[param]
+	if params == nil {
+		return ``
+	}
+
+	return params[0]
+}
+
+// Redirect sends a redirect to the client
+func (c *Context) Redirect(code int, url string) error {
+	http.Redirect(c.Response, c.Request, url, code)
+	return nil
+}
+
+// Bytes returns the given status code and writes the bytes to the body
 func (c *Context) Bytes(code int, b []byte) error {
 	c.Response.WriteHeader(code)
 	_, err := c.Response.Write(b)
@@ -48,19 +70,35 @@ func (c *Context) NoContent(code int) error {
 
 // JSON returns the given status code and writes JSON to the body
 func (c *Context) JSON(code int, data interface{}) error {
-	c.Response.Header().Set(`Content-Type`, `application/json`)
+	// write to buffer first in case of error
-	c.Response.WriteHeader(code)
+	var buf bytes.Buffer
-	return json.NewEncoder(c.Response).Encode(data) // TODO: Encode to buffer first to prevent partial responses on error
+	err := json.NewEncoder(&buf).Encode(data)
+	if err != nil {
+		return err
 	}
 
+	c.Response.Header().Set(`Content-Type`, `application/json`)
+	c.Response.WriteHeader(code)
+	_, err = io.Copy(c.Response, &buf)
+	return err
+}
+
+// Render renders a templating using the Renderer set in router
 func (c *Context) Render(code int, template string, data interface{}) error {
 	if c.router.Renderer == nil {
 		panic(`Cannot call render without a renderer set`)
 	}
 
+	var b bytes.Buffer
+	err := c.router.Renderer.Render(&b, template, data, c)
+	if err != nil {
+		return err
+	}
+
 	c.Response.Header().Set(`Content-Type`, `text/html`)
 	c.Response.WriteHeader(code)
-	return c.router.Renderer.Render(c.Response, template, data, c)
+	_, _ = io.Copy(c.Response, &b)
+	return nil
 }
 
 // Set sets a value in the context. Set is not safe to be used concurrently
@@ -72,3 +110,20 @@ func (c *Context) Set(key string, value interface{}) {
 func (c *Context) Get(key string) interface{} {
 	return c.store[key]
 }
+
+// RealIP uses proxy headers for the real ip, if none exist the IP of the current connection is returned
+func (c *Context) RealIP() string {
+	reqIP := c.Request.RemoteAddr
+
+	if ip := c.Request.Header.Get(`X-Forwarded-For`); ip != `` {
+		reqIP = strings.Split(ip, `, `)[0]
+	} else if ip := c.Request.Header.Get(`X-Real-IP`); ip != `` {
+		reqIP = ip
+	}
+
+	ra, _, _ := net.SplitHostPort(reqIP)
+	if ra != `` {
+		reqIP = ra
+	}
+	return reqIP
+}

default.go

@@ -13,7 +13,7 @@ func defaultMethodNotAllowedHandler(c *Context) error {
 	return c.StatusText(http.StatusMethodNotAllowed)
 }
 
-func defaultErrorHandler(c *Context, err interface{}) {
+func defaultErrorHandler(c *Context, _ interface{}) {
 	_ = c.StatusText(http.StatusInternalServerError)
 }
 

go.mod

@@ -0,0 +1,5 @@
+module git.fuyu.moe/Fuyu/router
+
+go 1.22.0
+
+require github.com/julienschmidt/httprouter v1.3.0

go.sum

@@ -0,0 +1,2 @@
+github.com/julienschmidt/httprouter v1.3.0 h1:U0609e9tgbseu3rBINet9P48AI/D3oJs4dN7jwJOQ1U=
+github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM=

group.go

@@ -1,6 +1,9 @@
 package router
 
-import urlpath "path"
+import (
+	urlpath "path"
+	"slices"
+)
 
 func join(prefix, path string) string {
 	return urlpath.Join(prefix, urlpath.Clean(path))
@@ -15,40 +18,40 @@ type Group struct {
 
 // Group creates a new router group with a shared prefix and set of middlewares
 func (g *Group) Group(prefix string, middleware ...Middleware) *Group {
-	return &Group{prefix: join(g.prefix, prefix), router: g.router, middleware: append(g.middleware, middleware...)}
+	return &Group{prefix: join(g.prefix, prefix), router: g.router, middleware: slices.Concat(g.middleware, middleware)}
 }
 
 // GET adds a GET route
 func (g *Group) GET(path string, handle Handle, middleware ...Middleware) {
-	g.router.GET(join(g.prefix, path), handle, append(g.middleware, middleware...)...)
+	g.router.GET(join(g.prefix, path), handle, slices.Concat(g.middleware, middleware)...)
 }
 
 // POST adds a POST route
 func (g *Group) POST(path string, handle interface{}, middleware ...Middleware) {
-	g.router.POST(join(g.prefix, path), handle, append(g.middleware, middleware...)...)
+	g.router.POST(join(g.prefix, path), handle, slices.Concat(g.middleware, middleware)...)
 }
 
 // DELETE adds a DELETE route
 func (g *Group) DELETE(path string, handle Handle, middleware ...Middleware) {
-	g.router.DELETE(join(g.prefix, path), handle, append(g.middleware, middleware...)...)
+	g.router.DELETE(join(g.prefix, path), handle, slices.Concat(g.middleware, middleware)...)
 }
 
 // PUT adds a PUT route
 func (g *Group) PUT(path string, handle interface{}, middleware ...Middleware) {
-	g.router.PUT(join(g.prefix, path), handle, append(g.middleware, middleware...)...)
+	g.router.PUT(join(g.prefix, path), handle, slices.Concat(g.middleware, middleware)...)
 }
 
 // PATCH adds a PATCH route
 func (g *Group) PATCH(path string, handle interface{}, middleware ...Middleware) {
-	g.router.PATCH(join(g.prefix, path), handle, append(g.middleware, middleware...)...)
+	g.router.PATCH(join(g.prefix, path), handle, slices.Concat(g.middleware, middleware)...)
 }
 
 // HEAD adds a HEAD route
 func (g *Group) HEAD(path string, handle Handle, middleware ...Middleware) {
-	g.router.HEAD(join(g.prefix, path), handle, append(g.middleware, middleware...)...)
+	g.router.HEAD(join(g.prefix, path), handle, slices.Concat(g.middleware, middleware)...)
 }
 
 // OPTIONS adds a OPTIONS route
 func (g *Group) OPTIONS(path string, handle Handle, middleware ...Middleware) {
-	g.router.OPTIONS(join(g.prefix, path), handle, append(g.middleware, middleware...)...)
+	g.router.OPTIONS(join(g.prefix, path), handle, slices.Concat(g.middleware, middleware)...)
 }

router.go

@@ -1,8 +1,13 @@
 package router
 
 import (
+	"context"
+	"crypto/tls"
+	"errors"
 	"net/http"
 	"reflect"
+	"slices"
+	"time"
 
 	"github.com/julienschmidt/httprouter"
 )
@@ -23,7 +28,7 @@ type ErrorHandle func(*Context, interface{})
 // Middleware is a function that runs before your route, it gets the next handler as a parameter
 type Middleware func(Handle) Handle
 
-// Binder reads input to dst, returns true is successful
+// Reader reads input to dst, returns true if successful
 type Reader func(c *Context, dst interface{}) (bool, error)
 
 // Router is the router itself
@@ -35,11 +40,18 @@ type Router struct {
 	NotFoundHandler         Handle
 	MethodNotAllowedHandler Handle
 	ErrorHandler            ErrorHandle
+	TrimTrailingSlashes     bool
+	server                  *http.Server
 }
 
 // New returns a new Router
 func New() *Router {
-	return &Router{Reader: defaultReader, NotFoundHandler: defaultNotFoundHandler, MethodNotAllowedHandler: defaultMethodNotAllowedHandler, ErrorHandler: defaultErrorHandler}
+	return &Router{
+		Reader:                  defaultReader,
+		NotFoundHandler:         defaultNotFoundHandler,
+		MethodNotAllowedHandler: defaultMethodNotAllowedHandler,
+		ErrorHandler:            defaultErrorHandler,
+	}
 }
 
 // Use adds a global middleware
@@ -94,10 +106,36 @@ func (r *Router) OPTIONS(path string, handle Handle, middleware ...Middleware) {
 func (r *Router) Start(addr string) error {
 	httpr := r.getHttpr()
 
-	return http.ListenAndServe(addr, httpr)
+	r.server = &http.Server{Addr: addr, Handler: httpr}
+	return r.server.ListenAndServe()
 }
 
-func (r *Router) getHttpr() *httprouter.Router {
+// StartTLS starts a TLS web server using the given key, cert and config and binds to the given address
+func (r *Router) StartTLS(addr, certFile, keyFile string, conf *tls.Config) error {
+	httpr := r.getHttpr()
+
+	r.server = &http.Server{Addr: addr, Handler: httpr, TLSConfig: conf}
+	return r.server.ListenAndServeTLS(certFile, keyFile)
+}
+
+// Stop stops the web server
+func (r *Router) Stop() error {
+	if r.server == nil {
+		return nil
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
+	defer cancel()
+	err := r.server.Shutdown(ctx)
+	if errors.Is(err, context.DeadlineExceeded) {
+		err = r.server.Close()
+	}
+	r.server = nil
+
+	return err
+}
+
+func (r *Router) getHttpr() http.Handler {
 	httpr := httprouter.New()
 
 	for _, v := range r.routes {
@@ -106,7 +144,9 @@ func (r *Router) getHttpr() *httprouter.Router {
 			handle = handlePOST(r, v.Handle)
 		}
 
-		httpr.Handle(v.Method, v.Path, handleReq(r, handle, append(r.middleware, v.Middleware...)))
+		httpr.Handle(v.Method, v.Path, handleReq(r, handle,
+			slices.Concat(r.middleware, v.Middleware),
+		))
 	}
 
 	httpr.NotFound = http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
@@ -118,18 +158,23 @@ func (r *Router) getHttpr() *httprouter.Router {
 	})
 
 	httpr.PanicHandler = func(res http.ResponseWriter, req *http.Request, err interface{}) {
-		c := newContext(r, res, req, nil)
+		c := NewContext(r, res, req, nil)
 		r.ErrorHandler(c, err)
 	}
 
-	return httpr
+	if r.TrimTrailingSlashes {
+		httpr.RedirectTrailingSlash = false
+
+		return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
+			l := len(req.URL.Path)
+			if l > 1 && req.URL.Path[l-1] == '/' {
+				req.URL.Path = req.URL.Path[:l-1]
+			}
+			httpr.ServeHTTP(w, req)
+		})
 	}
 
-func handleErr(errHandler ErrorHandle, err interface{}) Handle {
+	return httpr
-	return func(c *Context) error {
-		errHandler(c, err)
-		return nil
-	}
 }
 
 func checkInterfaceHandle(f interface{}) {
@@ -154,8 +199,6 @@ func checkInterfaceHandle(f interface{}) {
 	if rt.In(0) != reflect.TypeOf(&Context{}) {
 		panic(`handle should accept Context as first argument`)
 	}
-
-	return
 }
 
 func handlePOST(r *Router, f interface{}) Handle {
@@ -166,7 +209,7 @@ func handlePOST(r *Router, f interface{}) Handle {
 
 		if r.Reader != nil {
 			ok, err := r.Reader(c, data.Interface())
-			c.Request.Body.Close()
+			_ = c.Request.Body.Close()
 			if err != nil {
 				return err
 			}
@@ -186,15 +229,14 @@ func handlePOST(r *Router, f interface{}) Handle {
 
 func handleReq(r *Router, handle Handle, m []Middleware) httprouter.Handle {
 	return func(res http.ResponseWriter, req *http.Request, param httprouter.Params) {
-		c := newContext(r, res, req, param)
+		c := NewContext(r, res, req, param)
 
 		f := handle
-		for i := len(m) - 1; i >= 0; i-- { // TODO: 1,2,3 of 3,2,1
+		for i := len(m) - 1; i >= 0; i-- {
 			f = m[i](f)
 		}
 
 		err := f(c)
-
 		if err != nil {
 			r.ErrorHandler(c, err)
 		}

type.go

@@ -4,6 +4,7 @@ import (
 	"io"
 )
 
+// Renderer renders a template
 type Renderer interface {
 	Render(w io.Writer, template string, data interface{}, c *Context) error
 }