fix: preserve existing template fields in PATCH requests #19238
Conversation
Fixes issue where updating only specific fields (like default_ttl_ms) would unintentionally clear other fields (like icon, display_name, description) when they weren't provided in the PATCH request. The fix preserves existing values for fields that are not explicitly provided in the request, following the expected PATCH semantics. Fixes #19036 Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
CI Test FailuresThe CI is showing two test failures that appear to be unrelated to the template PATCH changes:
Both failures appear to be flaky tests unrelated to the template PATCH field preservation changes. The modified code only affects the The core functionality of the fix (preserving template fields during PATCH requests) should work correctly based on the code analysis and manual testing performed. |
CI Test Failures AnalysisThe CI test failures appear to be unrelated to the template PATCH changes: Failed Tests:
My Changes:
Analysis:These test failures are in completely different areas of the codebase and don't interact with the template PATCH endpoint logic I modified. The failures appear to be either flaky tests or pre-existing issues. The core functionality implemented (preserving |
Description
Fixes issue #19036 where updating only specific fields (like
default_ttl_ms) via PATCH request would unintentionally clear other fields (likeicon,display_name,description) when they weren't provided in the request.Problem
When making a PATCH request to
/api/v2/templates/{template_id}with only{"default_ttl_ms": 12345}, the template's icon field was being cleared because the request struct would have empty strings for fields not provided in the JSON, and these empty strings were being used to update the database.Solution
The fix preserves existing values for fields that are not explicitly provided in the request:
This follows proper PATCH semantics where only provided fields should be updated.
Changes
coderd/templates.go: Added logic to preserve existing values forname,displayName,description, andiconfields when they are empty in the requestcoderd/templates_test.go: Updated test to verify that fields are preserved when not provided in PATCH requestsTesting
Breaking Changes
This change modifies the behavior of the template PATCH endpoint. Previously, sending an empty string for a field would clear it. Now, empty strings are treated as "preserve existing value". This is generally the expected behavior for PATCH operations, but it means you can no longer explicitly clear fields by sending empty strings.
Fixes
Fixes #19036