Compare commits
15 Commits
Author | SHA1 | Date | |
---|---|---|---|
b5f9b6b638
|
|||
c7949febf2
|
|||
15a4b2a713 | |||
493c6ebae8 | |||
fb847b03af | |||
f826633e6e
|
|||
edeae23bf1
|
|||
a038b86147
|
|||
ede0b99d3a
|
|||
d04ce18eb0
|
|||
8ae9a0f107
|
|||
a259bb6dbc
|
|||
adf32568ee
|
|||
0cfa159cb1
|
|||
0ead99608a
|
@@ -47,6 +47,7 @@ var (
|
|||||||
TypeBindFailQuery = ErrorType{"BINDFAIL_QUERY", langext.Ptr(400)}
|
TypeBindFailQuery = ErrorType{"BINDFAIL_QUERY", langext.Ptr(400)}
|
||||||
TypeBindFailJSON = ErrorType{"BINDFAIL_JSON", langext.Ptr(400)}
|
TypeBindFailJSON = ErrorType{"BINDFAIL_JSON", langext.Ptr(400)}
|
||||||
TypeBindFailFormData = ErrorType{"BINDFAIL_FORMDATA", langext.Ptr(400)}
|
TypeBindFailFormData = ErrorType{"BINDFAIL_FORMDATA", langext.Ptr(400)}
|
||||||
|
TypeBindFailHeader = ErrorType{"BINDFAIL_HEADER", langext.Ptr(400)}
|
||||||
|
|
||||||
TypeUnauthorized = ErrorType{"UNAUTHORIZED", langext.Ptr(401)}
|
TypeUnauthorized = ErrorType{"UNAUTHORIZED", langext.Ptr(401)}
|
||||||
TypeAuthFailed = ErrorType{"AUTH_FAILED", langext.Ptr(401)}
|
TypeAuthFailed = ErrorType{"AUTH_FAILED", langext.Ptr(401)}
|
||||||
|
@@ -52,6 +52,7 @@ func (ee *ExErr) Output(g *gin.Context) {
|
|||||||
var baseCat = ee.RecursiveCategory()
|
var baseCat = ee.RecursiveCategory()
|
||||||
var baseType = ee.RecursiveType()
|
var baseType = ee.RecursiveType()
|
||||||
var baseStatuscode = ee.RecursiveStatuscode()
|
var baseStatuscode = ee.RecursiveStatuscode()
|
||||||
|
var baseMessage = ee.RecursiveMessage()
|
||||||
|
|
||||||
if baseCat == CatUser {
|
if baseCat == CatUser {
|
||||||
statuscode = http.StatusBadRequest
|
statuscode = http.StatusBadRequest
|
||||||
@@ -69,9 +70,9 @@ func (ee *ExErr) Output(g *gin.Context) {
|
|||||||
|
|
||||||
ginOutput := gin.H{
|
ginOutput := gin.H{
|
||||||
"errorid": ee.UniqueID,
|
"errorid": ee.UniqueID,
|
||||||
"message": ee.RecursiveMessage(),
|
"message": baseMessage,
|
||||||
"errorcode": ee.RecursiveType(),
|
"errorcode": baseType.Key,
|
||||||
"category": ee.RecursiveCategory(),
|
"category": baseCat.Category,
|
||||||
}
|
}
|
||||||
|
|
||||||
if pkgconfig.ExtendedGinOutput {
|
if pkgconfig.ExtendedGinOutput {
|
||||||
|
@@ -1,8 +1,14 @@
|
|||||||
package ginext
|
package ginext
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"fmt"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
"github.com/rs/zerolog/log"
|
||||||
|
"gogs.mikescher.com/BlackForestBytes/goext/langext"
|
||||||
|
"gogs.mikescher.com/BlackForestBytes/goext/mathext"
|
||||||
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -13,6 +19,15 @@ type GinWrapper struct {
|
|||||||
allowCors bool
|
allowCors bool
|
||||||
ginDebug bool
|
ginDebug bool
|
||||||
requestTimeout time.Duration
|
requestTimeout time.Duration
|
||||||
|
|
||||||
|
routeSpecs []ginRouteSpec
|
||||||
|
}
|
||||||
|
|
||||||
|
type ginRouteSpec struct {
|
||||||
|
Method string
|
||||||
|
URL string
|
||||||
|
Middlewares []string
|
||||||
|
Handler string
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewEngine(allowCors bool, ginDebug bool, timeout time.Duration) *GinWrapper {
|
func NewEngine(allowCors bool, ginDebug bool, timeout time.Duration) *GinWrapper {
|
||||||
@@ -33,18 +48,94 @@ func NewEngine(allowCors bool, ginDebug bool, timeout time.Duration) *GinWrapper
|
|||||||
engine.Use(CorsMiddleware())
|
engine.Use(CorsMiddleware())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// do not debug-print routes
|
||||||
|
gin.DebugPrintRouteFunc = func(_, _, _ string, _ int) {}
|
||||||
|
|
||||||
if ginDebug {
|
if ginDebug {
|
||||||
|
gin.SetMode(gin.ReleaseMode)
|
||||||
|
|
||||||
ginlogger := gin.Logger()
|
ginlogger := gin.Logger()
|
||||||
engine.Use(func(context *gin.Context) {
|
engine.Use(func(context *gin.Context) {
|
||||||
if !wrapper.SuppressGinLogs {
|
if !wrapper.SuppressGinLogs {
|
||||||
ginlogger(context)
|
ginlogger(context)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
} else {
|
||||||
|
gin.SetMode(gin.DebugMode)
|
||||||
}
|
}
|
||||||
|
|
||||||
return wrapper
|
return wrapper
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinWrapper) ServeHTTP(writer http.ResponseWriter, request *http.Request) {
|
func (w *GinWrapper) ListenAndServeHTTP(addr string, postInit func(port string)) (chan error, *http.Server) {
|
||||||
w.engine.ServeHTTP(writer, request)
|
|
||||||
|
w.DebugPrintRoutes()
|
||||||
|
|
||||||
|
httpserver := &http.Server{
|
||||||
|
Addr: addr,
|
||||||
|
Handler: w.engine,
|
||||||
|
}
|
||||||
|
|
||||||
|
errChan := make(chan error)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
|
||||||
|
ln, err := net.Listen("tcp", httpserver.Addr)
|
||||||
|
if err != nil {
|
||||||
|
errChan <- err
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
_, port, err := net.SplitHostPort(ln.Addr().String())
|
||||||
|
if err != nil {
|
||||||
|
errChan <- err
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
log.Info().Str("address", httpserver.Addr).Msg("HTTP-Server started on http://localhost:" + port)
|
||||||
|
|
||||||
|
if postInit != nil {
|
||||||
|
postInit(port) // the net.Listener a few lines above is at this point actually already buffering requests
|
||||||
|
}
|
||||||
|
|
||||||
|
errChan <- httpserver.Serve(ln)
|
||||||
|
}()
|
||||||
|
|
||||||
|
return errChan, httpserver
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *GinWrapper) DebugPrintRoutes() {
|
||||||
|
if !w.ginDebug {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
lines := make([][4]string, 0)
|
||||||
|
|
||||||
|
pad := [4]int{0, 0, 0, 0}
|
||||||
|
|
||||||
|
for _, spec := range w.routeSpecs {
|
||||||
|
|
||||||
|
line := [4]string{
|
||||||
|
spec.Method,
|
||||||
|
spec.URL,
|
||||||
|
strings.Join(spec.Middlewares, " -> "),
|
||||||
|
spec.Handler,
|
||||||
|
}
|
||||||
|
|
||||||
|
lines = append(lines, line)
|
||||||
|
|
||||||
|
pad[0] = mathext.Max(pad[0], len(line[0]))
|
||||||
|
pad[1] = mathext.Max(pad[1], len(line[1]))
|
||||||
|
pad[2] = mathext.Max(pad[2], len(line[2]))
|
||||||
|
pad[3] = mathext.Max(pad[3], len(line[3]))
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, line := range lines {
|
||||||
|
|
||||||
|
fmt.Printf("Gin-Route: %s %s --> %s --> %s\n",
|
||||||
|
langext.StrPadRight("["+line[0]+"]", " ", pad[0]+2),
|
||||||
|
langext.StrPadRight(line[1], " ", pad[1]),
|
||||||
|
langext.StrPadRight(line[2], " ", pad[2]),
|
||||||
|
langext.StrPadRight(line[3], " ", pad[3]))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@@ -25,7 +25,7 @@ func Wrap(w *GinWrapper, fn WHandlerFunc) gin.HandlerFunc {
|
|||||||
Str("trace", stackTrace).
|
Str("trace", stackTrace).
|
||||||
Build()
|
Build()
|
||||||
|
|
||||||
wrap = APIError(g, err)
|
wrap = Error(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if g.Writer.Written() {
|
if g.Writer.Written() {
|
||||||
|
@@ -17,6 +17,7 @@ type PreContext struct {
|
|||||||
query any
|
query any
|
||||||
body any
|
body any
|
||||||
form any
|
form any
|
||||||
|
header any
|
||||||
}
|
}
|
||||||
|
|
||||||
func (pctx *PreContext) URI(uri any) *PreContext {
|
func (pctx *PreContext) URI(uri any) *PreContext {
|
||||||
@@ -39,6 +40,11 @@ func (pctx *PreContext) Form(form any) *PreContext {
|
|||||||
return pctx
|
return pctx
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (pctx *PreContext) Header(header any) *PreContext {
|
||||||
|
pctx.header = header
|
||||||
|
return pctx
|
||||||
|
}
|
||||||
|
|
||||||
func (pctx PreContext) Start() (*AppContext, *gin.Context, *HTTPResponse) {
|
func (pctx PreContext) Start() (*AppContext, *gin.Context, *HTTPResponse) {
|
||||||
if pctx.uri != nil {
|
if pctx.uri != nil {
|
||||||
if err := pctx.ginCtx.ShouldBindUri(pctx.uri); err != nil {
|
if err := pctx.ginCtx.ShouldBindUri(pctx.uri); err != nil {
|
||||||
@@ -46,7 +52,7 @@ func (pctx PreContext) Start() (*AppContext, *gin.Context, *HTTPResponse) {
|
|||||||
WithType(exerr.TypeBindFailURI).
|
WithType(exerr.TypeBindFailURI).
|
||||||
Str("struct_type", fmt.Sprintf("%T", pctx.uri)).
|
Str("struct_type", fmt.Sprintf("%T", pctx.uri)).
|
||||||
Build()
|
Build()
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
return nil, nil, langext.Ptr(Error(err))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -56,7 +62,7 @@ func (pctx PreContext) Start() (*AppContext, *gin.Context, *HTTPResponse) {
|
|||||||
WithType(exerr.TypeBindFailQuery).
|
WithType(exerr.TypeBindFailQuery).
|
||||||
Str("struct_type", fmt.Sprintf("%T", pctx.query)).
|
Str("struct_type", fmt.Sprintf("%T", pctx.query)).
|
||||||
Build()
|
Build()
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
return nil, nil, langext.Ptr(Error(err))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -67,13 +73,13 @@ func (pctx PreContext) Start() (*AppContext, *gin.Context, *HTTPResponse) {
|
|||||||
WithType(exerr.TypeBindFailJSON).
|
WithType(exerr.TypeBindFailJSON).
|
||||||
Str("struct_type", fmt.Sprintf("%T", pctx.body)).
|
Str("struct_type", fmt.Sprintf("%T", pctx.body)).
|
||||||
Build()
|
Build()
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
return nil, nil, langext.Ptr(Error(err))
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
err := exerr.New(exerr.TypeBindFailJSON, "missing JSON body").
|
err := exerr.New(exerr.TypeBindFailJSON, "missing JSON body").
|
||||||
Str("struct_type", fmt.Sprintf("%T", pctx.body)).
|
Str("struct_type", fmt.Sprintf("%T", pctx.body)).
|
||||||
Build()
|
Build()
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
return nil, nil, langext.Ptr(Error(err))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -84,13 +90,23 @@ func (pctx PreContext) Start() (*AppContext, *gin.Context, *HTTPResponse) {
|
|||||||
WithType(exerr.TypeBindFailFormData).
|
WithType(exerr.TypeBindFailFormData).
|
||||||
Str("struct_type", fmt.Sprintf("%T", pctx.form)).
|
Str("struct_type", fmt.Sprintf("%T", pctx.form)).
|
||||||
Build()
|
Build()
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
return nil, nil, langext.Ptr(Error(err))
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
err := exerr.New(exerr.TypeBindFailFormData, "missing form body").
|
err := exerr.New(exerr.TypeBindFailFormData, "missing form body").
|
||||||
Str("struct_type", fmt.Sprintf("%T", pctx.form)).
|
Str("struct_type", fmt.Sprintf("%T", pctx.form)).
|
||||||
Build()
|
Build()
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
return nil, nil, langext.Ptr(Error(err))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if pctx.header != nil {
|
||||||
|
if err := pctx.ginCtx.ShouldBindHeader(pctx.query); err != nil {
|
||||||
|
err = exerr.Wrap(err, "Failed to read header").
|
||||||
|
WithType(exerr.TypeBindFailHeader).
|
||||||
|
Str("struct_type", fmt.Sprintf("%T", pctx.query)).
|
||||||
|
Build()
|
||||||
|
return nil, nil, langext.Ptr(Error(err))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -7,50 +7,93 @@ import (
|
|||||||
json "gogs.mikescher.com/BlackForestBytes/goext/gojson"
|
json "gogs.mikescher.com/BlackForestBytes/goext/gojson"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
type headerval struct {
|
||||||
|
Key string
|
||||||
|
Val string
|
||||||
|
}
|
||||||
|
|
||||||
type HTTPResponse interface {
|
type HTTPResponse interface {
|
||||||
Write(g *gin.Context)
|
Write(g *gin.Context)
|
||||||
|
WithHeader(k string, v string) HTTPResponse
|
||||||
}
|
}
|
||||||
|
|
||||||
type jsonHTTPResponse struct {
|
type jsonHTTPResponse struct {
|
||||||
statusCode int
|
statusCode int
|
||||||
data any
|
data any
|
||||||
|
headers []headerval
|
||||||
}
|
}
|
||||||
|
|
||||||
func (j jsonHTTPResponse) Write(g *gin.Context) {
|
func (j jsonHTTPResponse) Write(g *gin.Context) {
|
||||||
|
for _, v := range j.headers {
|
||||||
|
g.Header(v.Key, v.Val)
|
||||||
|
}
|
||||||
g.Render(j.statusCode, json.GoJsonRender{Data: j.data, NilSafeSlices: true, NilSafeMaps: true})
|
g.Render(j.statusCode, json.GoJsonRender{Data: j.data, NilSafeSlices: true, NilSafeMaps: true})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (j jsonHTTPResponse) WithHeader(k string, v string) HTTPResponse {
|
||||||
|
j.headers = append(j.headers, headerval{k, v})
|
||||||
|
return j
|
||||||
|
}
|
||||||
|
|
||||||
type emptyHTTPResponse struct {
|
type emptyHTTPResponse struct {
|
||||||
statusCode int
|
statusCode int
|
||||||
|
headers []headerval
|
||||||
}
|
}
|
||||||
|
|
||||||
func (j emptyHTTPResponse) Write(g *gin.Context) {
|
func (j emptyHTTPResponse) Write(g *gin.Context) {
|
||||||
|
for _, v := range j.headers {
|
||||||
|
g.Header(v.Key, v.Val)
|
||||||
|
}
|
||||||
g.Status(j.statusCode)
|
g.Status(j.statusCode)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (j emptyHTTPResponse) WithHeader(k string, v string) HTTPResponse {
|
||||||
|
j.headers = append(j.headers, headerval{k, v})
|
||||||
|
return j
|
||||||
|
}
|
||||||
|
|
||||||
type textHTTPResponse struct {
|
type textHTTPResponse struct {
|
||||||
statusCode int
|
statusCode int
|
||||||
data string
|
data string
|
||||||
|
headers []headerval
|
||||||
}
|
}
|
||||||
|
|
||||||
func (j textHTTPResponse) Write(g *gin.Context) {
|
func (j textHTTPResponse) Write(g *gin.Context) {
|
||||||
|
for _, v := range j.headers {
|
||||||
|
g.Header(v.Key, v.Val)
|
||||||
|
}
|
||||||
g.String(j.statusCode, "%s", j.data)
|
g.String(j.statusCode, "%s", j.data)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (j textHTTPResponse) WithHeader(k string, v string) HTTPResponse {
|
||||||
|
j.headers = append(j.headers, headerval{k, v})
|
||||||
|
return j
|
||||||
|
}
|
||||||
|
|
||||||
type dataHTTPResponse struct {
|
type dataHTTPResponse struct {
|
||||||
statusCode int
|
statusCode int
|
||||||
data []byte
|
data []byte
|
||||||
contentType string
|
contentType string
|
||||||
|
headers []headerval
|
||||||
}
|
}
|
||||||
|
|
||||||
func (j dataHTTPResponse) Write(g *gin.Context) {
|
func (j dataHTTPResponse) Write(g *gin.Context) {
|
||||||
|
for _, v := range j.headers {
|
||||||
|
g.Header(v.Key, v.Val)
|
||||||
|
}
|
||||||
g.Data(j.statusCode, j.contentType, j.data)
|
g.Data(j.statusCode, j.contentType, j.data)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (j dataHTTPResponse) WithHeader(k string, v string) HTTPResponse {
|
||||||
|
j.headers = append(j.headers, headerval{k, v})
|
||||||
|
return j
|
||||||
|
}
|
||||||
|
|
||||||
type fileHTTPResponse struct {
|
type fileHTTPResponse struct {
|
||||||
mimetype string
|
mimetype string
|
||||||
filepath string
|
filepath string
|
||||||
filename *string
|
filename *string
|
||||||
|
headers []headerval
|
||||||
}
|
}
|
||||||
|
|
||||||
func (j fileHTTPResponse) Write(g *gin.Context) {
|
func (j fileHTTPResponse) Write(g *gin.Context) {
|
||||||
@@ -59,26 +102,46 @@ func (j fileHTTPResponse) Write(g *gin.Context) {
|
|||||||
g.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", *j.filename))
|
g.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", *j.filename))
|
||||||
|
|
||||||
}
|
}
|
||||||
|
for _, v := range j.headers {
|
||||||
|
g.Header(v.Key, v.Val)
|
||||||
|
}
|
||||||
g.File(j.filepath)
|
g.File(j.filepath)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (j fileHTTPResponse) WithHeader(k string, v string) HTTPResponse {
|
||||||
|
j.headers = append(j.headers, headerval{k, v})
|
||||||
|
return j
|
||||||
|
}
|
||||||
|
|
||||||
type redirectHTTPResponse struct {
|
type redirectHTTPResponse struct {
|
||||||
statusCode int
|
statusCode int
|
||||||
url string
|
url string
|
||||||
|
headers []headerval
|
||||||
}
|
}
|
||||||
|
|
||||||
func (j redirectHTTPResponse) Write(g *gin.Context) {
|
func (j redirectHTTPResponse) Write(g *gin.Context) {
|
||||||
g.Redirect(j.statusCode, j.url)
|
g.Redirect(j.statusCode, j.url)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (j redirectHTTPResponse) WithHeader(k string, v string) HTTPResponse {
|
||||||
|
j.headers = append(j.headers, headerval{k, v})
|
||||||
|
return j
|
||||||
|
}
|
||||||
|
|
||||||
type jsonAPIErrResponse struct {
|
type jsonAPIErrResponse struct {
|
||||||
err *exerr.ExErr
|
err *exerr.ExErr
|
||||||
|
headers []headerval
|
||||||
}
|
}
|
||||||
|
|
||||||
func (j jsonAPIErrResponse) Write(g *gin.Context) {
|
func (j jsonAPIErrResponse) Write(g *gin.Context) {
|
||||||
j.err.Output(g)
|
j.err.Output(g)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (j jsonAPIErrResponse) WithHeader(k string, v string) HTTPResponse {
|
||||||
|
j.headers = append(j.headers, headerval{k, v})
|
||||||
|
return j
|
||||||
|
}
|
||||||
|
|
||||||
func Status(sc int) HTTPResponse {
|
func Status(sc int) HTTPResponse {
|
||||||
return &emptyHTTPResponse{statusCode: sc}
|
return &emptyHTTPResponse{statusCode: sc}
|
||||||
}
|
}
|
||||||
@@ -107,12 +170,18 @@ func Redirect(sc int, newURL string) HTTPResponse {
|
|||||||
return &redirectHTTPResponse{statusCode: sc, url: newURL}
|
return &redirectHTTPResponse{statusCode: sc, url: newURL}
|
||||||
}
|
}
|
||||||
|
|
||||||
func APIError(g *gin.Context, e error) HTTPResponse {
|
func Error(e error) HTTPResponse {
|
||||||
return &jsonAPIErrResponse{
|
return &jsonAPIErrResponse{
|
||||||
err: exerr.FromError(e),
|
err: exerr.FromError(e),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func NotImplemented(g *gin.Context) HTTPResponse {
|
func ErrWrap(e error, errorType exerr.ErrorType, msg string) HTTPResponse {
|
||||||
return APIError(g, exerr.New(exerr.TypeNotImplemented, "").Build())
|
return &jsonAPIErrResponse{
|
||||||
|
err: exerr.FromError(exerr.Wrap(e, msg).WithType(errorType).Build()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func NotImplemented() HTTPResponse {
|
||||||
|
return Error(exerr.New(exerr.TypeNotImplemented, "").Build())
|
||||||
}
|
}
|
||||||
|
139
ginext/routes.go
139
ginext/routes.go
@@ -2,7 +2,14 @@ package ginext
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
"gogs.mikescher.com/BlackForestBytes/goext/langext"
|
||||||
|
"gogs.mikescher.com/BlackForestBytes/goext/rext"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"path"
|
||||||
|
"reflect"
|
||||||
|
"regexp"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
var anyMethods = []string{
|
var anyMethods = []string{
|
||||||
@@ -12,60 +19,89 @@ var anyMethods = []string{
|
|||||||
}
|
}
|
||||||
|
|
||||||
type GinRoutesWrapper struct {
|
type GinRoutesWrapper struct {
|
||||||
wrapper *GinWrapper
|
wrapper *GinWrapper
|
||||||
routes gin.IRouter
|
routes gin.IRouter
|
||||||
|
absPath string
|
||||||
|
defaultHandler []gin.HandlerFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
type GinRouteBuilder struct {
|
type GinRouteBuilder struct {
|
||||||
routes *GinRoutesWrapper
|
routes *GinRoutesWrapper
|
||||||
|
|
||||||
methods []string
|
method string
|
||||||
relPath string
|
relPath string
|
||||||
|
absPath string
|
||||||
handlers []gin.HandlerFunc
|
handlers []gin.HandlerFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinWrapper) Routes() *GinRoutesWrapper {
|
func (w *GinWrapper) Routes() *GinRoutesWrapper {
|
||||||
return &GinRoutesWrapper{wrapper: w, routes: w.engine}
|
return &GinRoutesWrapper{
|
||||||
|
wrapper: w,
|
||||||
|
routes: w.engine,
|
||||||
|
absPath: "",
|
||||||
|
defaultHandler: make([]gin.HandlerFunc, 0),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) Group(relativePath string) *GinRoutesWrapper {
|
func (w *GinRoutesWrapper) Group(relativePath string) *GinRoutesWrapper {
|
||||||
return &GinRoutesWrapper{wrapper: w.wrapper, routes: w.routes.Group(relativePath)}
|
return &GinRoutesWrapper{
|
||||||
|
wrapper: w.wrapper,
|
||||||
|
routes: w.routes.Group(relativePath),
|
||||||
|
defaultHandler: langext.ArrCopy(w.defaultHandler),
|
||||||
|
absPath: joinPaths(w.absPath, relativePath),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *GinRoutesWrapper) Use(middleware ...gin.HandlerFunc) *GinRoutesWrapper {
|
||||||
|
defHandler := langext.ArrCopy(w.defaultHandler)
|
||||||
|
defHandler = append(defHandler, middleware...)
|
||||||
|
return &GinRoutesWrapper{wrapper: w.wrapper, routes: w.routes, defaultHandler: defHandler}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) GET(relativePath string) *GinRouteBuilder {
|
func (w *GinRoutesWrapper) GET(relativePath string) *GinRouteBuilder {
|
||||||
return &GinRouteBuilder{routes: w, methods: []string{http.MethodGet}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)}
|
return w._route(http.MethodGet, relativePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) POST(relativePath string) *GinRouteBuilder {
|
func (w *GinRoutesWrapper) POST(relativePath string) *GinRouteBuilder {
|
||||||
return &GinRouteBuilder{routes: w, methods: []string{http.MethodPost}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)}
|
return w._route(http.MethodPost, relativePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) DELETE(relativePath string) *GinRouteBuilder {
|
func (w *GinRoutesWrapper) DELETE(relativePath string) *GinRouteBuilder {
|
||||||
return &GinRouteBuilder{routes: w, methods: []string{http.MethodDelete}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)}
|
return w._route(http.MethodDelete, relativePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) PATCH(relativePath string) *GinRouteBuilder {
|
func (w *GinRoutesWrapper) PATCH(relativePath string) *GinRouteBuilder {
|
||||||
return &GinRouteBuilder{routes: w, methods: []string{http.MethodPatch}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)}
|
return w._route(http.MethodPatch, relativePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) PUT(relativePath string) *GinRouteBuilder {
|
func (w *GinRoutesWrapper) PUT(relativePath string) *GinRouteBuilder {
|
||||||
return &GinRouteBuilder{routes: w, methods: []string{http.MethodPut}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)}
|
return w._route(http.MethodPut, relativePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) OPTIONS(relativePath string) *GinRouteBuilder {
|
func (w *GinRoutesWrapper) OPTIONS(relativePath string) *GinRouteBuilder {
|
||||||
return &GinRouteBuilder{routes: w, methods: []string{http.MethodOptions}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)}
|
return w._route(http.MethodOptions, relativePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) HEAD(relativePath string) *GinRouteBuilder {
|
func (w *GinRoutesWrapper) HEAD(relativePath string) *GinRouteBuilder {
|
||||||
return &GinRouteBuilder{routes: w, methods: []string{http.MethodHead}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)}
|
return w._route(http.MethodHead, relativePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) COUNT(relativePath string) *GinRouteBuilder {
|
func (w *GinRoutesWrapper) COUNT(relativePath string) *GinRouteBuilder {
|
||||||
return &GinRouteBuilder{routes: w, methods: []string{"COUNT"}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)}
|
return w._route("COUNT", relativePath)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRoutesWrapper) Any(relativePath string) *GinRouteBuilder {
|
func (w *GinRoutesWrapper) Any(relativePath string) *GinRouteBuilder {
|
||||||
return &GinRouteBuilder{routes: w, methods: anyMethods, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)}
|
return w._route("*", relativePath)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *GinRoutesWrapper) _route(method string, relativePath string) *GinRouteBuilder {
|
||||||
|
return &GinRouteBuilder{
|
||||||
|
routes: w,
|
||||||
|
method: method,
|
||||||
|
relPath: relativePath,
|
||||||
|
absPath: joinPaths(w.absPath, relativePath),
|
||||||
|
handlers: langext.ArrCopy(w.defaultHandler),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRouteBuilder) Use(middleware ...gin.HandlerFunc) *GinRouteBuilder {
|
func (w *GinRouteBuilder) Use(middleware ...gin.HandlerFunc) *GinRouteBuilder {
|
||||||
@@ -74,12 +110,83 @@ func (w *GinRouteBuilder) Use(middleware ...gin.HandlerFunc) *GinRouteBuilder {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRouteBuilder) Handle(handler WHandlerFunc) {
|
func (w *GinRouteBuilder) Handle(handler WHandlerFunc) {
|
||||||
|
|
||||||
|
middlewareNames := langext.ArrMap(w.handlers, func(v gin.HandlerFunc) string { return nameOfFunction(v) })
|
||||||
|
handlerName := nameOfFunction(handler)
|
||||||
|
|
||||||
w.handlers = append(w.handlers, Wrap(w.routes.wrapper, handler))
|
w.handlers = append(w.handlers, Wrap(w.routes.wrapper, handler))
|
||||||
for _, m := range w.methods {
|
|
||||||
w.routes.routes.Handle(m, w.relPath, w.handlers...)
|
methodName := w.method
|
||||||
|
|
||||||
|
if w.method == "*" {
|
||||||
|
methodName = "ANY"
|
||||||
|
for _, method := range anyMethods {
|
||||||
|
w.routes.routes.Handle(method, w.relPath, w.handlers...)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
w.routes.routes.Handle(w.method, w.relPath, w.handlers...)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
w.routes.wrapper.routeSpecs = append(w.routes.wrapper.routeSpecs, ginRouteSpec{
|
||||||
|
Method: methodName,
|
||||||
|
URL: w.absPath,
|
||||||
|
Middlewares: middlewareNames,
|
||||||
|
Handler: handlerName,
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinWrapper) NoRoute(handler WHandlerFunc) {
|
func (w *GinWrapper) NoRoute(handler WHandlerFunc) {
|
||||||
w.engine.NoRoute(Wrap(w, handler))
|
w.engine.NoRoute(Wrap(w, handler))
|
||||||
|
|
||||||
|
w.routeSpecs = append(w.routeSpecs, ginRouteSpec{
|
||||||
|
Method: "ANY",
|
||||||
|
URL: "[NO_ROUTE]",
|
||||||
|
Middlewares: nil,
|
||||||
|
Handler: nameOfFunction(handler),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func nameOfFunction(f any) string {
|
||||||
|
|
||||||
|
fname := runtime.FuncForPC(reflect.ValueOf(f).Pointer()).Name()
|
||||||
|
|
||||||
|
split := strings.Split(fname, "/")
|
||||||
|
if len(split) == 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
fname = split[len(split)-1]
|
||||||
|
|
||||||
|
// https://stackoverflow.com/a/32925345/1761622
|
||||||
|
if strings.HasSuffix(fname, "-fm") {
|
||||||
|
fname = fname[:len(fname)-len("-fm")]
|
||||||
|
}
|
||||||
|
|
||||||
|
suffix := rext.W(regexp.MustCompile("\\.func[0-9]+$"))
|
||||||
|
|
||||||
|
if match, ok := suffix.MatchFirst(fname); ok {
|
||||||
|
fname = fname[:len(fname)-match.FullMatch().Length()]
|
||||||
|
}
|
||||||
|
|
||||||
|
return fname
|
||||||
|
}
|
||||||
|
|
||||||
|
// joinPaths is copied verbatim from gin@v1.9.1/gin.go
|
||||||
|
func joinPaths(absolutePath, relativePath string) string {
|
||||||
|
if relativePath == "" {
|
||||||
|
return absolutePath
|
||||||
|
}
|
||||||
|
|
||||||
|
finalPath := path.Join(absolutePath, relativePath)
|
||||||
|
if lastChar(relativePath) == '/' && lastChar(finalPath) != '/' {
|
||||||
|
return finalPath + "/"
|
||||||
|
}
|
||||||
|
return finalPath
|
||||||
|
}
|
||||||
|
|
||||||
|
func lastChar(str string) uint8 {
|
||||||
|
if str == "" {
|
||||||
|
panic("The length of the string can't be 0")
|
||||||
|
}
|
||||||
|
return str[len(str)-1]
|
||||||
}
|
}
|
||||||
|
2
go.mod
2
go.mod
@@ -14,7 +14,7 @@ require (
|
|||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/bytedance/sonic v1.10.0-rc2 // indirect
|
github.com/bytedance/sonic v1.10.0-rc3 // indirect
|
||||||
github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d // indirect
|
github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d // indirect
|
||||||
github.com/chenzhuoyu/iasm v0.9.0 // indirect
|
github.com/chenzhuoyu/iasm v0.9.0 // indirect
|
||||||
github.com/gabriel-vasile/mimetype v1.4.2 // indirect
|
github.com/gabriel-vasile/mimetype v1.4.2 // indirect
|
||||||
|
2
go.sum
2
go.sum
@@ -2,6 +2,8 @@ github.com/bytedance/sonic v1.5.0/go.mod h1:ED5hyg4y6t3/9Ku1R6dU/4KyJ48DZ4jPhfY1
|
|||||||
github.com/bytedance/sonic v1.10.0-rc/go.mod h1:ElCzW+ufi8qKqNW0FY314xriJhyJhuoJ3gFZdAHF7NM=
|
github.com/bytedance/sonic v1.10.0-rc/go.mod h1:ElCzW+ufi8qKqNW0FY314xriJhyJhuoJ3gFZdAHF7NM=
|
||||||
github.com/bytedance/sonic v1.10.0-rc2 h1:oDfRZ+4m6AYCOC0GFeOCeYqvBmucy1isvouS2K0cPzo=
|
github.com/bytedance/sonic v1.10.0-rc2 h1:oDfRZ+4m6AYCOC0GFeOCeYqvBmucy1isvouS2K0cPzo=
|
||||||
github.com/bytedance/sonic v1.10.0-rc2/go.mod h1:iZcSUejdk5aukTND/Eu/ivjQuEL0Cu9/rf50Hi0u/g4=
|
github.com/bytedance/sonic v1.10.0-rc2/go.mod h1:iZcSUejdk5aukTND/Eu/ivjQuEL0Cu9/rf50Hi0u/g4=
|
||||||
|
github.com/bytedance/sonic v1.10.0-rc3 h1:uNSnscRapXTwUgTyOF0GVljYD08p9X/Lbr9MweSV3V0=
|
||||||
|
github.com/bytedance/sonic v1.10.0-rc3/go.mod h1:iZcSUejdk5aukTND/Eu/ivjQuEL0Cu9/rf50Hi0u/g4=
|
||||||
github.com/chenzhuoyu/base64x v0.0.0-20211019084208-fb5309c8db06/go.mod h1:DH46F32mSOjUmXrMHnKwZdA8wcEefY7UVqBKYGjpdQY=
|
github.com/chenzhuoyu/base64x v0.0.0-20211019084208-fb5309c8db06/go.mod h1:DH46F32mSOjUmXrMHnKwZdA8wcEefY7UVqBKYGjpdQY=
|
||||||
github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311/go.mod h1:b583jCggY9gE99b6G5LEC39OIiVsWj+R97kbl5odCEk=
|
github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311/go.mod h1:b583jCggY9gE99b6G5LEC39OIiVsWj+R97kbl5odCEk=
|
||||||
github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d h1:77cEq6EriyTZ0g/qfRdp61a3Uu/AWrgIq2s0ClJV1g0=
|
github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d h1:77cEq6EriyTZ0g/qfRdp61a3Uu/AWrgIq2s0ClJV1g0=
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
package goext
|
package goext
|
||||||
|
|
||||||
const GoextVersion = "0.0.196"
|
const GoextVersion = "0.0.211"
|
||||||
|
|
||||||
const GoextVersionTimestamp = "2023-07-24T11:47:47+0200"
|
const GoextVersionTimestamp = "2023-07-26T10:40:42+0200"
|
||||||
|
Reference in New Issue
Block a user