fix: Ensure tags values are strings #4459
Open
Conversation
This file contains hidden or 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ All tests successful. No failed tests found. Additional details and impacted files@@ Coverage Diff @@
## master #4459 +/- ##
=======================================
Coverage 80.59% 80.60%
=======================================
Files 142 142
Lines 16030 16030
Branches 2745 2748 +3
=======================================
+ Hits 12920 12921 +1
Misses 2243 2243
+ Partials 867 866 -1
|
|
Looks like tests are failing because the non-string values were being asserted in the test suites |
sentrivana
reviewed
Jun 17, 2025
There was a problem hiding this comment.
Some high-level thoughts:
- We seem to be stringifying the tags in multiple places. Do we need to do it in all of those? Is there a way to centralize it, e.g. move it to the end of the pipeline, e.g. in the serializer?
- Are we sure we're not changing anything user-facing, especially in callbacks? (E.g. if a user is accessing tags in a
before_sendor similar.)
Comment on lines
+964
to
+1015
| def test_set_tag_handles_conversion_failure(): | ||
| """Test that set_tag handles objects that fail to convert to string.""" | ||
| scope = Scope() | ||
|
|
||
| # Create an object that raises an exception when str() is called | ||
| class BadObject: | ||
| def __str__(self): | ||
| raise Exception("Cannot convert to string") | ||
|
|
||
| def __repr__(self): | ||
| return "BadObject()" | ||
|
|
||
| bad_obj = BadObject() | ||
|
|
||
| # This should not raise an exception | ||
| scope.set_tag("bad_object", bad_obj) | ||
|
|
||
| # The tag should be set with the repr value | ||
| event = scope.apply_to_event({}, {}) | ||
| tags = event.get("tags", {}) | ||
|
|
||
| assert tags["bad_object"] == "BadObject()", "Tag should be set with repr value" | ||
|
|
||
|
|
||
| def test_set_tags_handles_conversion_failure(): | ||
| """Test that set_tags handles objects that fail to convert to string.""" | ||
| scope = Scope() | ||
|
|
||
| # Create an object that raises an exception when str() is called | ||
| class BadObject: | ||
| def __str__(self): | ||
| raise Exception("Cannot convert to string") | ||
|
|
||
| def __repr__(self): | ||
| return "BadObject()" | ||
|
|
||
| bad_obj = BadObject() | ||
|
|
||
| scope.set_tags( | ||
| { | ||
| "good_tag1": "value1", | ||
| "bad_tag": bad_obj, | ||
| "good_tag2": 123, | ||
| } | ||
| ) | ||
|
|
||
| event = scope.apply_to_event({}, {}) | ||
| tags = event.get("tags", {}) | ||
|
|
||
| assert tags["good_tag1"] == "value1" | ||
| assert tags["bad_tag"] == "BadObject()", "Tag should be set with repr value" | ||
| assert tags["good_tag2"] == "123" |
There was a problem hiding this comment.
Maybe consolidate these two test cases into one?
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.
Ensure tag values are strings before serializing an event or a transaction to an
Eventdictionary.Fixes #4391