Skip to content

fix!: support empty or default fields when updating templates #19256

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 8 commits into from
Aug 12, 2025
+178 −74
Merged

fix!: support empty or default fields when updating templates #19256

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1775321
fix: Add support for empty/default template fields
rafrdz Aug 8, 2025
e7ccbaf
Merge branch 'main' into rafrdz/fix-icon-removed
rafrdz Aug 8, 2025
0665980
Fix pointer issues in tests
rafrdz Aug 8, 2025
7c1317e
Test updates based on PR comments
rafrdz Aug 8, 2025
2c6062f
Merge branch 'main' into rafrdz/fix-icon-removed
rafrdz Aug 8, 2025
38bdabf
fix: Add nil/default support to template displayName
rafrdz Aug 8, 2025
a5118d6
Merge branch 'rafrdz/fix-icon-removed' of https://github.com/coder/co…
rafrdz Aug 8, 2025
aaab655
Fix pointer issues in tests
rafrdz Aug 8, 2025
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
Test updates based on PR comments
  • Loading branch information
@rafrdz
rafrdz committed Aug 8, 2025
commit 7c1317efb050ef967286ce6b1c7302a1d37ae8de
53 changes: 37 additions & 16 deletions coderd/templates_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1619,7 +1619,7 @@ func TestPatchTemplateMeta(t *testing.T) {
assert.False(t, updated.UseClassicParameterFlow, "expected false")
})

t.Run("SupportEmptyOrDefault", func(t *testing.T) {
t.Run("SupportEmptyOrDefaultFields", func(t *testing.T) {
t.Parallel()

client := coderdtest.New(t, nil)
Expand All @@ -1630,11 +1630,13 @@ func TestPatchTemplateMeta(t *testing.T) {
icon := "/icon/icon.png"
defaultTTLMillis := 10 * time.Hour.Milliseconds()

template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
reference := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
ctr.Description = description
ctr.Icon = icon
ctr.DefaultTTLMillis = ptr.Ref(defaultTTLMillis)
})
require.Equal(t, description, reference.Description)
require.Equal(t, icon, reference.Icon)

restoreReq := codersdk.UpdateTemplateMeta{
Description: &description,
Expand All @@ -1655,29 +1657,48 @@ func TestPatchTemplateMeta(t *testing.T) {
}

tests := []testCase{
{name: "Only update default_ttl_ms", req: codersdk.UpdateTemplateMeta{DefaultTTLMillis: 99 * time.Hour.Milliseconds()}, expected: expected{description: template.Description, icon: template.Icon, defaultTTLMillis: 99 * time.Hour.Milliseconds()}},
{name: "Clear description", req: codersdk.UpdateTemplateMeta{Description: ptr.Ref("")}, expected: expected{description: "", icon: template.Icon, defaultTTLMillis: 0}},
{name: "Clear icon", req: codersdk.UpdateTemplateMeta{Icon: ptr.Ref("")}, expected: expected{description: template.Description, icon: "", defaultTTLMillis: 0}},
{name: "Nil description defaults to template description", req: codersdk.UpdateTemplateMeta{Description: nil}, expected: expected{description: template.Description, icon: template.Icon, defaultTTLMillis: 0}},
{name: "Nil icon defaults to template icon", req: codersdk.UpdateTemplateMeta{Icon: nil}, expected: expected{description: template.Description, icon: template.Icon, defaultTTLMillis: 0}},
{
name: "Only update default_ttl_ms",
req: codersdk.UpdateTemplateMeta{DefaultTTLMillis: 99 * time.Hour.Milliseconds()},
expected: expected{description: reference.Description, icon: reference.Icon, defaultTTLMillis: 99 * time.Hour.Milliseconds()},
},
{
name: "Clear description",
req: codersdk.UpdateTemplateMeta{Description: ptr.Ref("")},
expected: expected{description: "", icon: reference.Icon, defaultTTLMillis: 0},
},
{
name: "Clear icon",
req: codersdk.UpdateTemplateMeta{Icon: ptr.Ref("")},
expected: expected{description: reference.Description, icon: "", defaultTTLMillis: 0},
},
{
name: "Nil description defaults to reference description",
req: codersdk.UpdateTemplateMeta{Description: nil},
expected: expected{description: reference.Description, icon: reference.Icon, defaultTTLMillis: 0},
},
{
name: "Nil icon defaults to reference icon",
req: codersdk.UpdateTemplateMeta{Icon: nil},
expected: expected{description: reference.Description, icon: reference.Icon, defaultTTLMillis: 0},
},
}

// It is unfortunate we need to sleep, but the test can fail if the
// updatedAt is too close together.
time.Sleep(time.Millisecond * 5)

for _, tc := range tests {
//nolint:tparallel,paralleltest
t.Run(tc.name, func(t *testing.T) {
defer func() {
ctx := testutil.Context(t, testutil.WaitLong)
// Restore reference after each test case
_, err := client.UpdateTemplateMeta(ctx, reference.ID, restoreReq)
require.NoError(t, err)
}()
ctx := testutil.Context(t, testutil.WaitLong)
updated, err := client.UpdateTemplateMeta(ctx, template.ID, tc.req)
updated, err := client.UpdateTemplateMeta(ctx, reference.ID, tc.req)
require.NoError(t, err)
assert.Equal(t, tc.expected.description, updated.Description)
assert.Equal(t, tc.expected.icon, updated.Icon)
assert.Equal(t, tc.expected.defaultTTLMillis, updated.DefaultTTLMillis)

// Restore template after each test case
_, err = client.UpdateTemplateMeta(ctx, template.ID, restoreReq)
require.NoError(t, err)
})
}
})
Expand Down