2024-05-14 13:07:09 +00:00
|
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
// SPDX-FileCopyrightText: © 2015 LabStack LLC and Echo contributors
|
|
|
|
|
2024-02-18 10:42:21 +00:00
|
|
|
package middleware
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bufio"
|
|
|
|
"bytes"
|
2024-05-14 13:07:09 +00:00
|
|
|
"errors"
|
2024-02-18 10:42:21 +00:00
|
|
|
"io"
|
|
|
|
"net"
|
|
|
|
"net/http"
|
|
|
|
|
|
|
|
"github.com/labstack/echo/v4"
|
|
|
|
)
|
|
|
|
|
2024-05-14 13:07:09 +00:00
|
|
|
// BodyDumpConfig defines the config for BodyDump middleware.
|
|
|
|
type BodyDumpConfig struct {
|
|
|
|
// Skipper defines a function to skip middleware.
|
|
|
|
Skipper Skipper
|
2024-02-18 10:42:21 +00:00
|
|
|
|
2024-05-14 13:07:09 +00:00
|
|
|
// Handler receives request and response payload.
|
|
|
|
// Required.
|
|
|
|
Handler BodyDumpHandler
|
|
|
|
}
|
2024-02-18 10:42:21 +00:00
|
|
|
|
2024-05-14 13:07:09 +00:00
|
|
|
// BodyDumpHandler receives the request and response payload.
|
|
|
|
type BodyDumpHandler func(echo.Context, []byte, []byte)
|
2024-02-18 10:42:21 +00:00
|
|
|
|
2024-05-14 13:07:09 +00:00
|
|
|
type bodyDumpResponseWriter struct {
|
|
|
|
io.Writer
|
|
|
|
http.ResponseWriter
|
|
|
|
}
|
2024-02-18 10:42:21 +00:00
|
|
|
|
2024-05-14 13:07:09 +00:00
|
|
|
// DefaultBodyDumpConfig is the default BodyDump middleware config.
|
|
|
|
var DefaultBodyDumpConfig = BodyDumpConfig{
|
|
|
|
Skipper: DefaultSkipper,
|
|
|
|
}
|
2024-02-18 10:42:21 +00:00
|
|
|
|
|
|
|
// BodyDump returns a BodyDump middleware.
|
|
|
|
//
|
|
|
|
// BodyDump middleware captures the request and response payload and calls the
|
|
|
|
// registered handler.
|
|
|
|
func BodyDump(handler BodyDumpHandler) echo.MiddlewareFunc {
|
|
|
|
c := DefaultBodyDumpConfig
|
|
|
|
c.Handler = handler
|
|
|
|
return BodyDumpWithConfig(c)
|
|
|
|
}
|
|
|
|
|
|
|
|
// BodyDumpWithConfig returns a BodyDump middleware with config.
|
|
|
|
// See: `BodyDump()`.
|
|
|
|
func BodyDumpWithConfig(config BodyDumpConfig) echo.MiddlewareFunc {
|
|
|
|
// Defaults
|
|
|
|
if config.Handler == nil {
|
|
|
|
panic("echo: body-dump middleware requires a handler function")
|
|
|
|
}
|
|
|
|
if config.Skipper == nil {
|
|
|
|
config.Skipper = DefaultBodyDumpConfig.Skipper
|
|
|
|
}
|
|
|
|
|
|
|
|
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
|
|
|
return func(c echo.Context) (err error) {
|
|
|
|
if config.Skipper(c) {
|
|
|
|
return next(c)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Request
|
|
|
|
reqBody := []byte{}
|
|
|
|
if c.Request().Body != nil { // Read
|
|
|
|
reqBody, _ = io.ReadAll(c.Request().Body)
|
|
|
|
}
|
|
|
|
c.Request().Body = io.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
|
|
|
|
|
|
|
|
if err = next(c); err != nil {
|
|
|
|
c.Error(err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Callback
|
|
|
|
config.Handler(c, reqBody, resBody.Bytes())
|
|
|
|
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
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() {
|
2024-05-14 13:07:09 +00:00
|
|
|
err := responseControllerFlush(w.ResponseWriter)
|
|
|
|
if err != nil && errors.Is(err, http.ErrNotSupported) {
|
|
|
|
panic(errors.New("response writer flushing is not supported"))
|
|
|
|
}
|
2024-02-18 10:42:21 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (w *bodyDumpResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) {
|
2024-05-14 13:07:09 +00:00
|
|
|
return responseControllerHijack(w.ResponseWriter)
|
|
|
|
}
|
|
|
|
|
|
|
|
func (w *bodyDumpResponseWriter) Unwrap() http.ResponseWriter {
|
|
|
|
return w.ResponseWriter
|
2024-02-18 10:42:21 +00:00
|
|
|
}
|