feat: allow new immutable parameters for existing workspaces #18579
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
Emyrk
commented
Jun 25, 2025
Comment on lines
+172
to
+180
| originalValue, ok := originalValues[parameter.Name] | ||
| // Immutable parameters should not be changed after the first build. | ||
| // They can match the original value though! | ||
| if parameter.Value.AsString() != originalValues[parameter.Name].Value { | ||
| // If the value matches the original value, that is fine. | ||
| // | ||
| // If the original value is not set, that means this is a new parameter. New | ||
| // immutable parameters are allowed. This is an opinionated choice to prevent | ||
| // workspaces failing to update or delete. Ideally we would block this, as | ||
| // immutable parameters should only be able to be set at creation time. | ||
| if ok && parameter.Value.AsString() != originalValue.Value { |
There was a problem hiding this comment.
This is the change. The rest is testing
You mean a more e2e test? Like from coderd, template versions, etc? The test I did write is pretty locally scoped to the parameter validation logic. |
|
Doesn't have to be e2e necessarily;
|
Added! aa2a809 Test ran on main failed with: (as expected and matches the issue) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #18578
This was a somewhat conscience choice to prevent new immutable parameters. In an ideal world, immutable parameters can only be set at creation time. The example to illustrate this is:
us-east1East-1is created.regionsparameter with the defaultus-west1.us-west1. Volumes do not transfer, and this workspace is either broken, or wiped.If we disallow new immutable parameters, then the fix would be to let
regionsbemutable. Push an update, update the the workspace, then make it immutable.Since the workaround has no more protection than the original problem, it's probably best to just allow new immutable parameters. If at some point in the future we allow some first class flow to handling this case, we can change back this enforcement.
Notes