8000 feat(coderd): add provisioner_daemons to /debug/health endpoint by johnstcn · Pull Request #11393 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

feat(coderd): add provisioner_daemons to /debug/health endpoint #11393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Jan 8, 2024
Merged

feat(coderd): add provisioner_daemons to /debug/health endpoint #11393

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
ffe19ea
WIP: add version healthcheck for provisioner daemons
johnstcn Jan 3, 2024
764e5ae
fix unit tests
johnstcn Jan 4, 2024
8a7c555
implement provisioner daemon healthcheck
johnstcn Jan 4, 2024
23b7869
wire up provisioner daemons healthcheck
johnstcn Jan 4, 2024
1c449eb
do not ts generate ProvisionerDaemonsReportOptions
johnstcn Jan 4, 2024
a9978e7
typescript fixings
johnstcn Jan 4, 2024
6131b6b
hack once again for apitypings
johnstcn Jan 4, 2024
a785764
make gen lint fmt
johnstcn Jan 4, 2024
e191f14
fix after rebase
johnstcn Jan 5, 2024
a002fc1
make fmt
johnstcn Jan 5, 2024
fa67370
only check provisioner major api version mismatch
johnstcn Jan 5, 2024
eefdfc9
move convertProvisionerDaemon to db2sdk
johnstcn Jan 5, 2024
a61d348
use store instead of fn
johnstcn Jan 5, 2024
c2361cd
rename ProvisionerDaemonsReportOptions -> ProvisionerDaemonsReportDeps
johnstcn Jan 5, 2024
2675615
appease linter
johnstcn Jan 5, 2024
1fb49ac
better handle stale daemons
johnstcn Jan 5, 2024
2159ac6
address comment about named return values
johnstcn Jan 5, 2024
19e896a
address PR comments
johnstcn Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
use store instead of fn
  • Loading branch information
@johnstcn
johnstcn committed Jan 8, 2024
commit a61d34835959855fe0ae7d449a3e36b06f0d98c0
10 changes: 5 additions & 5 deletions coderd/coderd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,11 +441,11 @@ func New(options *Options) *API {
WorkspaceProxiesFetchUpdater: *(options.WorkspaceProxiesFetchUpdater).Load(),
},
ProvisionerDaemons: healthcheck.ProvisionerDaemonsReportOptions{
CurrentVersion: buildinfo.Version(),
CurrentAPIVersion: provisionersdk.VersionCurrent,
ProvisionerDaemonsFn: options.Database.GetProvisionerDaemons,
TimeNowFn: dbtime.Now,
StaleInterval: provisionerdserver.DefaultHeartbeatInterval * 3,
CurrentVersion: buildinfo.Version(),
CurrentAPIMajorVersion: provisionersdk.CurrentMajor,
Store: options.Database,
TimeNowFn: dbtime.Now,
StaleInterval: provisionerdserver.DefaultHeartbeatInterval * 3,
},
})
}
Expand Down
16 changes: 9 additions & 7 deletions coderd/healthcheck/provisioner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,18 @@ type ProvisionerDaemonsReportOptions struct {
CurrentVersion string
CurrentAPIMajorVersion int

// ProvisionerDaemonsFn is a function that returns ProvisionerDaemons.
// Satisfied by database.Store.ProvisionerDaemons
ProvisionerDaemonsFn func(context.Context) ([]database.ProvisionerDaemon, error)
Store ProvisionerDaemonsStore

TimeNowFn func() time.Time
StaleInterval time.Duration

Dismissed bool
}

type ProvisionerDaemonsStore interface {
GetProvisionerDaemons(ctx context.Context) ([]database.ProvisionerDaemon, error)
}

func (r *ProvisionerDaemonsReport) Run(ctx context.Context, opts *ProvisionerDaemonsReportOptions) {
r.ProvisionerDaemons = make([]codersdk.ProvisionerDaemon, 0)
r.Severity = health.SeverityOK
Expand All @@ -60,18 +62,18 @@ func (r *ProvisionerDaemonsReport) Run(ctx context.Context, opts *ProvisionerDae

if opts.CurrentAPIMajorVersion == 0 {
r.Severity = health.SeverityError
r.Error = ptr.Ref("Developer error: CurrentAPIVersion must be non-zero!")
r.Error = ptr.Ref("Developer error: CurrentAPIMajorVersion must be non-zero!")
return
}

if opts.ProvisionerDaemonsFn == nil {
if opts.Store == nil {
r.Severity = health.SeverityError
r.Error = ptr.Ref("Developer error: ProvisionerDaemonsFn is nil!")
r.Error = ptr.Ref("Developer error: Store is nil!")
return
}

// nolint: gocritic // need an actor to fetch provisioner daemons
daemons, err := opts.ProvisionerDaemonsFn(dbauthz.AsSystemRestricted(ctx))
daemons, err := opts.Store.GetProvisionerDaemons(dbauthz.AsSystemRestricted(ctx))
if err != nil {
r.Severity = health.SeverityError
r.Error = ptr.Ref("error fetching provisioner daemons: " + err.Error())
Expand Down
59 changes: 19 additions & 40 deletions coderd/healthcheck/provisioner_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ import (
"github.com/stretchr/testify/assert"

"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbmock"
"github.com/coder/coder/v2/coderd/database/dbtime"
"github.com/coder/coder/v2/coderd/healthcheck"
"github.com/coder/coder/v2/coderd/healthcheck/health"
"github.com/coder/coder/v2/provisionersdk"

gomock "go.uber.org/mock/gomock"
)

func TestProvisionerDaemonReport(t *testing.T) {
Expand All @@ -23,7 +26,8 @@ func TestProvisionerDaemonReport(t *testing.T) {
name string
currentVersion string
currentAPIMajorVersion int
provisionerDaemonsFn func(context.Context) ([]database.ProvisionerDaemon, error)
provisionerDaemons []database.ProvisionerDaemon
provisionerDaemonsErr error
expectedSeverity health.Severity
expectedWarningCode health.Code
expectedError string
Expand All @@ -34,26 +38,18 @@ func TestProvisionerDaemonReport(t *testing.T) {
expectedSeverity: health.SeverityError,
expectedError: "Developer error: CurrentVersion is empty",
},
{
name: "provisionerdaemonsfn nil",
currentVersion: "v1.2.3",
currentAPIMajorVersion: 1,
expectedSeverity: health.SeverityError,
expectedError: "Developer error: ProvisionerDaemonsFn is nil",
},
{
name: "no daemons",
currentVersion: "v1.2.3",
currentAPIMajorVersion: provisionersdk.CurrentMajor,
provisionerDaemonsFn: fakeProvisionerDaemonsFn(),
expectedSeverity: health.SeverityError,
expectedError: "No provisioner daemons found!",
},
{
name: "error fetching daemons",
currentVersion: "v1.2.3",
currentAPIMajorVersion: provisionersdk.CurrentMajor,
provisionerDaemonsFn: fakeProvisionerDaemonsFnErr(assert.AnError),
provisionerDaemonsErr: assert.AnError,
expectedSeverity: health.SeverityError,
expectedError: assert.AnError.Error(),
},
Expand All @@ -62,69 +58,62 @@ func TestProvisionerDaemonReport(t *testing.T) {
currentVersion: "v1.2.3",
currentAPIMajorVersion: provisionersdk.CurrentMajor,
expectedSeverity: health.SeverityOK,
provisionerDaemonsFn: fakeProvisionerDaemonsFn(fakeProvisionerDaemon(t, "pd-ok", "v1.2.3", "1.0")),
provisionerDaemons: []database.ProvisionerDaemon{fakeProvisionerDaemon(t, "pd-ok", "v1.2.3", "1.0")},
},
{
name: "one daemon out of date",
currentVersion: "v1.2.3",
currentAPIMajorVersion: provisionersdk.CurrentMajor,
expectedSeverity: health.SeverityWarning,
expectedWarningCode: health.CodeProvisionerDaemonVersionMismatch,
provisionerDaemonsFn: fakeProvisionerDaemonsFn(fakeProvisionerDaemon(t, "pd-old", "v1.1.2", "1.0")),
provisionerDaemons: []database.ProvisionerDaemon{fakeProvisionerDaemon(t, "pd-old", "v1.1.2", "1.0")},
},
{
name: "invalid daemon version",
currentVersion: "v1.2.3",
currentAPIMajorVersion: provisionersdk.CurrentMajor,
expectedSeverity: health.SeverityError,
expectedWarningCode: health.CodeUnknown,
provisionerDaemonsFn: fakeProvisionerDaemonsFn(fakeProvisionerDaemon(t, "pd-invalid-version", "invalid", "1.0")),
provisionerDaemons: []database.ProvisionerDaemon{fakeProvisionerDaemon(t, "pd-invalid-version", "invalid", "1.0")},
},
{
name: "invalid daemon api version",
currentVersion: "v1.2.3",
currentAPIMajorVersion: provisionersdk.CurrentMajor,
expectedSeverity: health.SeverityError,
expectedWarningCode: health.CodeUnknown,
provisionerDaemonsFn: fakeProvisionerDaemonsFn(fakeProvisionerDaemon(t, "pd-new-minor", "v1.2.3", "invalid")),
provisionerDaemons: []database.ProvisionerDaemon{fakeProvisionerDaemon(t, "pd-new-minor", "v1.2.3", "invalid")},
},
{
name: "api version backward compat",
currentVersion: "v2.3.4",
currentAPIMajorVersion: 2,
expectedSeverity: health.SeverityWarning,
expectedWarningCode: health.CodeProvisionerDaemonAPIMajorVersionDeprecated,
provisionerDaemonsFn: fakeProvisionerDaemonsFn(
fakeProvisionerDaemon(t, "pd-old-api", "v2.3.4", "1.0")),
provisionerDaemons: []database.ProvisionerDaemon{fakeProvisionerDaemon(t, "pd-old-api", "v2.3.4", "1.0")},
},
{
name: "one up to date, one out of date",
currentVersion: "v1.2.3",
currentAPIMajorVersion: provisionersdk.CurrentMajor,
expectedSeverity: health.SeverityWarning,
expectedWarningCode: health.CodeProvisionerDaemonVersionMismatch,
provisionerDaemonsFn: fakeProvisionerDaemonsFn(
fakeProvisionerDaemon(t, "pd-ok", "v1.2.3", "1.0"),
fakeProvisionerDaemon(t, "pd-old", "v1.1.2", "1.0")),
provisionerDaemons: []database.ProvisionerDaemon{fakeProvisionerDaemon(t, "pd-ok", "v1.2.3", "1.0"), fakeProvisionerDaemon(t, "pd-old", "v1.1.2", "1.0")},
},
{
name: "one up to date, one newer",
currentVersion: "v1.2.3",
currentAPIMajorVersion: provisionersdk.CurrentMajor,
expectedSeverity: health.SeverityWarning,
expectedWarningCode: health.CodeProvisionerDaemonVersionMismatch,
provisionerDaemonsFn: fakeProvisionerDaemonsFn(
fakeProvisionerDaemon(t, "pd-ok", "v1.2.3", "1.0"),
fakeProvisionerDaemon(t, "pd-new", "v2.3.4", "1.0")),
provisionerDaemons: []database.ProvisionerDaemon{fakeProvisionerDaemon(t, "pd-ok", "v1.2.3", "1.0"), fakeProvisionerDaemon(t, "pd-new", "v2.3.4", "1.0")},
},
{
name: "one up to date, one stale older",
currentVersion: "v2.3.4",
currentAPIMajorVersion: provisionersdk.CurrentMajor,
expectedSeverity: health.SeverityOK,
provisionerDaemonsFn: fakeProvisionerDaemonsFn(
fakeProvisionerDaemonStale(t, "pd-ok", "v1.2.3", "0.9", dbtime.Now().Add(-5*time.Minute)),
fakeProvisionerDaemon(t, "pd-new", "v2.3.4", "1.0")),
provisionerDaemons: []database.ProvisionerDaemon{fakeProvisionerDaemonStale(t, "pd-ok", "v1.2.3", "0.9", dbtime.Now().Add(-5*time.Minute)), fakeProvisionerDaemon(t, "pd-new", "v2.3.4", "1.0")},
},
} {
tt := tt
Expand All @@ -138,14 +127,16 @@ func TestProvisionerDaemonReport(t *testing.T) {
if tt.currentAPIMajorVersion == 0 {
opts.CurrentAPIMajorVersion = provisionersdk.CurrentMajor
}
if tt.provisionerDaemonsFn != nil {
opts.ProvisionerDaemonsFn = tt.provisionerDaemonsFn
}
now := dbtime.Now()
opts.TimeNowFn = func() time.Time {
return now
}

ctrl := gomock.NewController(t)
mDB := dbmock.NewMockStore(ctrl)
mDB.EXPECT().GetProvisionerDaemons(gomock.Any()).AnyTimes().Return(tt.provisionerDaemons, tt.provisionerDaemonsErr)
opts.Store = mDB

rpt.Run(context.Background(), &opts)

assert.Equal(t, tt.expectedSeverity, rpt.Severity)
Expand Down Expand Up @@ -183,18 +174,6 @@ func fakeProvisionerDaemon(t *testing.T, name, version, apiVersion string) datab
}
}

func fakeProvisionerDaemonsFn(pds ...database.ProvisionerD 23D3 aemon) func(context.Context) ([]database.ProvisionerDaemon, error) {
return func(context.Context) ([]database.ProvisionerDaemon, error) {
return pds, nil
}
}

func fakeProvisionerDaemonsFnErr(err error) func(context.Context) ([]database.ProvisionerDaemon, error) {
return func(context.Context) ([]database.ProvisionerDaemon, error) {
return nil, err
}
}

func fakeProvisionerDaemonStale(t *testing.T, name, version, apiVersion string, lastSeenAt time.Time) database.ProvisionerDaemon {
t.Helper()
d := fakeProvisionerDaemon(t, name, version, apiVersion)
< 3C99 svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-fold-down"> Expand Down
0