Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f8cdf3a511 | |||
| e6a8880fd3 | |||
| aa6ba87f4e | |||
| 859d4fa458 | |||
| 894614cd54 | |||
| c34f5b7d0d | |||
| f4a2452a94 | |||
| eda7c79ab6 | |||
| f72529aea5 | |||
|
|
116afe7930 | ||
|
|
d639ea1b71 |
234
README.md
234
README.md
@@ -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
|
```go
|
||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log/slog"
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
|
||||||
"gitserver.in/patialtech/mux"
|
"code.patial.tech/go/mux"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
// create a new router
|
// Create a new router
|
||||||
r := mux.NewRouter()
|
router := mux.NewRouter()
|
||||||
|
|
||||||
// you can use any middleware that is: "func(http.Handler) http.Handler"
|
// Define a simple route
|
||||||
// so you can use any of it
|
router.GET("/", func(w http.ResponseWriter, r *http.Request) {
|
||||||
// - https://github.com/gorilla/handlers
|
fmt.Fprint(w, "Hello, World!")
|
||||||
// - 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"))
|
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
|
||||||
// create a group of few routes with their own middlewares
|
// Start the server
|
||||||
r.Group(func(grp *mux.Router) {
|
http.ListenAndServe(":8080", 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)
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|||||||
@@ -4,12 +4,31 @@ import (
|
|||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
|
||||||
"gitserver.in/patialtech/mux"
|
"code.patial.tech/go/mux"
|
||||||
|
"code.patial.tech/go/mux/middleware"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
// create a new router
|
// create a new router
|
||||||
r := mux.NewRouter()
|
r := mux.NewRouter()
|
||||||
|
r.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,
|
||||||
|
}))
|
||||||
|
|
||||||
|
r.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"
|
// you can use any middleware that is: "func(http.Handler) http.Handler"
|
||||||
// so you can use any of it
|
// so you can use any of it
|
||||||
@@ -20,7 +39,7 @@ func main() {
|
|||||||
r.Use(middleware1, middleware2)
|
r.Use(middleware1, middleware2)
|
||||||
|
|
||||||
// let's add a route
|
// let's add a route
|
||||||
r.Get("/hello", func(w http.ResponseWriter, r *http.Request) {
|
r.GET("/hello", func(w http.ResponseWriter, r *http.Request) {
|
||||||
w.Write([]byte("i am route /hello"))
|
w.Write([]byte("i am route /hello"))
|
||||||
})
|
})
|
||||||
// r.Post(pattern string, h http.HandlerFunc)
|
// r.Post(pattern string, h http.HandlerFunc)
|
||||||
@@ -30,13 +49,13 @@ func main() {
|
|||||||
// you can inline middleware(s) to a route
|
// you can inline middleware(s) to a route
|
||||||
r.
|
r.
|
||||||
With(mwInline).
|
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"))
|
w.Write([]byte("i am route /hello-2 with my own middleware"))
|
||||||
})
|
})
|
||||||
|
|
||||||
// define a resource
|
// define a resource
|
||||||
r.Resource("/photos", func(resource *mux.Resource) {
|
r.Resource("/photos", func(resource *mux.Resource) {
|
||||||
// rails style resource routes
|
// Rails style resource routes
|
||||||
// GET /photos
|
// GET /photos
|
||||||
// GET /photos/new
|
// GET /photos/new
|
||||||
// POST /photos
|
// POST /photos
|
||||||
@@ -57,13 +76,13 @@ func main() {
|
|||||||
// create a group of few routes with their own middlewares
|
// create a group of few routes with their own middlewares
|
||||||
r.Group(func(grp *mux.Router) {
|
r.Group(func(grp *mux.Router) {
|
||||||
grp.Use(mwGroup)
|
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"))
|
w.Write([]byte("i am route /group"))
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
// catches all
|
// catches all
|
||||||
r.Get("/", func(w http.ResponseWriter, r *http.Request) {
|
r.GET("/", func(w http.ResponseWriter, r *http.Request) {
|
||||||
w.Write([]byte("hello there"))
|
w.Write([]byte("hello there"))
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
4
go.mod
4
go.mod
@@ -1,3 +1,3 @@
|
|||||||
module gitserver.in/patialtech/mux
|
module code.patial.tech/go/mux
|
||||||
|
|
||||||
go 1.23.2
|
go 1.24
|
||||||
|
|||||||
322
middleware/cors.go
Normal file
322
middleware/cors.go
Normal file
@@ -0,0 +1,322 @@
|
|||||||
|
package middleware
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// copied from https://github.com/gorilla/handlers/blob/main/cors.go
|
||||||
|
// with some editing to fit in
|
||||||
|
//
|
||||||
|
|
||||||
|
// CORSOption represents a functional option for configuring the CORS middleware.
|
||||||
|
type CORSOption struct {
|
||||||
|
// AllowedOrigins list, including "*" will allow all
|
||||||
|
AllowedOrigins []string
|
||||||
|
|
||||||
|
// AllowedHeaders are a list of headers clients are allowed to use with.
|
||||||
|
// default: []string{"Accept", "Accept-Language", "Content-Language", "Origin"}
|
||||||
|
AllowedHeaders []string
|
||||||
|
|
||||||
|
// AllowedMethods are a list of methods clients are allowed to use.
|
||||||
|
//
|
||||||
|
// default: []string{"HEAD", "GET", "POST"}
|
||||||
|
AllowedMethods []string
|
||||||
|
|
||||||
|
ExposedHeaders []string
|
||||||
|
// MaxAge in seconds, max allowed value is 600
|
||||||
|
MaxAge uint
|
||||||
|
AllowCredentials bool
|
||||||
|
}
|
||||||
|
|
||||||
|
type cors struct {
|
||||||
|
h http.Handler
|
||||||
|
allowedHeaders []string
|
||||||
|
allowedMethods []string
|
||||||
|
allowedOrigins []string
|
||||||
|
allowedOriginValidator OriginValidator
|
||||||
|
exposedHeaders []string
|
||||||
|
maxAge uint
|
||||||
|
ignoreOptions bool
|
||||||
|
allowCredentials bool
|
||||||
|
optionStatusCode int
|
||||||
|
}
|
||||||
|
|
||||||
|
// OriginValidator takes an origin string and returns whether that origin is allowed.
|
||||||
|
type OriginValidator func(string) bool
|
||||||
|
|
||||||
|
var (
|
||||||
|
defaultCorsOptionStatusCode = http.StatusOK
|
||||||
|
defaultCorsMethods = []string{http.MethodHead, http.MethodGet, http.MethodPost}
|
||||||
|
defaultCorsHeaders = []string{"Accept", "Accept-Language", "Content-Language", "Origin"}
|
||||||
|
// (WebKit/Safari v9 sends the Origin header by default in AJAX requests).
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
corsOptionMethod string = http.MethodOptions
|
||||||
|
corsAllowOriginHeader string = "Access-Control-Allow-Origin"
|
||||||
|
corsExposeHeadersHeader string = "Access-Control-Expose-Headers"
|
||||||
|
corsMaxAgeHeader string = "Access-Control-Max-Age"
|
||||||
|
corsAllowMethodsHeader string = "Access-Control-Allow-Methods"
|
||||||
|
corsAllowHeadersHeader string = "Access-Control-Allow-Headers"
|
||||||
|
corsAllowCredentialsHeader string = "Access-Control-Allow-Credentials"
|
||||||
|
corsRequestMethodHeader string = "Access-Control-Request-Method"
|
||||||
|
corsRequestHeadersHeader string = "Access-Control-Request-Headers"
|
||||||
|
corsOriginHeader string = "Origin"
|
||||||
|
corsVaryHeader string = "Vary"
|
||||||
|
corsOriginMatchAll string = "*"
|
||||||
|
)
|
||||||
|
|
||||||
|
// CORS provides Cross-Origin Resource Sharing middleware.
|
||||||
|
// Example:
|
||||||
|
//
|
||||||
|
// import (
|
||||||
|
// "net/http"
|
||||||
|
// "gitserver.in/patialtech/mux/middleware"
|
||||||
|
// "gitserver.in/patialtech/mux"
|
||||||
|
// )
|
||||||
|
//
|
||||||
|
// func main() {
|
||||||
|
// r := mux.NewRouter()
|
||||||
|
// r.Use(middleware.CORS(middleware.CORSOption{
|
||||||
|
// AllowedOrigins: []string{"*"},
|
||||||
|
// MaxAge: 60,
|
||||||
|
// }))
|
||||||
|
//
|
||||||
|
// r.Get("/", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
// w.Write([]byte("hello there"))
|
||||||
|
// })
|
||||||
|
//
|
||||||
|
// r.Serve(func(srv *http.Server) error {
|
||||||
|
// srv.Addr = ":3001"
|
||||||
|
// slog.Info("listening on http://localhost" + srv.Addr)
|
||||||
|
// return srv.ListenAndServe()
|
||||||
|
// })
|
||||||
|
// }
|
||||||
|
func CORS(opts CORSOption) func(http.Handler) http.Handler {
|
||||||
|
return func(h http.Handler) http.Handler {
|
||||||
|
ch := &cors{
|
||||||
|
h: h,
|
||||||
|
allowedMethods: defaultCorsMethods,
|
||||||
|
allowedHeaders: defaultCorsHeaders,
|
||||||
|
allowedOrigins: []string{},
|
||||||
|
optionStatusCode: defaultCorsOptionStatusCode,
|
||||||
|
}
|
||||||
|
|
||||||
|
ch.setAllowedOrigins(opts.AllowedOrigins)
|
||||||
|
ch.setAllowedHeaders(opts.AllowedHeaders)
|
||||||
|
ch.setAllowedMethods(opts.AllowedMethods)
|
||||||
|
ch.setExposedHeaders(opts.ExposedHeaders)
|
||||||
|
ch.setMaxAge(opts.MaxAge)
|
||||||
|
ch.maxAge = opts.MaxAge
|
||||||
|
ch.allowCredentials = opts.AllowCredentials
|
||||||
|
|
||||||
|
return ch
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ch *cors) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||||
|
origin := r.Header.Get(corsOriginHeader)
|
||||||
|
if !ch.isOriginAllowed(origin) {
|
||||||
|
if r.Method != corsOptionMethod || ch.ignoreOptions {
|
||||||
|
ch.h.ServeHTTP(w, r)
|
||||||
|
}
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if r.Method == corsOptionMethod {
|
||||||
|
if ch.ignoreOptions {
|
||||||
|
ch.h.ServeHTTP(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, ok := r.Header[corsRequestMethodHeader]; !ok {
|
||||||
|
w.WriteHeader(http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
method := r.Header.Get(corsRequestMethodHeader)
|
||||||
|
if !ch.isMatch(method, ch.allowedMethods) {
|
||||||
|
w.WriteHeader(http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
requestHeaders := strings.Split(r.Header.Get(corsRequestHeadersHeader), ",")
|
||||||
|
var allowedHeaders []string
|
||||||
|
for _, v := range requestHeaders {
|
||||||
|
canonicalHeader := http.CanonicalHeaderKey(strings.TrimSpace(v))
|
||||||
|
if canonicalHeader == "" || ch.isMatch(canonicalHeader, defaultCorsHeaders) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !ch.isMatch(canonicalHeader, ch.allowedHeaders) {
|
||||||
|
w.WriteHeader(http.StatusForbidden)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
allowedHeaders = append(allowedHeaders, canonicalHeader)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(allowedHeaders) > 0 {
|
||||||
|
w.Header().Set(corsAllowHeadersHeader, strings.Join(allowedHeaders, ","))
|
||||||
|
}
|
||||||
|
|
||||||
|
if ch.maxAge > 0 {
|
||||||
|
w.Header().Set(corsMaxAgeHeader, strconv.Itoa(int(ch.maxAge)))
|
||||||
|
}
|
||||||
|
|
||||||
|
if !ch.isMatch(method, defaultCorsMethods) {
|
||||||
|
w.Header().Set(corsAllowMethodsHeader, method)
|
||||||
|
}
|
||||||
|
} else if len(ch.exposedHeaders) > 0 {
|
||||||
|
w.Header().Set(corsExposeHeadersHeader, strings.Join(ch.exposedHeaders, ","))
|
||||||
|
}
|
||||||
|
|
||||||
|
if ch.allowCredentials {
|
||||||
|
w.Header().Set(corsAllowCredentialsHeader, "true")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(ch.allowedOrigins) > 1 {
|
||||||
|
w.Header().Set(corsVaryHeader, corsOriginHeader)
|
||||||
|
}
|
||||||
|
|
||||||
|
returnOrigin := origin
|
||||||
|
if ch.allowedOriginValidator == nil && len(ch.allowedOrigins) == 0 {
|
||||||
|
returnOrigin = "*"
|
||||||
|
} else {
|
||||||
|
for _, o := range ch.allowedOrigins {
|
||||||
|
// A configuration of * is different from explicitly setting an allowed
|
||||||
|
// origin. Returning arbitrary origin headers in an access control allow
|
||||||
|
// origin header is unsafe and is not required by any use case.
|
||||||
|
if o == corsOriginMatchAll {
|
||||||
|
returnOrigin = "*"
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
w.Header().Set(corsAllowOriginHeader, returnOrigin)
|
||||||
|
|
||||||
|
if r.Method == corsOptionMethod {
|
||||||
|
w.WriteHeader(ch.optionStatusCode)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
ch.h.ServeHTTP(w, r)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AllowedOrigins sets the allowed origins for CORS requests, as used in the
|
||||||
|
// 'Allow-Access-Control-Origin' HTTP header.
|
||||||
|
// Note: Passing in a []string{"*"} will allow any domain.
|
||||||
|
func (ch *cors) setAllowedOrigins(origins []string) {
|
||||||
|
// look for "*"
|
||||||
|
for _, v := range origins {
|
||||||
|
if v == corsOriginMatchAll {
|
||||||
|
ch.allowedOrigins = []string{corsOriginMatchAll}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ch.allowedOrigins = origins
|
||||||
|
}
|
||||||
|
|
||||||
|
// setAllowedHeaders adds the provided headers to the list of allowed headers in a
|
||||||
|
// CORS request.
|
||||||
|
// This is an appended operation, so the headers Accept, Accept-Language,
|
||||||
|
// and Content-Language are always allowed.
|
||||||
|
// Content-Type must be explicitly declared if accepting Content-Types other than
|
||||||
|
// application/x-www-form-urlencoded, multipart/form-data, or text/plain.
|
||||||
|
func (ch *cors) setAllowedHeaders(headers []string) {
|
||||||
|
for _, v := range headers {
|
||||||
|
normalizedHeader := http.CanonicalHeaderKey(strings.TrimSpace(v))
|
||||||
|
if normalizedHeader == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !ch.isMatch(normalizedHeader, ch.allowedHeaders) {
|
||||||
|
ch.allowedHeaders = append(ch.allowedHeaders, normalizedHeader)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// AllowedMethods can be used to explicitly allow methods in the
|
||||||
|
// Access-Control-Allow-Methods header.
|
||||||
|
// This is a replacement operation, so you must also
|
||||||
|
// pass GET, HEAD, and POST if you wish to support those methods.
|
||||||
|
func (ch *cors) setAllowedMethods(methods []string) {
|
||||||
|
if len(methods) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
ch.allowedMethods = []string{}
|
||||||
|
for _, v := range methods {
|
||||||
|
normalizedMethod := strings.ToUpper(strings.TrimSpace(v))
|
||||||
|
if normalizedMethod == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !ch.isMatch(normalizedMethod, ch.allowedMethods) {
|
||||||
|
ch.allowedMethods = append(ch.allowedMethods, normalizedMethod)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExposedHeaders can be used to specify headers that are available
|
||||||
|
// and will not be stripped out by the user-agent.
|
||||||
|
func (ch *cors) setExposedHeaders(headers []string) {
|
||||||
|
ch.exposedHeaders = []string{}
|
||||||
|
for _, v := range headers {
|
||||||
|
normalizedHeader := http.CanonicalHeaderKey(strings.TrimSpace(v))
|
||||||
|
if normalizedHeader == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if !ch.isMatch(normalizedHeader, ch.exposedHeaders) {
|
||||||
|
ch.exposedHeaders = append(ch.exposedHeaders, normalizedHeader)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// MaxAge determines the maximum age (in seconds) between preflight requests. A
|
||||||
|
// maximum of 10 minutes is allowed. An age above this value will default to 10
|
||||||
|
// minutes.
|
||||||
|
func (ch *cors) setMaxAge(age uint) {
|
||||||
|
// Maximum of 10 minutes.
|
||||||
|
if age > 600 {
|
||||||
|
age = 600
|
||||||
|
}
|
||||||
|
|
||||||
|
ch.maxAge = age
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ch *cors) isOriginAllowed(origin string) bool {
|
||||||
|
if origin == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if ch.allowedOriginValidator != nil {
|
||||||
|
return ch.allowedOriginValidator(origin)
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(ch.allowedOrigins) == 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, allowedOrigin := range ch.allowedOrigins {
|
||||||
|
if allowedOrigin == origin || allowedOrigin == corsOriginMatchAll {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ch *cors) isMatch(needle string, haystack []string) bool {
|
||||||
|
for _, v := range haystack {
|
||||||
|
if v == needle {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
340
middleware/helmet.go
Normal file
340
middleware/helmet.go
Normal file
@@ -0,0 +1,340 @@
|
|||||||
|
// Author: Ankit Patial
|
||||||
|
// inspired from Helmet.js
|
||||||
|
// https://github.com/helmetjs/helmet/tree/main
|
||||||
|
|
||||||
|
package middleware
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
type (
|
||||||
|
HelmetOption struct {
|
||||||
|
ContentSecurityPolicy CSP
|
||||||
|
|
||||||
|
StrictTransportSecurity *TransportSecurity
|
||||||
|
|
||||||
|
// "require-corp" will be the default policy
|
||||||
|
CrossOriginEmbedderPolicy Embedder
|
||||||
|
|
||||||
|
// "same-origin" will be the default policy
|
||||||
|
CrossOriginOpenerPolicy Opener
|
||||||
|
|
||||||
|
// "same-origin" will be the default policy
|
||||||
|
CrossOriginResourcePolicy Resource
|
||||||
|
|
||||||
|
// "no-referrer" will be the default policy
|
||||||
|
ReferrerPolicy []Referrer
|
||||||
|
|
||||||
|
OriginAgentCluster bool
|
||||||
|
|
||||||
|
// set true to remove header "X-Content-Type-Options"
|
||||||
|
DisableSniffMimeType bool
|
||||||
|
|
||||||
|
// set true for header "X-DNS-Prefetch-Control: off"
|
||||||
|
//
|
||||||
|
// default is "X-DNS-Prefetch-Control: on"
|
||||||
|
DisableDNSPrefetch bool
|
||||||
|
|
||||||
|
// set true to remove header "X-Download-Options: noopen"
|
||||||
|
DisableXDownload bool
|
||||||
|
|
||||||
|
// X-Frame-Options
|
||||||
|
XFrameOption XFrame
|
||||||
|
|
||||||
|
// X-Permitted-Cross-Domain-Policies
|
||||||
|
//
|
||||||
|
// default value will be "none"
|
||||||
|
CrossDomainPolicies CDP
|
||||||
|
|
||||||
|
// X-XSS-Protection
|
||||||
|
//
|
||||||
|
// default is off
|
||||||
|
XssProtection bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// CSP is Content-Security-Policy settings
|
||||||
|
//
|
||||||
|
// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources
|
||||||
|
CSP struct {
|
||||||
|
// default-src, default value will be 'self'
|
||||||
|
DefaultSrc []string
|
||||||
|
// script-src, default value will be 'self'
|
||||||
|
ScriptSrc []string
|
||||||
|
// script-src-attr, default value will be 'none'
|
||||||
|
ScriptSrcAttr []string
|
||||||
|
// style-src, default value will be 'self' https: 'unsafe-inline'
|
||||||
|
StyleSrc []string
|
||||||
|
// img-src, default value will be 'self' data:
|
||||||
|
ImgSrc []string
|
||||||
|
// object-src, default value will be 'none'
|
||||||
|
ObjectSrc []string
|
||||||
|
// base-uri, default value will be 'self'
|
||||||
|
BaseUri []string
|
||||||
|
// font-src, default value will be 'self' https: data:
|
||||||
|
FontSrc []string
|
||||||
|
// form-action, default value will be 'self'
|
||||||
|
FormAction []string
|
||||||
|
// frame-ancestors, default value will be 'self'
|
||||||
|
FrameAncestors []string
|
||||||
|
|
||||||
|
UpgradeInsecureRequests bool
|
||||||
|
}
|
||||||
|
|
||||||
|
TransportSecurity struct {
|
||||||
|
// Age in seconts
|
||||||
|
MaxAge uint
|
||||||
|
IncludeSubDomains bool
|
||||||
|
Preload bool
|
||||||
|
}
|
||||||
|
|
||||||
|
Embedder string
|
||||||
|
Opener string
|
||||||
|
Resource string
|
||||||
|
Referrer string
|
||||||
|
// CDP Cross-Domain-Policy
|
||||||
|
CDP string
|
||||||
|
XFrame string
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
YearDuration = 365 * 24 * 60 * 60
|
||||||
|
|
||||||
|
// 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"
|
||||||
|
ResourceSameOrigin Resource = "same-origin"
|
||||||
|
ResourceSameSite Resource = "same-site"
|
||||||
|
ResourceCrossOrigin Resource = "cross-origin"
|
||||||
|
|
||||||
|
NoReferrer Referrer = "no-referrer"
|
||||||
|
NoReferrerWhenDowngrade Referrer = "no-referrer-when-downgrade"
|
||||||
|
SameOrigin Referrer = "same-origin"
|
||||||
|
Origin Referrer = "origin"
|
||||||
|
StrictOrigin Referrer = "strict-origin"
|
||||||
|
OriginWhenCrossOrigin Referrer = "origin-when-cross-origin"
|
||||||
|
StrictOriginWhenCrossOrigin Referrer = "strict-origin-when-cross-origin"
|
||||||
|
UnsafeUrl Referrer = "unsafe-url"
|
||||||
|
|
||||||
|
// CDPNone is default if no value supplied
|
||||||
|
CDPNone CDP = "none"
|
||||||
|
CDPMasterOnly CDP = "master-only"
|
||||||
|
CDPByContentType CDP = "by-content-type"
|
||||||
|
CDPAll CDP = "all"
|
||||||
|
|
||||||
|
// XFrameSameOrigin is default if no value supplied
|
||||||
|
XFrameSameOrigin XFrame = "sameorigin"
|
||||||
|
XFrameDeny XFrame = "deny"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Helmet headers to secure server response
|
||||||
|
func Helmet(opt HelmetOption) func(http.Handler) http.Handler {
|
||||||
|
return func(h http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Add("Content-Security-Policy", opt.ContentSecurityPolicy.value())
|
||||||
|
|
||||||
|
// 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))
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Referrer-Policy
|
||||||
|
rpCount := len(opt.ReferrerPolicy)
|
||||||
|
if rpCount > 0 {
|
||||||
|
refP := make([]string, rpCount)
|
||||||
|
for i, r := range opt.ReferrerPolicy {
|
||||||
|
refP[i] = string(r)
|
||||||
|
}
|
||||||
|
w.Header().Add("Referrer-Policy", string(NoReferrer))
|
||||||
|
} else {
|
||||||
|
// default no referer
|
||||||
|
w.Header().Add("Referrer-Policy", string(NoReferrer))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Origin-Agent-Cluster
|
||||||
|
if opt.OriginAgentCluster {
|
||||||
|
w.Header().Add("Origin-Agent-Cluster", "?1")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Strict-Transport-Security
|
||||||
|
if opt.StrictTransportSecurity != nil {
|
||||||
|
var sb strings.Builder
|
||||||
|
|
||||||
|
if opt.StrictTransportSecurity.MaxAge == 0 {
|
||||||
|
opt.StrictTransportSecurity.MaxAge = YearDuration
|
||||||
|
}
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf("max-age=%d", opt.StrictTransportSecurity.MaxAge))
|
||||||
|
if opt.StrictTransportSecurity.IncludeSubDomains {
|
||||||
|
sb.WriteString("; includeSubDomains")
|
||||||
|
}
|
||||||
|
|
||||||
|
if opt.StrictTransportSecurity.Preload {
|
||||||
|
sb.WriteString("; preload")
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Header().Add("Strict-Transport-Security", sb.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
if !opt.DisableSniffMimeType {
|
||||||
|
// MIME types advertised in the Content-Current headers should be followed and not be changed
|
||||||
|
w.Header().Add("X-Content-Type-Options", "nosniff")
|
||||||
|
}
|
||||||
|
|
||||||
|
if opt.DisableDNSPrefetch {
|
||||||
|
w.Header().Add("X-DNS-Prefetch-Control", "off")
|
||||||
|
} else {
|
||||||
|
w.Header().Add("X-DNS-Prefetch-Control", "on")
|
||||||
|
}
|
||||||
|
|
||||||
|
if !opt.DisableXDownload {
|
||||||
|
// Instructs Internet Explorer not to open the file directly but to offer it for download first.
|
||||||
|
w.Header().Add("X-Download-Options", "noopen")
|
||||||
|
}
|
||||||
|
|
||||||
|
// indicate whether a browser should be allowed to render a page in iframe | frame | embed | object
|
||||||
|
if opt.XFrameOption == "" {
|
||||||
|
w.Header().Add("X-Frame-Options", string(XFrameSameOrigin))
|
||||||
|
} else {
|
||||||
|
w.Header().Add("X-Frame-Options", string(opt.XFrameOption))
|
||||||
|
}
|
||||||
|
|
||||||
|
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))
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Header().Del("X-Powered-By")
|
||||||
|
|
||||||
|
if opt.XssProtection {
|
||||||
|
// feature of IE, Chrome and Safari that stops pages from loading when they detect reflected
|
||||||
|
// cross-site scripting (XSS) attacks.
|
||||||
|
w.Header().Add("X-Xss-Protection", "1; mode=block")
|
||||||
|
} else {
|
||||||
|
// Following a decision by Google Chrome developers to disable Auditor,
|
||||||
|
// developers should be able to disable the auditor for older browsers and set it to 0.
|
||||||
|
// The X-XSS-PROTECTION header was found to have a multitude of issues, instead of helping the
|
||||||
|
// developers protect their application.
|
||||||
|
w.Header().Add("X-Xss-Protection", "0")
|
||||||
|
}
|
||||||
|
|
||||||
|
h.ServeHTTP(w, r)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (csp *CSP) value() string {
|
||||||
|
var sb strings.Builder
|
||||||
|
|
||||||
|
// should be the first thing
|
||||||
|
if csp.UpgradeInsecureRequests {
|
||||||
|
sb.WriteString("upgrade-insecure-requests;")
|
||||||
|
}
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"default-src %s; ",
|
||||||
|
cspNormalised(csp.DefaultSrc, []string{"self"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"script-src %s; ",
|
||||||
|
cspNormalised(csp.ScriptSrc, []string{"self"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"script-src-attr %s; ",
|
||||||
|
cspNormalised(csp.ScriptSrcAttr, []string{"none"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"style-src %s; ",
|
||||||
|
cspNormalised(csp.StyleSrc, []string{"self", "https:", "unsafe-inline"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"img-src %s; ",
|
||||||
|
cspNormalised(csp.ImgSrc, []string{"self", "data:"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"object-src %s; ",
|
||||||
|
cspNormalised(csp.ObjectSrc, []string{"none"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"base-uri %s; ",
|
||||||
|
cspNormalised(csp.BaseUri, []string{"self"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"font-src %s; ",
|
||||||
|
cspNormalised(csp.FontSrc, []string{"self", "https:", "data:"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"form-action %s; ",
|
||||||
|
cspNormalised(csp.FormAction, []string{"self"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
sb.WriteString(fmt.Sprintf(
|
||||||
|
"frame-ancestors %s; ",
|
||||||
|
cspNormalised(csp.FrameAncestors, []string{"self"}),
|
||||||
|
))
|
||||||
|
|
||||||
|
return sb.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func cspNormalised(v, defaultVal []string) string {
|
||||||
|
if len(v) == 0 {
|
||||||
|
v = defaultVal
|
||||||
|
}
|
||||||
|
|
||||||
|
var sb strings.Builder
|
||||||
|
for _, val := range v {
|
||||||
|
val = strings.TrimSpace(val)
|
||||||
|
if val == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
sb.WriteString(" " + cspQuoted(val))
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.TrimSpace(sb.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func cspQuoted(v string) string {
|
||||||
|
switch v {
|
||||||
|
case "none",
|
||||||
|
"self",
|
||||||
|
"strict-dynamic",
|
||||||
|
"report-sample",
|
||||||
|
"inline-speculation-rules",
|
||||||
|
"unsafe-inline",
|
||||||
|
"unsafe-eval",
|
||||||
|
"unsafe-hashes",
|
||||||
|
"wasm-unsafe-eval":
|
||||||
|
return fmt.Sprintf("'%s'", v)
|
||||||
|
default:
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
}
|
||||||
52
middleware/helmet_test.go
Normal file
52
middleware/helmet_test.go
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
package middleware
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"code.patial.tech/go/mux"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestHelmet(t *testing.T) {
|
||||||
|
r := mux.NewRouter()
|
||||||
|
r.Use(Helmet(HelmetOption{}))
|
||||||
|
r.GET("/hello", func(writer http.ResponseWriter, request *http.Request) {
|
||||||
|
_, _ = writer.Write([]byte("hello there"))
|
||||||
|
})
|
||||||
|
|
||||||
|
srv := httptest.NewServer(r)
|
||||||
|
defer srv.Close()
|
||||||
|
w, _ := testRequest(t, srv, "GET", "/hello", nil)
|
||||||
|
|
||||||
|
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 is expected")
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
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)
|
||||||
|
}
|
||||||
95
router.go
95
router.go
@@ -6,82 +6,87 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
const RouteCtxKey = "ServeCTX"
|
// Router is a wrapper around the go's standard http.ServeMux.
|
||||||
|
// It's a lean wrapper with methods to make routing easier
|
||||||
type (
|
type Router struct {
|
||||||
// Router is a wrapper around the go's standard http.ServeMux.
|
mux *http.ServeMux
|
||||||
// It's a lean wrapper with methods to make routing easier
|
middlewares []func(http.Handler) http.Handler
|
||||||
Router struct {
|
}
|
||||||
mux *http.ServeMux
|
|
||||||
middlewares []func(http.Handler) http.Handler
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
func NewRouter() *Router {
|
func NewRouter() *Router {
|
||||||
return &Router{
|
r := &Router{
|
||||||
mux: http.NewServeMux(),
|
mux: http.NewServeMux(),
|
||||||
}
|
}
|
||||||
|
return r
|
||||||
}
|
}
|
||||||
|
|
||||||
// Use will register middleware(s) with router stack
|
// Use will register middleware(s) with router stack
|
||||||
func (r *Router) Use(h ...func(http.Handler) http.Handler) {
|
func (r *Router) Use(h ...func(http.Handler) http.Handler) {
|
||||||
if r == nil {
|
if r == nil {
|
||||||
panic("serve: func Use was called on nil")
|
panic("mux: func Use was called on nil")
|
||||||
}
|
}
|
||||||
r.middlewares = append(r.middlewares, h...)
|
r.middlewares = append(r.middlewares, h...)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Get method route
|
// GET method route
|
||||||
func (r *Router) Get(pattern string, h http.HandlerFunc) {
|
func (r *Router) GET(pattern string, h http.HandlerFunc) {
|
||||||
r.handlerFunc(http.MethodGet, pattern, h)
|
r.handle(http.MethodGet, pattern, h)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Head method route
|
// HEAD method route
|
||||||
func (r *Router) Head(pattern string, h http.HandlerFunc) {
|
func (r *Router) HEAD(pattern string, h http.HandlerFunc) {
|
||||||
r.handlerFunc(http.MethodHead, pattern, h)
|
r.handle(http.MethodHead, pattern, h)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Post method route
|
// POST method route
|
||||||
func (r *Router) Post(pattern string, h http.HandlerFunc) {
|
func (r *Router) POST(pattern string, h http.HandlerFunc) {
|
||||||
r.handlerFunc(http.MethodPost, pattern, h)
|
r.handle(http.MethodPost, pattern, h)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Put method route
|
// PUT method route
|
||||||
func (r *Router) Put(pattern string, h http.HandlerFunc) {
|
func (r *Router) PUT(pattern string, h http.HandlerFunc) {
|
||||||
r.handlerFunc(http.MethodPut, pattern, h)
|
r.handle(http.MethodPut, pattern, h)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Patch method route
|
// PATCH method route
|
||||||
func (r *Router) Patch(pattern string, h http.HandlerFunc) {
|
func (r *Router) PATCH(pattern string, h http.HandlerFunc) {
|
||||||
r.handlerFunc(http.MethodPatch, pattern, h)
|
r.handle(http.MethodPatch, pattern, h)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Delete method route
|
// DELETE method route
|
||||||
func (r *Router) Delete(pattern string, h http.HandlerFunc) {
|
func (r *Router) DELETE(pattern string, h http.HandlerFunc) {
|
||||||
r.handlerFunc(http.MethodDelete, pattern, h)
|
r.handle(http.MethodDelete, pattern, h)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Connect method route
|
// CONNECT method route
|
||||||
func (r *Router) Connect(pattern string, h http.HandlerFunc) {
|
func (r *Router) CONNECT(pattern string, h http.HandlerFunc) {
|
||||||
r.handlerFunc(http.MethodConnect, pattern, h)
|
r.handle(http.MethodConnect, pattern, h)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Options method route
|
// OPTIONS method route
|
||||||
func (r *Router) Options(pattern string, h http.HandlerFunc) {
|
func (r *Router) OPTIONS(pattern string, h http.HandlerFunc) {
|
||||||
r.handlerFunc(http.MethodOptions, pattern, h)
|
r.handle(http.MethodOptions, pattern, h)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Trace method route
|
// TRACE method route
|
||||||
func (r *Router) Trace(pattern string, h http.HandlerFunc) {
|
func (r *Router) TRACE(pattern string, h http.HandlerFunc) {
|
||||||
r.handlerFunc(http.MethodTrace, pattern, h)
|
r.handle(http.MethodTrace, pattern, h)
|
||||||
}
|
}
|
||||||
|
|
||||||
// HandleFunc registers the handler function for the given pattern.
|
// handle registers the handler for the given pattern.
|
||||||
// If the given pattern conflicts, with one that is already registered, HandleFunc
|
// If the given pattern conflicts, with one that is already registered, HandleFunc
|
||||||
// panics.
|
// panics.
|
||||||
func (r *Router) handlerFunc(method, pattern string, h http.HandlerFunc) {
|
func (r *Router) handle(method, pattern string, h http.HandlerFunc) {
|
||||||
if r == nil {
|
if r == nil {
|
||||||
panic("serve: func Handle() was called on 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)
|
path := fmt.Sprintf("%s %s", method, pattern)
|
||||||
@@ -106,7 +111,7 @@ func (r *Router) With(middleware ...func(http.Handler) http.Handler) *Router {
|
|||||||
// path, with a fresh middleware stack for the inline-Router.
|
// path, with a fresh middleware stack for the inline-Router.
|
||||||
func (r *Router) Group(fn func(grp *Router)) {
|
func (r *Router) Group(fn func(grp *Router)) {
|
||||||
if r == nil {
|
if r == nil {
|
||||||
panic("mux: Resource() called on nil")
|
panic("mux: Group() called on nil")
|
||||||
}
|
}
|
||||||
|
|
||||||
if fn == nil {
|
if fn == nil {
|
||||||
@@ -142,12 +147,14 @@ func (r *Router) Resource(pattern string, fn func(resource *Resource)) {
|
|||||||
|
|
||||||
func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request) {
|
func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request) {
|
||||||
if r == nil {
|
if r == nil {
|
||||||
panic("method ServeHTTP called on nil")
|
panic("mux: method ServeHTTP called on nil")
|
||||||
}
|
}
|
||||||
|
|
||||||
r.mux.ServeHTTP(w, req)
|
r.mux.ServeHTTP(w, req)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TODO: proxy for aws lambda and other serverless platforms
|
||||||
|
|
||||||
// stack middlewares(http handler) in order they are passed (FIFO)
|
// stack middlewares(http handler) in order they are passed (FIFO)
|
||||||
func stack(middlewares []func(http.Handler) http.Handler, endpoint http.Handler) http.Handler {
|
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
|
// Return ahead of time if there aren't any middlewares for the chain
|
||||||
|
|||||||
@@ -2,6 +2,8 @@ package mux
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
@@ -10,8 +12,23 @@ import (
|
|||||||
|
|
||||||
type ServeCB func(srv *http.Server) error
|
type ServeCB func(srv *http.Server) error
|
||||||
|
|
||||||
// Serve with gracefull shutdown
|
// Serve with graceful shutdown
|
||||||
func (r *Router) Serve(cb ServeCB) {
|
func (r *Router) Serve(cb ServeCB) {
|
||||||
|
// catch all options
|
||||||
|
// lets get it thorugh all middlewares
|
||||||
|
r.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)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
srv := &http.Server{
|
srv := &http.Server{
|
||||||
Handler: r,
|
Handler: r,
|
||||||
}
|
}
|
||||||
@@ -32,7 +49,7 @@ func (r *Router) Serve(cb ServeCB) {
|
|||||||
close(idleConnsClosed)
|
close(idleConnsClosed)
|
||||||
}()
|
}()
|
||||||
|
|
||||||
if err := cb(srv); err != http.ErrServerClosed {
|
if err := cb(srv); !errors.Is(err, http.ErrServerClosed) {
|
||||||
// Error starting or closing listener:
|
// Error starting or closing listener:
|
||||||
slog.Error("start server error", "error", err)
|
slog.Error("start server error", "error", err)
|
||||||
}
|
}
|
||||||
|
|||||||
330
router_test.go
Normal file
330
router_test.go
Normal file
@@ -0,0 +1,330 @@
|
|||||||
|
package mux
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRouterGET(t *testing.T) {
|
||||||
|
r := NewRouter()
|
||||||
|
r.GET("/test", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
fmt.Fprint(w, "GET test")
|
||||||
|
})
|
||||||
|
|
||||||
|
ts := httptest.NewServer(r)
|
||||||
|
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) {
|
||||||
|
r := NewRouter()
|
||||||
|
r.POST("/test", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
fmt.Fprint(w, "POST test")
|
||||||
|
})
|
||||||
|
|
||||||
|
ts := httptest.NewServer(r)
|
||||||
|
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) {
|
||||||
|
r := NewRouter()
|
||||||
|
|
||||||
|
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)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
r.With(middleware).GET("/test", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
fmt.Fprint(w, "GET with middleware")
|
||||||
|
})
|
||||||
|
|
||||||
|
ts := httptest.NewServer(r)
|
||||||
|
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 := NewRouter()
|
||||||
|
|
||||||
|
var groupCalled bool
|
||||||
|
|
||||||
|
r.Group(func(g *Router) {
|
||||||
|
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 := NewRouter()
|
||||||
|
|
||||||
|
r.Resource("/users", func(resource *Resource) {
|
||||||
|
resource.Index(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
fmt.Fprint(w, "All users")
|
||||||
|
})
|
||||||
|
|
||||||
|
resource.Show(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 := NewRouter()
|
||||||
|
|
||||||
|
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 *Router
|
||||||
|
r.GET("/", func(w http.ResponseWriter, r *http.Request) {})
|
||||||
|
}
|
||||||
|
|
||||||
|
func BenchmarkRouterSimple(b *testing.B) {
|
||||||
|
r := NewRouter()
|
||||||
|
|
||||||
|
r.GET("/", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
fmt.Fprint(w, "Hello")
|
||||||
|
})
|
||||||
|
|
||||||
|
req, _ := http.NewRequest(http.MethodGet, "/", nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
b.ResetTimer()
|
||||||
|
for i := 0; i < b.N; i++ {
|
||||||
|
r.ServeHTTP(w, req)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func BenchmarkRouterWithMiddleware(b *testing.B) {
|
||||||
|
r := NewRouter()
|
||||||
|
|
||||||
|
middleware := func(h http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
h.ServeHTTP(w, r)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
r.Use(middleware, middleware)
|
||||||
|
|
||||||
|
r.GET("/", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
fmt.Fprint(w, "Hello")
|
||||||
|
})
|
||||||
|
|
||||||
|
req, _ := http.NewRequest(http.MethodGet, "/", nil)
|
||||||
|
w := httptest.NewRecorder()
|
||||||
|
|
||||||
|
b.ResetTimer()
|
||||||
|
for i := 0; i < b.N; i++ {
|
||||||
|
r.ServeHTTP(w, req)
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user