mirror of
https://github.com/labstack/echo.git
synced 2025-01-07 23:01:56 +02:00
6ef5f77bf2
WIP: make default logger implemented custom writer for jsonlike logs WIP: improve examples WIP: defaultErrorHandler use errors.As to unwrap errors. Update readme WIP: default logger logs json, restore e.Start method WIP: clean router.Match a bit WIP: func types/fields have echo.Context has first element WIP: remove yaml tags as functions etc can not be serialized anyway WIP: change BindPathParams,BindQueryParams,BindHeaders from methods to functions and reverse arguments to be like DefaultBinder.Bind is WIP: improved comments, logger now extracts status from error WIP: go mod tidy WIP: rebase with 4.5.0 WIP: * removed todos. * removed StartAutoTLS and StartH2CServer methods from `StartConfig` * KeyAuth middleware errorhandler can swallow the error and resume next middleware WIP: add RouterConfig.UseEscapedPathForMatching to use escaped path for matching request against routes WIP: FIXMEs WIP: upgrade golang-jwt/jwt to `v4` WIP: refactor http methods to return RouteInfo WIP: refactor static not creating multiple routes WIP: refactor route and middleware adding functions not to return error directly WIP: Use 401 for problematic/missing headers for key auth and JWT middleware (#1552, #1402). > In summary, a 401 Unauthorized response should be used for missing or bad authentication WIP: replace `HTTPError.SetInternal` with `HTTPError.WithInternal` so we could not mutate global error variables WIP: add RouteInfo and RouteMatchType into Context what we could know from in middleware what route was matched and/or type of that match (200/404/405) WIP: make notFoundHandler and methodNotAllowedHandler private. encourage that all errors be handled in Echo.HTTPErrorHandler WIP: server cleanup ideas WIP: routable.ForGroup WIP: note about logger middleware WIP: bind should not default values on second try. use crypto rand for better randomness WIP: router add route as interface and returns info as interface WIP: improve flaky test (remains still flaky) WIP: add notes about bind default values WIP: every route can have their own path params names WIP: routerCreator and different tests WIP: different things WIP: remove route implementation WIP: support custom method types WIP: extractor tests WIP: v5.0.x proposal over v4.4.0
100 lines
2.4 KiB
Go
100 lines
2.4 KiB
Go
package middleware
|
|
|
|
import (
|
|
"bufio"
|
|
"bytes"
|
|
"errors"
|
|
"io"
|
|
"io/ioutil"
|
|
"net"
|
|
"net/http"
|
|
|
|
"github.com/labstack/echo/v4"
|
|
)
|
|
|
|
// BodyDumpConfig defines the config for BodyDump middleware.
|
|
type BodyDumpConfig struct {
|
|
// Skipper defines a function to skip middleware.
|
|
Skipper Skipper
|
|
|
|
// Handler receives request and response payload.
|
|
// Required.
|
|
Handler BodyDumpHandler
|
|
}
|
|
|
|
// BodyDumpHandler receives the request and response payload.
|
|
type BodyDumpHandler func(c echo.Context, reqBody []byte, resBody []byte)
|
|
|
|
type bodyDumpResponseWriter struct {
|
|
io.Writer
|
|
http.ResponseWriter
|
|
}
|
|
|
|
// BodyDump returns a BodyDump middleware.
|
|
//
|
|
// BodyDump middleware captures the request and response payload and calls the
|
|
// registered handler.
|
|
func BodyDump(handler BodyDumpHandler) echo.MiddlewareFunc {
|
|
return BodyDumpWithConfig(BodyDumpConfig{Handler: handler})
|
|
}
|
|
|
|
// BodyDumpWithConfig returns a BodyDump middleware with config.
|
|
// See: `BodyDump()`.
|
|
func BodyDumpWithConfig(config BodyDumpConfig) echo.MiddlewareFunc {
|
|
return toMiddlewareOrPanic(config)
|
|
}
|
|
|
|
// ToMiddleware converts BodyDumpConfig to middleware or returns an error for invalid configuration
|
|
func (config BodyDumpConfig) ToMiddleware() (echo.MiddlewareFunc, error) {
|
|
if config.Handler == nil {
|
|
return nil, errors.New("echo body-dump middleware requires a handler function")
|
|
}
|
|
if config.Skipper == nil {
|
|
config.Skipper = DefaultSkipper
|
|
}
|
|
|
|
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
|
return func(c echo.Context) error {
|
|
if config.Skipper(c) {
|
|
return next(c)
|
|
}
|
|
|
|
// Request
|
|
reqBody := []byte{}
|
|
if c.Request().Body != nil {
|
|
reqBody, _ = ioutil.ReadAll(c.Request().Body)
|
|
}
|
|
c.Request().Body = ioutil.NopCloser(bytes.NewBuffer(reqBody)) // Reset
|
|
|
|
// Response
|
|
resBody := new(bytes.Buffer)
|
|
mw := io.MultiWriter(c.Response().Writer, resBody)
|
|
writer := &bodyDumpResponseWriter{Writer: mw, ResponseWriter: c.Response().Writer}
|
|
c.Response().Writer = writer
|
|
|
|
err := next(c)
|
|
|
|
// Callback
|
|
config.Handler(c, reqBody, resBody.Bytes())
|
|
|
|
return err
|
|
}
|
|
}, nil
|
|
}
|
|
|
|
func (w *bodyDumpResponseWriter) WriteHeader(code int) {
|
|
w.ResponseWriter.WriteHeader(code)
|
|
}
|
|
|
|
func (w *bodyDumpResponseWriter) Write(b []byte) (int, error) {
|
|
return w.Writer.Write(b)
|
|
}
|
|
|
|
func (w *bodyDumpResponseWriter) Flush() {
|
|
w.ResponseWriter.(http.Flusher).Flush()
|
|
}
|
|
|
|
func (w *bodyDumpResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) {
|
|
return w.ResponseWriter.(http.Hijacker).Hijack()
|
|
}
|