Skip to content

feat: assign empty value to ephemeral, required parameter while stopping #8545

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

Closed
wants to merge 1 commit into from
Closed

feat: assign empty value to ephemeral, required parameter while stopping #8545

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
4 changes: 3 additions & 1 deletion coderd/wsbuilder/wsbuilder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,8 +495,10 @@ func (b *Builder) getParameters() (names, values []string, err error) {
if err != nil {
return nil, nil, BuildError{http.StatusBadRequest, "Unable to build workspace with unsupported parameters", err}
}

resolver := codersdk.ParameterResolver{
Rich: db2sdk.WorkspaceBuildParameters(lastBuildParameters),
Rich: db2sdk.WorkspaceBuildParameters(lastBuildParameters),
Transition: codersdk.WorkspaceTransition(b.trans),
}
for _, templateVersionParameter := range templateVersionParameters {
tvp, err := db2sdk.TemplateVersionParameter(templateVersionParameter)
Expand Down
9 changes: 8 additions & 1 deletion codersdk/richparameters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,18 @@ func validationEnabled(param TemplateVersionParameter) bool {
// correctly validates.
// @typescript-ignore ParameterResolver
type ParameterResolver struct {
Rich []WorkspaceBuildParameter
Rich []WorkspaceBuildParameter
Transition WorkspaceTransition
}

// ValidateResolve checks the provided value, v, against the parameter, p, and the previous build. If v is nil, it also
// resolves the correct value. It returns the value of the parameter, if valid, and an error if invalid.
func (r *ParameterResolver) ValidateResolve(p TemplateVersionParameter, v *WorkspaceBuildParameter) (value string, err error) {
// Assume value for required, ephemeral parameter for stopped/deleted workspace
if p.Ephemeral && r.Transition != "" && r.Transition != WorkspaceTransitionStart {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In what situation will we get an empty transition?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess, only unit tests?

return "", nil
}

prevV := r.findLastValue(p)
if !p.Mutable && v != nil && prevV != nil {
return "", xerrors.Errorf("Parameter %q is not mutable, so it can't be updated after creating a workspace.", p.Name)
Expand All @@ -171,6 +177,7 @@ func (r *ParameterResolver) ValidateResolve(p TemplateVersionParameter, v *Works
Value: p.DefaultValue,
}
}

err = ValidateWorkspaceBuildParameter(p, resolvedValue, prevV)
if err != nil {
return "", err
Expand Down
21 changes: 20 additions & 1 deletion codersdk/richparameters_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,9 @@ func TestParameterResolver_ValidateResolve_Ephemeral_UseEmptyDefault(t *testing.

func TestParameterResolver_ValidateResolve_Ephemeral_RequiredButMissing(t *testing.T) {
t.Parallel()
uut := codersdk.ParameterResolver{}
uut := codersdk.ParameterResolver{
Transition: codersdk.WorkspaceTransitionStart,
}
p := codersdk.TemplateVersionParameter{
Name: "n",
Type: "number",
Expand All @@ -394,3 +396,20 @@ func TestParameterResolver_ValidateResolve_Ephemeral_RequiredButMissing(t *testi
require.Error(t, err) // Parameter is required, but not provided.
require.Equal(t, "", v)
}

func TestParameterResolver_ValidateResolve_Ephemeral_RequiredButMissing_StoppedWorkspace(t *testing.T) {
t.Parallel()
uut := codersdk.ParameterResolver{
Transition: codersdk.WorkspaceTransitionStop,
}
p := codersdk.TemplateVersionParameter{
Name: "n",
Type: "number",
Mutable: true,
Required: true,
Ephemeral: true,
}
v, err := uut.ValidateResolve(p, nil)
require.NoError(t, err) // Parameter is not provided, but resolver assumes an empty value.
require.Equal(t, "", v)
}