Skip to content

Commit 1cfdd0d

Browse files
committed
extracted loggermw to a separate package
1 parent 66799a6 commit 1cfdd0d

File tree

13 files changed

+29
-24
lines changed

13 files changed

+29
-24
lines changed

Makefile

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ GEN_FILES := \
582582
coderd/database/pubsub/psmock/psmock.go \
583583
agent/agentcontainers/acmock/acmock.go \
584584
agent/agentcontainers/dcspec/dcspec_gen.go \
585-
coderd/httpmw/loggermock/loggermock.go
585+
coderd/httpmw/logger/loggermock/loggermock.go
586586

587587
# all gen targets should be added here and to gen/mark-fresh
588588
gen: gen/db gen/golden-files $(GEN_FILES)
@@ -631,8 +631,7 @@ gen/mark-fresh:
631631
coderd/database/pubsub/psmock/psmock.go \
632632
agent/agentcontainers/acmock/acmock.go \
633633
agent/agentcontainers/dcspec/dcspec_gen.go \
634-
coderd/httpmw/loggermock/loggermock.go \
635-
"
634+
coderd/httpmw/logger/loggermock/loggermock.go
636635

637636
for file in $$files; do
638637
echo "$$file"
@@ -671,8 +670,8 @@ agent/agentcontainers/acmock/acmock.go: agent/agentcontainers/containers.go
671670
go generate ./agent/agentcontainers/acmock/
672671
touch "$@"
673672

674-
coderd/httpmw/loggermock/loggermock.go: coderd/httpmw/logger.go
675-
go generate ./coderd/httpmw/loggermock/
673+
coderd/httpmw/logger/loggermock/loggermock.go: coderd/httpmw/logger/logger.go
674+
go generate ./coderd/httpmw/logger/loggermock/
676675
touch "$@"
677676

678677
agent/agentcontainers/dcspec/dcspec_gen.go: \

coderd/coderd.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ import (
6464
"github.com/coder/coder/v2/coderd/healthcheck/derphealth"
6565
"github.com/coder/coder/v2/coderd/httpapi"
6666
"github.com/coder/coder/v2/coderd/httpmw"
67+
loggermw "github.com/coder/coder/v2/coderd/httpmw/logger"
6768
"github.com/coder/coder/v2/coderd/metricscache"
6869
"github.com/coder/coder/v2/coderd/notifications"
6970
"github.com/coder/coder/v2/coderd/portsharing"
@@ -799,7 +800,7 @@ func New(options *Options) *API {
799800
tracing.Middleware(api.TracerProvider),
800801
httpmw.AttachRequestID,
801802
httpmw.ExtractRealIP(api.RealIPConfig),
802-
httpmw.Logger(api.Logger),
803+
loggermw.Logger(api.Logger),
803804
singleSlashMW,
804805
rolestore.CustomRoleMW,
805806
prometheusMW,

coderd/database/dbmem/dbmem.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4241,7 +4241,7 @@ func (q *FakeQuerier) GetPresetByID(ctx context.Context, presetID uuid.UUID) (da
42414241
if preset.ID == presetID {
42424242
tv, ok := versionMap[preset.TemplateVersionID]
42434243
if !ok {
4244-
return empty, fmt.Errorf("template version %v does not exist", preset.TemplateVersionID)
4244+
return empty, xerrors.Errorf("template version %v does not exist", preset.TemplateVersionID)
42454245
}
42464246
return database.GetPresetByIDRow{
42474247
ID: preset.ID,
@@ -4256,7 +4256,7 @@ func (q *FakeQuerier) GetPresetByID(ctx context.Context, presetID uuid.UUID) (da
42564256
}
42574257
}
42584258

4259-
return empty, fmt.Errorf("preset %v does not exist", presetID)
4259+
return empty, xerrors.Errorf("preset %v does not exist", presetID)
42604260
}
42614261

42624262
func (q *FakeQuerier) GetPresetByWorkspaceBuildID(_ context.Context, workspaceBuildID uuid.UUID) (database.TemplateVersionPreset, error) {

coderd/httpmw/logger.go renamed to coderd/httpmw/logger/logger.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package httpmw
1+
package logger
22

33
import (
44
"context"

coderd/httpmw/logger_internal_test.go renamed to coderd/httpmw/logger/logger_internal_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package httpmw
1+
package logger
22

33
import (
44
"context"
@@ -79,7 +79,7 @@ func TestLoggerMiddleware_SingleRequest(t *testing.T) {
7979

8080
require.Equal(t, sink.entries[0].Message, "GET")
8181

82-
fieldsMap := make(map[string]interface{})
82+
fieldsMap := make(map[string]any)
8383
for _, field := range sink.entries[0].Fields {
8484
fieldsMap[field.Name] = field.Value
8585
}

coderd/httpmw/loggermock/loggermock.go renamed to coderd/httpmw/logger/loggermock/loggermock.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/inboxnotifications.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import (
1616
"github.com/coder/coder/v2/coderd/database/dbtime"
1717
"github.com/coder/coder/v2/coderd/httpapi"
1818
"github.com/coder/coder/v2/coderd/httpmw"
19+
loggermw "github.com/coder/coder/v2/coderd/httpmw/logger"
1920
"github.com/coder/coder/v2/coderd/notifications"
2021
"github.com/coder/coder/v2/coderd/pubsub"
2122
markdown "github.com/coder/coder/v2/coderd/render"
@@ -220,7 +221,7 @@ func (api *API) watchInboxNotifications(rw http.ResponseWriter, r *http.Request)
220221
defer encoder.Close(websocket.StatusNormalClosure)
221222

222223
// Log the request immediately instead of after it completes.
223-
httpmw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
224+
loggermw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
224225

225226
for {
226227
select {

coderd/provisionerjobs.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import (
2020
"github.com/coder/coder/v2/coderd/database/pubsub"
2121
"github.com/coder/coder/v2/coderd/httpapi"
2222
"github.com/coder/coder/v2/coderd/httpmw"
23+
loggermw "github.com/coder/coder/v2/coderd/httpmw/logger"
2324
"github.com/coder/coder/v2/coderd/rbac"
2425
"github.com/coder/coder/v2/coderd/rbac/policy"
2526
"github.com/coder/coder/v2/coderd/util/slice"
@@ -555,7 +556,7 @@ func (f *logFollower) follow() {
555556
}
556557

557558
// Log the request immediately instead of after it completes.
558-
httpmw.RequestLoggerFromContext(f.ctx).WriteLog(f.ctx, http.StatusAccepted)
559+
loggermw.RequestLoggerFromContext(f.ctx).WriteLog(f.ctx, http.StatusAccepted)
559560

560561
// no need to wait if the job is done
561562
if f.complete {

coderd/provisionerjobs_internal_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ import (
1919
"github.com/coder/coder/v2/coderd/database/dbmock"
2020
"github.com/coder/coder/v2/coderd/database/dbtime"
2121
"github.com/coder/coder/v2/coderd/database/pubsub"
22-
"github.com/coder/coder/v2/coderd/httpmw"
23-
"github.com/coder/coder/v2/coderd/httpmw/loggermock"
22+
loggermw "github.com/coder/coder/v2/coderd/httpmw/logger"
23+
"github.com/coder/coder/v2/coderd/httpmw/logger/loggermock"
2424
"github.com/coder/coder/v2/codersdk"
2525
"github.com/coder/coder/v2/provisionersdk"
2626
"github.com/coder/coder/v2/testutil"
@@ -309,7 +309,7 @@ func Test_logFollower_EndOfLogs(t *testing.T) {
309309

310310
mockLogger := loggermock.NewMockRequestLogger(ctrl)
311311
mockLogger.EXPECT().WriteLog(gomock.Any(), http.StatusAccepted).Times(1)
312-
ctx = httpmw.WithRequestLogger(ctx, mockLogger)
312+
ctx = loggermw.WithRequestLogger(ctx, mockLogger)
313313

314314
// we need an HTTP server to get a websocket
315315
srv := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {

coderd/workspaceagents.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import (
3333
"github.com/coder/coder/v2/coderd/externalauth"
3434
"github.com/coder/coder/v2/coderd/httpapi"
3535
"github.com/coder/coder/v2/coderd/httpmw"
36+
loggermw "github.com/coder/coder/v2/coderd/httpmw/logger"
3637
"github.com/coder/coder/v2/coderd/jwtutils"
3738
"github.com/coder/coder/v2/coderd/rbac"
3839
"github.com/coder/coder/v2/coderd/rbac/policy"
@@ -556,7 +557,7 @@ func (api *API) workspaceAgentLogs(rw http.ResponseWriter, r *http.Request) {
556557
defer t.Stop()
557558

558559
// Log the request immediately instead of after it completes.
559-
httpmw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
560+
loggermw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
560561

561562
go func() {
562563
defer func() {
@@ -932,7 +933,7 @@ func (api *API) derpMapUpdates(rw http.ResponseWriter, r *http.Request) {
932933
defer encoder.Close(websocket.StatusGoingAway)
933934

934935
// Log the request immediately instead of after it completes.
935-
httpmw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
936+
loggermw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
936937

937938
go func(ctx context.Context) {
938939
// TODO(mafredri): Is this too frequent? Use separate ping disconnect timeout?
@@ -1322,7 +1323,7 @@ func (api *API) watchWorkspaceAgentMetadata(
13221323
defer sendTicker.Stop()
13231324

13241325
// Log the request immediately instead of after it completes.
1325-
httpmw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
1326+
loggermw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
13261327

13271328
// Send initial metadata.
13281329
sendMetadata()

enterprise/coderd/provisionerdaemons.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import (
2424
"github.com/coder/coder/v2/coderd/database/dbtime"
2525
"github.com/coder/coder/v2/coderd/httpapi"
2626
"github.com/coder/coder/v2/coderd/httpmw"
27+
loggermw "github.com/coder/coder/v2/coderd/httpmw/logger"
2728
"github.com/coder/coder/v2/coderd/provisionerdserver"
2829
"github.com/coder/coder/v2/coderd/rbac"
2930
"github.com/coder/coder/v2/coderd/rbac/policy"
@@ -378,7 +379,7 @@ func (api *API) provisionerDaemonServe(rw http.ResponseWriter, r *http.Request)
378379
})
379380

380381
// Log the request immediately instead of after it completes.
381-
httpmw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
382+
loggermw.RequestLoggerFromContext(ctx).WriteLog(ctx, http.StatusAccepted)
382383

383384
err = server.Serve(ctx, session)
384385
srvCancel()

enterprise/wsproxy/wsproxy.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ import (
3232
"github.com/coder/coder/v2/coderd/cryptokeys"
3333
"github.com/coder/coder/v2/coderd/httpapi"
3434
"github.com/coder/coder/v2/coderd/httpmw"
35+
loggermw "github.com/coder/coder/v2/coderd/httpmw/logger"
3536
"github.com/coder/coder/v2/coderd/tracing"
3637
"github.com/coder/coder/v2/coderd/workspaceapps"
3738
"github.com/coder/coder/v2/codersdk"
@@ -336,7 +337,7 @@ func New(ctx context.Context, opts *Options) (*Server, error) {
336337
tracing.Middleware(s.TracerProvider),
337338
httpmw.AttachRequestID,
338339
httpmw.ExtractRealIP(s.Options.RealIPConfig),
339-
httpmw.Logger(s.Logger),
340+
loggermw.Logger(s.Logger),
340341
prometheusMW,
341342
corsMW,
342343

tailnet/test/integration/integration.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import (
3333

3434
"cdr.dev/slog"
3535
"github.com/coder/coder/v2/coderd/httpapi"
36-
"github.com/coder/coder/v2/coderd/httpmw"
36+
loggermw "github.com/coder/coder/v2/coderd/httpmw/logger"
3737
"github.com/coder/coder/v2/coderd/tracing"
3838
"github.com/coder/coder/v2/codersdk"
3939
"github.com/coder/coder/v2/tailnet"
@@ -200,7 +200,7 @@ func (o SimpleServerOptions) Router(t *testing.T, logger slog.Logger) *chi.Mux {
200200
})
201201
},
202202
tracing.StatusWriterMiddleware,
203-
httpmw.Logger(logger),
203+
loggermw.Logger(logger),
204204
)
205205

206206
r.Route("/derp", func(r chi.Router) {

0 commit comments

Comments
 (0)