slog: factoring out code to make the examples playable and remove unu…

…sed test method
golang · Sep 4, 2024 · a9dfb77 · a9dfb77
1 parent 1b5ae45
commit a9dfb77
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 18 deletions.
diff --git a/src/log/slog/example_level_handler_test.go b/src/log/slog/example_level_handler_test.go
@@ -7,7 +7,6 @@ package slog_test
 import (
 	"context"
 	"log/slog"
-	"log/slog/internal/slogtest"
 	"os"
 )
 
@@ -63,7 +62,13 @@ func (h *LevelHandler) Handler() slog.Handler {
 // Another typical use would be to decrease the log level (to LevelDebug, say)
 // during a part of the program that was suspected of containing a bug.
 func ExampleHandler_levelHandler() {
-	th := slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ReplaceAttr: slogtest.RemoveTime})
+	removeTime := func(groups []string, a slog.Attr) slog.Attr {
+		if a.Key == slog.TimeKey && len(groups) == 0 {
+			return slog.Attr{}
+		}
+		return a
+	}
+	th := slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ReplaceAttr: removeTime})
 	logger := slog.New(NewLevelHandler(slog.LevelWarn, th))
 	logger.Info("not printed")
 	logger.Warn("printed")

diff --git a/src/log/slog/example_log_level_test.go b/src/log/slog/example_log_level_test.go
@@ -7,7 +7,6 @@ package slog_test
 import (
 	"log"
 	"log/slog"
-	"log/slog/internal/slogtest"
 	"os"
 )
 
@@ -49,7 +48,13 @@ func ExampleSetLogLoggerLevel_slog() {
 	defer slog.SetLogLoggerLevel(currentLogLevel) // revert changes after the example
 
 	defer slog.SetDefault(slog.Default()) // revert changes after the example
-	slog.SetDefault(slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ReplaceAttr: slogtest.RemoveTime})))
+	removeTime := func(groups []string, a slog.Attr) slog.Attr {
+		if a.Key == slog.TimeKey && len(groups) == 0 {
+			return slog.Attr{}
+		}
+		return a
+	}
+	slog.SetDefault(slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ReplaceAttr: removeTime})))
 
 	log.Print("error") // level=ERROR msg=error
 

diff --git a/src/log/slog/example_logvaluer_secret_test.go b/src/log/slog/example_logvaluer_secret_test.go
@@ -6,7 +6,6 @@ package slog_test
 
 import (
 	"log/slog"
-	"log/slog/internal/slogtest"
 	"os"
 )
 
@@ -23,7 +22,13 @@ func (Token) LogValue() slog.Value {
 // with an alternative representation to avoid revealing secrets.
 func ExampleLogValuer_secret() {
 	t := Token("shhhh!")
-	logger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ReplaceAttr: slogtest.RemoveTime}))
+	removeTime := func(groups []string, a slog.Attr) slog.Attr {
+		if a.Key == slog.TimeKey && len(groups) == 0 {
+			return slog.Attr{}
+		}
+		return a
+	}
+	logger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{ReplaceAttr: removeTime}))
 	logger.Info("permission granted", "user", "Perry", "token", t)
 
 	// Output:

diff --git a/src/log/slog/internal/slogtest/slogtest.go b/src/log/slog/internal/slogtest/slogtest.go
@@ -4,15 +4,3 @@
 
 // Package slogtest contains support functions for testing slog.
 package slogtest
-
-import "log/slog"
-
-// RemoveTime removes the top-level time attribute.
-// It is intended to be used as a ReplaceAttr function,
-// to make example output deterministic.
-func RemoveTime(groups []string, a slog.Attr) slog.Attr {
-	if a.Key == slog.TimeKey && len(groups) == 0 {
-		return slog.Attr{}
-	}
-	return a
-}