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

fix: fix slog to always use array of Fields (#21426)

Browse Source 
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.
This commit is contained in:
Spike Curtis
2026-01-08 10:29:41 +04:00
committed by GitHub
parent d1b0722034
commit 49b34a716a
376 changed files with 789 additions and 546 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/database/dbauthz/customroles_test.go
+2 -1
View File
@@ -7,7 +7,8 @@ import (
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/require"
"cdr.dev/slog"
"cdr.dev/slog/v3"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/db2sdk"
coderd/database/dbauthz/dbauthz.go
+1 -2
View File
@@ -15,8 +15,7 @@ import (
"github.com/open-policy-agent/opa/topdown"
"golang.org/x/xerrors"
"cdr.dev/slog"
slog "cdr.dev/slog/v3"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbtime"
"github.com/coder/coder/v2/coderd/httpapi/httpapiconstraints"
coderd/database/dbauthz/dbauthz_test.go
+3 -2
View File
@@ -18,8 +18,9 @@ import (
"go.uber.org/mock/gomock"
"golang.org/x/xerrors"
"cdr.dev/slog"
"cdr.dev/slog/sloggers/slogtest"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/db2sdk"
coderd/database/dbauthz/groupsauth_test.go
+2 -1
View File
@@ -8,7 +8,8 @@ import (
"github.com/prometheus/client_golang/prometheus"
"github.com/stretchr/testify/require"
"cdr.dev/slog/sloggers/slogtest"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbauthz"
coderd/database/dbauthz/setup_test.go
+1 -1
View File
@@ -20,7 +20,7 @@ import (
"go.uber.org/mock/gomock"
"golang.org/x/xerrors"
"cdr.dev/slog"
"cdr.dev/slog/v3"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
coderd/database/dbfake/dbfake.go
+7 -5
View File
@@ -12,8 +12,8 @@ import (
"github.com/sqlc-dev/pqtype"
"github.com/stretchr/testify/require"
"cdr.dev/slog"
"cdr.dev/slog/sloggers/slogtest"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbauthz"
@@ -228,7 +228,7 @@ func (b WorkspaceBuildBuilder) doInTX() WorkspaceResponse {
// If a task was requested, ensure it exists and is associated with this
// workspace.
if b.taskAppID != uuid.Nil {
b.logger.Debug(context.Background(), "creating or updating task", "task_id", b.taskSeed.ID)
b.logger.Debug(context.Background(), "creating or updating task", slog.F("task_id", b.taskSeed.ID))
b.taskSeed.OrganizationID = takeFirst(b.taskSeed.OrganizationID, b.ws.OrganizationID)
b.taskSeed.OwnerID = takeFirst(b.taskSeed.OwnerID, b.ws.OwnerID)
b.taskSeed.Name = takeFirst(b.taskSeed.Name, b.ws.Name)
@@ -238,7 +238,9 @@ func (b WorkspaceBuildBuilder) doInTX() WorkspaceResponse {
// Try to fetch existing task and update its workspace ID.
if task, err := b.db.GetTaskByID(ownerCtx, b.taskSeed.ID); err == nil {
if !task.WorkspaceID.Valid {
b.logger.Info(context.Background(), "updating task workspace id", "task_id", b.taskSeed.ID, "workspace_id", b.ws.ID)
b.logger.Info(context.Background(), "updating task workspace id",
slog.F("task_id", b.taskSeed.ID),
slog.F("workspace_id", b.ws.ID))
_, err = b.db.UpdateTaskWorkspaceID(ownerCtx, database.UpdateTaskWorkspaceIDParams{
ID: b.taskSeed.ID,
WorkspaceID: uuid.NullUUID{UUID: b.ws.ID, Valid: true},
@@ -250,7 +252,7 @@ func (b WorkspaceBuildBuilder) doInTX() WorkspaceResponse {
} else if errors.Is(err, sql.ErrNoRows) {
task := dbgen.Task(b.t, b.db, b.taskSeed)
b.taskSeed.ID = task.ID
b.logger.Info(context.Background(), "created new task", "task_id", b.taskSeed.ID)
b.logger.Info(context.Background(), "created new task", slog.F("task_id", b.taskSeed.ID))
} else {
require.NoError(b.t, err, "get task by id")
}
coderd/database/dbgen/dbgen.go
+1 -1
View File
@@ -14,7 +14,7 @@ import (
"testing"
"time"
"cdr.dev/slog"
"cdr.dev/slog/v3"
"github.com/google/uuid"
"github.com/sqlc-dev/pqtype"
coderd/database/dbmetrics/dbmetrics.go
+2 -1
View File
@@ -8,7 +8,8 @@ import (
"github.com/prometheus/client_golang/prometheus"
"cdr.dev/slog"
"cdr.dev/slog/v3"
"github.com/coder/coder/v2/coderd/database"
)
coderd/database/dbmetrics/dbmetrics_test.go
+3 -2
View File
@@ -8,8 +8,9 @@ import (
"github.com/stretchr/testify/require"
"golang.org/x/xerrors"
"cdr.dev/slog"
"cdr.dev/slog/sloggers/sloghuman"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/sloghuman"
"github.com/coder/coder/v2/coderd/coderdtest/promhelp"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbmetrics"
coderd/database/dbmetrics/querymetrics.go
+5 -2
View File
@@ -11,8 +11,11 @@ import (
"github.com/google/uuid"
"github.com/prometheus/client_golang/prometheus"
"cdr.dev/slog"
// the redundant alias `slog` works around the fact that github.com/dave/dst is bugged and doesn't correctly resolve
// the package name. We use github.com/dave/dst in scripts/dbgen/ to generate new stubs for database.Store methods.
// Without this workaround, dbgen will drop and re-add slog, possibly resolving to a different version (e.g. v1).
// It can also result in the imports being sorted incorrectly.
slog "cdr.dev/slog/v3"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/rbac"
"github.com/coder/coder/v2/coderd/rbac/policy"
coderd/database/dbpurge/dbpurge.go
+1 -1
View File
@@ -9,7 +9,7 @@ import (
"github.com/prometheus/client_golang/prometheus"
"cdr.dev/slog"
"cdr.dev/slog/v3"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbauthz"
coderd/database/dbpurge/dbpurge_test.go
+2 -2
View File
@@ -19,8 +19,8 @@ import (
"go.uber.org/mock/gomock"
"golang.org/x/xerrors"
"cdr.dev/slog"
"cdr.dev/slog/sloggers/slogtest"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/coderdtest/promhelp"
coderd/database/dbrollup/dbrollup.go
+1 -1
View File
@@ -7,7 +7,7 @@ import (
"golang.org/x/sync/errgroup"
"cdr.dev/slog"
"cdr.dev/slog/v3"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbauthz"
coderd/database/dbrollup/dbrollup_test.go
+2 -2
View File
@@ -10,8 +10,8 @@ import (
"github.com/stretchr/testify/require"
"go.uber.org/goleak"
"cdr.dev/slog"
"cdr.dev/slog/sloggers/slogtest"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbgen"
coderd/database/dbtestutil/cleaner.go
+3 -2
View File
@@ -13,8 +13,9 @@ import (
"github.com/google/uuid"
"golang.org/x/xerrors"
"cdr.dev/slog"
"cdr.dev/slog/sloggers/sloghuman"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/sloghuman"
"github.com/coder/retry"
)
coderd/database/dbtestutil/db.go
+2 -1
View File
@@ -17,7 +17,8 @@ import (
"github.com/stretchr/testify/require"
"golang.org/x/xerrors"
"cdr.dev/slog"
"cdr.dev/slog/v3"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/pubsub"
"github.com/coder/coder/v2/testutil"
coderd/database/pubsub/latency.go
+1 -1
View File
@@ -9,7 +9,7 @@ import (
"github.com/google/uuid"
"golang.org/x/xerrors"
"cdr.dev/slog"
"cdr.dev/slog/v3"
)
// LatencyMeasurer is used to measure the send & receive latencies of the underlying Pubsub implementation. We use these
coderd/database/pubsub/pubsub.go
+1 -1
View File
@@ -17,7 +17,7 @@ import (
"github.com/coder/coder/v2/coderd/database"
"cdr.dev/slog"
"cdr.dev/slog/v3"
)
// Listener represents a pubsub handler.
coderd/database/pubsub/pubsub_linux_test.go
+4 -3
View File
@@ -15,9 +15,10 @@ import (
"go.uber.org/mock/gomock"
"golang.org/x/xerrors"
"cdr.dev/slog"
"cdr.dev/slog/sloggers/sloghuman"
"cdr.dev/slog/sloggers/slogtest"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/sloghuman"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/database/dbtestutil"
"github.com/coder/coder/v2/coderd/database/pubsub"
"github.com/coder/coder/v2/coderd/database/pubsub/psmock"
coderd/database/pubsub/pubsub_test.go
+3 -2
View File
@@ -10,8 +10,9 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"cdr.dev/slog"
"cdr.dev/slog/sloggers/slogtest"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/database/dbtestutil"
"github.com/coder/coder/v2/coderd/database/pubsub"
"github.com/coder/coder/v2/testutil"
coderd/database/pubsub/watchdog.go
+2 -1
View File
@@ -7,7 +7,8 @@ import (
"sync"
"time"
"cdr.dev/slog"
"cdr.dev/slog/v3"
"github.com/coder/quartz"
)
coderd/database/pubsub/watchdog_test.go
+3 -2
View File
@@ -6,8 +6,9 @@ import (
"github.com/stretchr/testify/require"
"cdr.dev/slog"
"cdr.dev/slog/sloggers/slogtest"
"cdr.dev/slog/v3"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/database/pubsub"
"github.com/coder/coder/v2/testutil"
"github.com/coder/quartz"
coderd/database/querier_test.go
+2 -1
View File
@@ -18,7 +18,8 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"cdr.dev/slog/sloggers/slogtest"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/coderdtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/db2sdk"