Fix entry data bleed when using WithContext and WithTime #1072
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
Creates a copy of the data map when using WithContext to create a child entity. Without this, the data map of the parent entitiy, which is exposed in the entity struct, is shared between a parent and all children instances. This can create bugs of shared or overwritten data when a parent entity is used to make children in differing contexts, and behaves differently than `WithField` and its diritivites which does make a copy of the data. Additionally implements the same logic for WithTime, for API consistency in behavior.
|
@dgsb Looks like you're one of the more active maintainers here. If this LGTY (or another maintainer) I can add an entry to the changelog if you'd like me to, or you're welcome to. This change maintains API compatibility but technically breaks backwards compatibility if a user is reliant on the bug to share data amongst entities. However, I don't think that's a significant enough risk to justify a major version release as strict semver would dictate, so I was thinking a patch release to 1.4.3 would be best? |
Clarifies the data used in the EntryWithContextCopiesData test and adds an equivalent test to verify the behavior of WithTime.
taywrobel
changed the title
|
@freeformzSFDC Any chance you can review this and get it published? We're needing to do a pretty questionable workaround for this right now, and having an upstream fix available would be 🍬 |
cgxxv
pushed a commit
to cgxxv/logrus
that referenced
this pull request
Mar 25, 2022
…sEntities Fix entry data bleed when using WithContext and WithTime
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.
Creates a copy of the
Datamap when usingWithContextto create achild Entry. Without this, the data map of the parent Entry,
which is exposed in the Entry struct, is shared between a parent
and all children instances.
This can create bugs of shared or overwritten data when a parent
Entry is used to make children in differing contexts, and behaves
differently than
WithFieldand its derivatives which does makea copy of the
Datamap.Additionally implements the same logic for
WithTime, for APIconsistency in behavior.