Skip to content

chore: color value_source for deployment values #9922

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

Merged
merged 21 commits into from
Sep 29, 2023
Merged

chore: color value_source for deployment values #9922

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
ac997a9
chore: Return populated options vs a blank
Emyrk Sep 28, 2023
3748430
Strip secret values
Emyrk Sep 28, 2023
07588ec
Merge remote-tracking branch 'origin/main' into stevenmasley/deployme…
Emyrk Sep 28, 2023
e1a8997
Color the value source for a deployment value
Emyrk Sep 28, 2023
a6cc10e
Use theme colors
Emyrk Sep 28, 2023
be1aec3
try going with a blue
Emyrk Sep 28, 2023
dc67bb7
Fix json marshal of secrets
Emyrk Sep 28, 2023
53b147b
Fix unmarshal json for optionsets
Emyrk Sep 29, 2023
b1058a6
Add comment
Emyrk Sep 29, 2023
6ce3af7
Add diff color to config option when it is source
BrunoQuaresma Sep 29, 2023
5049884
rename optionset receiver
Emyrk Sep 29, 2023
9e68d53
fixup! rename optionset receiver
Emyrk Sep 29, 2023
27cc9f3
Ignore unused arg
Emyrk Sep 29, 2023
a5029d1
Add json marshal/unmarshal test
Emyrk Sep 29, 2023
ab2ecd9
Fixups
Emyrk Sep 29, 2023
1afa4fe
Use nil for secret types
Emyrk Sep 29, 2023
03a7883
Add unit test for missing opts case
Emyrk Sep 29, 2023
93aa426
Linting
Emyrk Sep 29, 2023
42fb5d0
Fix unit test
Emyrk Sep 29, 2023
cbb69bc
Formatting
Emyrk Sep 29, 2023
b5a9164
Increment the error context counter
Emyrk Sep 29, 2023
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
Prev Previous commit
Next Next commit
Fixups
  • Loading branch information
@Emyrk
Emyrk committed Sep 29, 2023
commit ab2ecd955fa5ecc00b52e4a70ea12fcb5a124d81
13 changes: 7 additions & 6 deletions cli/clibase/option.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ type OptionSet []Option
//
// The value is discarded if it's type cannot be inferred. This behavior just
// feels "safer", although it should never happen if the correct option set
// is passed in.
// is passed in. The situation where this could occur is if a client and server
// are on different versions with different options.
func (optSet *OptionSet) UnmarshalJSON(data []byte) error {
dec := json.NewDecoder(bytes.NewBuffer(data))
// Should be a json array, so consume the starting open bracket.
Expand Down Expand Up @@ -136,23 +137,23 @@ OptionSetDecodeLoop:

// Try to see if the option already exists in the option set.
// If it does, just update the existing option.
for i, have := range *optSet {
for optIndex, have := range *optSet {
if have.Name == opt.Name {
if jValue != nil {
err := json.Unmarshal(jValue, &(*optSet)[i].Value)
err := json.Unmarshal(jValue, &(*optSet)[optIndex].Value)
if err != nil {
return xerrors.Errorf("decode option %q value: %w", have.Name, err)
}
// Set the opt's value
opt.Value = (*optSet)[i].Value
opt.Value = (*optSet)[optIndex].Value
} else {
// Hopefully the user passed empty values in the option set. There is no easy way
// to tell, and if we do not do this, it breaks json.Marshal if we do it again on
// this new option set.
opt.Value = (*optSet)[i].Value
opt.Value = (*optSet)[optIndex].Value
}
// Override the existing.
(*optSet)[i] = opt
(*optSet)[optIndex] = opt
// Go to the next option to decode.
continue OptionSetDecodeLoop
}
Expand Down
2 changes: 1 addition & 1 deletion coderd/coderd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ type Options struct {
MetricsCacheRefreshInterval time.Duration
AgentStatsRefreshInterval time.Duration
DeploymentValues *codersdk.DeploymentValues
// DeploymentOptions do contain the copy of DeploymentValues, but contain
// DeploymentOptions do contain the copy of DeploymentValues, and contain
// contextual information about how the values were set.
// Do not use DeploymentOptions to retrieve values, use DeploymentValues instead.
Copy link
Member

Choose a reason for hiding this comment

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

Why not just strip all values from DeploymentOptions then? Too many allocations?

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 wanted to go this route, but the UI grabs the value from the option. Values are returned in the parsed form, and the option form:

coder/coderd/deployment.go

Lines 34 to 37 in b1058a6

codersdk.DeploymentConfig{
Values: values,
Options: api.DeploymentOptions,
},

There is no way to associate the values between the two, so the value needs to be present on the Option for the UI to know.

I feel like this could use a bit of a refactor, but it is working and not really that important.

// All secrets values are stripped.
Expand Down