From 6a2e1c074e6f95c38a274bd78afa4684fcfd3a6c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?=
 <bjorn.erik.pedersen@gmail.com>
Date: Mon, 6 Nov 2023 09:56:47 +0100
Subject: [PATCH] Add logg.ErrStopLogEntry

As a way to stop a log entry from being passed on in the log handler chain
---
 handlers/multi/multi_test.go | 23 +++++++++++++++++++++++
 logger.go                    |  8 +++++++-
 2 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/handlers/multi/multi_test.go b/handlers/multi/multi_test.go
index e358c4e..0bd587a 100644
--- a/handlers/multi/multi_test.go
+++ b/handlers/multi/multi_test.go
@@ -51,3 +51,26 @@ func TestMultiModifyEntry(t *testing.T) {
 	qt.Assert(t, b.Entries[0].Fields[0].Name, qt.Equals, "initial")
 	qt.Assert(t, b.Entries[0].Fields[1].Name, qt.Equals, "added")
 }
+
+func TestStopEntry(t *testing.T) {
+	var a logg.HandlerFunc = func(e *logg.Entry) error {
+		if e.Fields[0].Value == "v2" {
+			return logg.ErrStopLogEntry
+		}
+		return nil
+	}
+
+	b := memory.New()
+
+	l := logg.New(
+		logg.Options{
+			Level:   logg.LevelInfo,
+			Handler: multi.New(a, b),
+		})
+
+	l.WithLevel(logg.LevelInfo).WithField("v", "v1").Log(logg.String("text"))
+	l.WithLevel(logg.LevelInfo).WithField("v", "v2").Log(logg.String("text"))
+	l.WithLevel(logg.LevelInfo).WithField("v", "v3").Log(logg.String("text"))
+
+	qt.Assert(t, b.Entries, qt.HasLen, 2)
+}
diff --git a/logger.go b/logger.go
index 710521d..7cee32c 100644
--- a/logger.go
+++ b/logger.go
@@ -137,6 +137,10 @@ func (l *logger) WithError(err error) *Entry {
 	return NewEntry(l).WithError(err)
 }
 
+// ErrStopLogEntry is a sentinel error that can be returned from a
+// handler to stop the entry from being passed to the next handler.
+var ErrStopLogEntry = fmt.Errorf("stop log entry")
+
 // log the message, invoking the handler.
 func (l *logger) log(e *Entry, s fmt.Stringer) {
 	if e.Level < l.Level {
@@ -148,6 +152,8 @@ func (l *logger) log(e *Entry, s fmt.Stringer) {
 	e.finalize(finalized, s.String())
 
 	if err := l.Handler.HandleLog(finalized); err != nil {
-		stdlog.Printf("error logging: %s", err)
+		if err != ErrStopLogEntry {
+			stdlog.Printf("error logging: %s", err)
+		}
 	}
 }