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.

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

registry: Allow configuring the logger #521

Closed
wants to merge 1 commit into from
Closed

registry: Allow configuring the logger #521

wants to merge 1 commit into from

Conversation

nhooyr
Copy link

@nhooyr nhooyr commented Sep 11, 2019

No description provided.

@jonjohnsonjr
Copy link
Collaborator

cc @clrprod

@codecov-io
Copy link

codecov-io commented Sep 12, 2019

Codecov Report

Merging #521 into master will increase coverage by 0.01%.
The diff coverage is 88.88%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #521      +/-   ##
==========================================
+ Coverage   73.13%   73.15%   +0.01%     
==========================================
  Files          92       92              
  Lines        3905     3915      +10     
==========================================
+ Hits         2856     2864       +8     
- Misses        690      691       +1     
- Partials      359      360       +1
Impacted Files Coverage Δ
pkg/registry/registry.go 94.87% <88.88%> (-5.13%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8b1ae43...1cc28c7. Read the comment docs.

@clrprod
Copy link
Contributor

clrprod commented Sep 18, 2019

Sorry for the delay taking a look now.

// Log is used to log requests.
// If nil, the global logger is used.
Log *log.Logger
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks awesome - I think this is definitely a pretty reasonable thing to change and thank you for sending in the change.

They style in go is generally to define a option type - i.e.

type Option func(o *registry)

And then have New take variadic arguments - i.e.
New(o Option...)

and in the body do something like

opts := &registry{log:defaultLog}
for _, o := range options {
o(opts)
}

And define the logger option like
func WithLogger(l log.Type) Option

so you can call New() to get default behaviour, New(WithLogger(log.SomethingComplicated)) to get more interesting behaviour.

Let me know if that makes sense - I'm happy to have the log be configurable, just want to make sure the option pattern is nice for the user. I'm also happy to make these changes if I'm asking for too much work from you.

Copy link
Author

Choose a reason for hiding this comment

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

They style in go is generally to define a option type - i.e.

Its another pattern for sure but I wouldn't say its generally better. The stdlib for example doesn't use it at all and even though later packages did, the new go-cloud package made by the Go team explicitly decided against using them in favour of optional structs.

See google/go-cloud#908 (comment)

Copy link
Author

Choose a reason for hiding this comment

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

I'm also happy to make these changes if I'm asking for too much work from you.

Feel free to take over.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think both approaches are reasonable. There are definitely some hard to solve problems with the functional options approach, but it looks so much nicer in some cases 😄

We should keep in mind any other extension points e.g. #488

Copy link
Contributor

Choose a reason for hiding this comment

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

I pushed a version of this in #537 - let me know what you think :D

@nhooyr
Copy link
Author

nhooyr commented Sep 19, 2019

Closed in favour of #537

@nhooyr nhooyr closed this Sep 19, 2019
@nhooyr nhooyr deleted the log-opt branch September 19, 2019 16:44
@nhooyr nhooyr restored the log-opt branch September 19, 2019 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants