Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
430bd76230 | ||
|
|
3dbe6954d7 |
@@ -1,34 +0,0 @@
|
||||
version: "2"
|
||||
|
||||
# Config schema uses the golangci-lint v2 layout (settings live under
|
||||
# linters.settings, not top-level linters-settings) so that the
|
||||
# thresholds below are actually applied by golangci-lint >= v2.
|
||||
|
||||
run:
|
||||
timeout: 5m
|
||||
modules-download-mode: readonly
|
||||
|
||||
linters:
|
||||
default: all
|
||||
disable:
|
||||
# Genuinely incompatible with project patterns
|
||||
- exhaustruct # Requires all struct fields
|
||||
- depguard # Dependency allow/block lists
|
||||
- godot # Requires comments to end with periods
|
||||
- wsl # Deprecated, replaced by wsl_v5
|
||||
- wrapcheck # Too verbose for internal packages
|
||||
- varnamelen # Short names like db, id are idiomatic Go
|
||||
settings:
|
||||
lll:
|
||||
line-length: 88
|
||||
funlen:
|
||||
lines: 80
|
||||
statements: 50
|
||||
cyclop:
|
||||
max-complexity: 15
|
||||
dupl:
|
||||
threshold: 100
|
||||
|
||||
issues:
|
||||
max-issues-per-linter: 0
|
||||
max-same-issues: 0
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
# Lint stage: format check + golangci-lint
|
||||
# golangci/golangci-lint:v2.12.2 (Debian-based), 2026-08-07
|
||||
FROM golangci/golangci-lint:v2.12.2@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240 AS lint
|
||||
# golangci-lint v1.64.8 (2025-02-18)
|
||||
FROM golangci/golangci-lint@sha256:2987913e27f4eca9c8a39129d2c7bc1e74fbcf77f181e01cea607be437aa5cb8 AS lint
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
|
||||
@@ -28,10 +28,6 @@ files it depends on: .golangci.yml, REPO_POLICIES.md, .editorconfig,
|
||||
JSON and webhook handlers now emit record attributes, accumulate
|
||||
WithAttrs without mutating the receiver, and honour WithGroup;
|
||||
slog.Group values nest and LogValuer values are resolved
|
||||
* 2026-08-07: added canonical `.golangci.yml` (v2 schema), pinned the
|
||||
`Dockerfile` lint stage to golangci-lint v2.12.2 (tag+digest), and
|
||||
fixed all findings the v1→v2 jump surfaced without changing any
|
||||
exported signatures or behavior
|
||||
* 2026-02-08: fixed JSONHandler deadlock from recursive log.Println,
|
||||
with regression test; tagged 1.0.1
|
||||
* 2024-06-14: 1.0 prep: lint and fmt enforced in Docker build, call
|
||||
|
||||
@@ -25,7 +25,6 @@ func (h handlerAttrs) withAttrs(attrs []slog.Attr) handlerAttrs {
|
||||
combined := make([]slog.Attr, 0, len(h.attrs)+len(qualified))
|
||||
combined = append(combined, h.attrs...)
|
||||
combined = append(combined, qualified...)
|
||||
|
||||
return handlerAttrs{attrs: combined, groups: h.groups}
|
||||
}
|
||||
|
||||
@@ -35,11 +34,9 @@ func (h handlerAttrs) withGroup(name string) handlerAttrs {
|
||||
if name == "" {
|
||||
return h
|
||||
}
|
||||
|
||||
groups := make([]string, 0, len(h.groups)+1)
|
||||
groups = append(groups, h.groups...)
|
||||
groups = append(groups, name)
|
||||
|
||||
return handlerAttrs{attrs: h.attrs, groups: groups}
|
||||
}
|
||||
|
||||
@@ -50,7 +47,6 @@ func (h handlerAttrs) forRecord(record slog.Record) []slog.Attr {
|
||||
all := make([]slog.Attr, 0, len(h.attrs)+len(own))
|
||||
all = append(all, h.attrs...)
|
||||
all = append(all, own...)
|
||||
|
||||
return all
|
||||
}
|
||||
|
||||
@@ -62,7 +58,6 @@ func qualifyAttrs(groups []string, attrs []slog.Attr) []slog.Attr {
|
||||
Value: slog.GroupValue(attrs...),
|
||||
}}
|
||||
}
|
||||
|
||||
return attrs
|
||||
}
|
||||
|
||||
@@ -73,10 +68,8 @@ func recordAttrs(record slog.Record) []slog.Attr {
|
||||
attrs := make([]slog.Attr, 0, record.NumAttrs())
|
||||
record.Attrs(func(attr slog.Attr) bool {
|
||||
attrs = append(attrs, attr)
|
||||
|
||||
return true
|
||||
})
|
||||
|
||||
return attrs
|
||||
}
|
||||
|
||||
@@ -103,7 +96,6 @@ func recordToMap(record slog.Record, attrs handlerAttrs) groupMap {
|
||||
fields["Level"] = record.Level
|
||||
fields["Message"] = record.Message
|
||||
fields["PC"] = record.PC
|
||||
|
||||
return fields
|
||||
}
|
||||
|
||||
@@ -115,7 +107,6 @@ func attrsToMap(attrs []slog.Attr) groupMap {
|
||||
for _, attr := range attrs {
|
||||
addAttrToMap(fields, attr)
|
||||
}
|
||||
|
||||
return fields
|
||||
}
|
||||
|
||||
@@ -144,14 +135,11 @@ func addAttrToMap(fields groupMap, attr slog.Attr) {
|
||||
nested = make(groupMap, len(group))
|
||||
fields[attr.Key] = nested
|
||||
}
|
||||
|
||||
target = nested
|
||||
}
|
||||
|
||||
for _, member := range group {
|
||||
addAttrToMap(target, member)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
@@ -185,12 +173,8 @@ func jsonValue(value slog.Value) any {
|
||||
return value.Duration().Nanoseconds()
|
||||
case slog.KindTime:
|
||||
return value.Time()
|
||||
case slog.KindAny, slog.KindGroup, slog.KindLogValuer:
|
||||
// Only KindAny arrives here in practice: addAttrToMap renders
|
||||
// groups itself and resolves every value first.
|
||||
return jsonAnyValue(value)
|
||||
default:
|
||||
// Anything a future Go release adds.
|
||||
// KindAny, and anything a future Go release adds.
|
||||
return jsonAnyValue(value)
|
||||
}
|
||||
}
|
||||
@@ -202,12 +186,9 @@ func jsonAnyValue(value slog.Value) any {
|
||||
return err.Error()
|
||||
}
|
||||
}
|
||||
|
||||
_, err := json.Marshal(held)
|
||||
if err != nil {
|
||||
if _, err := json.Marshal(held); err != nil {
|
||||
return value.String()
|
||||
}
|
||||
|
||||
return held
|
||||
}
|
||||
|
||||
@@ -223,7 +204,6 @@ func attrsToText(attrs []slog.Attr) string {
|
||||
for _, attr := range attrs {
|
||||
appendAttrText(&out, "", attr)
|
||||
}
|
||||
|
||||
return out.String()
|
||||
}
|
||||
|
||||
@@ -238,16 +218,13 @@ func appendAttrText(out *strings.Builder, prefix string, attr slog.Attr) {
|
||||
if len(group) == 0 {
|
||||
return
|
||||
}
|
||||
|
||||
nested := prefix
|
||||
if attr.Key != "" {
|
||||
nested = prefix + attr.Key + "."
|
||||
}
|
||||
|
||||
for _, member := range group {
|
||||
appendAttrText(out, nested, member)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
@@ -268,13 +245,11 @@ func quoteIfNeeded(text string) string {
|
||||
if text == "" {
|
||||
return `""`
|
||||
}
|
||||
|
||||
for _, r := range text {
|
||||
if unicode.IsSpace(r) || !unicode.IsPrint(r) ||
|
||||
r == '"' || r == '=' {
|
||||
return strconv.Quote(text)
|
||||
}
|
||||
}
|
||||
|
||||
return text
|
||||
}
|
||||
|
||||
+155
-140
@@ -1,4 +1,4 @@
|
||||
package simplelog_test
|
||||
package simplelog
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
@@ -7,17 +7,13 @@ import (
|
||||
"errors"
|
||||
"io"
|
||||
"log/slog"
|
||||
"maps"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"reflect"
|
||||
"slices"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/simplelog"
|
||||
)
|
||||
|
||||
// These tests assert on the bytes the handlers actually emit, because that is
|
||||
@@ -26,8 +22,7 @@ import (
|
||||
|
||||
// captureStdout redirects os.Stdout for the duration of fn and returns what was
|
||||
// written to it. Both the console and the JSON handler write to os.Stdout, so
|
||||
// this is the only way to see their real output. os.Stdout is shared by the
|
||||
// whole process, so a test that uses this must not run in parallel.
|
||||
// this is the only way to see their real output.
|
||||
func captureStdout(t *testing.T, fn func()) string {
|
||||
t.Helper()
|
||||
|
||||
@@ -40,10 +35,8 @@ func captureStdout(t *testing.T, fn func()) string {
|
||||
os.Stdout = w
|
||||
|
||||
collected := make(chan string, 1)
|
||||
|
||||
go func() {
|
||||
var buf bytes.Buffer
|
||||
|
||||
_, _ = io.Copy(&buf, r)
|
||||
collected <- buf.String()
|
||||
}()
|
||||
@@ -56,9 +49,7 @@ func captureStdout(t *testing.T, fn func()) string {
|
||||
fn()
|
||||
|
||||
os.Stdout = original
|
||||
|
||||
err = w.Close()
|
||||
if err != nil {
|
||||
if err := w.Close(); err != nil {
|
||||
t.Fatalf("close pipe writer: %v", err)
|
||||
}
|
||||
|
||||
@@ -69,21 +60,9 @@ func captureStdout(t *testing.T, fn func()) string {
|
||||
func testRecord(message string, attrs ...slog.Attr) slog.Record {
|
||||
record := slog.NewRecord(time.Now(), slog.LevelInfo, message, 0)
|
||||
record.AddAttrs(attrs...)
|
||||
|
||||
return record
|
||||
}
|
||||
|
||||
// handle passes record to handler and fails the test if Handle returns an
|
||||
// error.
|
||||
func handle(t *testing.T, handler slog.Handler, record slog.Record) {
|
||||
t.Helper()
|
||||
|
||||
err := handler.Handle(context.Background(), record)
|
||||
if err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// decodeLine parses a single line of JSON handler output.
|
||||
func decodeLine(t *testing.T, output string) map[string]any {
|
||||
t.Helper()
|
||||
@@ -94,12 +73,9 @@ func decodeLine(t *testing.T, output string) map[string]any {
|
||||
}
|
||||
|
||||
var decoded map[string]any
|
||||
|
||||
err := json.Unmarshal([]byte(line), &decoded)
|
||||
if err != nil {
|
||||
if err := json.Unmarshal([]byte(line), &decoded); err != nil {
|
||||
t.Fatalf("output is not valid JSON: %v\noutput: %s", err, line)
|
||||
}
|
||||
|
||||
return decoded
|
||||
}
|
||||
|
||||
@@ -111,7 +87,6 @@ func wantField(t *testing.T, decoded map[string]any, key string, want any) {
|
||||
if !ok {
|
||||
t.Fatalf("field %q missing from output: %v", key, decoded)
|
||||
}
|
||||
|
||||
if got != want {
|
||||
t.Fatalf("field %q = %v, want %v", key, got, want)
|
||||
}
|
||||
@@ -125,12 +100,10 @@ func wantGroup(t *testing.T, decoded map[string]any, key string) map[string]any
|
||||
if !ok {
|
||||
t.Fatalf("group %q missing from output: %v", key, decoded)
|
||||
}
|
||||
|
||||
group, ok := got.(map[string]any)
|
||||
if !ok {
|
||||
t.Fatalf("field %q = %v, want a nested object", key, got)
|
||||
}
|
||||
|
||||
return group
|
||||
}
|
||||
|
||||
@@ -183,19 +156,18 @@ func (c castTarget) LogValue() slog.Value {
|
||||
|
||||
var _ slog.LogValuer = castTarget{}
|
||||
|
||||
// errConnectionRefused is the error the ResolvesValues tests log.
|
||||
var errConnectionRefused = errors.New("connection refused")
|
||||
|
||||
func TestJSONHandlerEmitsRecordAttrs(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler()
|
||||
handler := NewJSONHandler()
|
||||
record := testRecord(
|
||||
"casting",
|
||||
slog.String("device", "livingroom"),
|
||||
slog.String("file", "movie.mp4"),
|
||||
slog.Int("attempt", 3),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
decoded := decodeLine(t, output)
|
||||
@@ -207,11 +179,13 @@ func TestJSONHandlerEmitsRecordAttrs(t *testing.T) {
|
||||
|
||||
func TestJSONHandlerWithAttrsAccumulates(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler().
|
||||
handler := NewJSONHandler().
|
||||
WithAttrs([]slog.Attr{slog.String("service", "cattbox")}).
|
||||
WithAttrs([]slog.Attr{slog.String("component", "caster")})
|
||||
record := testRecord("casting", slog.String("device", "livingroom"))
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
decoded := decodeLine(t, output)
|
||||
@@ -221,38 +195,43 @@ func TestJSONHandlerWithAttrsAccumulates(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestJSONHandlerWithAttrsDoesNotMutateReceiver(t *testing.T) {
|
||||
parent := simplelog.NewJSONHandler()
|
||||
parent := NewJSONHandler()
|
||||
first := parent.WithAttrs([]slog.Attr{slog.String("worker", "first")})
|
||||
second := parent.WithAttrs([]slog.Attr{slog.String("worker", "second")})
|
||||
|
||||
firstOutput := captureStdout(t, func() {
|
||||
handle(t, first, testRecord("work"))
|
||||
if err := first.Handle(context.Background(), testRecord("work")); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
secondOutput := captureStdout(t, func() {
|
||||
handle(t, second, testRecord("work"))
|
||||
if err := second.Handle(context.Background(), testRecord("work")); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
parentOutput := captureStdout(t, func() {
|
||||
handle(t, parent, testRecord("work"))
|
||||
if err := parent.Handle(context.Background(), testRecord("work")); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantField(t, decodeLine(t, firstOutput), "worker", "first")
|
||||
wantField(t, decodeLine(t, secondOutput), "worker", "second")
|
||||
|
||||
if _, present := decodeLine(t, parentOutput)["worker"]; present {
|
||||
t.Fatalf(
|
||||
"parent handler leaked an attribute from a derived handler: %s",
|
||||
parentOutput,
|
||||
)
|
||||
t.Fatalf("parent handler leaked an attribute from a derived handler: %s", parentOutput)
|
||||
}
|
||||
}
|
||||
|
||||
func TestJSONHandlerWithGroupNestsAttrs(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler().
|
||||
handler := NewJSONHandler().
|
||||
WithGroup("cast").
|
||||
WithAttrs([]slog.Attr{slog.String("device", "livingroom")})
|
||||
record := testRecord("casting", slog.String("file", "movie.mp4"))
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
decoded := decodeLine(t, output)
|
||||
@@ -265,14 +244,16 @@ func TestJSONHandlerWithGroupNestsAttrs(t *testing.T) {
|
||||
|
||||
func TestJSONHandlerResolvesValues(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler()
|
||||
handler := NewJSONHandler()
|
||||
record := testRecord(
|
||||
"cast failed",
|
||||
slog.Group("request", slog.Int("status", 502), slog.String("method", "POST")),
|
||||
slog.Any("target", castTarget{id: "chromecast-7"}),
|
||||
slog.Any("error", errConnectionRefused),
|
||||
slog.Any("error", errors.New("connection refused")),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
decoded := decodeLine(t, output)
|
||||
@@ -286,14 +267,16 @@ func TestJSONHandlerResolvesValues(t *testing.T) {
|
||||
|
||||
func TestConsoleHandlerEmitsRecordAttrs(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewConsoleHandler()
|
||||
handler := NewConsoleHandler()
|
||||
record := testRecord(
|
||||
"casting",
|
||||
slog.String("device", "livingroom"),
|
||||
slog.String("file", "movie.mp4"),
|
||||
slog.Int("attempt", 3),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, output, "casting")
|
||||
@@ -304,9 +287,11 @@ func TestConsoleHandlerEmitsRecordAttrs(t *testing.T) {
|
||||
|
||||
func TestConsoleHandlerQuotesValuesNeedingIt(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewConsoleHandler()
|
||||
handler := NewConsoleHandler()
|
||||
record := testRecord("casting", slog.String("file", "The Movie.mp4"))
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, output, `file="The Movie.mp4"`)
|
||||
@@ -327,42 +312,42 @@ func TestConsoleHandlerQuotesKeysNeedingIt(t *testing.T) {
|
||||
}{
|
||||
{
|
||||
name: "an ordinary key is left bare",
|
||||
build: func() slog.Handler { return simplelog.NewConsoleHandler() },
|
||||
build: func() slog.Handler { return NewConsoleHandler() },
|
||||
attrs: []slog.Attr{slog.String("device", "livingroom")},
|
||||
want: " device=livingroom",
|
||||
notWant: `"device"`,
|
||||
},
|
||||
{
|
||||
name: "a key containing an equals sign is quoted",
|
||||
build: func() slog.Handler { return simplelog.NewConsoleHandler() },
|
||||
build: func() slog.Handler { return NewConsoleHandler() },
|
||||
attrs: []slog.Attr{slog.String("a=b", "v2")},
|
||||
want: ` "a=b"=v2`,
|
||||
notWant: " a=b=v2",
|
||||
},
|
||||
{
|
||||
name: "a key containing a space is quoted",
|
||||
build: func() slog.Handler { return simplelog.NewConsoleHandler() },
|
||||
build: func() slog.Handler { return NewConsoleHandler() },
|
||||
attrs: []slog.Attr{slog.String("my key", "v")},
|
||||
want: ` "my key"=v`,
|
||||
notWant: " my key=v",
|
||||
},
|
||||
{
|
||||
name: "a key containing a quote is escaped",
|
||||
build: func() slog.Handler { return simplelog.NewConsoleHandler() },
|
||||
build: func() slog.Handler { return NewConsoleHandler() },
|
||||
attrs: []slog.Attr{slog.String(`he"llo`, "v")},
|
||||
want: ` "he\"llo"=v`,
|
||||
notWant: ` he"llo=v`,
|
||||
},
|
||||
{
|
||||
name: "a printable non-ascii key is left bare",
|
||||
build: func() slog.Handler { return simplelog.NewConsoleHandler() },
|
||||
build: func() slog.Handler { return NewConsoleHandler() },
|
||||
attrs: []slog.Attr{slog.String("キー", "v")},
|
||||
want: " キー=v",
|
||||
notWant: `"キー"`,
|
||||
},
|
||||
{
|
||||
name: "a group prefix is quoted together with its key",
|
||||
build: func() slog.Handler { return simplelog.NewConsoleHandler() },
|
||||
build: func() slog.Handler { return NewConsoleHandler() },
|
||||
attrs: []slog.Attr{
|
||||
slog.Group("grp", slog.String("a=b", "v")),
|
||||
},
|
||||
@@ -370,9 +355,9 @@ func TestConsoleHandlerQuotesKeysNeedingIt(t *testing.T) {
|
||||
notWant: " grp.a=b=v",
|
||||
},
|
||||
{
|
||||
name: "a WithGroup prefix needing quotes is quoted with its key",
|
||||
name: "a WithGroup prefix needing quotes quotes the whole key",
|
||||
build: func() slog.Handler {
|
||||
return simplelog.NewConsoleHandler().WithGroup("my grp")
|
||||
return NewConsoleHandler().WithGroup("my grp")
|
||||
},
|
||||
attrs: []slog.Attr{slog.String("k", "v")},
|
||||
want: ` "my grp.k"=v`,
|
||||
@@ -380,7 +365,7 @@ func TestConsoleHandlerQuotesKeysNeedingIt(t *testing.T) {
|
||||
},
|
||||
{
|
||||
name: "an empty key is quoted rather than left as a gap",
|
||||
build: func() slog.Handler { return simplelog.NewConsoleHandler() },
|
||||
build: func() slog.Handler { return NewConsoleHandler() },
|
||||
attrs: []slog.Attr{slog.String("", "v")},
|
||||
want: ` ""=v`,
|
||||
notWant: " =v",
|
||||
@@ -390,7 +375,11 @@ func TestConsoleHandlerQuotesKeysNeedingIt(t *testing.T) {
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handle(t, test.build(), testRecord("casting", test.attrs...))
|
||||
handler := test.build()
|
||||
record := testRecord("casting", test.attrs...)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, output, test.want)
|
||||
@@ -401,11 +390,13 @@ func TestConsoleHandlerQuotesKeysNeedingIt(t *testing.T) {
|
||||
|
||||
func TestConsoleHandlerWithAttrsAccumulates(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewConsoleHandler().
|
||||
handler := NewConsoleHandler().
|
||||
WithAttrs([]slog.Attr{slog.String("service", "cattbox")}).
|
||||
WithAttrs([]slog.Attr{slog.String("component", "caster")})
|
||||
record := testRecord("casting", slog.String("device", "livingroom"))
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, output, "service=cattbox")
|
||||
@@ -414,18 +405,24 @@ func TestConsoleHandlerWithAttrsAccumulates(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestConsoleHandlerWithAttrsDoesNotMutateReceiver(t *testing.T) {
|
||||
parent := simplelog.NewConsoleHandler()
|
||||
parent := NewConsoleHandler()
|
||||
first := parent.WithAttrs([]slog.Attr{slog.String("worker", "first")})
|
||||
second := parent.WithAttrs([]slog.Attr{slog.String("worker", "second")})
|
||||
|
||||
firstOutput := captureStdout(t, func() {
|
||||
handle(t, first, testRecord("work"))
|
||||
if err := first.Handle(context.Background(), testRecord("work")); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
secondOutput := captureStdout(t, func() {
|
||||
handle(t, second, testRecord("work"))
|
||||
if err := second.Handle(context.Background(), testRecord("work")); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
parentOutput := captureStdout(t, func() {
|
||||
handle(t, parent, testRecord("work"))
|
||||
if err := parent.Handle(context.Background(), testRecord("work")); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, firstOutput, "worker=first")
|
||||
@@ -437,11 +434,13 @@ func TestConsoleHandlerWithAttrsDoesNotMutateReceiver(t *testing.T) {
|
||||
|
||||
func TestConsoleHandlerWithGroupQualifiesAttrs(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewConsoleHandler().
|
||||
handler := NewConsoleHandler().
|
||||
WithGroup("cast").
|
||||
WithAttrs([]slog.Attr{slog.String("device", "livingroom")})
|
||||
record := testRecord("casting", slog.String("file", "movie.mp4"))
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, output, "cast.device=livingroom")
|
||||
@@ -450,14 +449,16 @@ func TestConsoleHandlerWithGroupQualifiesAttrs(t *testing.T) {
|
||||
|
||||
func TestConsoleHandlerResolvesValues(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewConsoleHandler()
|
||||
handler := NewConsoleHandler()
|
||||
record := testRecord(
|
||||
"cast failed",
|
||||
slog.Group("request", slog.Int("status", 502)),
|
||||
slog.Any("target", castTarget{id: "chromecast-7"}),
|
||||
slog.Any("error", errConnectionRefused),
|
||||
slog.Any("error", errors.New("connection refused")),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, output, "request.status=502")
|
||||
@@ -466,32 +467,29 @@ func TestConsoleHandlerResolvesValues(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestWebhookHandlerEmitsAttrs(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
bodies := make(chan []byte, 1)
|
||||
|
||||
server := httptest.NewServer(http.HandlerFunc(
|
||||
func(w http.ResponseWriter, r *http.Request) {
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
t.Errorf("read webhook body: %v", err)
|
||||
}
|
||||
|
||||
bodies <- body
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
},
|
||||
))
|
||||
defer server.Close()
|
||||
|
||||
handler, err := simplelog.NewWebhookHandler(server.URL)
|
||||
handler, err := NewWebhookHandler(server.URL)
|
||||
if err != nil {
|
||||
t.Fatalf("NewWebhookHandler: %v", err)
|
||||
}
|
||||
|
||||
withAttrs := handler.WithAttrs([]slog.Attr{slog.String("service", "cattbox")})
|
||||
record := testRecord("casting", slog.String("device", "livingroom"))
|
||||
handle(t, withAttrs, record)
|
||||
if err := withAttrs.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
|
||||
var body []byte
|
||||
select {
|
||||
@@ -506,15 +504,15 @@ func TestWebhookHandlerEmitsAttrs(t *testing.T) {
|
||||
}
|
||||
|
||||
// TestMultiplexHandlerPassesAttrsThrough guards the composite handler that
|
||||
// package init installs: attributes must survive the multiplex too. It is
|
||||
// built while stdout is the capture pipe, which is not a terminal, so it
|
||||
// writes through the JSON handler.
|
||||
// package init installs: attributes must survive the multiplex too.
|
||||
func TestMultiplexHandlerPassesAttrsThrough(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewMultiplexHandler().
|
||||
handler := (&MultiplexHandler{handlers: []ExtendedHandler{NewJSONHandler()}}).
|
||||
WithAttrs([]slog.Attr{slog.String("service", "cattbox")})
|
||||
record := testRecord("casting", slog.String("device", "livingroom"))
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
decoded := decodeLine(t, output)
|
||||
@@ -531,19 +529,20 @@ func TestMultiplexHandlerPassesAttrsThrough(t *testing.T) {
|
||||
|
||||
func TestJSONHandlerDoesNotMutateCallerMap(t *testing.T) {
|
||||
caller := map[string]any{"mine": "untouched"}
|
||||
want := maps.Clone(caller)
|
||||
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler()
|
||||
handler := NewJSONHandler()
|
||||
record := testRecord(
|
||||
"casting",
|
||||
slog.Any("g", caller),
|
||||
slog.Group("g", slog.Int("injected", 1)),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantUnchanged(t, "map", caller, want)
|
||||
wantUnchanged(t, "map", caller, map[string]any{"mine": "untouched"})
|
||||
|
||||
// The later attribute wins the key outright, as any repeated key does.
|
||||
group := wantGroup(t, decodeLine(t, output), "g")
|
||||
@@ -553,17 +552,18 @@ func TestJSONHandlerDoesNotMutateCallerMap(t *testing.T) {
|
||||
|
||||
func TestJSONHandlerDoesNotMutateCallerMapThroughWithAttrs(t *testing.T) {
|
||||
caller := map[string]any{"id": "req-1"}
|
||||
want := maps.Clone(caller)
|
||||
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler().
|
||||
handler := NewJSONHandler().
|
||||
WithAttrs([]slog.Attr{slog.Any("req", caller)}).
|
||||
WithGroup("req")
|
||||
record := testRecord("cast failed", slog.Int("status", 502))
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantUnchanged(t, "map", caller, want)
|
||||
wantUnchanged(t, "map", caller, map[string]any{"id": "req-1"})
|
||||
|
||||
group := wantGroup(t, decodeLine(t, output), "req")
|
||||
wantField(t, group, "status", float64(502))
|
||||
@@ -579,20 +579,26 @@ func TestJSONHandlerDoesNotMutateCallerSlice(t *testing.T) {
|
||||
caller := make([]any, 2, 4)
|
||||
caller[0] = "first"
|
||||
caller[1] = "second"
|
||||
backing := slices.Clone(caller[:cap(caller)])
|
||||
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler()
|
||||
handler := NewJSONHandler()
|
||||
record := testRecord(
|
||||
"casting",
|
||||
slog.Any("s", caller),
|
||||
slog.Group("s", slog.Int("injected", 1)),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantUnchanged(t, "slice", caller, backing[:2])
|
||||
wantUnchanged(t, "slice backing array", caller[:cap(caller)], backing)
|
||||
wantUnchanged(t, "slice", caller, []any{"first", "second"})
|
||||
wantUnchanged(
|
||||
t,
|
||||
"slice backing array",
|
||||
caller[:cap(caller)],
|
||||
[]any{"first", "second", nil, nil},
|
||||
)
|
||||
|
||||
group := wantGroup(t, decodeLine(t, output), "s")
|
||||
wantField(t, group, "injected", float64(1))
|
||||
@@ -600,45 +606,40 @@ func TestJSONHandlerDoesNotMutateCallerSlice(t *testing.T) {
|
||||
|
||||
func TestConsoleHandlerDoesNotMutateCallerMap(t *testing.T) {
|
||||
caller := map[string]any{"mine": "untouched"}
|
||||
want := maps.Clone(caller)
|
||||
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewConsoleHandler()
|
||||
handler := NewConsoleHandler()
|
||||
record := testRecord(
|
||||
"casting",
|
||||
slog.Any("g", caller),
|
||||
slog.Group("g", slog.Int("injected", 1)),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantUnchanged(t, "map", caller, want)
|
||||
wantUnchanged(t, "map", caller, map[string]any{"mine": "untouched"})
|
||||
wantContains(t, output, "g.injected=1")
|
||||
}
|
||||
|
||||
func TestWebhookHandlerDoesNotMutateCallerMap(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
caller := map[string]any{"id": "req-1"}
|
||||
want := maps.Clone(caller)
|
||||
|
||||
bodies := make(chan []byte, 1)
|
||||
|
||||
server := httptest.NewServer(http.HandlerFunc(
|
||||
func(w http.ResponseWriter, r *http.Request) {
|
||||
body, err := io.ReadAll(r.Body)
|
||||
if err != nil {
|
||||
t.Errorf("read webhook body: %v", err)
|
||||
}
|
||||
|
||||
bodies <- body
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
},
|
||||
))
|
||||
defer server.Close()
|
||||
|
||||
handler, err := simplelog.NewWebhookHandler(server.URL)
|
||||
handler, err := NewWebhookHandler(server.URL)
|
||||
if err != nil {
|
||||
t.Fatalf("NewWebhookHandler: %v", err)
|
||||
}
|
||||
@@ -647,7 +648,9 @@ func TestWebhookHandlerDoesNotMutateCallerMap(t *testing.T) {
|
||||
WithAttrs([]slog.Attr{slog.Any("req", caller)}).
|
||||
WithGroup("req")
|
||||
record := testRecord("cast failed", slog.Int("status", 502))
|
||||
handle(t, derived, record)
|
||||
if err := derived.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
|
||||
var body []byte
|
||||
select {
|
||||
@@ -656,7 +659,7 @@ func TestWebhookHandlerDoesNotMutateCallerMap(t *testing.T) {
|
||||
t.Fatal("webhook handler posted nothing")
|
||||
}
|
||||
|
||||
wantUnchanged(t, "map", caller, want)
|
||||
wantUnchanged(t, "map", caller, map[string]any{"id": "req-1"})
|
||||
|
||||
group := wantGroup(t, decodeLine(t, string(body)), "req")
|
||||
wantField(t, group, "status", float64(502))
|
||||
@@ -668,16 +671,17 @@ func TestWebhookHandlerDoesNotMutateCallerMap(t *testing.T) {
|
||||
// form would silently arrive as a string.
|
||||
func TestJSONHandlerRendersDurationAsNanoseconds(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler()
|
||||
handler := NewJSONHandler()
|
||||
record := testRecord("casting", slog.Duration("elapsed", 3*time.Second))
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
decoded := decodeLine(t, output)
|
||||
if _, isNumber := decoded["elapsed"].(float64); !isNumber {
|
||||
t.Fatalf("field \"elapsed\" = %#v, want a json number", decoded["elapsed"])
|
||||
}
|
||||
|
||||
wantField(t, decoded, "elapsed", float64((3 * time.Second).Nanoseconds()))
|
||||
}
|
||||
|
||||
@@ -686,9 +690,11 @@ func TestJSONHandlerRendersDurationAsNanoseconds(t *testing.T) {
|
||||
// form slog.NewTextHandler uses.
|
||||
func TestConsoleHandlerRendersDurationReadably(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewConsoleHandler()
|
||||
handler := NewConsoleHandler()
|
||||
record := testRecord("casting", slog.Duration("elapsed", 3*time.Second))
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, output, "elapsed=3s")
|
||||
@@ -710,10 +716,9 @@ func TestJSONHandlerContractEdgeCases(t *testing.T) {
|
||||
}{
|
||||
{
|
||||
name: "empty attr is ignored",
|
||||
build: func() slog.Handler { return simplelog.NewJSONHandler() },
|
||||
build: func() slog.Handler { return NewJSONHandler() },
|
||||
attrs: []slog.Attr{{}, slog.String("kept", "yes")},
|
||||
verify: func(t *testing.T, decoded map[string]any) {
|
||||
t.Helper()
|
||||
wantField(t, decoded, "kept", "yes")
|
||||
wantNoField(t, decoded, "")
|
||||
},
|
||||
@@ -721,24 +726,22 @@ func TestJSONHandlerContractEdgeCases(t *testing.T) {
|
||||
{
|
||||
name: "empty group is elided along with its key",
|
||||
build: func() slog.Handler {
|
||||
return simplelog.NewJSONHandler().
|
||||
return NewJSONHandler().
|
||||
WithAttrs([]slog.Attr{slog.Group("empty")})
|
||||
},
|
||||
attrs: []slog.Attr{slog.String("kept", "yes")},
|
||||
verify: func(t *testing.T, decoded map[string]any) {
|
||||
t.Helper()
|
||||
wantField(t, decoded, "kept", "yes")
|
||||
wantNoField(t, decoded, "empty")
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "group with an empty key is inlined",
|
||||
build: func() slog.Handler { return simplelog.NewJSONHandler() },
|
||||
build: func() slog.Handler { return NewJSONHandler() },
|
||||
attrs: []slog.Attr{
|
||||
slog.Group("", slog.String("inner", "yes")),
|
||||
},
|
||||
verify: func(t *testing.T, decoded map[string]any) {
|
||||
t.Helper()
|
||||
wantField(t, decoded, "inner", "yes")
|
||||
wantNoField(t, decoded, "")
|
||||
},
|
||||
@@ -746,11 +749,10 @@ func TestJSONHandlerContractEdgeCases(t *testing.T) {
|
||||
{
|
||||
name: "WithGroup with an empty name is a no-op",
|
||||
build: func() slog.Handler {
|
||||
return simplelog.NewJSONHandler().WithGroup("")
|
||||
return NewJSONHandler().WithGroup("")
|
||||
},
|
||||
attrs: []slog.Attr{slog.String("kept", "yes")},
|
||||
verify: func(t *testing.T, decoded map[string]any) {
|
||||
t.Helper()
|
||||
wantField(t, decoded, "kept", "yes")
|
||||
wantNoField(t, decoded, "")
|
||||
},
|
||||
@@ -760,7 +762,11 @@ func TestJSONHandlerContractEdgeCases(t *testing.T) {
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handle(t, test.build(), testRecord("casting", test.attrs...))
|
||||
handler := test.build()
|
||||
record := testRecord("casting", test.attrs...)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
test.verify(t, decodeLine(t, output))
|
||||
@@ -780,7 +786,7 @@ func TestConsoleHandlerContractEdgeCases(t *testing.T) {
|
||||
}{
|
||||
{
|
||||
name: "empty attr is ignored",
|
||||
build: func() slog.Handler { return simplelog.NewConsoleHandler() },
|
||||
build: func() slog.Handler { return NewConsoleHandler() },
|
||||
attrs: []slog.Attr{{}, slog.String("kept", "yes")},
|
||||
want: "kept=yes",
|
||||
notWant: " =",
|
||||
@@ -788,7 +794,7 @@ func TestConsoleHandlerContractEdgeCases(t *testing.T) {
|
||||
{
|
||||
name: "empty group is elided along with its key",
|
||||
build: func() slog.Handler {
|
||||
return simplelog.NewConsoleHandler().
|
||||
return NewConsoleHandler().
|
||||
WithAttrs([]slog.Attr{slog.Group("empty")})
|
||||
},
|
||||
attrs: []slog.Attr{slog.String("kept", "yes")},
|
||||
@@ -797,7 +803,7 @@ func TestConsoleHandlerContractEdgeCases(t *testing.T) {
|
||||
},
|
||||
{
|
||||
name: "group with an empty key is inlined",
|
||||
build: func() slog.Handler { return simplelog.NewConsoleHandler() },
|
||||
build: func() slog.Handler { return NewConsoleHandler() },
|
||||
attrs: []slog.Attr{
|
||||
slog.Group("", slog.String("inner", "yes")),
|
||||
},
|
||||
@@ -807,7 +813,7 @@ func TestConsoleHandlerContractEdgeCases(t *testing.T) {
|
||||
{
|
||||
name: "WithGroup with an empty name is a no-op",
|
||||
build: func() slog.Handler {
|
||||
return simplelog.NewConsoleHandler().WithGroup("")
|
||||
return NewConsoleHandler().WithGroup("")
|
||||
},
|
||||
attrs: []slog.Attr{slog.String("kept", "yes")},
|
||||
want: " kept=yes",
|
||||
@@ -818,7 +824,11 @@ func TestConsoleHandlerContractEdgeCases(t *testing.T) {
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handle(t, test.build(), testRecord("casting", test.attrs...))
|
||||
handler := test.build()
|
||||
record := testRecord("casting", test.attrs...)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, output, test.want)
|
||||
@@ -832,7 +842,7 @@ func TestConsoleHandlerContractEdgeCases(t *testing.T) {
|
||||
// and an attribute keyed after one of them is dropped rather than emitted.
|
||||
func TestJSONHandlerRecordFieldsWinKeyCollision(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler()
|
||||
handler := NewJSONHandler()
|
||||
record := testRecord(
|
||||
"the real message",
|
||||
slog.String("Time", "hijacked"),
|
||||
@@ -841,14 +851,15 @@ func TestJSONHandlerRecordFieldsWinKeyCollision(t *testing.T) {
|
||||
slog.String("PC", "hijacked"),
|
||||
slog.String("kept", "yes"),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
decoded := decodeLine(t, output)
|
||||
wantField(t, decoded, "kept", "yes")
|
||||
wantField(t, decoded, "Message", "the real message")
|
||||
wantField(t, decoded, "Level", "INFO")
|
||||
|
||||
for _, reserved := range []string{"Time", "PC"} {
|
||||
if decoded[reserved] == "hijacked" {
|
||||
t.Fatalf("attribute overwrote the record's own %q field: %v", reserved, decoded)
|
||||
@@ -860,13 +871,15 @@ func TestJSONHandlerRecordFieldsWinKeyCollision(t *testing.T) {
|
||||
// payload being an object: a key logged twice collapses to its last value.
|
||||
func TestJSONHandlerDuplicateKeysKeepLast(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewJSONHandler()
|
||||
handler := NewJSONHandler()
|
||||
record := testRecord(
|
||||
"casting",
|
||||
slog.String("device", "kitchen"),
|
||||
slog.String("device", "livingroom"),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantField(t, decodeLine(t, output), "device", "livingroom")
|
||||
@@ -876,13 +889,15 @@ func TestJSONHandlerDuplicateKeysKeepLast(t *testing.T) {
|
||||
// text is not an object, so both pairs survive there.
|
||||
func TestConsoleHandlerKeepsDuplicateKeys(t *testing.T) {
|
||||
output := captureStdout(t, func() {
|
||||
handler := simplelog.NewConsoleHandler()
|
||||
handler := NewConsoleHandler()
|
||||
record := testRecord(
|
||||
"casting",
|
||||
slog.String("device", "kitchen"),
|
||||
slog.String("device", "livingroom"),
|
||||
)
|
||||
handle(t, handler, record)
|
||||
if err := handler.Handle(context.Background(), record); err != nil {
|
||||
t.Fatalf("Handle: %v", err)
|
||||
}
|
||||
})
|
||||
|
||||
wantContains(t, output, "device=kitchen")
|
||||
|
||||
+2
-6
@@ -1,5 +1,3 @@
|
||||
// Command example demonstrates logging through simplelog's default
|
||||
// slog handler.
|
||||
package main
|
||||
|
||||
import (
|
||||
@@ -8,15 +6,13 @@ import (
|
||||
_ "sneak.berlin/go/simplelog"
|
||||
)
|
||||
|
||||
// attemptNumber is the example login attempt count logged below.
|
||||
const attemptNumber = 3
|
||||
|
||||
func main() {
|
||||
|
||||
// log structured data with slog as usual:
|
||||
slog.Info(
|
||||
"User login attempt",
|
||||
slog.String("user", "JohnDoe"),
|
||||
slog.Int("attempt", attemptNumber),
|
||||
slog.Int("attempt", 3),
|
||||
)
|
||||
slog.Warn(
|
||||
"Configuration mismatch",
|
||||
|
||||
+6
-30
@@ -4,41 +4,28 @@ import (
|
||||
"context"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"os"
|
||||
"runtime"
|
||||
"time"
|
||||
|
||||
"github.com/fatih/color"
|
||||
)
|
||||
|
||||
// callerSkipFrames is the number of stack frames between runtime.Caller
|
||||
// and the slog call site that produced the record.
|
||||
const callerSkipFrames = 4
|
||||
|
||||
// ConsoleHandler writes human-readable, colored log lines to stdout.
|
||||
type ConsoleHandler struct {
|
||||
attrs handlerAttrs
|
||||
}
|
||||
|
||||
// NewConsoleHandler returns a new ConsoleHandler.
|
||||
func NewConsoleHandler() *ConsoleHandler {
|
||||
return &ConsoleHandler{}
|
||||
}
|
||||
|
||||
// Handle writes the record to stdout as a colored, timestamped line
|
||||
// including the caller file and line, followed by the attributes as
|
||||
// key=value pairs.
|
||||
func (c *ConsoleHandler) Handle(
|
||||
_ context.Context,
|
||||
ctx context.Context,
|
||||
record slog.Record,
|
||||
) error {
|
||||
timestamp := time.Now().UTC().Format("2006-01-02T15:04:05.000Z07:00")
|
||||
|
||||
var colorFunc func(format string, a ...any) string
|
||||
var colorFunc func(format string, a ...interface{}) string
|
||||
|
||||
switch record.Level {
|
||||
case slog.LevelDebug:
|
||||
colorFunc = color.New(color.FgWhite).SprintfFunc()
|
||||
case slog.LevelInfo:
|
||||
colorFunc = color.New(color.FgBlue).SprintfFunc()
|
||||
case slog.LevelWarn:
|
||||
@@ -50,14 +37,12 @@ func (c *ConsoleHandler) Handle(
|
||||
}
|
||||
|
||||
// Get the caller information
|
||||
_, file, line, ok := runtime.Caller(callerSkipFrames)
|
||||
_, file, line, ok := runtime.Caller(4)
|
||||
if !ok {
|
||||
file = "???"
|
||||
line = 0
|
||||
}
|
||||
|
||||
_, _ = fmt.Fprintln(
|
||||
os.Stdout,
|
||||
fmt.Println(
|
||||
colorFunc(
|
||||
"%s [%s] %s:%d: %s%s",
|
||||
timestamp,
|
||||
@@ -68,35 +53,26 @@ func (c *ConsoleHandler) Handle(
|
||||
attrsToText(c.attrs.forRecord(record)),
|
||||
),
|
||||
)
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Enabled reports whether the handler processes records at the given
|
||||
// level; it always returns true.
|
||||
func (c *ConsoleHandler) Enabled(
|
||||
_ context.Context,
|
||||
_ slog.Level,
|
||||
ctx context.Context,
|
||||
level slog.Level,
|
||||
) bool {
|
||||
return true
|
||||
}
|
||||
|
||||
// WithAttrs returns a new handler that also emits attrs, qualified by the
|
||||
// groups open now. The receiver is not modified.
|
||||
func (c *ConsoleHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
|
||||
if len(attrs) == 0 {
|
||||
return c
|
||||
}
|
||||
|
||||
return &ConsoleHandler{attrs: c.attrs.withAttrs(attrs)}
|
||||
}
|
||||
|
||||
// WithGroup returns a new handler that qualifies later attributes with
|
||||
// the group name. An empty name returns the receiver.
|
||||
func (c *ConsoleHandler) WithGroup(name string) slog.Handler {
|
||||
if name == "" {
|
||||
return c
|
||||
}
|
||||
|
||||
return &ConsoleHandler{attrs: c.attrs.withGroup(name)}
|
||||
}
|
||||
|
||||
@@ -7,8 +7,6 @@ import (
|
||||
"github.com/google/uuid"
|
||||
)
|
||||
|
||||
// Event is a single structured log entry with a unique ID and
|
||||
// timestamp.
|
||||
type Event struct {
|
||||
ID uuid.UUID `json:"id"`
|
||||
Timestamp time.Time `json:"timestamp"`
|
||||
@@ -17,8 +15,6 @@ type Event struct {
|
||||
Data json.RawMessage `json:"data"`
|
||||
}
|
||||
|
||||
// NewEvent returns an Event with a fresh ID and the current UTC
|
||||
// timestamp.
|
||||
func NewEvent(level, message string, data json.RawMessage) Event {
|
||||
return Event{
|
||||
ID: uuid.New(),
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@ package simplelog
|
||||
|
||||
import "log/slog"
|
||||
|
||||
// ExtendedHandler defines the interface for different log outputs.
|
||||
// Handler defines the interface for different log outputs.
|
||||
type ExtendedHandler interface {
|
||||
slog.Handler
|
||||
}
|
||||
|
||||
+4
-18
@@ -8,51 +8,37 @@ import (
|
||||
"os"
|
||||
)
|
||||
|
||||
// JSONHandler writes each log record to stdout as a JSON document.
|
||||
type JSONHandler struct {
|
||||
attrs handlerAttrs
|
||||
}
|
||||
|
||||
// NewJSONHandler returns a new JSONHandler.
|
||||
func NewJSONHandler() *JSONHandler {
|
||||
return &JSONHandler{}
|
||||
}
|
||||
|
||||
// Handle marshals the record, with its attributes, to one JSON object and
|
||||
// writes it to stdout.
|
||||
func (j *JSONHandler) Handle(_ context.Context, record slog.Record) error {
|
||||
func (j *JSONHandler) Handle(ctx context.Context, record slog.Record) error {
|
||||
jsonData, err := json.Marshal(recordToMap(record, j.attrs))
|
||||
if err != nil {
|
||||
return err
|
||||
return fmt.Errorf("error marshaling log record: %w", err)
|
||||
}
|
||||
|
||||
_, _ = fmt.Fprintln(os.Stdout, string(jsonData))
|
||||
|
||||
fmt.Fprintln(os.Stdout, string(jsonData))
|
||||
return nil
|
||||
}
|
||||
|
||||
// Enabled reports whether the handler processes records at the given
|
||||
// level; it always returns true.
|
||||
func (j *JSONHandler) Enabled(_ context.Context, _ slog.Level) bool {
|
||||
func (j *JSONHandler) Enabled(ctx context.Context, level slog.Level) bool {
|
||||
return true
|
||||
}
|
||||
|
||||
// WithAttrs returns a new handler that also emits attrs, qualified by the
|
||||
// groups open now. The receiver is not modified.
|
||||
func (j *JSONHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
|
||||
if len(attrs) == 0 {
|
||||
return j
|
||||
}
|
||||
|
||||
return &JSONHandler{attrs: j.attrs.withAttrs(attrs)}
|
||||
}
|
||||
|
||||
// WithGroup returns a new handler that nests later attributes in an
|
||||
// object named after the group. An empty name returns the receiver.
|
||||
func (j *JSONHandler) WithGroup(name string) slog.Handler {
|
||||
if name == "" {
|
||||
return j
|
||||
}
|
||||
|
||||
return &JSONHandler{attrs: j.attrs.withGroup(name)}
|
||||
}
|
||||
|
||||
@@ -1,27 +1,22 @@
|
||||
package simplelog_test
|
||||
package simplelog
|
||||
|
||||
import (
|
||||
"log/slog"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"sneak.berlin/go/simplelog"
|
||||
)
|
||||
|
||||
// TestJSONHandlerDeadlock verifies that JSONHandler.Handle does not deadlock
|
||||
// when the default slog handler routes log.Println back through slog.
|
||||
// On the unfixed code this test will hang (deadlock); with the fix it completes.
|
||||
func TestJSONHandlerDeadlock(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
handler := simplelog.NewJSONHandler()
|
||||
handler := NewJSONHandler()
|
||||
|
||||
// Set our handler as the default so log.Println routes through slog
|
||||
logger := slog.New(handler)
|
||||
slog.SetDefault(logger)
|
||||
|
||||
done := make(chan struct{})
|
||||
|
||||
go func() {
|
||||
// This call deadlocks on unfixed code because Handle() calls
|
||||
// log.Println() which re-enters slog → Handle() → log.Println() …
|
||||
|
||||
+7
-41
@@ -1,7 +1,3 @@
|
||||
// Package simplelog installs a multiplexing slog handler as the process
|
||||
// default on import. It logs human-readable colored output when stdout is
|
||||
// a terminal, JSON otherwise, and can additionally POST each record to a
|
||||
// webhook configured via the LOGGER_WEBHOOK_URL environment variable.
|
||||
package simplelog
|
||||
|
||||
import (
|
||||
@@ -17,31 +13,23 @@ import (
|
||||
"github.com/mattn/go-isatty"
|
||||
)
|
||||
|
||||
//nolint:gochecknoglobals // webhook destination is read once from the environment
|
||||
var webhookURL = os.Getenv("LOGGER_WEBHOOK_URL")
|
||||
|
||||
//nolint:gochecknoglobals // package-level default logger state is the package's design
|
||||
var (
|
||||
ourCustomLogger *slog.Logger
|
||||
ourCustomHandler slog.Handler
|
||||
webhookURL = os.Getenv("LOGGER_WEBHOOK_URL")
|
||||
)
|
||||
|
||||
//nolint:gochecknoinits // installs itself as slog default on import by design
|
||||
var ourCustomLogger *slog.Logger
|
||||
var ourCustomHandler slog.Handler
|
||||
|
||||
func init() {
|
||||
ourCustomHandler = NewMultiplexHandler()
|
||||
ourCustomLogger = slog.New(ourCustomHandler)
|
||||
slog.SetDefault(ourCustomLogger)
|
||||
}
|
||||
|
||||
// MultiplexHandler fans each log record out to a set of underlying
|
||||
// handlers.
|
||||
type MultiplexHandler struct {
|
||||
handlers []ExtendedHandler
|
||||
}
|
||||
|
||||
// NewMultiplexHandler returns a handler that writes colored console
|
||||
// output when stdout is a terminal and JSON otherwise, plus an optional
|
||||
// webhook handler when LOGGER_WEBHOOK_URL is set.
|
||||
func NewMultiplexHandler() slog.Handler {
|
||||
cl := &MultiplexHandler{}
|
||||
if isatty.IsTerminal(os.Stdout.Fd()) {
|
||||
@@ -49,69 +37,52 @@ func NewMultiplexHandler() slog.Handler {
|
||||
} else {
|
||||
cl.handlers = append(cl.handlers, NewJSONHandler())
|
||||
}
|
||||
|
||||
if webhookURL != "" {
|
||||
handler, err := NewWebhookHandler(webhookURL)
|
||||
if err != nil {
|
||||
log.Fatalf("Failed to initialize Webhook handler: %v", err)
|
||||
}
|
||||
|
||||
cl.handlers = append(cl.handlers, handler)
|
||||
}
|
||||
|
||||
return cl
|
||||
}
|
||||
|
||||
// Handle forwards the record to every underlying handler, stopping at
|
||||
// the first error.
|
||||
func (cl *MultiplexHandler) Handle(
|
||||
ctx context.Context,
|
||||
record slog.Record,
|
||||
) error {
|
||||
for _, handler := range cl.handlers {
|
||||
err := handler.Handle(ctx, record)
|
||||
if err != nil {
|
||||
if err := handler.Handle(ctx, record); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Enabled reports whether the handler processes records at the given
|
||||
// level; it always returns true.
|
||||
func (cl *MultiplexHandler) Enabled(
|
||||
_ context.Context,
|
||||
_ slog.Level,
|
||||
ctx context.Context,
|
||||
level slog.Level,
|
||||
) bool {
|
||||
// send us all events
|
||||
return true
|
||||
}
|
||||
|
||||
// WithAttrs returns a new MultiplexHandler whose underlying handlers
|
||||
// each carry the given attributes.
|
||||
func (cl *MultiplexHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
|
||||
newHandlers := make([]ExtendedHandler, len(cl.handlers))
|
||||
for i, handler := range cl.handlers {
|
||||
newHandlers[i] = handler.WithAttrs(attrs)
|
||||
}
|
||||
|
||||
return &MultiplexHandler{handlers: newHandlers}
|
||||
}
|
||||
|
||||
// WithGroup returns a new MultiplexHandler whose underlying handlers
|
||||
// each use the given group name.
|
||||
func (cl *MultiplexHandler) WithGroup(name string) slog.Handler {
|
||||
newHandlers := make([]ExtendedHandler, len(cl.handlers))
|
||||
for i, handler := range cl.handlers {
|
||||
newHandlers[i] = handler.WithGroup(name)
|
||||
}
|
||||
|
||||
return &MultiplexHandler{handlers: newHandlers}
|
||||
}
|
||||
|
||||
// ExtendedEvent describes an Event augmented with caller file and line
|
||||
// information.
|
||||
type ExtendedEvent interface {
|
||||
GetID() uuid.UUID
|
||||
GetTimestamp() time.Time
|
||||
@@ -124,7 +95,6 @@ type ExtendedEvent interface {
|
||||
|
||||
type extendedEvent struct {
|
||||
Event
|
||||
|
||||
File string `json:"file"`
|
||||
Line int `json:"line"`
|
||||
}
|
||||
@@ -157,10 +127,6 @@ func (e extendedEvent) GetLine() int {
|
||||
return e.Line
|
||||
}
|
||||
|
||||
// NewExtendedEvent wraps baseEvent with the caller file and line it was
|
||||
// logged from.
|
||||
//
|
||||
//nolint:ireturn // returning the interface is this constructor's public API
|
||||
func NewExtendedEvent(baseEvent Event, file string, line int) ExtendedEvent {
|
||||
return extendedEvent{
|
||||
Event: baseEvent,
|
||||
|
||||
+1
-2
@@ -1,9 +1,8 @@
|
||||
package simplelog_test
|
||||
package simplelog
|
||||
|
||||
import "testing"
|
||||
|
||||
// TestCompile checks if the package compiles successfully.
|
||||
func TestCompile(t *testing.T) {
|
||||
t.Parallel()
|
||||
// This test ensures that the simplelog package compiles without error.
|
||||
}
|
||||
|
||||
+2
-15
@@ -1,5 +1,3 @@
|
||||
// Command relp_log_trial emits sample log messages through simplelog's
|
||||
// default slog handler for manual testing.
|
||||
package main
|
||||
|
||||
import (
|
||||
@@ -8,22 +6,11 @@ import (
|
||||
_ "sneak.berlin/go/simplelog" // Using underscore to only invoke init()
|
||||
)
|
||||
|
||||
// examplePort is the sample database port logged below.
|
||||
const examplePort = 5432
|
||||
|
||||
func main() {
|
||||
// Send some test messages with structured data
|
||||
slog.Info("Starting the application", slog.String("status", "initialized"))
|
||||
slog.Info(
|
||||
"Attempting to connect to database",
|
||||
slog.String("host", "localhost"),
|
||||
slog.Int("port", examplePort),
|
||||
)
|
||||
slog.Info("Attempting to connect to database", slog.String("host", "localhost"), slog.Int("port", 5432))
|
||||
slog.Warn("Using default configuration", slog.String("configuration", "default"))
|
||||
slog.Error(
|
||||
"Failed to load module",
|
||||
slog.String("module", "finance"),
|
||||
slog.String("error", "module not found"),
|
||||
)
|
||||
slog.Error("Failed to load module", slog.String("module", "finance"), slog.String("error", "module not found"))
|
||||
slog.Info("Shutting down the application", slog.String("status", "stopped"))
|
||||
}
|
||||
|
||||
+11
-42
@@ -10,82 +10,51 @@ import (
|
||||
"net/url"
|
||||
)
|
||||
|
||||
// WebhookHandler POSTs each log record as JSON to a configured webhook
|
||||
// URL.
|
||||
type WebhookHandler struct {
|
||||
webhookURL string
|
||||
attrs handlerAttrs
|
||||
}
|
||||
|
||||
// NewWebhookHandler returns a WebhookHandler that delivers records to
|
||||
// the given URL, validating the URL first.
|
||||
func NewWebhookHandler(webhookURL string) (*WebhookHandler, error) {
|
||||
_, err := url.ParseRequestURI(webhookURL)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("invalid webhook URL: %w", err)
|
||||
}
|
||||
|
||||
return &WebhookHandler{webhookURL: webhookURL}, nil
|
||||
}
|
||||
|
||||
// Enabled reports whether the handler processes records at the given
|
||||
// level; it always returns true.
|
||||
func (w *WebhookHandler) Enabled(_ context.Context, _ slog.Level) bool {
|
||||
func (w *WebhookHandler) Enabled(ctx context.Context, level slog.Level) bool {
|
||||
return true
|
||||
}
|
||||
|
||||
// WithAttrs returns a new handler that also emits attrs, qualified by the
|
||||
// groups open now. The receiver is not modified.
|
||||
func (w *WebhookHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
|
||||
if len(attrs) == 0 {
|
||||
return w
|
||||
}
|
||||
|
||||
return &WebhookHandler{
|
||||
webhookURL: w.webhookURL,
|
||||
attrs: w.attrs.withAttrs(attrs),
|
||||
}
|
||||
}
|
||||
|
||||
// WithGroup returns a new handler that nests later attributes in an
|
||||
// object named after the group. An empty name returns the receiver.
|
||||
func (w *WebhookHandler) WithGroup(name string) slog.Handler {
|
||||
if name == "" {
|
||||
return w
|
||||
}
|
||||
|
||||
return &WebhookHandler{
|
||||
webhookURL: w.webhookURL,
|
||||
attrs: w.attrs.withGroup(name),
|
||||
}
|
||||
}
|
||||
|
||||
// Handle marshals the record, with its attributes, to one JSON object and
|
||||
// POSTs it to the webhook URL.
|
||||
func NewWebhookHandler(webhookURL string) (*WebhookHandler, error) {
|
||||
if _, err := url.ParseRequestURI(webhookURL); err != nil {
|
||||
return nil, fmt.Errorf("invalid webhook URL: %v", err)
|
||||
}
|
||||
return &WebhookHandler{webhookURL: webhookURL}, nil
|
||||
}
|
||||
|
||||
func (w *WebhookHandler) Handle(ctx context.Context, record slog.Record) error {
|
||||
jsonData, err := json.Marshal(recordToMap(record, w.attrs))
|
||||
if err != nil {
|
||||
return fmt.Errorf("error marshaling event: %w", err)
|
||||
return fmt.Errorf("error marshaling event: %v", err)
|
||||
}
|
||||
|
||||
request, err := http.NewRequestWithContext(
|
||||
ctx,
|
||||
http.MethodPost,
|
||||
w.webhookURL,
|
||||
bytes.NewReader(jsonData),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("error creating webhook request: %w", err)
|
||||
}
|
||||
|
||||
request.Header.Set("Content-Type", "application/json")
|
||||
|
||||
response, err := http.DefaultClient.Do(request)
|
||||
response, err := http.Post(w.webhookURL, "application/json", bytes.NewBuffer(jsonData))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
defer func() { _ = response.Body.Close() }()
|
||||
|
||||
defer response.Body.Close()
|
||||
return nil
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user