mirror of
https://github.com/coder/coder.git
synced 2026-06-03 13:08:25 +00:00
Spike Curtis
bddb808b25
Fixes all our Go file imports to match the preferred spec that we've _mostly_ been using. For example: ``` import ( "context" "time" "github.com/prometheus/client_golang/prometheus" "golang.org/x/xerrors" "gopkg.in/natefinch/lumberjack.v2" "cdr.dev/slog/v3" "github.com/coder/coder/v2/codersdk/agentsdk" "github.com/coder/serpent" ) ``` 3 groups: standard library, 3rd partly libs, Coder libs. This PR makes the change across the codebase. The PR in the stack above modifies our formatting to maintain this state of affairs, and is a separate PR so it's possible to review that one in detail.
103 lines
2.6 KiB
Go
103 lines
2.6 KiB
Go
package tracing_test
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"sync/atomic"
|
|
"testing"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
"github.com/stretchr/testify/require"
|
|
"go.opentelemetry.io/otel/trace"
|
|
"go.opentelemetry.io/otel/trace/noop"
|
|
|
|
"github.com/coder/coder/v2/coderd/tracing"
|
|
"github.com/coder/coder/v2/testutil"
|
|
)
|
|
|
|
// noopTracer is just an alias because the fakeTracer implements a method
|
|
// with the same name 'Tracer'. Kinda dumb, but this is a workaround.
|
|
type noopTracer = noop.Tracer
|
|
|
|
type fakeTracer struct {
|
|
noop.TracerProvider
|
|
noopTracer
|
|
startCalled int64
|
|
}
|
|
|
|
var (
|
|
_ trace.TracerProvider = &fakeTracer{}
|
|
_ trace.Tracer = &fakeTracer{}
|
|
)
|
|
|
|
// Tracer implements trace.TracerProvider.
|
|
func (f *fakeTracer) Tracer(_ string, _ ...trace.TracerOption) trace.Tracer {
|
|
return f
|
|
}
|
|
|
|
// Start implements trace.Tracer.
|
|
func (f *fakeTracer) Start(ctx context.Context, _ string, _ ...trace.SpanStartOption) (context.Context, trace.Span) {
|
|
atomic.AddInt64(&f.startCalled, 1)
|
|
return ctx, tracing.NoopSpan
|
|
}
|
|
|
|
func Test_Middleware(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
t.Run("OnlyRunsOnExpectedRoutes", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
cases := []struct {
|
|
path string
|
|
runs bool
|
|
}{
|
|
// Should pass.
|
|
{"/api", true},
|
|
{"/api/v0", true},
|
|
{"/api/v2", true},
|
|
{"/api/v2/workspaces/", true},
|
|
{"/api/v2/workspaces", true},
|
|
{"/@hi/hi/apps/hi", true},
|
|
{"/@hi/hi/apps/hi/hi", true},
|
|
{"/@hi/hi/apps/hi/hi", true},
|
|
{"/%40hi/hi/apps/hi", true},
|
|
{"/%40hi/hi/apps/hi/hi", true},
|
|
{"/%40hi/hi/apps/hi/hi", true},
|
|
{"/external-auth/hi/callback", true},
|
|
|
|
// Other routes that should not be collected.
|
|
{"/index.html", false},
|
|
{"/static/coder_linux_amd64", false},
|
|
{"/workspaces", false},
|
|
{"/templates", false},
|
|
{"/@hi/hi/terminal", false},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
name := strings.ReplaceAll(strings.TrimPrefix(c.path, "/"), "/", "_")
|
|
t.Run(name, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
fake := &fakeTracer{}
|
|
|
|
rw := &tracing.StatusWriter{ResponseWriter: httptest.NewRecorder()}
|
|
r := httptest.NewRequest("GET", c.path, nil)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitLong)
|
|
defer cancel()
|
|
ctx = context.WithValue(ctx, chi.RouteCtxKey, chi.NewRouteContext())
|
|
r = r.WithContext(ctx)
|
|
|
|
tracing.Middleware(fake)(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
|
|
rw.WriteHeader(http.StatusNoContent)
|
|
})).ServeHTTP(rw, r)
|
|
|
|
didRun := atomic.LoadInt64(&fake.startCalled) == 1
|
|
require.Equal(t, c.runs, didRun, "expected middleware to run/not run")
|
|
})
|
|
}
|
|
})
|
|
}
|