feat: use preview to compute workspace tags from terraform #18720
+1,183
−78
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This stack of pull requests is managed by Graphite. Learn more about stacking. |
6c1fdf5 to
20d0254
Compare
15a6ca1 to
f0dd768
Compare
6f3d388 to
f4cd152
Compare
f0dd768 to
a87678d
Compare
29a7cf6 to
4d06a6c
Compare
Emyrk
commented
Jul 2, 2025
| "github.com/coder/coder/v2/testutil" | ||
| ) | ||
|
|
||
| func Test_DynamicWorkspaceTagDefaultsFromFile(t *testing.T) { |
There was a problem hiding this comment.
This test is copied from tfparse_test.go.
The tfparse test can be removed when this becomes the new standard.
96c83c7 to
8d594a7
Compare
fc1ad45 to
11e0407
Compare
3cc9349 to
699dd8e
Compare
11e0407 to
d1ed169
Compare
35d29b9 to
ea564d1
Compare
Emyrk
commented
Jul 3, 2025
coderd/dynamicparameters/error.go
Outdated
Comment on lines
13
to
23
| func ParameterValidationError(diags hcl.Diagnostics) *DiagnosticError { | ||
| func parameterValidationError(diags hcl.Diagnostics) *DiagnosticError { | ||
| return &DiagnosticError{ | ||
| Message: "Unable to validate parameters", | ||
| Diagnostics: diags, | ||
| KeyedDiagnostics: make(map[string]hcl.Diagnostics), | ||
| } | ||
| } | ||
|
|
||
| func TagValidationError(diags hcl.Diagnostics) *DiagnosticError { | ||
| func tagValidationError(diags hcl.Diagnostics) *DiagnosticError { | ||
| return &DiagnosticError{ | ||
| Message: "Failed to parse workspace tags", | ||
| Message: "Failed to parse provisioner tags", |
There was a problem hiding this comment.
Reducing the external api of this package a bit
| @@ -1464,8 +1470,9 @@ func (api *API) postTemplateVersionsByOrganization(rw http.ResponseWriter, r *ht | |||
| return | |||
| } | |||
|
|
|||
| var dynamicTemplate bool | |||
There was a problem hiding this comment.
Unfortunate, but orphan'd template versions can never use dynamic parameters 😢
Comment on lines
+1786
to
+1794
| case "application/zip": | ||
| files, err = archivefs.FromZipReader(bytes.NewReader(file.Data), int64(len(file.Data))) | ||
| if err != nil { | ||
| httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{ | ||
| Message: "Internal error checking workspace tags", | ||
| Detail: "extract zip archive: " + err.Error(), | ||
| }) | ||
| return nil, false | ||
| } |
There was a problem hiding this comment.
Do we have any zip based templates?
There was a problem hiding this comment.
Pull Request Overview
This PR replaces the tfparse-based workspace tag extraction with the preview SDK for dynamic-parameter templates, adds caching in the workspace builder, and expands end-to-end and unit tests for tag parsing.
- Upgrade to
github.com/coder/previewv1.0.3 for tag extraction - Implement
dynamicTemplateVersionTags/classicTemplateVersionTagsin the API and cache tags in the workspace builder - Add
tags_internal_test.goand integration testTestDynamicWorkspaceTags, plus a zip‐FS helper
Reviewed Changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| go.mod | Bump github.com/coder/preview to v1.0.3-… |
| enterprise/coderd/testdata/.../main.tf | Add Terraform test case for workspace tags |
| enterprise/coderd/dynamicparameters_test.go | Add TestDynamicWorkspaceTags integration test |
| coderd/wsbuilder/wsbuilder.go | Cache and return dynamic workspace tags |
| coderd/templateversions.go | Route tag parsing through preview.Preview for dynamic templates |
| coderd/dynamicparameters/tags.go | Add CheckTags and diagnostics for invalid tag values |
| coderd/dynamicparameters/error.go | Rename error constructors and update error messaging |
| coderd/dynamicparameters/render.go | Refactor workspace owner resolution and add version support |
| coderd/dynamicparameters/resolver.go | Rename error calls to lowercase versions |
| coderd/coderdtest/dynamicparameters.go | Expose Version hook in test helper |
| archive/fs/zip.go | Introduce FromZipReader helper for zip archives |
Comments suppressed due to low confidence (4)
coderd/templateversions.go:1765
- [nitpick] This new helper method lacks a GoDoc comment; consider adding a brief comment explaining its behavior and parameters.
func (api *API) dynamicTemplateVersionTags(ctx context.Context, rw http.ResponseWriter, orgID uuid.UUID, owner uuid.UUID, file database.File) (map[string]string, bool) {
coderd/templateversions.go:1795
- The unsupported mimetype branch in
dynamicTemplateVersionTagsisn’t exercised by existing tests; consider adding a test to cover this error path.
default:
archive/fs/zip.go:1
- The new
FromZipReaderhelper lacks unit tests; consider adding tests to validate correct in-memory FS creation from zip data.
package archivefs
coderd/dynamicparameters/error.go:21
- [nitpick] The error message is now "Failed to parse provisioner tags", which may be confusing in a workspace-tag context; consider using "workspace tags" for consistency with other messages.
func tagValidationError(diags hcl.Diagnostics) *DiagnosticError {
ea564d1 to
76ca1fa
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this does
If using dynamic parameters, workspace tags are extracted using
coder/preview. This occurs at template version import and workspace create.Templates that are not opted into dynamic parameters will use
tfparse.Future Work
When
previewis used as the source of truth for tags, we can removetfparse.Closes coder/internal#698