feat: recover log error func

Log error functions for printing panic errors with Logrus, ZeroLog,
ZapLog or CharmLog.

Author: faabiosr

charm.go

@@ -93,3 +93,17 @@ func CharmLogWithConfig(cfg CharmLogConfig) echo.MiddlewareFunc {
 		}
 	}
 }
+
+// CharmLogRecoverFn returns a CharmLog recover log function to print panic
+// errors.
+func CharmLogRecoverFn(logger *charm.Logger) mw.LogErrorFunc {
+	return func(ec echo.Context, err error, stack []byte) error {
+		logger.Error(
+			"panic recover",
+			"stacktrace", string(stack),
+			"error", err,
+		)
+
+		return err
+	}
+}

charm_test.go

@@ -13,6 +13,7 @@ import (
 
 	charm "github.com/charmbracelet/log"
 	"github.com/labstack/echo/v4"
+	emw "github.com/labstack/echo/v4/middleware"
 )
 
 func TestCharmLogWithConfig(t *testing.T) {
@@ -103,3 +104,31 @@ func TestCharmLogRetrievesAnError(t *testing.T) {
 		t.Errorf("invalid log: error not found")
 	}
 }
+
+func TestCharmLogRecoverFn(t *testing.T) {
+	ec := panicCtx(t)
+	b := new(bytes.Buffer)
+
+	logger := charm.New(b)
+
+	rec := emw.RecoverWithConfig(emw.RecoverConfig{
+		LogErrorFunc: CharmLogRecoverFn(logger),
+	})
+
+	config := CharmLogConfig{
+		Logger:   logger,
+		FieldMap: testFields,
+	}
+
+	_ = CharmLogWithConfig(config)(rec(testHandler))(ec)
+
+	res := b.String()
+
+	if !strings.Contains(res, "status=500") {
+		t.Errorf("invalid log: wrong status code")
+	}
+
+	if !strings.Contains(res, `error="unable to call"`) {
+		t.Errorf("invalid log: error not found")
+	}
+}

examples_test.go

@@ -10,6 +10,7 @@ import (
 
 	charm "github.com/charmbracelet/log"
 	"github.com/labstack/echo/v4"
+	emw "github.com/labstack/echo/v4/middleware"
 	"github.com/rs/zerolog"
 	"github.com/sirupsen/logrus"
 	"go.opencensus.io/stats/view"
@@ -47,6 +48,20 @@ func ExampleZeroLogWithConfig() {
 	e.Use(middleware.ZeroLogWithConfig(logConfig))
 }
 
+// This example register the ZeroLog log error function to echo middleware
+// Recover.
+func ExampleZeroLogRecoverFn() {
+	e := echo.New()
+
+	// Custom zerolog logger instance
+	logger := zerolog.New(os.Stderr).With().Timestamp().Logger()
+
+	// Middleware
+	e.Use(emw.RecoverWithConfig(emw.RecoverConfig{
+		LogErrorFunc: middleware.ZeroLogRecoverFn(logger),
+	}))
+}
+
 // This example registers the Logrus middleware with default configuration.
 func ExampleLogrus() {
 	e := echo.New()
@@ -76,6 +91,20 @@ func ExampleLogrusWithConfig() {
 	e.Use(middleware.LogrusWithConfig(logConfig))
 }
 
+// This example register the Logrus log error function to echo middleware
+// Recover.
+func ExampleLogrusRecoverFn() {
+	e := echo.New()
+
+	// Custom logrus logger instance
+	logger := logrus.New()
+
+	// Middleware
+	e.Use(emw.RecoverWithConfig(emw.RecoverConfig{
+		LogErrorFunc: middleware.LogrusRecoverFn(logger),
+	}))
+}
+
 // This example registers the OpenCensus middleware with default configuration.
 func ExampleOpenCensus() {
 	e := echo.New()
@@ -127,6 +156,20 @@ func ExampleZapLogWithConfig() {
 	e.Use(middleware.ZapLogWithConfig(logConfig))
 }
 
+// This example register the ZapLog log error function to echo middleware
+// Recover.
+func ExampleZapLogRecoverFn() {
+	e := echo.New()
+
+	// Custom ZapLog logger instance
+	logger, _ := zap.NewProduction()
+
+	// Middleware
+	e.Use(emw.RecoverWithConfig(emw.RecoverConfig{
+		LogErrorFunc: middleware.ZapLogRecoverFn(logger),
+	}))
+}
+
 // This example registers the CharmBracelet Log middleware with default configuration.
 func ExampleCharmLog() {
 	e := echo.New()
@@ -153,6 +196,17 @@ func ExampleCharmLogWithConfig() {
 	e.Use(middleware.CharmLogWithConfig(logConfig))
 }
 
+// This example register the CharmLog log error function to echo middleware
+// Recover.
+func ExampleCharmLogRecoverFn() {
+	e := echo.New()
+
+	// Middleware
+	e.Use(emw.RecoverWithConfig(emw.RecoverConfig{
+		LogErrorFunc: middleware.CharmLogRecoverFn(charm.Default()),
+	}))
+}
+
 // This example registers the RequestID middleware with default configuration.
 func ExampleRequestID() {
 	e := echo.New()

log_test.go

@@ -46,6 +46,10 @@ func testHandler(ec echo.Context) error {
 		return errors.New("error")
 	}
 
+	if v := ec.QueryParam("panic"); v != "" {
+		panic("unable to call")
+	}
+
 	return ec.String(http.StatusOK, "test")
 }
 
@@ -100,3 +104,7 @@ func postCtx(t *testing.T) echo.Context {
 
 	return ec
 }
+
+func panicCtx(t *testing.T) echo.Context {
+	return testCtx(t, "/some?panic=1")
+}

logrus.go

@@ -87,3 +87,14 @@ func LogrusWithConfig(cfg LogrusConfig) echo.MiddlewareFunc {
 		}
 	}
 }
+
+// LogrusRecoverFn returns a Logrus recover log function to print panic errors.
+func LogrusRecoverFn(logger *logrus.Logger) mw.LogErrorFunc {
+	return func(ec echo.Context, err error, stack []byte) error {
+		logger.WithField("stacktrace", string(stack)).
+			WithError(err).
+			Error("panic recover")
+
+		return err
+	}
+}

logrus_test.go

@@ -11,6 +11,7 @@ import (
 	"testing"
 
 	"github.com/labstack/echo/v4"
+	emw "github.com/labstack/echo/v4/middleware"
 	"github.com/sirupsen/logrus"
 )
 
@@ -105,3 +106,31 @@ func TestLogrusRetrievesAnError(t *testing.T) {
 		t.Errorf("invalid log: error not found")
 	}
 }
+
+func TestLogrusRecoverFn(t *testing.T) {
+	ec := panicCtx(t)
+	b := new(bytes.Buffer)
+
+	logger := logrus.StandardLogger()
+	logger.Out = b
+
+	rec := emw.RecoverWithConfig(emw.RecoverConfig{
+		LogErrorFunc: LogrusRecoverFn(logger),
+	})
+
+	config := LogrusConfig{
+		Logger: logger,
+	}
+
+	_ = LogrusWithConfig(config)(rec(testHandler))(ec)
+
+	res := b.String()
+
+	if !strings.Contains(res, "status=500") {
+		t.Errorf("invalid log: wrong status code")
+	}
+
+	if !strings.Contains(res, `error="unable to call"`) {
+		t.Errorf("invalid log: error not found")
+	}
+}

zap.go

@@ -97,3 +97,15 @@ func ZapLogWithConfig(cfg ZapLogConfig) echo.MiddlewareFunc {
 		}
 	}
 }
+
+// ZapLogRecoverFn returns a ZapLog recover log function to print panic errors.
+func ZapLogRecoverFn(logger *zap.Logger) mw.LogErrorFunc {
+	return func(ec echo.Context, err error, stack []byte) error {
+		logger.With(
+			zap.ByteString("stacktrace", stack),
+			zap.Error(err),
+		).Error("panic recover")
+
+		return err
+	}
+}

zap_test.go

@@ -11,6 +11,7 @@ import (
 	"testing"
 
 	"github.com/labstack/echo/v4"
+	emw "github.com/labstack/echo/v4/middleware"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zaptest/observer"
 )
@@ -105,3 +106,33 @@ func TestZapLogRetrievesAnError(t *testing.T) {
 		t.Errorf("invalid log: error not found")
 	}
 }
+
+func TestZapLogRecoverFn(t *testing.T) {
+	ec := panicCtx(t)
+	obsLog, logs := observer.New(zap.InfoLevel)
+	logger := zap.New(obsLog)
+
+	rec := emw.RecoverWithConfig(emw.RecoverConfig{
+		LogErrorFunc: ZapLogRecoverFn(logger),
+	})
+
+	config := ZapLogConfig{
+		Logger: logger,
+	}
+
+	_ = ZapLogWithConfig(config)(rec(testHandler))(ec)
+
+	entry := logs.All()[0]
+	ectx := entry.ContextMap()
+
+	if _, ok := ectx["error"]; !ok {
+		t.Errorf("invalid log: error not found")
+	}
+
+	entry = logs.All()[1]
+	ectx = entry.ContextMap()
+
+	if ectx["status"] != int64(http.StatusInternalServerError) {
+		t.Errorf("invalid log: wrong status code")
+	}
+}

zerolog.go

@@ -87,3 +87,18 @@ func ZeroLogWithConfig(cfg ZeroLogConfig) echo.MiddlewareFunc {
 		}
 	}
 }
+
+// ZeroLogRecoverFn returns a ZeroLog recover log function to print panic
+// errors.
+func ZeroLogRecoverFn(logger zerolog.Logger) mw.LogErrorFunc {
+	return func(ec echo.Context, err error, stack []byte) error {
+		logger.Error().
+			Err(err).
+			Fields(map[string]interface{}{
+				"stacktrace": stack,
+			}).
+			Msg("panic recover")
+
+		return err
+	}
+}

zerolog_test.go

@@ -11,6 +11,7 @@ import (
 	"testing"
 
 	"github.com/labstack/echo/v4"
+	emw "github.com/labstack/echo/v4/middleware"
 	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 )
@@ -102,3 +103,29 @@ func TestZeroLogRetrievesAnError(t *testing.T) {
 		t.Errorf("invalid log: error not found")
 	}
 }
+
+func TestZeroLogRecoverFn(t *testing.T) {
+	ec := panicCtx(t)
+	b := new(bytes.Buffer)
+	logger := log.Output(zerolog.ConsoleWriter{Out: b, NoColor: true})
+
+	rec := emw.RecoverWithConfig(emw.RecoverConfig{
+		LogErrorFunc: ZeroLogRecoverFn(logger),
+	})
+
+	config := ZeroLogConfig{
+		Logger: logger,
+	}
+
+	_ = ZeroLogWithConfig(config)(rec(testHandler))(ec)
+
+	res := b.String()
+
+	if !strings.Contains(res, "status=500") {
+		t.Errorf("invalid log: wrong status code")
+	}
+
+	if !strings.Contains(res, `error="unable to call"`) {
+		t.Errorf("invalid log: error not found")
+	}
+}