Skip to content

feat: allow for default presets #18445

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.

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 13 commits into from
Jun 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,5 +103,4 @@ Read [cursor rules](.cursorrules).

The frontend is contained in the site folder.

For building Frontend refer to [this document](docs/contributing/frontend.md)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drive-by: link is dead.

Copy link
Member

@aslilac aslilac Jun 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's in docs/about/contributing/ now. can you leave this as is and I'll do a quick pr to fix the link?

sorry, I just looked at the whole file and this diff makes more sense now. the line got duplicated, with one having the out of date path and one having the correct path. you're just removing the stale one.

For building Frontend refer to [this document](docs/about/contributing/frontend.md)
3 changes: 3 additions & 0 deletions coderd/apidoc/docs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions coderd/apidoc/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions coderd/database/dbfake/dbfake.go
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,7 @@ func (t TemplateVersionBuilder) Do() TemplateVersionResponse {
DesiredInstances: preset.DesiredInstances,
InvalidateAfterSecs: preset.InvalidateAfterSecs,
SchedulingTimezone: preset.SchedulingTimezone,
IsDefault: false,
})
}

Expand Down
1 change: 1 addition & 0 deletions coderd/database/dbgen/dbgen.go
Original file line number Diff line number Diff line change
Expand Up @@ -1303,6 +1303,7 @@ func Preset(t testing.TB, db database.Store, seed database.InsertPresetParams) d
DesiredInstances: seed.DesiredInstances,
InvalidateAfterSecs: seed.InvalidateAfterSecs,
SchedulingTimezone: seed.SchedulingTimezone,
IsDefault: seed.IsDefault,
})
require.NoError(t, err, "insert preset")
return preset
Expand Down
1 change: 1 addition & 0 deletions coderd/database/dbmem/dbmem.go
Original file line number Diff line number Diff line change
Expand Up @@ -9198,6 +9198,7 @@ func (q *FakeQuerier) InsertPreset(_ context.Context, arg database.InsertPresetP
Valid: true,
},
PrebuildStatus: database.PrebuildStatusHealthy,
IsDefault: arg.IsDefault,
}
q.presets = append(q.presets, preset)
return preset, nil
Expand Down
5 changes: 4 additions & 1 deletion coderd/database/dump.sql

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
DROP INDEX IF EXISTS idx_template_version_presets_default;
ALTER TABLE template_version_presets DROP COLUMN IF EXISTS is_default;
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
ALTER TABLE template_version_presets ADD COLUMN is_default BOOLEAN NOT NULL DEFAULT FALSE;

-- Add a unique constraint to ensure only one default preset per template version
CREATE UNIQUE INDEX idx_template_version_presets_default
ON template_version_presets (template_version_id)
WHERE is_default = TRUE;
1 change: 1 addition & 0 deletions coderd/database/models.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 15 additions & 6 deletions coderd/database/queries.sql.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions coderd/database/queries/presets.sql
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ INSERT INTO template_version_presets (
created_at,
desired_instances,
invalidate_after_secs,
scheduling_timezone
scheduling_timezone,
is_default
)
VALUES (
@id,
Expand All @@ -15,7 +16,8 @@ VALUES (
@created_at,
@desired_instances,
@invalidate_after_secs,
@scheduling_timezone
@scheduling_timezone,
@is_default
) RETURNING *;

-- name: InsertPresetParameters :many
Expand Down
1 change: 1 addition & 0 deletions coderd/database/unique_constraint.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions coderd/presets.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ func (api *API) templateVersionPresets(rw http.ResponseWriter, r *http.Request)
var res []codersdk.Preset
for _, preset := range presets {
sdkPreset := codersdk.Preset{
ID: preset.ID,
Name: preset.Name,
ID: preset.ID,
Name: preset.Name,
Default: preset.IsDefault,
}
for _, presetParam := range presetParams {
if presetParam.TemplateVersionPresetID != preset.ID {
Expand Down
92 changes: 92 additions & 0 deletions coderd/presets_test.go
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
package coderd_test

import (
"slices"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/coder/coder/v2/coderd/coderdtest"
Expand Down Expand Up @@ -137,3 +139,93 @@ func TestTemplateVersionPresets(t *testing.T) {
})
}
}

func TestTemplateVersionPresetsDefault(t *testing.T) {
t.Parallel()

type expectedPreset struct {
name string
isDefault bool
}

cases := []struct {
name string
presets []database.InsertPresetParams
expected []expectedPreset
}{
{
name: "no presets",
presets: nil,
expected: nil,
},
{
name: "single default preset",
presets: []database.InsertPresetParams{
{Name: "Default Preset", IsDefault: true},
},
expected: []expectedPreset{
{name: "Default Preset", isDefault: true},
},
},
{
name: "single non-default preset",
presets: []database.InsertPresetParams{
{Name: "Regular Preset", IsDefault: false},
},
expected: []expectedPreset{
{name: "Regular Preset", isDefault: false},
},
},
{
name: "mixed presets",
presets: []database.InsertPresetParams{
{Name: "Default Preset", IsDefault: true},
{Name: "Regular Preset", IsDefault: false},
},
expected: []expectedPreset{
{name: "Default Preset", isDefault: true},
{name: "Regular Preset", isDefault: false},
},
},
}

for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)

client, db := coderdtest.NewWithDatabase(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
user := coderdtest.CreateFirstUser(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)

// Create presets
for _, preset := range tc.presets {
preset.TemplateVersionID = version.ID
_ = dbgen.Preset(t, db, preset)
}

// Get presets via API
userSubject, _, err := httpmw.UserRBACSubject(ctx, db, user.UserID, rbac.ScopeAll)
require.NoError(t, err)
userCtx := dbauthz.As(ctx, userSubject)

gotPresets, err := client.TemplateVersionPresets(userCtx, version.ID)
require.NoError(t, err)

// Verify results
require.Len(t, gotPresets, len(tc.expected))

for _, expected := range tc.expected {
found := slices.ContainsFunc(gotPresets, func(preset codersdk.Preset) bool {
if preset.Name != expected.name {
return false
}

return assert.Equal(t, expected.isDefault, preset.Default)
})
require.True(t, found, "Expected preset %s not found", expected.name)
}
})
}
}
1 change: 1 addition & 0 deletions coderd/provisionerdserver/provisionerdserver.go
Original file line number Diff line number Diff line change
Expand Up @@ -2230,6 +2230,7 @@ func InsertWorkspacePresetAndParameters(ctx context.Context, db database.Store,
DesiredInstances: desiredInstances,
InvalidateAfterSecs: ttl,
SchedulingTimezone: schedulingTimezone,
IsDefault: protoPreset.GetDefault(),
})
if err != nil {
return xerrors.Errorf("insert preset: %w", err)
Expand Down
1 change: 1 addition & 0 deletions codersdk/presets.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ type Preset struct {
ID uuid.UUID
Name string
Parameters []PresetParameter
Default bool
}

type PresetParameter struct {
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/api/schemas.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading