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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
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
fix: Add nil/default support to template displayName
  • Loading branch information
@rafrdz
rafrdz committed Aug 8, 2025
commit 38bdabf47de59b4d7cfe287219058014194b14b3
2 changes: 1 addition & 1 deletion cli/templateedit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ func (r *RootCmd) templateEdit() *serpent.Command {

req := codersdk.UpdateTemplateMeta{
Name: name,
DisplayName: displayName,
DisplayName: &displayName,
Description: &description,
Icon: &icon,
DefaultTTLMillis: defaultTTL.Milliseconds(),
Expand Down
5 changes: 3 additions & 2 deletions coderd/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -771,14 +771,15 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
classicTemplateFlow = *req.UseClassicParameterFlow
}

displayName := ptr.NilToDefault(req.DisplayName, template.DisplayName)
description := ptr.NilToDefault(req.Description, template.Description)
icon := ptr.NilToDefault(req.Icon, template.Icon)

var updated database.Template
err = api.Database.InTx(func(tx database.Store) error {
if req.Name == template.Name &&
description == template.Description &&
req.DisplayName == template.DisplayName &&
displayName == template.DisplayName &&
icon == template.Icon &&
req.AllowUserAutostart == template.AllowUserAutostart &&
req.AllowUserAutostop == template.AllowUserAutostop &&
Expand Down Expand Up @@ -830,7 +831,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
ID: template.ID,
UpdatedAt: dbtime.Now(),
Name: name,
DisplayName: req.DisplayName,
DisplayName: displayName,
Description: description,
Icon: icon,
AllowUserCancelWorkspaceJobs: req.AllowUserCancelWorkspaceJobs,
Expand Down
42 changes: 29 additions & 13 deletions coderd/templates_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -901,7 +901,7 @@ func TestPatchTemplateMeta(t *testing.T) {

req := codersdk.UpdateTemplateMeta{
Name: "new-template-name",
DisplayName: "Displayed Name 456",
DisplayName: ptr.Ref("Displayed Name 456"),
Description: ptr.Ref("lorem ipsum dolor sit amet et cetera"),
Icon: ptr.Ref("/icon/new-icon.png"),
DefaultTTLMillis: 12 * time.Hour.Milliseconds(),
Expand Down Expand Up @@ -1167,7 +1167,7 @@ func TestPatchTemplateMeta(t *testing.T) {

got, err := client.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
DefaultTTLMillis: 0,
Expand Down Expand Up @@ -1202,7 +1202,7 @@ func TestPatchTemplateMeta(t *testing.T) {

got, err := client.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
DefaultTTLMillis: template.DefaultTTLMillis,
Expand Down Expand Up @@ -1263,7 +1263,7 @@ func TestPatchTemplateMeta(t *testing.T) {
allowAutostop.Store(false)
got, err := client.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
DefaultTTLMillis: template.DefaultTTLMillis,
Expand Down Expand Up @@ -1294,7 +1294,7 @@ func TestPatchTemplateMeta(t *testing.T) {

got, err := client.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
// Increase the default TTL to avoid error "not modified".
Expand Down Expand Up @@ -1442,7 +1442,7 @@ func TestPatchTemplateMeta(t *testing.T) {
require.EqualValues(t, 1, template.AutostopRequirement.Weeks)
req := codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
AllowUserCancelWorkspaceJobs: template.AllowUserCancelWorkspaceJobs,
Expand Down Expand Up @@ -1519,7 +1519,7 @@ func TestPatchTemplateMeta(t *testing.T) {
require.EqualValues(t, 2, template.AutostopRequirement.Weeks)
req := codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
AllowUserCancelWorkspaceJobs: template.AllowUserCancelWorkspaceJobs,
Expand Down Expand Up @@ -1556,7 +1556,7 @@ func TestPatchTemplateMeta(t *testing.T) {
require.EqualValues(t, 1, template.AutostopRequirement.Weeks)
req := codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
AllowUserCancelWorkspaceJobs: template.AllowUserCancelWorkspaceJobs,
Expand Down Expand Up @@ -1626,25 +1626,30 @@ func TestPatchTemplateMeta(t *testing.T) {
user := coderdtest.CreateFirstUser(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)

displayName := "Test Display Name"
description := "test-description"
icon := "/icon/icon.png"
defaultTTLMillis := 10 * time.Hour.Milliseconds()

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

restoreReq := codersdk.UpdateTemplateMeta{
DisplayName: &displayName,
Description: &description,
Icon: &icon,
DefaultTTLMillis: defaultTTLMillis,
}

type expected struct {
displayName string
description string
icon string
defaultTTLMillis int64
Expand All @@ -1660,27 +1665,37 @@ func TestPatchTemplateMeta(t *testing.T) {
{
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()},
expected: expected{displayName: reference.DisplayName, description: reference.Description, icon: reference.Icon, defaultTTLMillis: 99 * time.Hour.Milliseconds()},
},
{
name: "Clear display name",
req: codersdk.UpdateTemplateMeta{DisplayName: ptr.Ref("")},
expected: expected{displayName: "", description: reference.Description, icon: reference.Icon, defaultTTLMillis: 0},
},
{
name: "Clear description",
req: codersdk.UpdateTemplateMeta{Description: ptr.Ref("")},
expected: expected{description: "", icon: reference.Icon, defaultTTLMillis: 0},
expected: expected{displayName: reference.DisplayName, description: "", icon: reference.Icon, defaultTTLMillis: 0},
},
{
name: "Clear icon",
req: codersdk.UpdateTemplateMeta{Icon: ptr.Ref("")},
expected: expected{description: reference.Description, icon: "", defaultTTLMillis: 0},
expected: expected{displayName: reference.DisplayName, description: reference.Description, icon: "", defaultTTLMillis: 0},
},
{
name: "Nil display name defaults to reference display name",
req: codersdk.UpdateTemplateMeta{DisplayName: nil},
expected: expected{displayName: reference.DisplayName, description: reference.Description, icon: reference.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},
expected: expected{displayName: reference.DisplayName, 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},
expected: expected{displayName: reference.DisplayName, description: reference.Description, icon: reference.Icon, defaultTTLMillis: 0},
},
}

Expand All @@ -1696,6 +1711,7 @@ func TestPatchTemplateMeta(t *testing.T) {
ctx := testutil.Context(t, testutil.WaitLong)
updated, err := client.UpdateTemplateMeta(ctx, reference.ID, tc.req)
require.NoError(t, err)
assert.Equal(t, tc.expected.displayName, updated.DisplayName)
assert.Equal(t, tc.expected.description, updated.Description)
assert.Equal(t, tc.expected.icon, updated.Icon)
assert.Equal(t, tc.expected.defaultTTLMillis, updated.DefaultTTLMillis)
Expand Down
2 changes: 1 addition & 1 deletion codersdk/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ type ACLAvailable struct {

type UpdateTemplateMeta struct {
Name string `json:"name,omitempty" validate:"omitempty,template_name"`
DisplayName string `json:"display_name,omitempty" validate:"omitempty,template_display_name"`
DisplayName *string `json:"display_name,omitempty" validate:"omitempty,template_display_name"`
Description *string `json:"description,omitempty"`
Icon *string `json:"icon,omitempty"`
DefaultTTLMillis int64 `json:"default_ttl_ms,omitempty"`
Expand Down
4 changes: 2 additions & 2 deletions enterprise/cli/templateedit_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ func TestTemplateEdit(t *testing.T) {

template, err := ownerClient.UpdateTemplateMeta(ctx, dbtemplate.ID, codersdk.UpdateTemplateMeta{
Name: expectedName,
DisplayName: expectedDisplayName,
DisplayName: &expectedDisplayName,
Description: &expectedDescription,
Icon: &expectedIcon,
DefaultTTLMillis: expectedDefaultTTLMillis,
Expand Down Expand Up @@ -267,7 +267,7 @@ func TestTemplateEdit(t *testing.T) {

template, err = ownerClient.UpdateTemplateMeta(ctx, dbtemplate.ID, codersdk.UpdateTemplateMeta{
Name: expectedName,
DisplayName: expectedDisplayName,
DisplayName: &expectedDisplayName,
Description: &expectedDescription,
Icon: &expectedIcon,
DefaultTTLMillis: expectedDefaultTTLMillis,
Expand Down
14 changes: 7 additions & 7 deletions enterprise/coderd/templates_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ func TestTemplates(t *testing.T) {
ctx := testutil.Context(t, testutil.WaitLong)
updated, err := anotherClient.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
AutostartRequirement: &codersdk.TemplateAutostartRequirement{
Expand All @@ -276,7 +276,7 @@ func TestTemplates(t *testing.T) {
// Ensure a missing field is a noop
updated, err = anotherClient.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: ptr.Ref(template.Icon + "something"),
})
Expand Down Expand Up @@ -313,7 +313,7 @@ func TestTemplates(t *testing.T) {
ctx := testutil.Context(t, testutil.WaitLong)
_, err := anotherClient.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
AutostartRequirement: &codersdk.TemplateAutostartRequirement{
Expand Down Expand Up @@ -349,7 +349,7 @@ func TestTemplates(t *testing.T) {
ctx := context.Background()
updated, err := anotherClient.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
AllowUserCancelWorkspaceJobs: template.AllowUserCancelWorkspaceJobs,
Expand Down Expand Up @@ -403,7 +403,7 @@ func TestTemplates(t *testing.T) {

updated, err := anotherClient.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
AllowUserCancelWorkspaceJobs: template.AllowUserCancelWorkspaceJobs,
Expand Down Expand Up @@ -472,7 +472,7 @@ func TestTemplates(t *testing.T) {
t.Run(c.Name, func(t *testing.T) {
_, err := anotherClient.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
AllowUserCancelWorkspaceJobs: template.AllowUserCancelWorkspaceJobs,
Expand Down Expand Up @@ -1004,7 +1004,7 @@ func TestTemplateACL(t *testing.T) {
require.Equal(t, 1, len(acl.Groups))
_, err = client.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
Name: template.Name,
DisplayName: template.DisplayName,
DisplayName: &template.DisplayName,
Description: &template.Description,
Icon: &template.Icon,
AllowUserCancelWorkspaceJobs: template.AllowUserCancelWorkspaceJobs,
Expand Down