mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
Spike Curtis
49b34a716a
Upgrades to slog v3 which includes a small, but backward incompatible API change to the acceptible call arguments when logging. This change allows us to verify via compile time type checking that arguments are correct and won't cause a panic, as was possible in slog v1, which this replaces (v2 was tagged but never used in coder/coder). It also updates dependencies that also use slog and were updated. I've left the `aibridge` dependency as a commit SHA, under the assumption that the team there (cc @pawbana @dannykopping ) will tag and update the dependency soon and on their own schedule. Other dependencies, I pushed new tags.
84 lines
2.1 KiB
Go
84 lines
2.1 KiB
Go
package testutil
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"strings"
|
|
"sync"
|
|
"testing"
|
|
|
|
"github.com/hashicorp/yamux"
|
|
"golang.org/x/xerrors"
|
|
|
|
"cdr.dev/slog/v3"
|
|
"cdr.dev/slog/v3/sloggers/slogtest"
|
|
)
|
|
|
|
// Logger returns a "standard" testing logger, with debug level and common flaky
|
|
// errors ignored.
|
|
func Logger(t testing.TB) slog.Logger {
|
|
return slogtest.Make(
|
|
t, &slogtest.Options{IgnoreErrorFn: IgnoreLoggedError},
|
|
).Leveled(slog.LevelDebug)
|
|
}
|
|
|
|
func IgnoreLoggedError(entry slog.SinkEntry) bool {
|
|
err, ok := slogtest.FindFirstError(entry)
|
|
if !ok {
|
|
return false
|
|
}
|
|
// Yamux sessions get shut down when we are shutting down tests, so ignoring
|
|
// them should reduce flakiness.
|
|
if xerrors.Is(err, yamux.ErrSessionShutdown) {
|
|
return true
|
|
}
|
|
// Canceled queries usually happen when we're shutting down tests, and so
|
|
// ignoring them should reduce flakiness. This also includes
|
|
// context.Canceled and context.DeadlineExceeded errors, even if they are
|
|
// not part of a query.
|
|
return isQueryCanceledError(err)
|
|
}
|
|
|
|
// isQueryCanceledError checks if the error is due to a query being canceled. This reproduces
|
|
// database.IsQueryCanceledError, but is reimplemented here to avoid importing the database package,
|
|
// which would result in import loops. We also use string matching on the error PostgreSQL returns
|
|
// to us, rather than the pq error type, because we don't want testutil, which is imported in lots
|
|
// of places to import lib/pq, which we have our own fork of.
|
|
func isQueryCanceledError(err error) bool {
|
|
if xerrors.Is(err, context.Canceled) || xerrors.Is(err, context.DeadlineExceeded) {
|
|
return true
|
|
}
|
|
if strings.Contains(err.Error(), "canceling statement due to user request") {
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
type testLogWriter struct {
|
|
t testing.TB
|
|
mu sync.Mutex
|
|
testOver bool
|
|
}
|
|
|
|
func NewTestLogWriter(t testing.TB) io.Writer {
|
|
w := &testLogWriter{t: t}
|
|
t.Cleanup(func() {
|
|
w.mu.Lock()
|
|
defer w.mu.Unlock()
|
|
w.testOver = true
|
|
})
|
|
return w
|
|
}
|
|
|
|
func (w *testLogWriter) Write(p []byte) (n int, err error) {
|
|
n = len(p)
|
|
w.mu.Lock()
|
|
defer w.mu.Unlock()
|
|
if w.testOver {
|
|
return n, nil
|
|
}
|
|
w.t.Logf("%q", string(p))
|
|
|
|
return n, nil
|
|
}
|