12 Commits

Author SHA1 Message Date
855b82e9df Split code in respective files.
Resource method name change.

Route list func
2025-08-16 11:19:45 +05:30
f91090b35e Func rename 2025-07-10 19:09:29 +05:30
5b380a294b expose ServeMux 2025-07-10 19:05:31 +05:30
ddb4b35181 helmet.go removed wildcard directive. 2025-05-18 22:48:11 +05:30
f8cdf3a511 middleware helmet changes.
router check and panic message change.
README enhancement
2025-05-17 18:55:15 +05:30
e6a8880fd3 middleware helemt changes 2025-03-21 13:00:31 +05:30
aa6ba87f4e default header reset 2024-11-04 11:26:10 +05:30
859d4fa458 option handler 2024-11-04 11:06:49 +05:30
894614cd54 default options handler 2024-11-04 11:00:02 +05:30
c34f5b7d0d route catch optiong route 2024-11-04 10:40:29 +05:30
f4a2452a94 removed proxy func, need to revist it again 2024-11-03 22:33:56 +05:30
eda7c79ab6 test correction and Proxy func addition 2024-11-03 22:24:28 +05:30
13 changed files with 1013 additions and 477 deletions

234
README.md
View File

@@ -1,115 +1,153 @@
# Mux
# Mux - A Lightweight HTTP Router for Go
Tiny wrapper around Go's builtin http.ServeMux with easy routing methods.
Mux is a simple, lightweight HTTP router for Go that wraps around the standard `http.ServeMux` to provide additional functionality and a more ergonomic API.
## Example
## Features
- HTTP method-specific routing (GET, POST, PUT, DELETE, etc.)
- Middleware support with flexible stacking
- Route grouping for organization and shared middleware
- RESTful resource routing
- URL parameter extraction
- Graceful shutdown support
- Minimal dependencies (only uses Go standard library)
## Installation
```bash
go get code.patial.tech/go/mux
```
## Basic Usage
```go
package main
import (
"log/slog"
"fmt"
"net/http"
"gitserver.in/patialtech/mux"
"code.patial.tech/go/mux"
)
func main() {
// create a new router
r := mux.NewRouter()
// Create a new router
router := mux.NewRouter()
// you can use any middleware that is: "func(http.Handler) http.Handler"
// so you can use any of it
// - https://github.com/gorilla/handlers
// - https://github.com/go-chi/chi/tree/master/middleware
// add some root level middlewares, these will apply to all routes after it
r.Use(middleware1, middleware2)
// let's add a route
r.Get("/hello", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("i am route /hello"))
})
// r.Post(pattern string, h http.HandlerFunc)
// r.Put(pattern string, h http.HandlerFunc)
// ...
// you can inline middleware(s) to a route
r.
With(mwInline).
Get("/hello-2", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("i am route /hello-2 with my own middleware"))
})
// define a resource
r.Resource("/photos", func(resource *mux.Resource) {
// rails style resource routes
// GET /photos
// GET /photos/new
// POST /photos
// GET /photos/:id
// GET /photos/:id/edit
// PUT /photos/:id
// PATCH /photos/:id
// DELETE /photos/:id
resource.Index(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("all photos"))
})
resource.New(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("upload a new pohoto"))
})
// Define a simple route
router.GET("/", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Hello, World!")
})
// create a group of few routes with their own middlewares
r.Group(func(grp *mux.Router) {
grp.Use(mwGroup)
grp.Get("/group", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("i am route /group"))
})
})
// catches all
r.Get("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("hello there"))
})
// Serve allows graceful shutdown, you can use it
r.Serve(func(srv *http.Server) error {
srv.Addr = ":3001"
// srv.ReadTimeout = time.Minute
// srv.WriteTimeout = time.Minute
slog.Info("listening on http://localhost" + srv.Addr)
return srv.ListenAndServe()
})
}
func middleware1(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
slog.Info("i am middleware 1")
h.ServeHTTP(w, r)
})
}
func middleware2(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
slog.Info("i am middleware 2")
h.ServeHTTP(w, r)
})
}
func mwInline(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
slog.Info("i am inline middleware")
h.ServeHTTP(w, r)
})
}
func mwGroup(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
slog.Info("i am group middleware")
h.ServeHTTP(w, r)
})
// Start the server
http.ListenAndServe(":8080", router)
}
```
## Routing
Mux supports all HTTP methods defined in the Go standard library:
```go
router.GET("/users", listUsers)
router.POST("/users", createUser)
router.PUT("/users/{id}", updateUser)
router.DELETE("/users/{id}", deleteUser)
router.PATCH("/users/{id}", partialUpdateUser)
router.HEAD("/users", headUsers)
router.OPTIONS("/users", optionsUsers)
router.TRACE("/users", traceUsers)
router.CONNECT("/users", connectUsers)
```
## URL Parameters
Mux supports URL parameters using curly braces:
```go
router.GET("/users/{id}", func(w http.ResponseWriter, r *http.Request) {
id := r.PathValue("id")
fmt.Fprintf(w, "User ID: %s", id)
})
```
## Middleware
Middleware functions take an `http.Handler` and return an `http.Handler`. You can add global middleware to all routes:
```go
// Logging middleware
func loggingMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
fmt.Printf("[%s] %s\n", r.Method, r.URL.Path)
next.ServeHTTP(w, r)
})
}
// Add middleware to all routes
router.Use(loggingMiddleware)
```
## Route Groups
Group related routes and apply middleware to specific groups:
```go
// API routes group
router.Group(func(api *mux.Router) {
// Middleware only for API routes
api.Use(authMiddleware)
// API routes
api.GET("/api/users", listUsers)
api.POST("/api/users", createUser)
})
```
## RESTful Resources
Easily define RESTful resources:
```go
router.Resource("/posts", func(r *mux.Resource) {
r.Index(listPosts) // GET /posts
r.Show(showPost) // GET /posts/{id}
r.Create(createPost) // POST /posts
r.Update(updatePost) // PUT /posts/{id}
r.Destroy(deletePost) // DELETE /posts/{id}
r.New(newPostForm) // GET /posts/new
})
```
## Graceful Shutdown
Use the built-in graceful shutdown functionality:
```go
router.Serve(func(srv *http.Server) error {
srv.Addr = ":8080"
return srv.ListenAndServe()
})
```
## Custom 404 Handler
can be tried like this
```go
router.GET("/", func(writer http.ResponseWriter, request *http.Request) {
if request.URL.Path != "/" {
writer.WriteHeader(404)
writer.Write([]byte(`not found, da xiong dei !!!`))
return
}
})
```
## Full Example
See the [examples directory](./example) for complete working examples.
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

View File

@@ -4,16 +4,30 @@ import (
"log/slog"
"net/http"
"gitserver.in/patialtech/mux"
"gitserver.in/patialtech/mux/middleware"
"code.patial.tech/go/mux"
"code.patial.tech/go/mux/middleware"
)
func main() {
// create a new router
r := mux.NewRouter()
r.Use(middleware.CORS(middleware.CORSOption{
AllowedOrigins: []string{"*"},
MaxAge: 60,
m := mux.New()
m.Use(middleware.CORS(middleware.CORSOption{
AllowedOrigins: []string{"*"},
AllowedMethods: []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"},
AllowedHeaders: []string{"Accept", "Authorization", "Content-Type", "X-CSRF-AccessToken", "X-Real-IP"},
ExposedHeaders: []string{"Link"},
AllowCredentials: true,
MaxAge: 300,
}))
m.Use(middleware.Helmet(middleware.HelmetOption{
StrictTransportSecurity: &middleware.TransportSecurity{
MaxAge: 31536000,
IncludeSubDomains: true,
Preload: true,
},
XssProtection: true,
XFrameOption: middleware.XFrameDeny,
}))
// you can use any middleware that is: "func(http.Handler) http.Handler"
@@ -22,10 +36,10 @@ func main() {
// - https://github.com/go-chi/chi/tree/master/middleware
// add some root level middlewares, these will apply to all routes after it
r.Use(middleware1, middleware2)
m.Use(middleware1, middleware2)
// let's add a route
r.Get("/hello", func(w http.ResponseWriter, r *http.Request) {
m.GET("/hello", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("i am route /hello"))
})
// r.Post(pattern string, h http.HandlerFunc)
@@ -33,47 +47,62 @@ func main() {
// ...
// you can inline middleware(s) to a route
r.
m.
With(mwInline).
Get("/hello-2", func(w http.ResponseWriter, r *http.Request) {
GET("/hello-2", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("i am route /hello-2 with my own middleware"))
})
// define a resource
r.Resource("/photos", func(resource *mux.Resource) {
// Rails style resource routes
// GET /photos
// GET /photos/new
// POST /photos
// GET /photos/:id
// GET /photos/:id/edit
// PUT /photos/:id
// PATCH /photos/:id
// DELETE /photos/:id
resource.Index(func(w http.ResponseWriter, r *http.Request) {
m.Resource("/photos", func(res *mux.Resource) {
res.Index(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("all photos"))
})
resource.New(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("upload a new pohoto"))
res.CreateView(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("new photo view"))
})
res.Create(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("new photo"))
})
res.View(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("view photo detail"))
})
res.Update(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("update photos"))
})
res.UpdatePartial(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("update few of photo fields"))
})
res.Delete(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("removed a phot"))
})
})
// create a group of few routes with their own middlewares
r.Group(func(grp *mux.Router) {
m.Group(func(grp *mux.Mux) {
grp.Use(mwGroup)
grp.Get("/group", func(w http.ResponseWriter, r *http.Request) {
grp.GET("/group", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("i am route /group"))
})
})
// catches all
r.Get("/", func(w http.ResponseWriter, r *http.Request) {
m.GET("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("hello there"))
})
m.GET("/routes", func(w http.ResponseWriter, r *http.Request) {
m.PrintRoutes(w)
})
// Serve allows graceful shutdown, you can use it
r.Serve(func(srv *http.Server) error {
m.Serve(func(srv *http.Server) error {
srv.Addr = ":3001"
// srv.ReadTimeout = time.Minute
// srv.WriteTimeout = time.Minute

4
go.mod
View File

@@ -1,3 +1,3 @@
module gitserver.in/patialtech/mux
module code.patial.tech/go/mux
go 1.23.2
go 1.24

View File

@@ -1,3 +1,7 @@
// Author: Ankit Patial
// inspired from Helmet.js
// https://github.com/helmetjs/helmet/tree/main
package middleware
import (
@@ -6,9 +10,6 @@ import (
"strings"
)
// inspired from Helmet.js
// https://github.com/helmetjs/helmet/tree/main
type (
HelmetOption struct {
ContentSecurityPolicy CSP
@@ -101,20 +102,17 @@ type (
const (
YearDuration = 365 * 24 * 60 * 60
// EmbedderDefault default value will be "require-corp"
EmbedderDefault Embedder = ""
EmbedderRequireCorp Embedder = "require-corp"
EmbedderCredentialLess Embedder = "credentialless"
EmbedderUnsafeNone Embedder = "unsafe-none"
// OpenerDefault default value will be "same-origin"
OpenerDefault Opener = ""
// OpenerSameOrigin is default if no value supplied
OpenerSameOrigin Opener = "same-origin"
OpenerSameOriginAllowPopups Opener = "same-origin-allow-popups"
OpenerUnsafeNone Opener = "unsafe-none"
// EmbedderDefault is default if no value supplied
EmbedderRequireCorp Embedder = "require-corp"
EmbedderCredentialLess Embedder = "credentialless"
EmbedderUnsafeNone Embedder = "unsafe-none"
// ResourceDefault default value will be "same-origin"
ResourceDefault Resource = ""
ResourceSameOrigin Resource = "same-origin"
ResourceSameSite Resource = "same-site"
ResourceCrossOrigin Resource = "cross-origin"
@@ -128,15 +126,13 @@ const (
StrictOriginWhenCrossOrigin Referrer = "strict-origin-when-cross-origin"
UnsafeUrl Referrer = "unsafe-url"
// CDPDefault default value is "none"
CDPDefault CDP = ""
// CDPNone is default if no value supplied
CDPNone CDP = "none"
CDPMasterOnly CDP = "master-only"
CDPByContentType CDP = "by-content-type"
CDPAll CDP = "all"
// XFrameDefault default value will be "sameorigin"
XFrameDefault XFrame = ""
// XFrameSameOrigin is default if no value supplied
XFrameSameOrigin XFrame = "sameorigin"
XFrameDeny XFrame = "deny"
)
@@ -147,22 +143,15 @@ func Helmet(opt HelmetOption) func(http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Add("Content-Security-Policy", opt.ContentSecurityPolicy.value())
// Cross-Origin-Embedder-Policy, if nil set default
if opt.CrossOriginEmbedderPolicy == EmbedderDefault {
w.Header().Add("Cross-Origin-Embedder-Policy", string(EmbedderRequireCorp))
} else {
w.Header().Add("Cross-Origin-Embedder-Policy", string(opt.CrossOriginEmbedderPolicy))
}
// Cross-Origin-Opener-Policy, if nil set default
if opt.CrossOriginOpenerPolicy == OpenerDefault {
// Opener-Policy
if opt.CrossOriginOpenerPolicy == "" {
w.Header().Add("Cross-Origin-Opener-Policy", string(OpenerSameOrigin))
} else {
w.Header().Add("Cross-Origin-Opener-Policy", string(opt.CrossOriginOpenerPolicy))
}
// Cross-Origin-Resource-Policy, if nil set default
if opt.CrossOriginResourcePolicy == ResourceDefault {
// Resource-Policy
if opt.CrossOriginResourcePolicy == "" {
w.Header().Add("Cross-Origin-Resource-Policy", string(ResourceSameOrigin))
} else {
w.Header().Add("Cross-Origin-Resource-Policy", string(opt.CrossOriginResourcePolicy))
@@ -223,13 +212,13 @@ func Helmet(opt HelmetOption) func(http.Handler) http.Handler {
}
// indicate whether a browser should be allowed to render a page in iframe | frame | embed | object
if opt.XFrameOption == XFrameDefault {
if opt.XFrameOption == "" {
w.Header().Add("X-Frame-Options", string(XFrameSameOrigin))
} else {
w.Header().Add("X-Frame-Options", string(opt.XFrameOption))
}
if opt.CrossDomainPolicies == CDPDefault {
if opt.CrossDomainPolicies == "" {
w.Header().Add("X-Permitted-Cross-Domain-Policies", string(CDPNone))
} else {
w.Header().Add("X-Permitted-Cross-Domain-Policies", string(opt.CrossDomainPolicies))
@@ -279,7 +268,7 @@ func (csp *CSP) value() string {
sb.WriteString(fmt.Sprintf(
"style-src %s; ",
cspNormalised(csp.StyleSrc, []string{"self", "https:", "unsafe-inline"}),
cspNormalised(csp.StyleSrc, []string{"self", "unsafe-inline"}),
))
sb.WriteString(fmt.Sprintf(
@@ -299,7 +288,7 @@ func (csp *CSP) value() string {
sb.WriteString(fmt.Sprintf(
"font-src %s; ",
cspNormalised(csp.FontSrc, []string{"self", "https:", "data:"}),
cspNormalised(csp.FontSrc, []string{"self", "data:"}),
))
sb.WriteString(fmt.Sprintf(

View File

@@ -1,50 +1,52 @@
package middleware
import (
"io"
"net/http"
"net/http/httptest"
"testing"
"gitserver.in/patialtech/mux"
"code.patial.tech/go/mux"
)
func TestHelmet(t *testing.T) {
r := mux.NewRouter()
r.Get("/hello", func(writer http.ResponseWriter, request *http.Request) {
r := mux.New()
r.Use(Helmet(HelmetOption{}))
r.GET("/hello", func(writer http.ResponseWriter, request *http.Request) {
_, _ = writer.Write([]byte("hello there"))
})
endpoint := httptest.NewRequest(http.MethodGet, "/hello", nil)
srv := httptest.NewServer(r)
defer srv.Close()
w, _ := testRequest(t, srv, "GET", "/hello", nil)
// test endpoint registered/reachable
w := httptest.NewRecorder()
r.ServeHTTP(w, endpoint)
if w.Code != http.StatusOK {
t.Error("not expecting status", w.Code)
return
}
// no header test
w = httptest.NewRecorder()
r.ServeHTTP(w, endpoint)
csp := w.Header().Get("Content-Security-Policy")
csp := w.Header.Get("Content-Security-Policy")
// must not have a csp header, technically no header related to helmet but lets test with one.
if csp != "" {
t.Error("csp header not expected")
}
// introduce helmet middleware
r.Use(Helmet(HelmetOption{}))
// header tests..
w = httptest.NewRecorder()
r.ServeHTTP(w, endpoint)
// csp and other headers are expected
csp = w.Header().Get("Content-Security-Policy")
// fmt.Printf("csp %s", csp)
if csp == "" {
t.Error("csp header missing")
t.Error("csp header is expected")
}
// TODO need more tests
}
func testRequest(t *testing.T, ts *httptest.Server, method, path string, body io.Reader) (*http.Response, string) {
req, err := http.NewRequest(method, ts.URL+path, body)
if err != nil {
t.Fatal(err)
return nil, ""
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatal(err)
return nil, ""
}
respBody, err := io.ReadAll(io.Reader(resp.Body))
if err != nil {
t.Fatal(err)
return nil, ""
}
defer resp.Body.Close()
return resp, string(respBody)
}

154
mux.go Normal file
View File

@@ -0,0 +1,154 @@
package mux
import (
"fmt"
"io"
"net/http"
"strings"
"sync/atomic"
)
// Mux is a wrapper around the go's standard http.ServeMux.
// It's a lean wrapper with methods to make routing easier
type Mux struct {
mux *http.ServeMux
middlewares []func(http.Handler) http.Handler
routes *RouteList
IsShuttingDown atomic.Bool
}
func New() *Mux {
m := &Mux{
mux: http.NewServeMux(),
routes: new(RouteList),
}
return m
}
// HttpServeMux DO NOT USE it for routing, exposed only for edge cases.
func (m *Mux) HttpServeMux() *http.ServeMux {
return m.mux
}
// Use will register middleware(s) with router stack
func (m *Mux) Use(h ...func(http.Handler) http.Handler) {
if m == nil {
panic("mux: func Use was called on nil")
}
m.middlewares = append(m.middlewares, h...)
}
// GET method route
func (m *Mux) GET(pattern string, h http.HandlerFunc) {
m.handle(http.MethodGet, pattern, h)
}
// HEAD method route
func (m *Mux) HEAD(pattern string, h http.HandlerFunc) {
m.handle(http.MethodHead, pattern, h)
}
// POST method route
func (m *Mux) POST(pattern string, h http.HandlerFunc) {
m.handle(http.MethodPost, pattern, h)
}
// PUT method route
func (m *Mux) PUT(pattern string, h http.HandlerFunc) {
m.handle(http.MethodPut, pattern, h)
}
// PATCH method route
func (m *Mux) PATCH(pattern string, h http.HandlerFunc) {
m.handle(http.MethodPatch, pattern, h)
}
// DELETE method route
func (m *Mux) DELETE(pattern string, h http.HandlerFunc) {
m.handle(http.MethodDelete, pattern, h)
}
// CONNECT method route
func (m *Mux) CONNECT(pattern string, h http.HandlerFunc) {
m.handle(http.MethodConnect, pattern, h)
}
// OPTIONS method route
func (m *Mux) OPTIONS(pattern string, h http.HandlerFunc) {
m.handle(http.MethodOptions, pattern, h)
}
// TRACE method route
func (m *Mux) TRACE(pattern string, h http.HandlerFunc) {
m.handle(http.MethodTrace, pattern, h)
}
// handle registers the handler for the given pattern.
// If the given pattern conflicts, with one that is already registered, HandleFunc
// panics.
func (m *Mux) handle(method, pattern string, h http.HandlerFunc) {
if m == nil {
panic("mux: func Handle() was called on nil")
}
if strings.TrimSpace(pattern) == "" {
panic("mux: pattern cannot be empty")
}
if !strings.HasPrefix(pattern, "/") {
pattern = "/" + pattern
}
path := fmt.Sprintf("%s %s", method, pattern)
m.mux.Handle(path, stack(m.middlewares, h))
m.routes.Add(path)
}
// With adds inline middlewares for an endpoint handler.
func (m *Mux) With(middleware ...func(http.Handler) http.Handler) *Mux {
mws := make([]func(http.Handler) http.Handler, len(m.middlewares))
copy(mws, m.middlewares)
mws = append(mws, middleware...)
im := &Mux{
mux: m.mux,
middlewares: mws,
routes: m.routes,
}
return im
}
// Group adds a new inline-Router along the current routing
// path, with a fresh middleware stack for the inline-Router.
func (m *Mux) Group(fn func(grp *Mux)) {
if m == nil {
panic("mux: Group() called on nil")
}
if fn == nil {
panic("mux: Group() requires callback")
}
im := m.With()
fn(im)
}
func (m *Mux) ServeHTTP(w http.ResponseWriter, req *http.Request) {
if m == nil {
panic("mux: method ServeHTTP called on nil")
}
m.mux.ServeHTTP(w, req)
}
func (m *Mux) PrintRoutes(w io.Writer) {
for _, route := range m.routes.All() {
w.Write([]byte(route))
w.Write([]byte("\n"))
}
}
func (m *Mux) RouteList() []string {
return m.routes.All()
}

340
mux_test.go Normal file
View File

@@ -0,0 +1,340 @@
package mux
import (
"fmt"
"io"
"math/rand"
"net/http"
"net/http/httptest"
"strconv"
"strings"
"testing"
"time"
)
func TestRouterGET(t *testing.T) {
m := New()
m.GET("/test", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "GET test")
})
ts := httptest.NewServer(m)
defer ts.Close()
resp, err := http.Get(ts.URL + "/test")
if err != nil {
t.Fatalf("Error making GET request: %v", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
t.Errorf("Expected status OK; got %v", resp.Status)
}
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("Error reading response body: %v", err)
}
expected := "GET test"
if string(body) != expected {
t.Errorf("Expected body %q; got %q", expected, string(body))
}
}
func TestRouterPOST(t *testing.T) {
m := New()
m.POST("/test", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "POST test")
})
ts := httptest.NewServer(m)
defer ts.Close()
resp, err := http.Post(ts.URL+"/test", "text/plain", strings.NewReader("test data"))
if err != nil {
t.Fatalf("Error making POST request: %v", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
t.Errorf("Expected status OK; got %v", resp.Status)
}
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("Error reading response body: %v", err)
}
expected := "POST test"
if string(body) != expected {
t.Errorf("Expected body %q; got %q", expected, string(body))
}
}
func TestRouterWith(t *testing.T) {
m := New()
middleware := func(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("X-Test", "middleware")
h.ServeHTTP(w, r)
})
}
m.With(middleware).GET("/test", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "GET with middleware")
})
ts := httptest.NewServer(m)
defer ts.Close()
resp, err := http.Get(ts.URL + "/test")
if err != nil {
t.Fatalf("Error making GET request: %v", err)
}
defer resp.Body.Close()
if resp.Header.Get("X-Test") != "middleware" {
t.Errorf("Expected header X-Test to be 'middleware'; got %q", resp.Header.Get("X-Test"))
}
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("Error reading response body: %v", err)
}
expected := "GET with middleware"
if string(body) != expected {
t.Errorf("Expected body %q; got %q", expected, string(body))
}
}
func TestRouterGroup(t *testing.T) {
r := New()
var groupCalled bool
r.Group(func(g *Mux) {
groupCalled = true
g.GET("/group", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Group route")
})
})
if !groupCalled {
t.Error("Expected Group callback to be called")
}
ts := httptest.NewServer(r)
defer ts.Close()
resp, err := http.Get(ts.URL + "/group")
if err != nil {
t.Fatalf("Error making GET request: %v", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
t.Errorf("Expected status OK; got %v", resp.Status)
}
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("Error reading response body: %v", err)
}
expected := "Group route"
if string(body) != expected {
t.Errorf("Expected body %q; got %q", expected, string(body))
}
}
func TestRouterResource(t *testing.T) {
r := New()
r.Resource("/users", func(res *Resource) {
res.Index(func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "All users")
})
res.View(func(w http.ResponseWriter, r *http.Request) {
id := r.PathValue("id")
fmt.Fprintf(w, "User %s", id)
})
})
ts := httptest.NewServer(r)
defer ts.Close()
// Test Index
resp, err := http.Get(ts.URL + "/users")
if err != nil {
t.Fatalf("Error making GET request: %v", err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("Error reading response body: %v", err)
}
expected := "All users"
if string(body) != expected {
t.Errorf("Expected body %q; got %q", expected, string(body))
}
// Test Show
resp, err = http.Get(ts.URL + "/users/123")
if err != nil {
t.Fatalf("Error making GET request: %v", err)
}
defer resp.Body.Close()
body, err = io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("Error reading response body: %v", err)
}
expected = "User 123"
if string(body) != expected {
t.Errorf("Expected body %q; got %q", expected, string(body))
}
}
func TestGetParams(t *testing.T) {
r := New()
r.GET("/users/{id}/posts/{post_id}", func(w http.ResponseWriter, r *http.Request) {
userId := r.PathValue("id")
postId := r.PathValue("post_id")
fmt.Fprintf(w, "User: %s, Post: %s", userId, postId)
})
ts := httptest.NewServer(r)
defer ts.Close()
resp, err := http.Get(ts.URL + "/users/123/posts/456")
if err != nil {
t.Fatalf("Error making GET request: %v", err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("Error reading response body: %v", err)
}
expected := "User: 123, Post: 456"
if string(body) != expected {
t.Errorf("Expected body %q; got %q", expected, string(body))
}
}
func TestStack(t *testing.T) {
var calls []string
middleware1 := func(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
calls = append(calls, "middleware1 before")
h.ServeHTTP(w, r)
calls = append(calls, "middleware1 after")
})
}
middleware2 := func(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
calls = append(calls, "middleware2 before")
h.ServeHTTP(w, r)
calls = append(calls, "middleware2 after")
})
}
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
calls = append(calls, "handler")
})
middlewares := []func(http.Handler) http.Handler{middleware1, middleware2}
stacked := stack(middlewares, handler)
w := httptest.NewRecorder()
r := httptest.NewRequest(http.MethodGet, "/", nil)
stacked.ServeHTTP(w, r)
expected := []string{
"middleware1 before",
"middleware2 before",
"handler",
"middleware2 after",
"middleware1 after",
}
if len(calls) != len(expected) {
t.Errorf("Expected %d calls; got %d", len(expected), len(calls))
}
for i, call := range calls {
if i < len(expected) && call != expected[i] {
t.Errorf("Expected call %d to be %q; got %q", i, expected[i], call)
}
}
}
func TestRouterPanic(t *testing.T) {
defer func() {
if r := recover(); r == nil {
t.Error("Expected panic but none occurred")
}
}()
var r *Mux
r.GET("/", func(w http.ResponseWriter, r *http.Request) {})
}
// BenchmarkRouterSimple-12 1125854 1058 ns/op 1568 B/op 17 allocs/op
func BenchmarkRouterSimple(b *testing.B) {
m := New()
for i := range 10000 {
m.GET("/"+strconv.Itoa(i), func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Hello from "+strconv.Itoa(i))
})
}
source := rand.NewSource(time.Now().UnixNano())
r := rand.New(source)
// Generate a random integer between 0 and 99 (inclusive)
rn := r.Intn(10000)
for b.Loop() {
req, _ := http.NewRequest(http.MethodGet, "/"+strconv.Itoa(rn), nil)
w := httptest.NewRecorder()
m.ServeHTTP(w, req)
}
}
// BenchmarkRouterWithMiddleware-12 14761327 68.70 ns/op 18 B/op 0 allocs/op
func BenchmarkRouterWithMiddleware(b *testing.B) {
m := New()
middleware := func(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
h.ServeHTTP(w, r)
})
}
m.Use(middleware, middleware)
m.GET("/", func(w http.ResponseWriter, r *http.Request) {
fmt.Fprint(w, "Hello")
})
req, _ := http.NewRequest(http.MethodGet, "/", nil)
w := httptest.NewRecorder()
for b.Loop() {
m.ServeHTTP(w, req)
}
}

View File

@@ -6,28 +6,134 @@ import (
"strings"
)
// Resource is a resourceful route provides a mapping between HTTP verbs and URLs and controller actions.
// By convention, each action also maps to particular CRUD operations in a database.
// A single entry in the routing file, such as
// Index route
//
// GET /resource-name # index route
//
// GET /resource-name/new # create resource page
//
// POST /resource-name # create resource post
//
// GET /resource-name/:id # view resource
//
// GET /resource-name/:id/edit # edit resource
//
// PUT /resource-name/:id # update resource
//
// DELETE /resource-name/:id # delete resource
type Resource struct {
mux *http.ServeMux
pattern string
middlewares []func(http.Handler) http.Handler
routes *RouteList
}
// Resource routes mapping by using HTTP verbs
// - GET /pattern view all resources
// - GET /pattern/create new resource view
// - POST /pattern create a new resource
// - GET /pattern/:id view a resource
// - PUT /pattern/:id update a resource
// - PATCH /pattern/:id partial update a resource
// - DELETE /resource/:id delete a resource
func (m *Mux) Resource(pattern string, fn func(res *Resource)) {
if m == nil {
panic("mux: Resource() called on nil")
}
if strings.TrimSpace(pattern) == "" {
panic("mux: Resource() requires a patter to work")
}
if fn == nil {
panic("mux: Resource() requires callback")
}
// Copy root middlewares.
mws := make([]func(http.Handler) http.Handler, len(m.middlewares))
copy(mws, m.middlewares)
fn(&Resource{
mux: m.mux,
pattern: pattern,
middlewares: mws,
routes: m.routes,
})
}
// Index of all resource.
//
// GET /pattern
func (res *Resource) Index(h http.HandlerFunc) {
res.routes.Add(http.MethodGet + " " + res.pattern)
res.handlerFunc(http.MethodGet, res.pattern, h)
}
// CreateView new resource
//
// GET /pattern/create
func (res *Resource) CreateView(h http.HandlerFunc) {
p := suffixIt(res.pattern, "create")
res.routes.Add(http.MethodGet + " " + p)
res.handlerFunc(http.MethodGet, p, h)
}
// Create a new resource
//
// POST /pattern/create
func (res *Resource) Create(h http.HandlerFunc) {
res.routes.Add(http.MethodPost + " " + res.pattern)
res.handlerFunc(http.MethodPost, res.pattern, h)
}
// View a resource
//
// GET /pattern/:id
func (res *Resource) View(h http.HandlerFunc) {
p := suffixIt(res.pattern, "{id}")
res.routes.Add(http.MethodGet + " " + p)
res.handlerFunc(http.MethodGet, p, h)
}
// Update a resource
//
// PUT /pattern/:id
func (res *Resource) Update(h http.HandlerFunc) {
p := suffixIt(res.pattern, "{id}")
res.routes.Add(http.MethodPut + " " + p)
res.handlerFunc(http.MethodPut, p, h)
}
// UpdatePartial resource info
// PATCH /pattern/:id
func (res *Resource) UpdatePartial(h http.HandlerFunc) {
p := suffixIt(res.pattern, "{id}")
res.routes.Add(http.MethodPatch + " " + p)
res.handlerFunc(http.MethodPatch, p, h)
}
// Delete a resource
//
// DELETE /pattern/:id
func (res *Resource) Delete(h http.HandlerFunc) {
p := suffixIt(res.pattern, "{id}")
res.routes.Add(http.MethodDelete + " " + p)
res.handlerFunc(http.MethodDelete, p, h)
}
func (res *Resource) Handle(pattern string, h http.HandlerFunc) {
p := suffixIt(res.pattern, "{id}")
res.routes.Add(http.MethodDelete + " " + p)
res.handlerFunc(http.MethodDelete, p, h)
}
// handlerFunc registers the handler function for the given pattern.
// If the given pattern conflicts, with one that is already registered, HandleFunc
// panics.
func (res *Resource) handlerFunc(method, pattern string, h http.HandlerFunc) {
if res == nil {
panic("serve: func handlerFunc() was called on nil")
}
if res.mux == nil {
panic("serve: router mux is nil")
}
path := fmt.Sprintf("%s %s", method, pattern)
res.mux.Handle(path, stack(res.middlewares, h))
}
// Use will register middleware(s) on Router stack.
func (res *Resource) Use(middlewares ...func(http.Handler) http.Handler) {
if res == nil {
panic("serve: func Use was called on nil")
}
res.middlewares = append(res.middlewares, middlewares...)
}
func suffixIt(str, suffix string) string {
@@ -39,61 +145,3 @@ func suffixIt(str, suffix string) string {
p.WriteString(suffix)
return p.String()
}
// Index is GET /resource-name
func (r *Resource) Index(h http.HandlerFunc) {
r.handlerFunc(http.MethodGet, r.pattern, h)
}
// New is GET /resource-name/new
func (r *Resource) New(h http.HandlerFunc) {
r.handlerFunc(http.MethodGet, suffixIt(r.pattern, "new"), h)
}
// Create is POST /resource-name
func (r *Resource) Create(h http.HandlerFunc) {
r.handlerFunc(http.MethodPost, r.pattern, h)
}
// Show is GET /resource-name/:id
func (r *Resource) Show(h http.HandlerFunc) {
r.handlerFunc(http.MethodGet, suffixIt(r.pattern, "{id}"), h)
}
// Update is PUT /resource-name/:id
func (r *Resource) Update(h http.HandlerFunc) {
r.handlerFunc(http.MethodPut, suffixIt(r.pattern, "{id}"), h)
}
// PartialUpdate is PATCH /resource-name/:id
func (r *Resource) PartialUpdate(h http.HandlerFunc) {
r.handlerFunc(http.MethodPatch, suffixIt(r.pattern, "{id}"), h)
}
func (r *Resource) Destroy(h http.HandlerFunc) {
r.handlerFunc(http.MethodDelete, suffixIt(r.pattern, "{id}"), h)
}
// handlerFunc registers the handler function for the given pattern.
// If the given pattern conflicts, with one that is already registered, HandleFunc
// panics.
func (r *Resource) handlerFunc(method, pattern string, h http.HandlerFunc) {
if r == nil {
panic("serve: func handlerFunc() was called on nil")
}
if r.mux == nil {
panic("serve: router mux is nil")
}
path := fmt.Sprintf("%s %s", method, pattern)
r.mux.Handle(path, stack(r.middlewares, h))
}
// Use will register middleware(s) on Router stack.
func (r *Resource) Use(middlewares ...func(http.Handler) http.Handler) {
if r == nil {
panic("serve: func Use was called on nil")
}
r.middlewares = append(r.middlewares, middlewares...)
}

51
route.go Normal file
View File

@@ -0,0 +1,51 @@
package mux
import (
"fmt"
"log/slog"
"sync"
)
type RouteList struct {
mu sync.RWMutex
routes []string
}
func (s *RouteList) Add(item string) {
if s == nil {
slog.Warn("failed on Add, RouteList is nil")
return
}
s.mu.Lock()
defer s.mu.Unlock()
s.routes = append(s.routes, item)
}
func (s *RouteList) Get(index int) (string, error) {
if s == nil {
slog.Warn("failed on Get, RouteList is nil")
return "", nil
}
s.mu.RLock()
defer s.mu.RUnlock()
if index < 0 || index >= len(s.routes) {
return "0", fmt.Errorf("index out of bounds")
}
return s.routes[index], nil
}
func (s *RouteList) All() []string {
if s == nil {
slog.Warn("failed on All, RouteList is nil")
return nil
}
s.mu.RLock()
defer s.mu.RUnlock()
return s.routes
}

170
router.go
View File

@@ -1,170 +0,0 @@
package mux
import (
"fmt"
"net/http"
"strings"
)
// Router is a wrapper around the go's standard http.ServeMux.
// It's a lean wrapper with methods to make routing easier
type Router struct {
mux *http.ServeMux
middlewares []func(http.Handler) http.Handler
}
func NewRouter() *Router {
return &Router{
mux: http.NewServeMux(),
}
}
// Use will register middleware(s) with router stack
func (r *Router) Use(h ...func(http.Handler) http.Handler) {
if r == nil {
panic("mux: func Use was called on nil")
}
r.middlewares = append(r.middlewares, h...)
}
// Get method route
func (r *Router) Get(pattern string, h http.HandlerFunc) {
r.handlerFunc(http.MethodGet, pattern, h)
}
// Head method route
func (r *Router) Head(pattern string, h http.HandlerFunc) {
r.handlerFunc(http.MethodHead, pattern, h)
}
// Post method route
func (r *Router) Post(pattern string, h http.HandlerFunc) {
r.handlerFunc(http.MethodPost, pattern, h)
}
// Put method route
func (r *Router) Put(pattern string, h http.HandlerFunc) {
r.handlerFunc(http.MethodPut, pattern, h)
}
// Patch method route
func (r *Router) Patch(pattern string, h http.HandlerFunc) {
r.handlerFunc(http.MethodPatch, pattern, h)
}
// Delete method route
func (r *Router) Delete(pattern string, h http.HandlerFunc) {
r.handlerFunc(http.MethodDelete, pattern, h)
}
// Connect method route
func (r *Router) Connect(pattern string, h http.HandlerFunc) {
r.handlerFunc(http.MethodConnect, pattern, h)
}
// Options method route
func (r *Router) Options(pattern string, h http.HandlerFunc) {
r.handlerFunc(http.MethodOptions, pattern, h)
}
// Trace method route
func (r *Router) Trace(pattern string, h http.HandlerFunc) {
r.handlerFunc(http.MethodTrace, pattern, h)
}
// HandleFunc registers the handler function for the given pattern.
// If the given pattern conflicts, with one that is already registered, HandleFunc
// panics.
func (r *Router) handlerFunc(method, pattern string, h http.HandlerFunc) {
if r == nil {
panic("mux: func Handle() was called on nil")
}
path := fmt.Sprintf("%s %s", method, pattern)
r.mux.Handle(path, stack(r.middlewares, h))
}
// With adds inline middlewares for an endpoint handler.
func (r *Router) With(middleware ...func(http.Handler) http.Handler) *Router {
mws := make([]func(http.Handler) http.Handler, len(r.middlewares))
copy(mws, r.middlewares)
mws = append(mws, middleware...)
im := &Router{
mux: r.mux,
middlewares: mws,
}
return im
}
// Group adds a new inline-Router along the current routing
// path, with a fresh middleware stack for the inline-Router.
func (r *Router) Group(fn func(grp *Router)) {
if r == nil {
panic("mux: Resource() called on nil")
}
if fn == nil {
panic("mux: Group() requires callback")
}
im := r.With()
fn(im)
}
// Resource resourceful route provides a mapping between HTTP verbs for given the pattern
func (r *Router) Resource(pattern string, fn func(resource *Resource)) {
if r == nil {
panic("mux: Resource() called on nil")
}
if strings.TrimSpace(pattern) == "" {
panic("mux: Resource() requires a patter to work")
}
if fn == nil {
panic("mux: Resource() requires callback")
}
mws := make([]func(http.Handler) http.Handler, len(r.middlewares))
copy(mws, r.middlewares)
fn(&Resource{
mux: r.mux,
pattern: pattern,
middlewares: mws,
})
}
func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request) {
if r == nil {
panic("mux: method ServeHTTP called on nil")
}
h, pattern := r.mux.Handler(req)
if pattern == "" {
http.Error(w, "Not Found", http.StatusNotFound)
return
}
// ensure we run all the middlewares
h = stack(r.middlewares, h)
// serve
h.ServeHTTP(w, req)
}
// stack middlewares(http handler) in order they are passed (FIFO)
func stack(middlewares []func(http.Handler) http.Handler, endpoint http.Handler) http.Handler {
// Return ahead of time if there aren't any middlewares for the chain
if len(middlewares) == 0 {
return endpoint
}
// wrap the end handler with the middleware chain
h := middlewares[len(middlewares)-1](endpoint)
for i := len(middlewares) - 2; i >= 0; i-- {
h = middlewares[i](h)
}
return h
}

View File

@@ -1,42 +0,0 @@
package mux
import (
"context"
"errors"
"log/slog"
"net/http"
"os"
"os/signal"
)
type ServeCB func(srv *http.Server) error
// Serve with graceful shutdown
func (r *Router) Serve(cb ServeCB) {
srv := &http.Server{
Handler: r,
}
idleConnsClosed := make(chan struct{})
go func() {
sigint := make(chan os.Signal, 1)
signal.Notify(sigint, os.Interrupt)
<-sigint
// We received an interrupt signal, shut down.
if err := srv.Shutdown(context.Background()); err != nil {
// Error from closing listeners, or context timeout:
slog.Error("server shutdown error", "error", err)
} else {
slog.Info("server shutdown")
}
close(idleConnsClosed)
}()
if err := cb(srv); !errors.Is(err, http.ErrServerClosed) {
// Error starting or closing listener:
slog.Error("start server error", "error", err)
}
<-idleConnsClosed
}

78
serve.go Normal file
View File

@@ -0,0 +1,78 @@
package mux
import (
"context"
"errors"
"io"
"log"
"log/slog"
"net"
"net/http"
"os/signal"
"syscall"
"time"
)
type ServeCB func(srv *http.Server) error
const (
shutdownDelay = time.Second * 10
shutdownHardDelay = time.Second * 5
drainDelay = time.Second
)
// Serve with graceful shutdown
func (m *Mux) Serve(cb ServeCB) {
rootCtx, stop := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
defer stop()
// catch all options
// lets get it thorugh all middlewares
m.OPTIONS("/", func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Length", "0")
if r.ContentLength != 0 {
// Read up to 4KB of OPTIONS body (as mentioned in the
// spec as being reserved for future use), but anything
// over that is considered a waste of server resources
// (or an attack) and we abort and close the connection,
// courtesy of MaxBytesReader's EOF behavior.
mb := http.MaxBytesReader(w, r.Body, 4<<10)
io.Copy(io.Discard, mb)
}
})
srvCtx, cancelSrvCtx := context.WithCancel(context.Background())
srv := &http.Server{
Handler: m,
BaseContext: func(_ net.Listener) context.Context {
return srvCtx
},
}
go func() {
if err := cb(srv); !errors.Is(err, http.ErrServerClosed) {
panic(err)
}
}()
// Wait for interrupt signal
<-rootCtx.Done()
stop()
m.IsShuttingDown.Store(true)
slog.Info("received interrupt singal, shutting down")
time.Sleep(drainDelay)
slog.Info("readiness check propagated, now waiting for ongoing requests to finish.")
shutdownCtx, cancel := context.WithTimeout(context.Background(), shutdownDelay)
defer cancel()
err := srv.Shutdown(shutdownCtx)
cancelSrvCtx()
if err != nil {
log.Println("failed to wait for ongoing requests to finish, waiting for forced cancellation")
time.Sleep(shutdownHardDelay)
}
slog.Info("seerver shut down gracefully")
}

19
stack.go Normal file
View File

@@ -0,0 +1,19 @@
package mux
import "net/http"
// stack middlewares(http handler) in order they are passed (FIFO)
func stack(middlewares []func(http.Handler) http.Handler, endpoint http.Handler) http.Handler {
// Return ahead of time if there aren't any middlewares for the chain
if len(middlewares) == 0 {
return endpoint
}
// wrap the end handler with the middleware chain
h := middlewares[len(middlewares)-1](endpoint)
for i := len(middlewares) - 2; i >= 0; i-- {
h = middlewares[i](h)
}
return h
}