Clarify argument capturing behaviour of With #1325
Merged
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
jquirke
force-pushed
the
clarify-with-captures
branch
2 times, most recently
from
df34488
to
8c6bb33
Compare
Make it clear that the contract with the With and logging methods is such that any arguments that could change are captured at the time of the With and logging method, and that any other behaviour introduced in future is intentionally contrary to this contract. There are proposed (uber-go#1319) future opt-in, changes that will explicitly relax this contract.
jquirke
force-pushed
the
clarify-with-captures
branch
from
8c6bb33
to
9b25d87
Compare
Use a custom encoder that only adds the message and nothing else, and assert.JSONEq to avoid having to JSON decode into a custom struct. This also fixes the actual test case: `b: [1]` should not be present in the second log entry, because it's not added to the logger.
abhinav
approved these changes
Aug 18, 2023
There was a problem hiding this comment.
Great! I tweaked the test a bit: assert.JSONEq plus an encoder that doesn't include time so that we don't have to json.Unmarshal.
Also, the test case was a bit off: b: [1] will not be present in the second entry
because Array("b", ..) was only used with the logger.Info, not logger.With.
Codecov Report
@@ Coverage Diff @@
## master #1325 +/- ##
=======================================
Coverage 97.77% 97.77%
=======================================
Files 51 51
Lines 3366 3366
=======================================
Hits 3291 3291
Misses 65 65
Partials 10 10
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
I'm late, but thanks for doing this! |
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.
Make it clear that the contract with the With and logging methods is such that any arguments that could change are captured at the time of the With and logging method, and that any other behaviour introduced in future is intentionally contrary to this contract.
There are proposed (#1319) future opt-in, changes that will explicitly relax this contract.