Gabriel Radureau
189d44d70f
Follow-up to PR #48 after user question on whether mutex/atomic would be a cleaner fix than removing the log call. Honest answer: the racing memory location is zerolog's global gLevel, which IS already mutated atomically by zerolog itself. The race detector flags it because LoadConfig → SetupLogging writes gLevel via zerolog.SetGlobalLevel and a leaked watcher goroutine reads gLevel via log.Info() — both atomic individually, but go test -race treats the write/read pair as a happens-before violation across goroutine boundaries when there's no synchronization between them. A mutex on Config would not help: the shared state isn't on Config, it's on zerolog's package-level global. atomic.Pointer wouldn't help for the same reason. Combined fix: 1. Keep the log-removal (PR #48) — it's the actual race source: our cancel-handler goroutine's log.Info("watcher stopped") was the reading party. Add a longer comment explaining WHY it's gone. 2. Add pkg/config/main_test.go with TestMain that disables zerolog globally during the test suite. Defense in depth: any FUTURE leaked log call from a watcher-related goroutine won't trigger a race either, because no log call evaluates against the level. Production behavior unchanged. SetupLogging in production runs once at startup before any goroutine could race with it. go test -race -count=2 ./pkg/config/... passes (was failing).
27 lines
953 B
Go
27 lines
953 B
Go
package config
|
|
|
|
import (
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/rs/zerolog"
|
|
)
|
|
|
|
// TestMain quiets the global zerolog level for the duration of the test
|
|
// suite. Rationale (Q-038, 2026-05-05): viper's internal watcher goroutine
|
|
// (started by viper.WatchConfig in WatchAndApply) has no public Stop and
|
|
// can outlive a test's context. Any log call from a leaked goroutine
|
|
// races with the next test's LoadConfig → SetupLogging →
|
|
// zerolog.SetGlobalLevel under `go test -race`. Disabling the logger here
|
|
// is the root-cause fix: the racing memory location is zerolog's gLevel
|
|
// global, and if no log call ever evaluates against it we sidestep the
|
|
// race entirely without changing production behavior.
|
|
//
|
|
// In production, log calls happen against an unchanging global level
|
|
// (SetupLogging runs once at startup), so the race condition does not
|
|
// occur there.
|
|
func TestMain(m *testing.M) {
|
|
zerolog.SetGlobalLevel(zerolog.Disabled)
|
|
os.Exit(m.Run())
|
|
}
|