|
| 1 | +package dynamicparameters |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "fmt" |
| 6 | + |
| 7 | + "github.com/google/uuid" |
| 8 | + "github.com/hashicorp/hcl/v2" |
| 9 | + |
| 10 | + "github.com/coder/coder/v2/coderd/database" |
| 11 | + "github.com/coder/coder/v2/coderd/util/slice" |
| 12 | + "github.com/coder/coder/v2/codersdk" |
| 13 | +) |
| 14 | + |
| 15 | +type parameterValueSource int |
| 16 | + |
| 17 | +const ( |
| 18 | + sourceDefault parameterValueSource = iota |
| 19 | + sourcePrevious |
| 20 | + sourceBuild |
| 21 | + sourcePreset |
| 22 | +) |
| 23 | + |
| 24 | +type parameterValue struct { |
| 25 | + Value string |
| 26 | + Source parameterValueSource |
| 27 | +} |
| 28 | + |
| 29 | +//nolint:revive // firstbuild is a control flag to turn on immutable validation |
| 30 | +func ResolveParameters( |
| 31 | + ctx context.Context, |
| 32 | + ownerID uuid.UUID, |
| 33 | + renderer Renderer, |
| 34 | + firstBuild bool, |
| 35 | + previousValues []database.WorkspaceBuildParameter, |
| 36 | + buildValues []codersdk.WorkspaceBuildParameter, |
| 37 | + presetValues []database.TemplateVersionPresetParameter, |
| 38 | +) (map[string]string, hcl.Diagnostics) { |
| 39 | + previousValuesMap := slice.ToMap(previousValues, func(p database.WorkspaceBuildParameter) (string, string) { |
| 40 | + return p.Name, p.Value |
| 41 | + }) |
| 42 | + |
| 43 | + // Start with previous |
| 44 | + values := parameterValueMap(slice.ToMap(previousValues, func(p database.WorkspaceBuildParameter) (string, parameterValue) { |
| 45 | + return p.Name, parameterValue{Source: sourcePrevious, Value: p.Value} |
| 46 | + })) |
| 47 | + |
| 48 | + // Add build values (overwrite previous values if they exist) |
| 49 | + for _, buildValue := range buildValues { |
| 50 | + values[buildValue.Name] = parameterValue{Source: sourceBuild, Value: buildValue.Value} |
| 51 | + } |
| 52 | + |
| 53 | + // Add preset values (overwrite previous and build values if they exist) |
| 54 | + for _, preset := range presetValues { |
| 55 | + values[preset.Name] = parameterValue{Source: sourcePreset, Value: preset.Value} |
| 56 | + } |
| 57 | + |
| 58 | + // originalValues is going to be used to detect if a user tried to change |
| 59 | + // an immutable parameter after the first build. |
| 60 | + originalValues := make(map[string]parameterValue, len(values)) |
| 61 | + for name, value := range values { |
| 62 | + // Store the original values for later use. |
| 63 | + originalValues[name] = value |
| 64 | + } |
| 65 | + |
| 66 | + // Render the parameters using the values that were supplied to the previous build. |
| 67 | + // |
| 68 | + // This is how the form should look to the user on their workspace settings page. |
| 69 | + // This is the original form truth that our validations should initially be based on. |
| 70 | + output, diags := renderer.Render(ctx, ownerID, values.ValuesMap()) |
| 71 | + if diags.HasErrors() { |
| 72 | + // Top level diagnostics should break the build. Previous values (and new) should |
| 73 | + // always be valid. If there is a case where this is not true, then this has to |
| 74 | + // be changed to allow the build to continue with a different set of values. |
| 75 | + |
| 76 | + return nil, diags |
| 77 | + } |
| 78 | + |
| 79 | + // The user's input now needs to be validated against the parameters. |
| 80 | + // Mutability & Ephemeral parameters depend on sequential workspace builds. |
| 81 | + // |
| 82 | + // To enforce these, the user's input values are trimmed based on the |
| 83 | + // mutability and ephemeral parameters defined in the template version. |
| 84 | + // The output parameters |
| 85 | + for _, parameter := range output.Parameters { |
| 86 | + // Ephemeral parameters should not be taken from the previous build. |
| 87 | + // They must always be explicitly set in every build. |
| 88 | + // So remove their values if they are sourced from the previous build. |
| 89 | + if parameter.Ephemeral { |
| 90 | + v := values[parameter.Name] |
| 91 | + if v.Source == sourcePrevious { |
| 92 | + delete(values, parameter.Name) |
| 93 | + } |
| 94 | + } |
| 95 | + |
| 96 | + // Immutable parameters should also not be allowed to be changed from |
| 97 | + // the previous build. Remove any values taken from the preset or |
| 98 | + // new build params. This forces the value to be the same as it was before. |
| 99 | + // |
| 100 | + // We do this so the next form render uses the original immutable value. |
| 101 | + if !firstBuild && !parameter.Mutable { |
| 102 | + delete(values, parameter.Name) |
| 103 | + prev, ok := previousValuesMap[parameter.Name] |
| 104 | + if ok { |
| 105 | + values[parameter.Name] = parameterValue{ |
| 106 | + Value: prev, |
| 107 | + Source: sourcePrevious, |
| 108 | + } |
| 109 | + } |
| 110 | + } |
| 111 | + } |
| 112 | + |
| 113 | + // This is the final set of values that will be used. Any errors at this stage |
| 114 | + // are fatal. Additional validation for immutability has to be done manually. |
| 115 | + output, diags = renderer.Render(ctx, ownerID, values.ValuesMap()) |
| 116 | + if diags.HasErrors() { |
| 117 | + return nil, diags |
| 118 | + } |
| 119 | + |
| 120 | + // parameterNames is going to be used to remove any excess values that were left |
| 121 | + // around without a parameter. |
| 122 | + parameterNames := make(map[string]struct{}, len(output.Parameters)) |
| 123 | + for _, parameter := range output.Parameters { |
| 124 | + parameterNames[parameter.Name] = struct{}{} |
| 125 | + |
| 126 | + if !firstBuild && !parameter.Mutable { |
| 127 | + // Immutable parameters should not be changed after the first build. |
| 128 | + // They can match the original value though! |
| 129 | + if parameter.Value.AsString() != originalValues[parameter.Name].Value { |
| 130 | + var src *hcl.Range |
| 131 | + if parameter.Source != nil { |
| 132 | + src = ¶meter.Source.HCLBlock().TypeRange |
| 133 | + } |
| 134 | + |
| 135 | + // An immutable parameter was changed, which is not allowed. |
| 136 | + // Add the failed diagnostic to the output. |
| 137 | + diags = diags.Append(&hcl.Diagnostic{ |
| 138 | + Severity: hcl.DiagError, |
| 139 | + Summary: "Immutable parameter changed", |
| 140 | + Detail: fmt.Sprintf("Parameter %q is not mutable, so it can't be updated after creating a workspace.", parameter.Name), |
| 141 | + Subject: src, |
| 142 | + }) |
| 143 | + } |
| 144 | + } |
| 145 | + |
| 146 | + // TODO: Fix the `hcl.Diagnostics(...)` type casting. It should not be needed. |
| 147 | + if hcl.Diagnostics(parameter.Diagnostics).HasErrors() { |
| 148 | + // All validation errors are raised here. |
| 149 | + diags = diags.Extend(hcl.Diagnostics(parameter.Diagnostics)) |
| 150 | + } |
| 151 | + |
| 152 | + // If the parameter has a value, but it was not set explicitly by the user at any |
| 153 | + // build, then save the default value. An example where this is important is if a |
| 154 | + // template has a default value of 'region = us-west-2', but the user never sets |
| 155 | + // it. If the default value changes to 'region = us-east-1', we want to preserve |
| 156 | + // the original value of 'us-west-2' for the existing workspaces. |
| 157 | + // |
| 158 | + // parameter.Value will be populated from the default at this point. So grab it |
| 159 | + // from there. |
| 160 | + if _, ok := values[parameter.Name]; !ok && parameter.Value.IsKnown() && parameter.Value.Valid() { |
| 161 | + values[parameter.Name] = parameterValue{ |
| 162 | + Value: parameter.Value.AsString(), |
| 163 | + Source: sourceDefault, |
| 164 | + } |
| 165 | + } |
| 166 | + } |
| 167 | + |
| 168 | + // Delete any values that do not belong to a parameter. This is to not save |
| 169 | + // parameter values that have no effect. These leaky parameter values can cause |
| 170 | + // problems in the future, as it makes it challenging to remove values from the |
| 171 | + // database |
| 172 | + for k := range values { |
| 173 | + if _, ok := parameterNames[k]; !ok { |
| 174 | + delete(values, k) |
| 175 | + } |
| 176 | + } |
| 177 | + |
| 178 | + // Return the values to be saved for the build. |
| 179 | + return values.ValuesMap(), diags |
| 180 | +} |
| 181 | + |
| 182 | +type parameterValueMap map[string]parameterValue |
| 183 | + |
| 184 | +func (p parameterValueMap) ValuesMap() map[string]string { |
| 185 | + values := make(map[string]string, len(p)) |
| 186 | + for name, paramValue := range p { |
| 187 | + values[name] = paramValue.Value |
| 188 | + } |
| 189 | + return values |
| 190 | +} |
0 commit comments