Skip to content

fix: preserve existing template fields in PATCH requests #19238

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+35 −16
Open

fix: preserve existing template fields in PATCH requests #19238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 29 additions & 13 deletions coderd/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -771,12 +771,34 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
classicTemplateFlow = *req.UseClassicParameterFlow
}

// Users should not be able to clear the template name in the UI
name := req.Name
if name == "" {
name = template.Name
}

// Preserve existing values for fields not provided in PATCH request
displayName := req.DisplayName
if displayName == "" {
displayName = template.DisplayName
}

description := req.Description
if description == "" {
description = template.Description
}

icon := req.Icon
if icon == "" {
icon = template.Icon
}

var updated database.Template
err = api.Database.InTx(func(tx database.Store) error {
if req.Name == template.Name &&
req.Description == template.Description &&
req.DisplayName == template.DisplayName &&
req.Icon == template.Icon &&
if name == template.Name &&
description == template.Description &&
displayName == template.DisplayName &&
icon == template.Icon &&
req.AllowUserAutostart == template.AllowUserAutostart &&
req.AllowUserAutostop == template.AllowUserAutostop &&
req.AllowUserCancelWorkspaceJobs == template.AllowUserCancelWorkspaceJobs &&
Expand All @@ -796,12 +818,6 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
return nil
}

// Users should not be able to clear the template name in the UI
name := req.Name
if name == "" {
name = template.Name
}

groupACL := template.GroupACL
if req.DisableEveryoneGroupAccess {
delete(groupACL, template.OrganizationID.String())
Expand All @@ -827,9 +843,9 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
ID: template.ID,
UpdatedAt: dbtime.Now(),
Name: name,
DisplayName: req.DisplayName,
Description: req.Description,
Icon: req.Icon,
DisplayName: displayName,
Description: description,
Icon: icon,
AllowUserCancelWorkspaceJobs: req.AllowUserCancelWorkspaceJobs,
GroupACL: groupACL,
MaxPortSharingLevel: maxPortShareLevel,
Expand Down
9 changes: 6 additions & 3 deletions coderd/templates_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1377,7 +1377,7 @@ func TestPatchTemplateMeta(t *testing.T) {
assert.Equal(t, template.DefaultTTLMillis, updated.DefaultTTLMillis)
})

t.Run("RemoveIcon", func(t *testing.T) {
t.Run("PreserveIconWhenEmpty", func(t *testing.T) {
t.Parallel()

client := coderdtest.New(t, nil)
Expand All @@ -1386,15 +1386,18 @@ func TestPatchTemplateMeta(t *testing.T) {
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(ctr *codersdk.CreateTemplateRequest) {
ctr.Icon = "/icon/code.png"
})
// Test that when only updating other fields, the icon is preserved
req := codersdk.UpdateTemplateMeta{
Icon: "",
DefaultTTLMillis: 12 * time.Hour.Milliseconds(),
}

ctx := testutil.Context(t, testutil.WaitLong)

updated, err := client.UpdateTemplateMeta(ctx, template.ID, req)
require.NoError(t, err)
assert.Equal(t, updated.Icon, "")
// Icon should be preserved when not explicitly provided
assert.Equal(t, "/icon/code.png", updated.Icon)
assert.Equal(t, req.DefaultTTLMillis, updated.DefaultTTLMillis)
})

t.Run("AutostopRequirement", func(t *testing.T) {
Expand Down
Loading