nest: Add PreNest marker (and other cleanups) #12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The PreNest marker allows us to drop the empty-string delimiters from library callers and still get readable output from fmt.Print-style renderers. I've added a new unit test showing that log implementations that want to detect Markers should use reflect.DeepEqual or something else that is stricter than ==. I've also adjusted the expected order of keys in the unit-test map. Currently this output is unstable, but [1,2,3] will have the order stabilized in future Go releases. The change here sets us up for compatibility with that new logic. I've also made the Newf and Logf implementations more compact by turning them into wrappers around New and Log respectively. [1]: https://go-review.googlesource.com/c/go/+/142737/ [2]: golang/go@a440cc0 [3]: golang/go#21095
|
I think my only qualm would be the naming. Nest/PreNest doesn't feel like the right thing. Going to merge but we need to change to something else I think. |
|
No need to rush these in ;). I'm fine letting them wait while we work out naming, etc. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
PreNestmarker allows us to drop the empty-string delimiters from library callers and still get readable output fromfmt.Print-style renderers. I've added a new unit test showing that log implementations that want to detectMarkers should usereflect.DeepEqualor something else that is stricter than==.I've also adjusted the expected order of keys in the unit-test map. Currently this output is unstable, but this (golang/go@a440cc0, golang/go#21095) will have the order stabilized in future Go releases. The change here sets us up for compatibility with that new logic.
I've also made the
NewfandLogfimplementations more compact by turning them into wrappers aroundNewandLogrespectively.I think this stabilizes around the library-consumer API we want here. There's probably still room for improvement in the parent-facing API (e.g. storing wrapping-call-site in the marker so parents can toggle logger display on a per-package basis?), but stabilizing that API is less important.