Route embedded NATS server logs through Coder's slog logger by installing a `natsserver.Logger` adapter with `SetLoggerV2` before starting the server. Add coverage for severity mapping, formatting, startup logging, and debug filtering, and allow expected NATS errors in the existing failure-path and teardown tests. Refs GRU-98. <details> <summary>Implementation decisions</summary> - Preserve the caller's logger fields and add the `server` logger name. - Let slog filter debug output; leave protocol and system-account tracing disabled to avoid logging message payloads. - Map NATS fatal messages to slog `Critical` so adding logging does not introduce process termination. - Restrict test log allowances to the embedded server's expected errors rather than ignoring all error logs. </details> Generated by Coder Agents on behalf of @spikecurtis.
71 lines
2.2 KiB
Go
71 lines
2.2 KiB
Go
package nats
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"cdr.dev/slog/v3"
|
|
"github.com/coder/coder/v2/testutil"
|
|
)
|
|
|
|
func TestServerLogger(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
for _, tc := range []struct {
|
|
name string
|
|
log func(serverLogger, string, ...any)
|
|
level slog.Level
|
|
}{
|
|
{name: "Notice", log: serverLogger.Noticef, level: slog.LevelInfo},
|
|
{name: "Warn", log: serverLogger.Warnf, level: slog.LevelWarn},
|
|
{name: "Fatal", log: serverLogger.Fatalf, level: slog.LevelCritical},
|
|
{name: "Error", log: serverLogger.Errorf, level: slog.LevelError},
|
|
{name: "Debug", log: serverLogger.Debugf, level: slog.LevelDebug},
|
|
{name: "Trace", log: serverLogger.Tracef, level: slog.LevelDebug},
|
|
} {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
sink := testutil.NewFakeSink(t)
|
|
logger := serverLogger{logger: sink.Logger().Named("nats").With(slog.F("replica", "test"))}
|
|
tc.log(logger, "connection %s: %d pending", "client", 42)
|
|
|
|
entries := sink.Entries()
|
|
require.Len(t, entries, 1)
|
|
require.Equal(t, tc.level, entries[0].Level)
|
|
require.Equal(t, "connection client: 42 pending", entries[0].Message)
|
|
require.Equal(t, []string{"nats"}, entries[0].LoggerNames)
|
|
require.Equal(t, slog.Map{slog.F("replica", "test")}, entries[0].Fields)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestEmbeddedServerLogging(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
sink := testutil.NewFakeSink(t)
|
|
ps, err := New(t.Context(), sink.Logger(slog.LevelDebug).Named("nats"), defaultTestOptions())
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() { _ = ps.Close() })
|
|
|
|
startup := sink.Entries(func(e slog.SinkEntry) bool {
|
|
return e.Message == "Starting nats-server"
|
|
})
|
|
require.Len(t, startup, 1, "logger must be installed before the server starts")
|
|
require.Equal(t, slog.LevelDebug, startup[0].Level)
|
|
require.Equal(t, []string{"nats", "server"}, startup[0].LoggerNames)
|
|
|
|
ps.Server.Debugf("debug %s", "message")
|
|
debug := sink.Entries(func(e slog.SinkEntry) bool {
|
|
return e.Message == "debug message"
|
|
})
|
|
|
|
require.Len(t, debug, 1)
|
|
|
|
ps.Server.Tracef("trace %s", "payload")
|
|
require.Empty(t, sink.Entries(func(e slog.SinkEntry) bool {
|
|
return e.Message == "trace payload"
|
|
}), "protocol tracing must remain disabled")
|
|
}
|