opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: extract testutil.FakeSink for slog test assertions (#23208)

Browse Source 
Follow-up to [review comment on
#23025](https://github.com/coder/coder/pull/23025#discussion_r2930309487)
from @mafredri.

Extracts the repeated `logSink` / `fakeSink` test pattern into a shared
`testutil.FakeSink` and migrates all existing call sites.

> 🤖 This PR was created with the help of Coder Agents, and will be
reviewed by my human. 🧑‍💻

---------

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Cian Johnston
2026-03-18 17:02:38 +00:00
committed by GitHub
co-authored by Copilot Autofix powered by AI
parent 2577d16af2
commit 65b7658568
6 changed files with 314 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/httpmw/loggermw/logger_internal_test.go
+44 -57
View File
@@ -26,9 +26,8 @@ func TestRequestLogger_WriteLog(t *testing.T) {
t.Parallel()
ctx := context.Background()
sink := &fakeSink{}
logger := slog.Make(sink)
logger = logger.Leveled(slog.LevelDebug)
sink := testutil.NewFakeSink(t)
logger := sink.Logger()
logCtx := NewRequestLogger(logger, "GET", time.Now())
// Add custom fields
@@ -39,24 +38,25 @@ func TestRequestLogger_WriteLog(t *testing.T) {
// Write log for 200 status
logCtx.WriteLog(ctx, http.StatusOK)
require.Len(t, sink.entries, 1, "log was written twice")
entries := sink.Entries()
require.Len(t, entries, 1, "log was written twice")
require.Equal(t, sink.entries[0].Message, "GET")
require.Equal(t, entries[0].Message, "GET")
require.Equal(t, sink.entries[0].Fields[0].Value, "custom_value")
require.Equal(t, entries[0].Fields[0].Value, "custom_value")
// Attempt to write again (should be skipped).
logCtx.WriteLog(ctx, http.StatusInternalServerError)
require.Len(t, sink.entries, 1, "log was written twice")
entries = sink.Entries()
require.Len(t, entries, 1, "log was written twice")
}
func TestLoggerMiddleware_SingleRequest(t *testing.T) {
t.Parallel()
sink := &fakeSink{}
logger := slog.Make(sink)
logger = logger.Leveled(slog.LevelDebug)
sink := testutil.NewFakeSink(t)
logger := sink.Logger()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
defer cancel()
@@ -80,12 +80,13 @@ func TestLoggerMiddleware_SingleRequest(t *testing.T) {
// Serve the request
wrappedHandler.ServeHTTP(sw, req)
require.Len(t, sink.entries, 1, "log was written twice")
entries := sink.Entries()
require.Len(t, entries, 1, "log was written twice")
require.Equal(t, sink.entries[0].Message, "GET")
require.Equal(t, entries[0].Message, "GET")
fieldsMap := make(map[string]any)
for _, field := range sink.entries[0].Fields {
for _, field := range entries[0].Fields {
fieldsMap[field.Name] = field.Value
}
@@ -96,7 +97,7 @@ func TestLoggerMiddleware_SingleRequest(t *testing.T) {
require.True(t, exists, "field %q is missing in log fields", field)
}
require.Len(t, sink.entries[0].Fields, len(requiredFields), "log should contain only the required fields")
require.Len(t, entries[0].Fields, len(requiredFields), "log should contain only the required fields")
// Check value of the status code
require.Equal(t, fieldsMap["status_code"], http.StatusOK)
@@ -107,12 +108,10 @@ func TestLoggerMiddleware_WebSocket(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
defer cancel()
sink := &fakeSink{
newEntries: make(chan slog.SinkEntry, 2),
}
logger := slog.Make(sink)
logger = logger.Leveled(slog.LevelDebug)
sink := testutil.NewFakeSink(t)
logger := sink.Logger()
done := make(chan struct{})
logged := make(chan struct{})
wg := sync.WaitGroup{}
// Create a test handler to simulate a WebSocket connection
testHandler := http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
@@ -124,6 +123,7 @@ func TestLoggerMiddleware_WebSocket(t *testing.T) {
requestLgr := RequestLoggerFromContext(r.Context())
requestLgr.WriteLog(r.Context(), http.StatusSwitchingProtocols)
close(logged)
// Block so we can be sure the end of the middleware isn't being called.
wg.Wait()
})
@@ -147,9 +147,11 @@ func TestLoggerMiddleware_WebSocket(t *testing.T) {
require.NoError(t, err, "failed to dial WebSocket")
defer conn.Close(websocket.StatusNormalClosure, "")
// Wait for the log from within the handler
newEntry := testutil.TryReceive(ctx, t, sink.newEntries)
require.Equal(t, newEntry.Message, "GET")
// Wait for the log from within the handler.
_ = testutil.TryReceive(ctx, t, logged)
entries := sink.Entries()
require.Len(t, entries, 1, "expected exactly one log entry after WriteLog")
require.Equal(t, entries[0].Message, "GET")
// Signal the websocket handler to return (and read to handle the close frame)
wg.Done()
@@ -158,15 +160,15 @@ func TestLoggerMiddleware_WebSocket(t *testing.T) {
// Wait for the request to finish completely and verify we only logged once
_ = testutil.TryReceive(ctx, t, done)
require.Len(t, sink.entries, 1, "log was written twice")
entries = sink.Entries()
require.Len(t, entries, 1, "log was written twice")
}
func TestRequestLogger_HTTPRouteParams(t *testing.T) {
t.Parallel()
sink := &fakeSink{}
logger := slog.Make(sink)
logger = logger.Leveled(slog.LevelDebug)
sink := testutil.NewFakeSink(t)
logger := sink.Logger()
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
defer cancel()
@@ -196,8 +198,10 @@ func TestRequestLogger_HTTPRouteParams(t *testing.T) {
// Serve the request
wrappedHandler.ServeHTTP(sw, req)
entries := sink.Entries()
require.Len(t, entries, 1, "expected exactly one log entry")
fieldsMap := make(map[string]any)
for _, field := range sink.entries[0].Fields {
for _, field := range entries[0].Fields {
fieldsMap[field.Name] = field.Value
}
@@ -252,9 +256,8 @@ func TestRequestLogger_RouteParamsLogging(t *testing.T) {
t.Run(tt.name, func(t *testing.T) {
t.Parallel()
sink := &fakeSink{}
logger := slog.Make(sink)
logger = logger.Leveled(slog.LevelDebug)
sink := testutil.NewFakeSink(t)
logger := sink.Logger()
// Create a route context with the test parameters
chiCtx := chi.NewRouteContext()
@@ -268,11 +271,12 @@ func TestRequestLogger_RouteParamsLogging(t *testing.T) {
// Write the log
logCtx.WriteLog(ctx, http.StatusOK)
require.Len(t, sink.entries, 1, "expected exactly one log entry")
entries := sink.Entries()
require.Len(t, entries, 1, "expected exactly one log entry")
// Convert fields to map for easier checking
fieldsMap := make(map[string]any)
for _, field := range sink.entries[0].Fields {
for _, field := range entries[0].Fields {
fieldsMap[field.Name] = field.Value
}
@@ -368,9 +372,8 @@ func TestRequestLogger_AuthContext(t *testing.T) {
t.Parallel()
ctx := context.Background()
sink := &fakeSink{}
logger := slog.Make(sink)
logger = logger.Leveled(slog.LevelDebug)
sink := testutil.NewFakeSink(t)
logger := sink.Logger()
logCtx := NewRequestLogger(logger, "GET", time.Now())
logCtx.WithAuthContext(rbac.Subject{
@@ -382,26 +385,10 @@ func TestRequestLogger_AuthContext(t *testing.T) {
logCtx.WriteLog(ctx, http.StatusOK)
require.Len(t, sink.entries, 1, "log was written twice")
require.Equal(t, sink.entries[0].Message, "GET")
require.Equal(t, sink.entries[0].Fields[0].Value, "test-user-id")
require.Equal(t, sink.entries[0].Fields[1].Value, "test name")
require.Equal(t, sink.entries[0].Fields[2].Value, "test@coder.com")
entries := sink.Entries()
require.Len(t, entries, 1, "log was written twice")
require.Equal(t, entries[0].Message, "GET")
require.Equal(t, entries[0].Fields[0].Value, "test-user-id")
require.Equal(t, entries[0].Fields[1].Value, "test name")
require.Equal(t, entries[0].Fields[2].Value, "test@coder.com")
}
type fakeSink struct {
entries []slog.SinkEntry
newEntries chan slog.SinkEntry
}
func (s *fakeSink) LogEntry(_ context.Context, e slog.SinkEntry) {
s.entries = append(s.entries, e)
if s.newEntries != nil {
select {
case s.newEntries <- e:
default:
}
}
}
func (*fakeSink) Sync() {}