Skip to content
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

Jump to bottom

Passing on secret option in config client #1391

Merged
merged 5 commits into from Sep 25, 2020
Merged

Passing on secret option in config client #1391

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2b5c03e
Passing on secret option in config client
crufter Sep 24, 2020
4e96b86
Test change
crufter Sep 24, 2020
b3f4b1d
Fix test
crufter Sep 24, 2020
7d1c08f
config: refactor secret into options message
ben-toogood Sep 25, 2020
e9c05a1
config: refactor secret into options message (cli)
ben-toogood Sep 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions service/config/client/client.go
View file
Open in desktop
Expand Up @@ -24,10 +24,15 @@ type srv struct {
}

func (m *srv) Get(path string, options ...config.Option) (config.Value, error) {
o := config.Options{}
for _, option := range options {
option(&o)
}
nullValue := config.NewJSONValue([]byte("null"))
req, err := m.client.Get(context.DefaultContext, &proto.GetRequest{
Namespace: m.namespace,
Path: path,
Secret: o.Secret,
Copy link
Member

Choose a reason for hiding this comment

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

If its an option it should be in options

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will change config endpoint interface then, but tests need this fix as they fail for Ben now.

Copy link
Contributor Author

@crufter crufter Sep 24, 2020 •
edited

Choose a reason for hiding this comment

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

BTW, I think we should consider adopting the convention of top level fields for endpoints as

micro config set --secret

Looks better than

micro config set --options.secret

(Config is a bad example here as it's a hardcoded one)

Something to think about, perhaps it's not right and indeed if something is optional it can be prefixed with options on the CLI too.

Copy link
Member

Choose a reason for hiding this comment

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

When I say add to options I simply mean in the RPC requests. It's being added as an extra field but should mimic other protos that add an options field with Options message type that will contain the secret option. In regards to the CLI behaviour I agree --secret is better.

Copy link
Contributor

Choose a reason for hiding this comment

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

I've amended the proto, waiting for builds to pass so we can merge.

}, goclient.WithAuthToken())
if verr := errors.Parse(err); verr != nil && verr.Code == http.StatusNotFound {
return nullValue, nil
Expand All @@ -39,10 +44,15 @@ func (m *srv) Get(path string, options ...config.Option) (config.Value, error) {
}

func (m *srv) Set(path string, value interface{}, options ...config.Option) error {
o := config.Options{}
for _, option := range options {
option(&o)
}
dat, _ := json.Marshal(value)
_, err := m.client.Set(context.DefaultContext, &proto.SetRequest{
Namespace: m.namespace,
Path: path,
Secret: o.Secret,
Value: &proto.Value{
Data: string(dat),
},
Expand Down
4 changes: 2 additions & 2 deletions test/service/config-example/main.go
View file
Open in desktop
Expand Up @@ -27,8 +27,8 @@ func main() {

val, _ = config.Get("key", config.Secret(true))
c := conf{}
val.Scan(&c)
fmt.Println("Value of key.subkey1: ", c.Key.Subkey1)
err = val.Scan(&c.Key)
fmt.Println("Value of key.subkey1: ", c.Key.Subkey1, err)
}
}()

Expand Down