Compare commits
12 Commits
Author | SHA1 | Date | |
---|---|---|---|
ede0b99d3a
|
|||
d04ce18eb0
|
|||
8ae9a0f107
|
|||
a259bb6dbc
|
|||
adf32568ee
|
|||
0cfa159cb1
|
|||
0ead99608a
|
|||
7fe3e66cad
|
|||
a73d7d1654
|
|||
bbd7a7bc2c
|
|||
f5151eb214
|
|||
eefb9ac9f5
|
@@ -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)}
|
||||||
|
@@ -6,12 +6,12 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type ErrorPackageConfig struct {
|
type ErrorPackageConfig struct {
|
||||||
ZeroLogErrTraces bool // autom print zerolog logs on .Build() (for SevErr and SevFatal)
|
ZeroLogErrTraces bool // autom print zerolog logs on .Build() (for SevErr and SevFatal)
|
||||||
ZeroLogAllTraces bool // autom print zerolog logs on .Build() (for all Severities)
|
ZeroLogAllTraces bool // autom print zerolog logs on .Build() (for all Severities)
|
||||||
RecursiveErrors bool // errors contains their Origin-Error
|
RecursiveErrors bool // errors contains their Origin-Error
|
||||||
ExtendedGinOutput bool // Log extended data (trace, meta, ...) to gin in err.Output()
|
ExtendedGinOutput bool // Log extended data (trace, meta, ...) to gin in err.Output()
|
||||||
ExtendGinOutput func(json map[string]any) // (Optionally) extend the gin output with more fields
|
ExtendGinOutput func(err *ExErr, json map[string]any) // (Optionally) extend the gin output with more fields
|
||||||
ExtendGinDataOutput func(json map[string]any) // (Optionally) extend the gin `__data` output with more fields
|
ExtendGinDataOutput func(err *ExErr, depth int, json map[string]any) // (Optionally) extend the gin `__data` output with more fields
|
||||||
}
|
}
|
||||||
|
|
||||||
type ErrorPackageConfigInit struct {
|
type ErrorPackageConfigInit struct {
|
||||||
@@ -19,8 +19,8 @@ type ErrorPackageConfigInit struct {
|
|||||||
ZeroLogAllTraces bool
|
ZeroLogAllTraces bool
|
||||||
RecursiveErrors bool
|
RecursiveErrors bool
|
||||||
ExtendedGinOutput bool
|
ExtendedGinOutput bool
|
||||||
ExtendGinOutput *func(json map[string]any)
|
ExtendGinOutput func(err *ExErr, json map[string]any)
|
||||||
ExtendGinDataOutput *func(json map[string]any)
|
ExtendGinDataOutput func(err *ExErr, depth int, json map[string]any)
|
||||||
}
|
}
|
||||||
|
|
||||||
var initialized = false
|
var initialized = false
|
||||||
@@ -30,8 +30,8 @@ var pkgconfig = ErrorPackageConfig{
|
|||||||
ZeroLogAllTraces: false,
|
ZeroLogAllTraces: false,
|
||||||
RecursiveErrors: true,
|
RecursiveErrors: true,
|
||||||
ExtendedGinOutput: false,
|
ExtendedGinOutput: false,
|
||||||
ExtendGinOutput: func(json map[string]any) {},
|
ExtendGinOutput: func(err *ExErr, json map[string]any) {},
|
||||||
ExtendGinDataOutput: func(json map[string]any) {},
|
ExtendGinDataOutput: func(err *ExErr, depth int, json map[string]any) {},
|
||||||
}
|
}
|
||||||
|
|
||||||
// Init initializes the exerr packages
|
// Init initializes the exerr packages
|
||||||
@@ -42,13 +42,23 @@ func Init(cfg ErrorPackageConfigInit) {
|
|||||||
panic("Cannot re-init error package")
|
panic("Cannot re-init error package")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
ego := func(err *ExErr, json map[string]any) {}
|
||||||
|
egdo := func(err *ExErr, depth int, json map[string]any) {}
|
||||||
|
|
||||||
|
if cfg.ExtendGinOutput != nil {
|
||||||
|
ego = cfg.ExtendGinOutput
|
||||||
|
}
|
||||||
|
if cfg.ExtendGinDataOutput != nil {
|
||||||
|
egdo = cfg.ExtendGinDataOutput
|
||||||
|
}
|
||||||
|
|
||||||
pkgconfig = ErrorPackageConfig{
|
pkgconfig = ErrorPackageConfig{
|
||||||
ZeroLogErrTraces: cfg.ZeroLogErrTraces,
|
ZeroLogErrTraces: cfg.ZeroLogErrTraces,
|
||||||
ZeroLogAllTraces: cfg.ZeroLogAllTraces,
|
ZeroLogAllTraces: cfg.ZeroLogAllTraces,
|
||||||
RecursiveErrors: cfg.RecursiveErrors,
|
RecursiveErrors: cfg.RecursiveErrors,
|
||||||
ExtendedGinOutput: cfg.ExtendedGinOutput,
|
ExtendedGinOutput: cfg.ExtendedGinOutput,
|
||||||
ExtendGinOutput: langext.Coalesce(cfg.ExtendGinOutput, func(json map[string]any) {}),
|
ExtendGinOutput: ego,
|
||||||
ExtendGinDataOutput: langext.Coalesce(cfg.ExtendGinDataOutput, func(json map[string]any) {}),
|
ExtendGinDataOutput: egdo,
|
||||||
}
|
}
|
||||||
|
|
||||||
initialized = true
|
initialized = true
|
||||||
|
@@ -162,7 +162,6 @@ func (ee *ExErr) RecursiveStatuscode() *int {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// fallback to <empty>
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -179,6 +178,18 @@ func (ee *ExErr) RecursiveCategory() ErrorCategory {
|
|||||||
return ee.Category
|
return ee.Category
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// RecursiveMeta searches (top-down) for teh first error that has a meta value with teh specified key
|
||||||
|
// and returns its value (or nil)
|
||||||
|
func (ee *ExErr) RecursiveMeta(key string) *MetaValue {
|
||||||
|
for curr := ee; curr != nil; curr = curr.OriginalError {
|
||||||
|
if metaval, ok := curr.Meta[key]; ok {
|
||||||
|
return langext.Ptr(metaval)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func (ee *ExErr) Depth() int {
|
func (ee *ExErr) Depth() int {
|
||||||
if ee.OriginalError == nil {
|
if ee.OriginalError == nil {
|
||||||
return 1
|
return 1
|
||||||
|
39
exerr/gin.go
39
exerr/gin.go
@@ -7,43 +7,43 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (ee *ExErr) toJson() gin.H {
|
func (ee *ExErr) toJson(depth int) gin.H {
|
||||||
json := gin.H{}
|
ginJson := gin.H{}
|
||||||
|
|
||||||
if ee.UniqueID != "" {
|
if ee.UniqueID != "" {
|
||||||
json["id"] = ee.UniqueID
|
ginJson["id"] = ee.UniqueID
|
||||||
}
|
}
|
||||||
if ee.Category != CatWrap {
|
if ee.Category != CatWrap {
|
||||||
json["category"] = ee.Category
|
ginJson["category"] = ee.Category
|
||||||
}
|
}
|
||||||
if ee.Type != TypeWrap {
|
if ee.Type != TypeWrap {
|
||||||
json["type"] = ee.Type
|
ginJson["type"] = ee.Type
|
||||||
}
|
}
|
||||||
if ee.StatusCode != nil {
|
if ee.StatusCode != nil {
|
||||||
json["statuscode"] = ee.StatusCode
|
ginJson["statuscode"] = ee.StatusCode
|
||||||
}
|
}
|
||||||
if ee.Message != "" {
|
if ee.Message != "" {
|
||||||
json["message"] = ee.Message
|
ginJson["message"] = ee.Message
|
||||||
}
|
}
|
||||||
if ee.Caller != "" {
|
if ee.Caller != "" {
|
||||||
json["caller"] = ee.Caller
|
ginJson["caller"] = ee.Caller
|
||||||
}
|
}
|
||||||
if ee.Severity != SevErr {
|
if ee.Severity != SevErr {
|
||||||
json["severity"] = ee.Severity
|
ginJson["severity"] = ee.Severity
|
||||||
}
|
}
|
||||||
if ee.Timestamp != (time.Time{}) {
|
if ee.Timestamp != (time.Time{}) {
|
||||||
json["time"] = ee.Timestamp.Format(time.RFC3339)
|
ginJson["time"] = ee.Timestamp.Format(time.RFC3339)
|
||||||
}
|
}
|
||||||
if ee.WrappedErrType != "" {
|
if ee.WrappedErrType != "" {
|
||||||
json["wrappedErrType"] = ee.WrappedErrType
|
ginJson["wrappedErrType"] = ee.WrappedErrType
|
||||||
}
|
}
|
||||||
if ee.OriginalError != nil {
|
if ee.OriginalError != nil {
|
||||||
json["original"] = ee.OriginalError.toJson()
|
ginJson["original"] = ee.OriginalError.toJson(depth + 1)
|
||||||
}
|
}
|
||||||
|
|
||||||
pkgconfig.ExtendGinDataOutput(json)
|
pkgconfig.ExtendGinDataOutput(ee, depth, ginJson)
|
||||||
|
|
||||||
return json
|
return ginJson
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ee *ExErr) Output(g *gin.Context) {
|
func (ee *ExErr) Output(g *gin.Context) {
|
||||||
@@ -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,16 +70,16 @@ 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 {
|
||||||
ginOutput["__data"] = ee.toJson()
|
ginOutput["__data"] = ee.toJson(0)
|
||||||
}
|
}
|
||||||
|
|
||||||
pkgconfig.ExtendGinOutput(ginOutput)
|
pkgconfig.ExtendGinOutput(ee, ginOutput)
|
||||||
|
|
||||||
g.Render(statuscode, json.GoJsonRender{Data: ginOutput, NilSafeSlices: true, NilSafeMaps: true})
|
g.Render(statuscode, json.GoJsonRender{Data: ginOutput, NilSafeSlices: true, NilSafeMaps: true})
|
||||||
}
|
}
|
||||||
|
@@ -50,10 +50,3 @@ func (ac *AppContext) RequestURI() string {
|
|||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ac *AppContext) FinishSuccess(res HTTPResponse) HTTPResponse {
|
|
||||||
if ac.cancelled {
|
|
||||||
panic("Cannot finish a cancelled request")
|
|
||||||
}
|
|
||||||
return res
|
|
||||||
}
|
|
||||||
|
@@ -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.Method,
|
||||||
|
}
|
||||||
|
|
||||||
|
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]),
|
||||||
|
langext.StrPadRight(line[1], " ", pad[1]),
|
||||||
|
langext.StrPadRight(line[2], " ", pad[2]),
|
||||||
|
langext.StrPadRight(line[3], " ", pad[3]))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
@@ -2,8 +2,10 @@ package ginext
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"fmt"
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
"github.com/gin-gonic/gin/binding"
|
"github.com/gin-gonic/gin/binding"
|
||||||
|
"gogs.mikescher.com/BlackForestBytes/goext/exerr"
|
||||||
"gogs.mikescher.com/BlackForestBytes/goext/langext"
|
"gogs.mikescher.com/BlackForestBytes/goext/langext"
|
||||||
"runtime/debug"
|
"runtime/debug"
|
||||||
)
|
)
|
||||||
@@ -15,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 {
|
||||||
@@ -37,36 +40,73 @@ 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 {
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailURI, "Failed to read uri", err))
|
err = exerr.Wrap(err, "Failed to read uri").
|
||||||
|
WithType(exerr.TypeBindFailURI).
|
||||||
|
Str("struct_type", fmt.Sprintf("%T", pctx.uri)).
|
||||||
|
Build()
|
||||||
|
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if pctx.query != nil {
|
if pctx.query != nil {
|
||||||
if err := pctx.ginCtx.ShouldBindQuery(pctx.query); err != nil {
|
if err := pctx.ginCtx.ShouldBindQuery(pctx.query); err != nil {
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailQuery, "Failed to read query", err))
|
err = exerr.Wrap(err, "Failed to read query").
|
||||||
|
WithType(exerr.TypeBindFailQuery).
|
||||||
|
Str("struct_type", fmt.Sprintf("%T", pctx.query)).
|
||||||
|
Build()
|
||||||
|
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if pctx.body != nil {
|
if pctx.body != nil {
|
||||||
if pctx.ginCtx.ContentType() == "application/json" {
|
if pctx.ginCtx.ContentType() == "application/json" {
|
||||||
if err := pctx.ginCtx.ShouldBindJSON(pctx.body); err != nil {
|
if err := pctx.ginCtx.ShouldBindJSON(pctx.body); err != nil {
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailJSON, "Failed to read body", err))
|
err = exerr.Wrap(err, "Failed to read json-body").
|
||||||
|
WithType(exerr.TypeBindFailJSON).
|
||||||
|
Str("struct_type", fmt.Sprintf("%T", pctx.body)).
|
||||||
|
Build()
|
||||||
|
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailJSON, "missing JSON body", nil))
|
err := exerr.New(exerr.TypeBindFailJSON, "missing JSON body").
|
||||||
|
Str("struct_type", fmt.Sprintf("%T", pctx.body)).
|
||||||
|
Build()
|
||||||
|
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if pctx.form != nil {
|
if pctx.form != nil {
|
||||||
if pctx.ginCtx.ContentType() == "multipart/form-data" {
|
if pctx.ginCtx.ContentType() == "multipart/form-data" {
|
||||||
if err := pctx.ginCtx.ShouldBindWith(pctx.form, binding.Form); err != nil {
|
if err := pctx.ginCtx.ShouldBindWith(pctx.form, binding.Form); err != nil {
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailFormData, "Failed to read multipart-form", err))
|
err = exerr.Wrap(err, "Failed to read multipart-form").
|
||||||
|
WithType(exerr.TypeBindFailFormData).
|
||||||
|
Str("struct_type", fmt.Sprintf("%T", pctx.form)).
|
||||||
|
Build()
|
||||||
|
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, err))
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailJSON, "missing form body", nil))
|
err := exerr.New(exerr.TypeBindFailFormData, "missing form body").
|
||||||
|
Str("struct_type", fmt.Sprintf("%T", pctx.form)).
|
||||||
|
Build()
|
||||||
|
return nil, nil, langext.Ptr(APIError(pctx.ginCtx, 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(APIError(pctx.ginCtx, 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}
|
||||||
}
|
}
|
||||||
|
@@ -2,7 +2,11 @@ package ginext
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
|
"gogs.mikescher.com/BlackForestBytes/goext/langext"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"reflect"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
var anyMethods = []string{
|
var anyMethods = []string{
|
||||||
@@ -12,14 +16,15 @@ var anyMethods = []string{
|
|||||||
}
|
}
|
||||||
|
|
||||||
type GinRoutesWrapper struct {
|
type GinRoutesWrapper struct {
|
||||||
wrapper *GinWrapper
|
wrapper *GinWrapper
|
||||||
routes gin.IRouter
|
routes gin.IRouter
|
||||||
|
defaultHandler []gin.HandlerFunc
|
||||||
}
|
}
|
||||||
|
|
||||||
type GinRouteBuilder struct {
|
type GinRouteBuilder struct {
|
||||||
routes *GinRoutesWrapper
|
routes *GinRoutesWrapper
|
||||||
|
|
||||||
methods []string
|
method string
|
||||||
relPath string
|
relPath string
|
||||||
handlers []gin.HandlerFunc
|
handlers []gin.HandlerFunc
|
||||||
}
|
}
|
||||||
@@ -29,43 +34,49 @@ func (w *GinWrapper) Routes() *GinRoutesWrapper {
|
|||||||
}
|
}
|
||||||
|
|
||||||
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)}
|
||||||
|
}
|
||||||
|
|
||||||
|
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 &GinRouteBuilder{routes: w, method: http.MethodGet, relPath: relativePath, handlers: langext.ArrCopy(w.defaultHandler)}
|
||||||
}
|
}
|
||||||
|
|
||||||
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 &GinRouteBuilder{routes: w, method: http.MethodPost, relPath: relativePath, handlers: langext.ArrCopy(w.defaultHandler)}
|
||||||
}
|
}
|
||||||
|
|
||||||
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 &GinRouteBuilder{routes: w, method: http.MethodDelete, relPath: relativePath, handlers: langext.ArrCopy(w.defaultHandler)}
|
||||||
}
|
}
|
||||||
|
|
||||||
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 &GinRouteBuilder{routes: w, method: http.MethodPatch, relPath: relativePath, handlers: langext.ArrCopy(w.defaultHandler)}
|
||||||
}
|
}
|
||||||
|
|
||||||
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 &GinRouteBuilder{routes: w, method: http.MethodPut, relPath: relativePath, handlers: langext.ArrCopy(w.defaultHandler)}
|
||||||
}
|
}
|
||||||
|
|
||||||
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 &GinRouteBuilder{routes: w, method: http.MethodOptions, relPath: relativePath, handlers: langext.ArrCopy(w.defaultHandler)}
|
||||||
}
|
}
|
||||||
|
|
||||||
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 &GinRouteBuilder{routes: w, method: http.MethodHead, relPath: relativePath, handlers: langext.ArrCopy(w.defaultHandler)}
|
||||||
}
|
}
|
||||||
|
|
||||||
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 &GinRouteBuilder{routes: w, method: "COUNT", relPath: relativePath, handlers: langext.ArrCopy(w.defaultHandler)}
|
||||||
}
|
}
|
||||||
|
|
||||||
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 &GinRouteBuilder{routes: w, method: "*", relPath: relativePath, handlers: langext.ArrCopy(w.defaultHandler)}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (w *GinRouteBuilder) Use(middleware ...gin.HandlerFunc) *GinRouteBuilder {
|
func (w *GinRouteBuilder) Use(middleware ...gin.HandlerFunc) *GinRouteBuilder {
|
||||||
@@ -74,12 +85,50 @@ 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.relPath,
|
||||||
|
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 {
|
||||||
|
|
||||||
|
n := runtime.FuncForPC(reflect.ValueOf(f).Pointer()).Name()
|
||||||
|
|
||||||
|
split := strings.Split(n, "/")
|
||||||
|
if len(split) == 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
return split[len(split)-1]
|
||||||
}
|
}
|
||||||
|
@@ -1,5 +1,5 @@
|
|||||||
package goext
|
package goext
|
||||||
|
|
||||||
const GoextVersion = "0.0.191"
|
const GoextVersion = "0.0.203"
|
||||||
|
|
||||||
const GoextVersionTimestamp = "2023-07-24T11:18:25+0200"
|
const GoextVersionTimestamp = "2023-07-24T18:38:04+0200"
|
||||||
|
Reference in New Issue
Block a user